New Tags

This section attempts to list all of the new tags added in HeaderDoc 8 (some of which were actually available, but undocumented, in HeaderDoc 7).

@classdesign

Text block describing the overall design of a class.

@coclass

String describing a class that this class was designed to work with.

@dependency

String describing a class upon which this class depends heavily.

@exception

String describing an exception thrown by a function/method/class.

@functiongroup

Tag for grouping functions and methods. This takes priority over the @group tag with respect to functions and methods.

@group

Tag for grouping data, functions, etc.

(Note: the @functiongroup tag takes priority over the @group tag for functions.)

@helper

String telling what helper classes this class uses.

@helps

For helper classes, string telling what sort of classes this class was designed to help.

@instancesize

Text block containing the size of an instance of this class.

@methodgroup

See @functiongroup.

@ownership

String describing what class instantiates the current class (e.g. I/O Kit nubs).

@performance

Text block to describe performance characteristics of a class (e.g. “This class is not appropriate for use in high-performance environments.)

@security

Text block to describe security considerations when using this class.

@superclass

Adds superclass info to a C pseudoclass. Also can be used to cause members of the superclass to be merged into the subclass.

@throws

See @exception.

© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (Last updated: 2004-05-27)