DocSystem

Documenter.DocSystemModule

Provides a consistent interface to retrieving DocStr objects from the Julia docsystem in both 0.4 and 0.5.

source
Documenter.DocSystem.bindingMethod

Converts an object to a Base.Docs.Binding object.

binding(any)

Supported inputs are:

  • Binding
  • DataType
  • Function
  • Module
  • Symbol

Note that unsupported objects will throw an ArgumentError.

source
Documenter.DocSystem.docstrMethod
docstr(md; kws...)

Construct a DocStr object from a Markdown.MD object.

The optional keyword arguments are used to add new data to the DocStr's .data dictionary.

source
Documenter.DocSystem.getdocsFunction
getdocs(binding; ...)
getdocs(binding, typesig; compare, modules, aliases)

Find all DocStr objects that somehow match the provided arguments. That is, if getspecificdocs fails, get docs for aliases of binding (unless aliases is set to false). For compare being == also try getting docs for <:.

source
Documenter.DocSystem.getdocsFunction
getdocs(object; ...)
getdocs(object, typesig; kws...)

Accepts objects of any type and tries to convert them to Bindings before searching for the Binding in the docsystem.

Note that when conversion fails this method returns an empty Vector{DocStr}.

source
Documenter.DocSystem.getspecificdocsFunction
getspecificdocs(binding)
getspecificdocs(binding, typesig)
getspecificdocs(binding, typesig, compare)
getspecificdocs(binding, typesig, compare, modules)

Find all DocStr objects that match the provided arguments exactly.

  • binding: the name of the object.
  • typesig: the signature of the object. Default: Union{}.
  • compare: how to compare signatures? (== (default), <: or >:)
  • modules: which modules to search through. Default: all modules.

Return a Vector{DocStr} ordered by definition order.

source
Documenter.DocSystem.parsedocMethod
DocSystem.parsedoc(docstr::DocStr) -> Markdown.MD

Thin internal wrapper around Base.Docs.parsedoc which prints additional debug information in case Base.Docs.parsedoc fails with an exception.

source