User`s guide

VxWorks
BSP Developer’s Guide, 6.0
146
In the examples that follow, mfr&board means the manufacturer’s name plus the
full model name of the board, as described in Board Names, p.145.
A template showing documentation for sysLib.c is provided in
target/config/templateCPU/sysLib.c. Reference entries for libraries and
subroutines always contain the sections shown in Table B-3 in the order shown;
other sections can be included as needed.
Special considerations for these sections are discussed below.
NAME Section
This section is generated automatically. The text is taken from the one-line title of
the C file or the subroutine.
Ta b le B -3 Sections for Libraries and Subroutines
Section Name
Library
Entry
Routine
Entry Description
NAME ✔✔The title line, containing the name of the
library or subroutine and a short, one-line
description.
ROUTINES ✔ The summary of subroutines provided by this
library, generated automatically by apigen.
SYNOPSIS ✔ The subroutine declaration, which is generated
automatically by apigen.
DESCRIPTION ✔✔An overall description of the library or
subroutine.
INCLUDE
FILES
✔ The relevant .h files.
RETURNS ✔ The values returned.
ERRNO ✔ The list of ERRNO values set.
SEE ALSO ✔✔Cross-references to reference entries for other
libraries and routines, or other user manuals.