fdoc

fdoc( 
s_function 
) 
=> t_doc / nil

Description

Returns the documentation string for the function bound to the symbol s_function. SKILL switch saveInlineDoc must be set to save and retrieve the doc string.

Arguments

Value Returned

Examples

sstatus(saveInlineDoc t) ;; enable inline documentation in compile time
defun(myFun (a b)
"documentation for myFun: return sum a and b"
a + b
)
fdoc('myFun)
=> "documentation for myFun: return sum a and b"=

Related Topics

Core Functions