Docile.Legacy
Macros [Exported]
@comment(text) ¶
Deprecated macro for adding object-independent docstrings to a module.
Use the following syntax instead:
["..."]
source: Docile/src/Legacy/macros.jl:54
@file_str(text) ¶
The text found in the file text
is used as the docstring content.
Deprecated in favour of automatically using a file's content if the docstring matches a file path.
source: Docile/src/Legacy/macros.jl:66
Methods [Internal]
call(::Type{Docile.Legacy.Manual}, ::Void, files) ¶
Usage from REPL, use current directory as root.
source: Docile/src/Legacy/types.jl:49
data(n, docstr) ¶
Assign to docs to n
and return a dictionary of keyword arguments.
source: Docile/src/Legacy/atdoc.jl:26
doc(expr::Expr) ¶
Main documentation generation routine.
source: Docile/src/Legacy/atdoc.jl:73
doc(expr::Expr, generic) ¶
Main documentation generation routine.
source: Docile/src/Legacy/atdoc.jl:73
doc(s::Symbol, ex::Expr) ¶
Detect '@doc+' syntax in macro call.
source: Docile/src/Legacy/atdoc.jl:201
lateguess(::Function) ¶
Return the category of an object.
source: Docile/src/Legacy/atdoc.jl:66
nameof(x::Expr) ¶
Get the symbolic name of an expression.
source: Docile/src/Legacy/atdoc.jl:40
unarrow(x::Expr) ¶
Extract the docstring and expression to be documented from an ->
expression.
source: Docile/src/Legacy/atdoc.jl:59
unblock(x::Expr) ¶
Extract the line number and documented object expression from a block.
source: Docile/src/Legacy/atdoc.jl:52
Macros [Internal]
@doc(ex) ¶
Document an object.
@doc " ... " ->
f(x) = x
@doc+ " ... " ->
g(x) = x
source: Docile/src/Legacy/atdoc.jl:217
@init() ¶
Setup macro-style documentation datastructures.
source: Docile/src/Legacy/atdoc.jl:5