DocumentFunction.jl

DocumentFunction.jl provides tools for documenting Julia functions.

DocumentFunction.jl produces automated outputs about function methods, arguments and keywords in the function documentation text.

DocumentFunction.jl generated text is accessible in REPL and by Documenter.jl.

DocumentFunction.jl module functions:

DocumentFunction.documentfunction — Method

Create function documentation

Arguments:

f: function to be documented

Keywords:

maintext: function description
argtext: dictionary with text for each argument
keytext: dictionary with text for each keyword
location: show/hide function location on the disk

DocumentFunction.getfunctionarguments — Function

Get function arguments

Arguments:

f: function to be documented"
m: function methods

DocumentFunction.getfunctionkeywords — Function

Get function keywords

Arguments:

f: function to be documented
m: function methods

DocumentFunction.getfunctionmethods — Method

Get function methods

Arguments:

f: function to be documented

Return:

Array with function methods