Meta-documentation for script functions

Forum > Scripting > Meta-documentation for script functions

n/A

postedon March 21, 2013at 3:41 PM

Could you provide a documentation for the (Javadoc-like) documentation mechanism for script functions?

In particular, I am interested in how I can add an 'Example' expression to a parameter documentation, as in the following snippet taken from the documentation of EVAL().

$expressionString (String)
the string with the expression that must be evaluated
Example: '1+2'

Thomas Suter

repliedon March 23, 2013at 7:36 AM

Documentation of function purpose and function parameters uses a small subset of the JavaDoc features.
The coment section has to be right before the function defintion. It starts with/**and ends with */.
Parameter descriptions start on a new line using the following patern "* @param $myVar ma params description"
The return value description follows the pattern "* @return description of return value".
Example expressions cannot be given with this JavaDoc like mechanism.

1/**
2 * A simple example description
3 * @param $text the text whose lenght must be calculated
4 * @return the length of the given text
5 */
6Function CalculateLenghtOfText(String $text) : String Begin
7 Return LENGTH($text);
8End

Please sign in to add a reply