HeaderDoc User's Guide | ||
HeaderDoc Unfettered: API Documentation From Header Files | |||||
What is HeaderDoc? | |||||
How Do I Get It? | |||||
Organization of this Document | |||||
HeaderDoc Tags | |||||
Introduction to HeaderDoc Comments and Tags | |||||
Multiword Names | |||||
Automatic Tagging | |||||
Tags for Frameworks | |||||
Tags for All Headers | |||||
Tags Common to All API Types | |||||
Tags for All Languages | |||||
C Pseudoclass Tags | |||||
Tags for C++ Headers | |||||
Tags for Objective-C Headers | |||||
Using HeaderDoc | |||||
Running headerDoc2HTML.pl | |||||
Running the Scripts Using MacPerl | |||||
Cocoa Front End | |||||
Using the C Preprocessor | |||||
Using gatherHeaderDoc | |||||
Running gatherHeaderDoc.pl | |||||
Creating a TOC Template File | |||||
Using Multiple Landing Page Templates | |||||
Example gatherHeaderDoc Template | |||||