Optimal.Doc (optimal v0.3.7)

View Source

Automatic opt documentation, to be placed into your function docstrings

Summary

Functions

document(schema, doc_opts \\ [])

@spec document(schema :: Optimal.schema(), doc_opts :: Keyword.t()) :: String.t()

Opts

  • name(:string): The top level header for the opts documentation - Default: "Opts"
  • header_depth(:int): How many # to prepend before any heading - Default: 1