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

B Documentation Guidelines

B.6 Directives

167

■

If ports are stacked, be sure that your notation includes a description of which

port is the relevant one (for example, “serial console (top connector)”).

■

Do not label jumper locations in your image unless your board is not

silk-screened or the silk-screen does not include jumper labels.

To include your JPEG image in the HTML output of the target.ref file, use the

\IMAGE apigen directive. For more information, see Graphics, p.167.

Graphics

VxWorks 6.0 users can insert graphics files using the directive \IMAGE filename. If

the output format is HTML, this image file is inserted into an <img> tag. If the

output format is anything else, the file is referenced by name in the text. The path

of filename must be relative to the directory containing the source file. Currently

this directive is used only in BSP target.ref files. Examples:

\IMAGE images/board.jpg

\IMAGE images/switches.gif

B.6 Directives

Directives are apigen controls for special non-formatting actions, such as including

information from other files, hiding internal information, or overriding default

behavior. This section provides information about the apigen directives available

for BSP documentation.

Directives must begin in column 1, and must be the only text on the line. All

directives begin with a backslash and the remaining letters are in upper case.

NOTE: The image notation should include text describing the port as well as a

circle (in white or black) surrounding the port or an arrow (in white or black)

pointing to the connector.

NOTE: VxWorks 5.5 users can also include a JPEG image in place of the plain-text

diagram as described above. However, the

\IMAGE directive is not available in

refgen, so you must include a text reference to the location of the JPEG file

manually.

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

Keine Kommentare

RAM 6.0 BUX II Series Betriebsanweisung Seite 175