Available formatting commands

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

Available formatting commands
Command	Short form	File	Class	Procedure
@argument	@a			+
@author		+	+	+
@bug	@b	+	+	+
@comment	@c	+	+	+
@danger	@d	+	+	+
@date		+	+	+
@example	@ex		+	+
@index	@i	+	+	+
@note	@n	+	+	+
@option	@o		+
@result	@r			+
@see		+	+
@short	@s	+
@var	@v		+
@version		+	+	+

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

Every command is on a single line, all text behind up to the end of the line is considered as its argument(s).
All text referring to the same entity (file, class, procedure) is concatenated together. Line breaks and superfluous whitespace will be eliminated. The HTML-browser is made responsible for a nice presentation.
All commands can be freely mixed. The extractor takes care that their data is placed into separate sections.

@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)
@bug: The text is interpreted as the description of a bug in the refered entity.
@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.
@date: The text is interpreted as date information pertaining to the refered object.
@example: The text is interpreted as an example about the usage of the refered entity. All formatting, especially whitespace, is preserved.
@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.
@version: Contain versioning information about the refered entity.

Remarks:

Unknown commands are simply ignored by the engine.
Method definitions inside a class are treated the same way as procedures.
The texts may contain cross references, these will be resolved before output.

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,