BSP Developer's Guide

VxWorks 5.5
BSP Developer’s Guide
9.3 Format
This section discusses general formatting requirements of Wind River reference
documentation. Specific requirements relevant to BSPs are discussed in
9.4 Subsections, p.183.
Layout
■
Module Layout. To work with refgen, the documentation in source modules
must be laid out in accordance with a few simple principles. These layout
requirements are described in the Tornado User’s Guide: Coding Conventions.
■
General. Text should fill out the full line length (assume about 75
characters). Do not start every sentence on a new line.
Special Elements
■
Subroutines. Include parentheses with all subroutine names, even those
generally construed as shell commands. Do not put a space between the
parentheses or after the name (unlike the Wind River convention for code):
CORRECT:
taskSpawn()
INCORRECT:
taskSpawn( ), taskSpawn (), taskSpawn
Note that there is one major exception to this rule: In the subroutine title, do
not include the parentheses in the name of the subroutine being defined:
CORRECT:
/*************************************************
*
* xxxFunc - do such and such
INCORRECT:
/*************************************************
*
* xxxFunc() - do such and such
180