Overview

4.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 (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	137
element	Identifier documentation	145
errors	Error section	147
fpdoc-description	Global tag	149
module	Unit tag	161
package	Package global tab	168
seealso	Cross-reference section	176
short	Short description	178
topic	Topic page	186

Table 4.2: Text formatting tags

Tag	Description	Page

b	Format bold	131
caption	Specify table caption	133
code	Syntax highlight code	135
dd	definition data	139
dl	definition list	141
dt	Definition term	143
i	format italics	150
img	include image	152
li	list element	154
link	Cross-reference	156
ol	numbered list	163
p	paragraph	165
pre	Preformatted text	169
remark	remark paragraph	174
table	Table	180
td	Table cell	182
th	Table header	184
tr	Table row	188
u	format underlined	190
ul	bulleted list	192
var	format as variable	197

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]