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 | 119 |
| element | Identi er documentation | 127 |
| errors | Error section | 129 |
| fpdoc-description | Global tag | 131 |
| module | Unit tag | 141 |
| package | Package global tab | 148 |
| seealso | Cross-reference section | 154 |
| short | Short description | 156 |
| topic | Topic page | 163 |
|
|
| | |
|
| Table 4.2: | Text formatting tags |
| Tag | Description | Page |
|
|
| | b | Format bold | 113 |
| caption | Specify table caption | 115 |
| code | Syntax highlight code | 117 |
| dd | de nition data | 121 |
| dl | de nition list | 123 |
| dt | De nition term | 125 |
| i | format italics | 132 |
| li | list element | 134 |
| link | Cross-reference | 136 |
| ol | numbered list | 143 |
| p | paragraph | 145 |
| pre | Preformatted text | 149 |
| remark | remark paragraph | 152 |
| table | Table | 158 |
| td | Table cell | 160 |
| th | Table header | 162 |
| tr | Table row | 165 |
| u | format underlined | 167 |
| ul | bulleted list | 169 |
| var | format as variable | 171 |
|
|
| | |
|
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:
Some beginning text
- A list item
some ending text
|
Instead, the correct XML should be
Some beginning text
- A list item
some ending text
|