Appendix D. Code Documentation Standards

Table of Contents

D.1. Introduction
D.2. General Comments
D.3. Application Code Documentation
D.3.1. Standard Header
D.3.2. main() Function
D.3.3. Application Datatypes and Functions
D.4. Library Code Documentation
D.4.1. Standard Header
D.4.2. Library Datatypes and Functions
D.4.3. Functional Sections
D.4.3.1. Function Section Documentation Tags
D.4.3.2. Example
D.5. Datatype Documentation
D.5.1. Datatype Documentation Tags
D.6. Function Documentation
D.6.1. Function Documentation Tags
D.6.2. Parameter Codes