DocSystem
Documenter.DocSystem
— ModuleProvides a consistent interface to retreiving DocStr
objects from the Julia docsystem in both 0.4
and 0.5
.
Documenter.DocSystem.binding
— MethodConverts 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
.
Documenter.DocSystem.convertmeta
— Methodconvertmeta(meta)
Converts a 0.4
-style docstring cache into a 0.5
one.
The original docstring cache is not modified.
Documenter.DocSystem.docstr
— Methoddocstr(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.
Documenter.DocSystem.getdocs
— Functiongetdocs(object)
getdocs(object, typesig; kws...)
Accepts objects of any type and tries to convert them to Binding
s before searching for the Binding
in the docsystem.
Note that when conversion fails this method returns an empty Vector{DocStr}
.
Documenter.DocSystem.getdocs
— Functiongetdocs(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
comparebeing
==also try getting docs for
<:`.
Documenter.DocSystem.getspecificdocs
— Functiongetspecificdocs(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.
Documenter.DocSystem.multidoc
— FunctionConstruct a MultiDoc
object from the provided argument.
Valid inputs are:
Markdown.MD
Docs.FuncDoc
Docs.TypeDoc
Documenter.DocSystem.parsedoc
— MethodDocSystem.parsedoc(docstr::DocStr)
Thin internal wrapper around Base.Docs.parsedoc
which prints additional debug information in case Base.Docs.parsedoc
fails with an exception.