Available formatting commands


Home | Packages | Files | Procedures | Classes | Keywords | External packages


First a table of all commands and their possible place of use:

Available formatting commands

CommandShort formFileClassProcedure
@argument@a+
@author+++
@comment@c+++
@danger@d+++
@index@i+++
@note@n+++
@option@o+
@result@r+
@see++
@short@s+
@var@v+

And now the meaning of the individual commands, with some generalities beforehand.

@argument <name>:
Describes the argument <name> given to the surrounding procedure.
@author
Describes the author of the referred entity. Entities not having an explicitly mentioned author automatically get the author of the containing entity. Distribution -> Package -> File -> Procedure, (Class -> Method)
@comment
The text is interpreted as description of the referred entity.
@danger
The text is interpreted as comment about restrictions, traps, pitfalls, ... the user of the described code has to be aware of.
@index
The text is interpreted as a comma-separated list of keywords to be used for indexing of the referred entity. Procedures and classes without keywords of their own are automatically indexed under the phrases defined for the containing file.
@note
As above, but less strong. May include musings, references to external material, explanation of decisions, hacks, etc. too. In short: Everything neither fitting into the more formal @comment nor the signpost @danger.
@result
Describes the result returned by the surrounding procedure/method.
@see
Cross references to related material (classes, procedures, ...).
@short
The text is interpreted as short description of the referred entity.
@option <name>:
Describes option (parameter) <name> of a class.
@var <name>:
Describes member variable <name> of a class. The old syntax ('@member') is still recognized, but marked as error, and not evaluated.

Remarks:

Next


Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries