Docile.Interface

Functions [Exported]


parsedocs

Parsing hook for specifying how to parse raw docstrings into formatted text.

source: Docile/src/Interface/legacy.jl:188

Methods [Exported]


category{C}(::Docile.Legacy.Entry{C})

What category does an Entry object belong to?

source: Docile/src/Interface/legacy.jl:137


data(d::Docile.Legacy.Docs{format})

Raw docstring associated with a Docs object d.

source: Docile/src/Interface/legacy.jl:169


docs(e::Docile.Legacy.Entry{category})

The Docs object for an Entry object e.

source: Docile/src/Interface/legacy.jl:158


documentation(mod::Module)

The Metadata object associated with a module mod.

source: Docile/src/Interface/legacy.jl:203


documented()

Returns the modules that are currently documented by Docile.

source: Docile/src/Interface/legacy.jl:26


entries(meta::Docile.Legacy.Metadata)

ObjectIdDict containing documented objects and their associated Entrys.

source: Docile/src/Interface/legacy.jl:68


files(meta::Docile.Legacy.Metadata)

List of all included files in a module documented by Metadata object meta.

source: Docile/src/Interface/legacy.jl:82


format{F}(d::Docile.Legacy.Docs{F})

The format that a docstring is written in.

source: Docile/src/Interface/legacy.jl:176


isdocumented(mod::Module)

Is the module mod documented by Docile?

source: Docile/src/Interface/legacy.jl:31


isexported(modname::Module, object)

Is the documented object object been exported from the given module modname?

source: Docile/src/Interface/legacy.jl:101


isloaded(meta::Docile.Legacy.Metadata)

Have the docstrings contained in a module been collected yet?

source: Docile/src/Interface/legacy.jl:89


manual(meta::Docile.Legacy.Metadata)

The manual files for a Metadata object meta.

source: Docile/src/Interface/legacy.jl:61


metadata(e::Docile.Legacy.Entry{category})

Arbitrary additional metadata associated with a particular Entry e.

source: Docile/src/Interface/legacy.jl:151


metadata(meta::Docile.Legacy.Metadata)

The Dict{Symbol, Any} containing arbitrary additional data about a Metadata object.

source: Docile/src/Interface/legacy.jl:96


metadata(mod::Module)

Get the Metadata object associated with a module mod.

source: Docile/src/Interface/legacy.jl:38


modulename(e::Docile.Legacy.Entry{category})

Which module does the Entry object come from?

source: Docile/src/Interface/legacy.jl:144


modulename(meta::Docile.Legacy.Metadata)

The Module that a Metadata object documents.

source: Docile/src/Interface/legacy.jl:54


parsed(d::Docile.Legacy.Docs{format})

Get the parsed docstring for a Docs object d.

source: Docile/src/Interface/legacy.jl:183


root(meta::Docile.Legacy.Metadata)

The rootfile of the module documented by a Metadata object meta.

source: Docile/src/Interface/legacy.jl:75

Functions [Internal]


name

Get the Symbol representing an object such as Function or Method.

source: Docile/src/Interface/legacy.jl:120

Globals [Internal]


DOCUMENTED

Storage for deprecated Metadata documentation.

source: Docile/src/Interface/legacy.jl:21