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 — FunctionCreate 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 — FunctionGet function arguments
Arguments:
f: function to be documented"m: function methods
DocumentFunction.getfunctionkeywords — FunctionGet function keywords
Arguments:
f: function to be documentedm: function methods
DocumentFunction.getfunctionmethods — MethodGet function methods
Arguments:
f: function to be documented
Return:
- array with function methods