BSP Developer's Guide

VxWorks 5.5
BSP Developer’s Guide
SEE ALSO Section
INCORRECT:
* RETURNS: OK, or ERROR
* if the tick rate is invalid or
* the timer cannot be set.
The SEE ALSO section should be the last section of a reference-page entry.
■
■
If the entry is a subroutine, refgen automatically includes the parent library in
the SEE ALSO section.
Do not cross-reference manual section numbers using the UNIX
parentheses-plus-number scheme:
CORRECT:
SEE ALSO: sysLib, vxTas()
INCORRECT:
SEE ALSO: sysLib(1), vxTas(2)
■
In the SEE ALSO section, include cross-references to chapters of the VxWorks
Programmer’s Guide or the Tornado User’s Guide by using the .pG macro or the
.tG macro, respectively. The dot must be the first character on the effective line
(for a subroutine section, refgen strips the star plus space); for example:
* SEE ALSO: someLib, anotherLib,
* .pG "Basic OS, Cross-Development,"
* .tG "Setup and Startup"
*/
As this example illustrates, the cross-reference to another volume should come
after cross-references to other libraries or subroutines. The .pG and .tG macros
should only be used in SEE ALSO sections.
Target Information Reference Page: target.nr
A template for the target-information reference page is provided in
target/config/templateCPU/target.nr. This reference entry always contains the
subsections described below, and others as needed. Summary:
NAME
the name of the board
186