
VxWorks
BSP Developer’s Guide, 6.0
150
bytesPerBlk
The size of each logical block on the disk. If zero, the default is 512.
blksPerTrack
The number of blocks on each logical track of the disk. If zero, the count of
blocks per track is set to nBlocks; that is, the disk is defined as having only
a single track.
nBlocks
The size of the disk in blocks. If zero, a default size is used; the default is
calculated as the size of the UNIX disk divided by the number of bytes per
block.
The text immediately following a parameter is a sentence fragment, not a complete
sentence; however, it should start with a capital and end with a period. Do not start
the sentence fragment with “specifies the ...”; this is understood. Do not reiterate
the name of the parameter. Do not omit articles (the words the, a, and an).
Any subsequent definition text that follows the sentence fragment must consist of
true complete sentences.
INCLUDE FILES Section
The subheading INCLUDE FILES should list relevant header files. Show include
files only when users must #include them in their code explicitly to use the library.
Required include files should be listed in both routine entries and library entries.
For example:
INCLUDE FILES: sysLib.h
RETURNS Section
■
Include a RETURNS section in all subroutines. If there is no return value (as in
the case of a void) simply type “N/A” without a period:
RETURNS: N/A
CORRECT:
The name of the UNIX file for the disk device.
INCORRECT:
Specifies the name of the UNIX file for the disk device.
INCORRECT:
<unixFile> specifies the name of the UNIX file for the disk device.
INCORRECT:
name of UNIX file for disk device.
NOTE: If you do not list any include files, apigen will issue a warning. This can be
safely ignored. refgen will not issue this warning.
Kommentare zu diesen Handbüchern