User`s guide

VxWorks
BSP Developer’s Guide, 6.0
148
Tcl Procedures, Scripts, Commands
For Tcl procedures, scripts, and other commands, this section is the execution
syntax; it must be typed manually, using the following conventions:
■
Enter the calling syntax and parameters between the tags \ss and \se.
■
Show parameters that are optional in square brackets.
■
Use the bar character (|) to indicate “or”.
■
Represent a variable list of arguments with three dots (...).
■
Bracket arguments between angle brackets (< and >) when they are
placeholders for user-supplied values.
■
If angle brackets are meant to indicate redirection of standard input/output,
surround them with space characters.
Example command or script input:
# SYNOPSIS
# \ss
# hex [-a <adrs>] [-l] [-v] [-p <pc>] [-s <sp>] <file>
# \se
Resulting output:
SYNOPSIS
hex [-a adrs] [-l] [-v] [-p pc] [-s sp] file
DESCRIPTION Section
This section contains the overall description of the library or routine. Start the
description with a sentence that begins This library or This routine as appropriate.
Use the word routine, not subroutine or function. Do not repeat the module or
routine name in this sentence; it has already been made clear in the NAME section.
The remainder of the sentence should be a summary of what the library or routine
does or provides and in more depth than the
NAME line, if possible.
If no heading entry precedes it, you can omit the DESCRIPTION heading. This is
true for both library and routine entries. However, if for example, there is a section
that precedes what you intend to be the description (such as a manually typed
SYNOPSIS section), the DESCRIPTION heading must be present or apigen will
generate a warning.
Parameter Lists
The DESCRIPTION section of a routine or command should list and define all
parameters. The automatically published routine declaration includes a short