
VxWorks
BSP Developer’s Guide, 6.0
160
Example input:
When semTake() returns due to timeout, it sets ’errno’ to
S_objLib_OBJ_TIMEOUT (defined in objLib.h).
Resulting output:
When semTake( ) returns due to timeout, it sets errno to
S_objLib_OBJ_TIMEOUT (defined in objLib.h).
Some library names do not end in the standard suffixes listed above. Flag such
names with the \lib tag. Note that unlike all other tags, the \lib tag can be inline.
For example:
The interface between BSD IP and the MUX is described in \lib ipProto.
Terminal Keys
Enter the names of terminal keys in all uppercase. For example: RETURN, ESC.
Prefix the names of control characters with
CTRL+. For example: CTRL+C.
Routine Names
Include parentheses with all routine names. Do not separate the parentheses from
the name with a space character (unlike the Wind River convention for code). Do
not put a space between the parentheses.
Even routines generally construed as VxWorks or host shell “shell commands”
must include the parentheses.
Note that there is one major exception to the parentheses rule: in the routine title,
do not include the parentheses in the name of the routine being defined:
Avoid using the name of a routine (or library, command, or other facility) as the
first word in a sentence. Names are case-specific and capitalization must never be
changed.
CORRECT:
taskSpawn()
INCORRECT:
taskSpawn( ), taskSpawn (), taskSpawn
CORRECT:
/**********************************************************
*
* xxxFunc - do such and such
INCORRECT:
/**********************************************************
*
* xxxFunc() - do such and such
Comentarios a estos manuales