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	165
element	Identifier documentation	173
errors	Error section	175
fpdoc-description	Global tag	179
module	Unit tag	191
package	Package global tab	202
seealso	Cross-reference section	210
short	Short description	212
topic	Topic page	220

Table 5.2: Text formatting tags

Tag	Description	Page

b	Format bold	159
caption	Specify table caption	161
code	Syntax highlight code	163
dd	definition data	167
dl	definition list	169
dt	Definition term	171
i	format italics	180
img	include image	182
li	list element	184
link	Cross-reference	186
ol	numbered list	197
p	paragraph	199
pre	Preformatted text	203
remark	remark paragraph	208
table	Table	214
td	Table cell	216
th	Table header	218
tr	Table row	222
u	format underlined	224
ul	bulleted list	226
var	format as variable	231

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]