Item Descriptions

Each item (module, class, function, variable) may be described in the source by a comment. A comment between /* and */ before an item is considered the item's description and included into the collected data and generated output. For the module or script itself, it is the comment the module source starts with.

The comment is output "as is", i.e. can be marked up with HTML. The following @-tags in comments are specially processed:

@internal: if the only word in the comment, output of the entire item is suppressed.
{@link item}: insert a link to the item. See the corresponding mdoc.
@param p: explains the function parameter with name p.
@return: explains the return value of a function.

Here is an example:

/* Run the event handling loop. This updates the UI, handles UI commands, idle timer ticks, and, if set, reads from streams. Returns if either {@link exit()} has been called, or a menu command has been executed. @return the menu command, or null if {@link exit()} has been called. */ function run() ...

Next: Module mdoc: Documentation Generator