One line description - the one given by CTRL-H at the command line
MYCOMMAND/QUAL1 | [parname=type] [parname2=type2] | Short description of this function (appears for /HELP) |
MYCOMMAND | Put in a row here only if the command can work without a qualifier. | |
MYCOMMAND:RETURN() | parname3=type3 | Use this syntax when the normal usage of the command would be in this form. |
MYCOMMAND/QUAL2 | etc. etc. |
example:
# Example in preformatted font # with explanatory comment IF NOT device:status() device/open "CPS" height=5.0 ENDIF
Note: Useful note here if necessary; no links here or above (for lynx formatting)
Full and detailed description of the general functioning of this command/qualifier combination, links to related commands if useful, exceptions, general rules etc.
/Optional
Describe only qualifiers which do not affect the parameter list here, before the parameters.
Parname (Type)
Detailed description of what is required for this parameter and if necessary, any non obvious behaviour or default values.
Parname2 (Type2)
As above
RESULT = (Restype)
This is left off completely if the function has no result. Otherwise, gives an exaplanation of the result.
As for Mycommand/Qual1
Everything similar to above descriptions but of course there will always be a RESULT entry here!
Parname3 (Type3)
As above
RESULT = (Boolean)
Returns a result of true if a device is already open.