

DocumentFunction.jl

Module provides tools for documenting Julia functions providing information about function methods, arguments and keywords.

DocumentFunction.jl module functions:

# DocumentFunction.documentfunction — Function.

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

source

# DocumentFunction.getfunctionarguments — Function.

Get function arguments

Arguments:

• f: function to be documented"
• m: function methods

source

# DocumentFunction.getfunctionkeywords — Function.

Get function keywords

Arguments:

• f: function to be documented
• m: function methods

source

# DocumentFunction.getfunctionmethods — Method.

Get function methods

Arguments:

• f: function to be documented

Return:

• array with function methods

source

# DocumentFunction.stdoutcaptureoff — Method.

Restore STDOUT

source

# DocumentFunction.stdoutcaptureon — Method.

Redirect STDOUT to a reader

source