
B Documentation Guidelines
B.5 Format and Style
157
B
inline ‘text’ or ’text’ Bold text, for literal names:
filenames, commands, keywords,
global variables, structure
members, and so on. Text can be
multiple words if on the same input
line.
same
inline <text> Italic text, for arguments,
placeholders, emphasis, special
terms. Text can be multiple words if
on the same input line.
same
inline \lib library This markup is for apigen only.
Explicit markup for a library name
if the name is non-standard (not
nameLib, nameDrv, nameShow,
nameSio, or if_name). This markup
is available for apigen only.
N/A
col 1
only
\tb booktitle The remainder of the line is a book
title reference.
.I, .pG, .tG
inline \< \> \’ \’ Plain characters <, >, `, and ‘. N/A
inline \\ Plain character\ (backslash). \e
col 1
only
\cs
...
\ce
Code example or terminal
session—preformatted display in
fixed-width.
.CS
...
.CE
col 1
only
\bs
...
\be
Board diagram—preformatted
display in reduced fixed-width.
.bS
...
.bE
col 1
only
\ss
...
\se
Syntax display—preformatted
display in fixed-width font and
containing markup.
.tS
...
.tE
Ta b le B -5 Apigen Markup
Location Markup Description Mangen Equiv.
Comentários a estes Manuais