| < Previous PageNext Page > |
Framework documentation should be inserted into a file ending
in .hdoc. Running HeaderDoc on this file generates
a documentation tree with special hidden markup that gatherHeaderDoc
will insert into the appropriate place within your TOC template
(or at the top of the built-in template).
Tag |
Example |
Identifies |
Fields |
|---|---|---|---|
@framework |
@framework Kernel Framework |
The name of the framework. |
1 |
@abstract |
@abstract In-kernel device driver framework |
A short string that briefly describes a framework. This should not contain multiple lines (at least for the default template) for aesthetic reasons. Save the detailed descriptions for the @discussion tag. |
1 |
@discussion |
@discussion The kernel framework contains functions useful to in-kernel device drivers. |
A detailed description of the framework. This may contain multiple paragraphs, and can contain HTML markup. |
1 |
| < Previous PageNext Page > |
© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (Last updated: 2004-05-27)