RAM 6.0 BUX II Series Guia do Utilizador descarregar pdf (Página 163)

B Documentation Guidelines

B.5 Format and Style

155

Use the \bs and \be tags to display board diagrams. See the template BSP for

guidelines on diagramming jumper positions.

SEE ALSO:

\tb Motorola PowerPC 603 RISC Microprocessor User’s Manual,

\tb Motorola PowerPC Microprocessor Family: The Programming Environments

Note the commas at the ends of the first references in the above examples; the

commas are necessary because these references will be run together on output.

Alternatively, you can separate the references with blank lines to keep each book

on a line by itself—this approach is preferable when there are three or more books.

B.5 Format and Style

This section describes apigen markup and text-input conventions. The formatting

elements are few and straightforward. One of the goals of source-code

documentation standards is to promote internal readability; minimal markup

supports this.

To work with apigen, source modules and their documentation must be laid out in

accordance with a few simple principles, following Wind River’s standard layout

as described in the VxWorks Hardware Interface Validation Guide: Coding Conventions.

Source-file text should fill out the full line width (80 characters maximum).

1 2 ... 158 159 160 161 162 163 164 165 166 167 168 ... 188 189

Sem comentários

RAM 6.0 BUX II Series Guia do Utilizador Página 163