02.03.2014 Views

BSP Developer's Guide

BSP Developer's Guide

BSP Developer's Guide

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

VxWorks 5.5<br />

<strong>BSP</strong> Developer’s <strong>Guide</strong><br />

-chapter<br />

Related to the -book option, this option allows you to set the documented routine or<br />

library chapter. The default value is set to “Wind River Systems Reference Libraries.”<br />

-category<br />

Related to the -book option, this option allows you to set the documented routine or<br />

library category. It can be used, for example, to differentiate routines available for<br />

different host platforms.<br />

-config configname<br />

Reads configuration information from the file configname if this optional parameter is<br />

present; the default configuration is C2html.<br />

-cpp<br />

This option specifies that the list of given files is to be treated as C++ files. Special<br />

processing is then performed to recover all the class members.<br />

-expath pathList<br />

Preempts EXPANDPATH settings recorded within files with the explicitly-supplied<br />

colon-delimited path list.<br />

-exbase basedir<br />

To simplify working under incomplete trees, this option uses basedir rather than<br />

WIND_BASE as the root for expand-file searching.<br />

-int<br />

If this optional parameter is present, it formats all available documentation, even if<br />

marked INTERNAL or NOMANUAL, and even for local routines.<br />

-l logFile<br />

Specifies that logFile is to be used to log refgen errors. If the -l option is not specified,<br />

standard output is used.<br />

-mg<br />

Converts from mangen markup “on the fly” (in memory, without saving the<br />

converted source file).<br />

-out outputDirectoryName<br />

Saves the output documentation file in outputDirectoryName.<br />

-verbose<br />

Prints reassuring messages to indicate that something is happening.<br />

sourceFileList<br />

Any other parameters are taken as names of source files from which to extract and<br />

format documentation.<br />

420

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!