Optionally, the description may be followed by one or more tags.
Our tag convention is strongly based on the conventions used by javaDoc.
It is adviced to place tags in the order they are described below.
@arg Name Description- Defines the predicate arguments. Each argument has its own
@arg
tag. The first word is the name of the argument. The remainder of the
tag is the description. Arguments declarations normally appear in order
used by the predicate.
@param Name Description- This is a synonym for
@arg, using the JavaDoc tag name.
@throws Term Description- Error condition. First Prolog term is the error term. Remainder is the
description.
@error Error Description- As
@throws, but the exception is embedded in error(Error,
Context).
@author Name- Author of the module or predicate. Multiple entries are used if there
are multiple authors.
@version Version- Version of the module. There is no formal versioning system.
@see Text- Point to related material. Often contains links to predicates or files.
@deprecated Alternative- The predicate or module is deprecated. The description specifies what to
use in new code.
@compat Standards and systems- When implementing libraries or externally defined interfaces this tag
describes to which standard the interface is compatible.
@copyright Copyright holder- Copyright notice.
@license License conditions- License conditions that apply to the source.
@bug Bug description- Known problems with the interface or implementation.
@tbd Work to be done- Not yet realised behaviour that is enticipated in future versions.
