edit

DocumentFunction.jl

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

DocumentFunction.jl module functions:

# DocumentFunction.documentfunctionFunction.

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.getfunctionargumentsFunction.

Get function arguments

Arguments:

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

source

# DocumentFunction.getfunctionkeywordsFunction.

Get function keywords

Arguments:

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

source

# DocumentFunction.getfunctionmethodsMethod.

Get function methods

Arguments:

  • f: function to be documented

Return:

  • array with function methods

source

# DocumentFunction.stdoutcaptureoffMethod.

Restore STDOUT

source

# DocumentFunction.stdoutcaptureonMethod.

Redirect STDOUT to a reader

source