The element contains the documentation for an identifier in a unit. It should occur inside a
module tag. It can contain 4 tags:
-
short
- For a one-line description of the identifier. Is used as a header or is used in overviews
of constants, types, variables or classes.
-
descr
- Contains the actual description of the identifier.
-
errors
- For functions an procedures this can be used to describe error conditions. It will be
put in a separate section below the description section.
-
seealso
- Used to refer to other nodes. will be typeset in a separate section.
The element tag should have at least the name attribute, it is used to link the element node to
the actual identifier in the Pascal unit. Other attributes may be added in future.
Example:
<element name="MyEnym">
<descr>Myenum is a simple enumeration type</descr>
</element>
The following attributes are supported:
-
name
- this attribute is required and should equal the identifier name.
-
opaque
- this attribute is used for opaque types: if set to 1, the declaration will be replaced
with the term “opaque”.
-
link
- this should contain the name of an element. A link to the current element will be
referred to this identifier instead. This can be used in overridden methods/properties
to refer to the parent documentation instead.
-
alwaysvisible
- if set to 1, documentation for the element will be shown anyway, even if the
current visibility is not shown. This can be used to force generation of documentation
for private or protected members of a class even when they are not supposed to be
shown. (for example, --hide-protected is given, and one wishes to show a protected
method.)
-
skip
- if set to 1, the element will not appear in any overviews. A documentation page may
be generated in HTML, but it will not be linked to from any overview.
See also: descr (165), short (212), errors (175), seealso (210)