RAM 6.0 BUX II Series Betriebsanweisung PDF herunterladen (Seite 176)

VxWorks

BSP Developer’s Guide, 6.0

168

The backslash is a significant deviation from refgen, apigen’s predecessor. Most

refgen directives required no backslash. However, the backslash requirement

makes the markup considerably more resistant to ambiguities.

The directives recognized by apigen are summarized in Table B-6. Details are

provided in the sections that follow.

Blocking Text from Publication

The following directives can be used to prevent the publication of specified

sections of text. In all cases, the masking action can be overridden by running

apigen with the -internal flag. This flag permits all content to be generated,

including C routines declared static or LOCAL, which are masked automatically.

The -internal flag is typically given to generate documentation for

company-internal code reviews.

NOTE: For backward compatibility, directives that were supported by refgen are

by default converted internally to the new form, and thus still work. However,

they should be changed when encountered and avoided in future work.

Ta b le B -6 Summary of apigen Directives

Directive Name Usage

\IMAGE filename Include an image (a reference to an image file) in

the output—normally used only for BSP board

diagrams. This directive is available for apigen

only.

\INTERNAL [title] Do not print the following title and section

unless the -internal flag is specified when

apigen is executed. If no title is given, the title is

“INTERNAL”.

\NOMANUAL

Do not generate this routine or library entry

unless the -internal flag is specified.

\TITLE name - shortdescription Overrides the file’s title line. Typically used only

in target.ref files. This directive must include a

backslash in both apigen and refgen.

1 2 ... 171 172 173 174 175 176 177 178 179 180 181 ... 188 189

Keine Kommentare

RAM 6.0 BUX II Series Betriebsanweisung Seite 176