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	172
element	Identifier documentation	180
errors	Error section	182
fpdoc-description	Global tag	188
module	Unit tag	200
package	Package global tab	211
seealso	Cross-reference section	219
short	Short description	221
topic	Topic page	229

Table 5.2: Text formatting tags

Tag	Description	Page

b	Format bold	164
caption	Specify table caption	168
code	Syntax highlight code	170
dd	definition data	174
dl	definition list	176
dt	Definition term	178
i	format italics	189
img	include image	191
li	list element	193
link	Cross-reference	195
ol	numbered list	206
p	paragraph	208
pre	Preformatted text	212
remark	remark paragraph	217
table	Table	223
td	Table cell	225
th	Table header	227
tr	Table row	231
u	format underlined	233
ul	bulleted list	235
var	format as variable	240

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]