[next] [prev] [prev-tail] [tail] [up]

#### element : Identifier documentation

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>

See also: descr (104), short (141), errors (114), seealso (139)

[next] [prev] [prev-tail] [front] [up]