User`s guide

VxWorks
BSP Developer’s Guide, 6.0
156
Formatting is controlled by special text markup, summarized in Table B-5. Some
markup consists of format commands called tags, which begin with a backslash
and are followed by letters. Some markup elements are inline; that is, they can
appear anywhere in the line of text. Other markup elements must start in text
column 1. Format tags, except \lib, always start in column 1. See the following
note.
NOTE: For the purpose of describing documentation markup, “column 1” really
means column 1 of text. In other words, where comment blocks are delineated with
a comment indicator at the beginning of each line, such as a C routine, Tcl
procedure, shell script, or C++ module, the first column is really the first character
after the *+space, #+space, or //+space. Thus, for example, in the doc header for a
C routine “column 1” really means column 3.
Ta b le B -5 Apigen Markup
Location Markup Description Mangen Equiv.
blank line Paragraph separator. N/A
col 1
only
initial spaces Preserve all spaces and line breaks
for this input line.
N/A
col 1
only
all capital letters Section heading. N/A
col 1
only
\&all-caps heading Escape that prevents the special
interpretation of an all-caps line as
a heading. Suppressed when at the
start of an input line, it otherwise
generates a plain ampersand.
N/A
col 1
only
\h heading Explicit section heading for use
when lowercase characters are
required.
N/A
col 1
only
\sh heading Subheading, always mixed case
with initial caps.
.SS heading