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 descriptionargtext
: dictionary with text for each argumentkeytext
: dictionary with text for each keywordlocation
: 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 documentedm
: function methods
#
DocumentFunction.getfunctionmethods
— Method.
Get function methods
Arguments:
f
: function to be documented
Return:
- array with function methods