NDoc User's Guide NDoc 1.3

<list>

[This is preliminary documentation and subject to change]

The <list> tag describes a numbered or bulleted list, a definition list or a table.

<list type="bullet" | "number" | "table" | "definition">
   <listheader>
      <term>term</term>
      <description>description</description>
   </listheader>
   <item>
      <term>term</term>
      <description>description</description>
   </item>
</list>

where:

term
A term to define, which will be defined in description.
description
Either an item in a bullet or numbered list or the definition of a term.

Remarks

The <listheader> block is used to define the heading row of a table.  When defining a table, you only need to supply an entry for term in the heading.

Each item in the list is specified with an <item> block. When creating a definition list, you will need to specify both term and description. However, for a table, bulleted list, or numbered list, you only need to supply an entry for description.

A list or table can have as many <item> blocks as needed.

Examples

See Also

Tag Usage | NDoc Tags | Microsoft's definition