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	171
element	Identifier documentation	179
errors	Error section	181
fpdoc-description	Global tag	187
module	Unit tag	199
package	Package global tab	210
seealso	Cross-reference section	218
short	Short description	220
topic	Topic page	228

Table 5.2: Text formatting tags

Tag	Description	Page

b	Format bold	163
caption	Specify table caption	167
code	Syntax highlight code	169
dd	definition data	173
dl	definition list	175
dt	Definition term	177
i	format italics	188
img	include image	190
li	list element	192
link	Cross-reference	194
ol	numbered list	205
p	paragraph	207
pre	Preformatted text	211
remark	remark paragraph	216
table	Table	222
td	Table cell	224
th	Table header	226
tr	Table row	230
u	format underlined	232
ul	bulleted list	234
var	format as variable	239

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]