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

B Documentation Guidelines

B.8 Generating Reference Entries

171

This will generate a target.ref file in the current directory.

The resulting target.ref files will require some cleanup, however minimal. Tables

will always require that columns be manually aligned using the column delimiter

(pipe character, |). If the target.nr included nroff-style column format commands,

these will be left behind and must be removed manually.

In addition, mg2ref also leaves a

\TITLE directive just below the initial comment

block. Both apigen and refgen create the NAME line based on information from

the

\TITLE directive, if it exists, or information from line 1 of the file, if \TITLE does

not exist. A manually typed NAME section is never used.

Always inspect the target.ref generated by mg2ref and test your changes by

running it through apigen.

For backward compatibility, the makefile system for generating VxWorks 6.0 BSP

documentation is set up to look first for target.ref; if target.ref is not found, it will

instead process target.nr.

B.8 Generating Reference Entries

This section discusses the mechanics of generating BSP documentation: the files

and tools used, the text formatting tags, and the makefile system used to process

documentation from source code to printable reference entries.

Files

Filename extensions indicate the following types of files:

target/config/bspname

This directory contains the C and assembly sources and documentation

sources for a particular BSP; bspname is a directory name reflecting the maker

.s assembly-language source files.

.c C-language source files.

.ref text file containing apigen markup.

.nr text file containing mangen markup (no longer used)

.html generated HTML file.

1 2 ... 174 175 176 177 178 179 180 181 182 183 184 ... 188 189

Keine Kommentare

RAM 6.0 BUX II Series Betriebsanweisung Seite 179