
137
B
Documentation Guidelines
B.1 Introduction 138
B.2 Written Style 138
B.3 Sections for Libraries and Subroutines 145
B.4 Sections for target.ref 153
B.5 Format and Style 155
B.6 Directives 167
B.7 Converting target.nr Files 170
B.8 Generating Reference Entries 171
NOTE: The instructions in this chapter are applicable to both VxWorks 5.5 and
VxWorks 6.0 users unless otherwise noted. However, the documentation tool
provided for the VxWorks 5.5 release is called refgen. In most cases, refgen and
apigen are used in the same manner and accept the same syntax and commands.
In this chapter, “apigen” is written to mean both refgen and apigen unless
otherwise noted.
Comentarios a estos manuales