
VxWorks
BSP Developer’s Guide, 6.0
162
Cross-References to Other Reference Entries
Do not use the UNIX-style parentheses-plus-number scheme to cross-reference the
documentation sections for libraries and routines:
Special Terms
When introducing or defining a special term, bracket the word in angle brackets (<
and >) at first usage. In output, these words will appear in italics.
Emphasis
In general, avoid applying emphasis to words; a well-cast sentence should be
sufficient to convey emphasis. However, if emphasizing a word is necessary,
bracket it with the angle brackets (< and >). In output, these words will appear in
italics. Never use uppercase to convey emphasis.
CORRECT:
sysLib, vxTas()
INCORRECT:
sysLib(1), vxTas(2)
Ta ble 3 Examples of Special Word Formatting
Component Input Output
library in title
sysLib.c
sysLib
library in text
sysLib
sysLib
name with .c extension
sysLib.c
sysLib.c
header file
objLib.h
objLib.h
routine in title
sysMemTop
sysMemTop( )
routine in text
sysMemTop()
sysMemTop( )
constant, option
INCLUDE_SCSI
INCLUDE_SCSI
other bold elements
’errno’
errno
placeholder,
routine parameter
<ptid>
ptid
book title
\tb Programmer’s Guide
Programmer’s Guide
emphasis, special terms
<must>
must
Kommentare zu diesen Handbüchern