The tags can roughly be divided in 2 groups:
- Documentation structure tags. These are needed for fpdoc to do it’s work. They
determine what elements are documented. See table (4.1)
- Text structure and formartting tags. These tags indicate blocks of text, such as
paragraphs, tables, lists and remarks, but also specify formatting: apply formatting
(make-up) to the text, or to provide links to other parts of the text. These mostly occur
in text structure tags. See table (4.2)
| Table 4.1: | Documentation structure tags |
| Tag | Description | Page |
|
|
| | descr | Element description | 136 |
| element | Identifier documentation | 144 |
| errors | Error section | 146 |
| fpdoc-description | Global tag | 148 |
| module | Unit tag | 160 |
| package | Package global tab | 167 |
| seealso | Cross-reference section | 173 |
| short | Short description | 175 |
| topic | Topic page | 182 |
|
|
| | |
|
| Table 4.2: | Text formatting tags |
| Tag | Description | Page |
|
|
| | b | Format bold | 130 |
| caption | Specify table caption | 132 |
| code | Syntax highlight code | 134 |
| dd | definition data | 138 |
| dl | definition list | 140 |
| dt | Definition term | 142 |
| i | format italics | 149 |
| img | include image | 151 |
| li | list element | 153 |
| link | Cross-reference | 155 |
| ol | numbered list | 162 |
| p | paragraph | 164 |
| pre | Preformatted text | 168 |
| remark | remark paragraph | 171 |
| table | Table | 177 |
| td | Table cell | 179 |
| th | Table header | 181 |
| tr | Table row | 184 |
| u | format underlined | 186 |
| ul | bulleted list | 188 |
| var | format as variable | 190 |
|
|
| | |
|
The nodes for formatting a text resemble closely the basic HTML formatting tags with the
following exceptions:
- Each opening tag must have a corresponding closing tag.
- Tags are case sensitive.
- Tables and paragraphs are at the same level, i.e. a table cannot occur inside a
paragraph. The same is true for all ’structural’ tags such as lists,
Also, if special formatting tags such as a table or lists are inserted, then the remaining text must
be inside a paragraph tag. This means that the following is wrong:
<descr>
Some beginning text
<ol>
<li>A list item</li>
</ol>
some ending text
</descr>
|
Instead, the correct XML should be
<descr>
<p>Some beginning text</p>
<ol>
<li>A list item</li>
</ol>
<p>some ending text</p>
</descr>
|