Overview

5.3.1 Overview

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 (5.1)
Text structure and formatting 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 (5.2)

Table 5.1: Documentation structure tags

Tag	Description	Page

descr	Element description	167
element	Identifier documentation	175
errors	Error section	177
fpdoc-description	Global tag	183
module	Unit tag	195
package	Package global tab	206
seealso	Cross-reference section	214
short	Short description	216
topic	Topic page	224

Table 5.2: Text formatting tags

Tag	Description	Page

b	Format bold	159
caption	Specify table caption	163
code	Syntax highlight code	165
dd	definition data	169
dl	definition list	171
dt	Definition term	173
i	format italics	184
img	include image	186
li	list element	188
link	Cross-reference	190
ol	numbered list	201
p	paragraph	203
pre	Preformatted text	207
remark	remark paragraph	212
table	Table	218
td	Table cell	220
th	Table header	222
tr	Table row	226
u	format underlined	228
ul	bulleted list	230
var	format as variable	235

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>

[next] [front] [up]