Tags Common to All API Types

The @abstract, @updated, and @discussion tags can be used within any of the type-specific tags below. For example,:

/*!

 @enum Beverage Categories

 @abstract Constants to group beverage types.

 @discussion These constants (such as kSoda, kBeer, etc.) can be used...

 @updated 2003-04-15

*/

They are not required within any HeaderDoc comment, but can improve the formatting of the HTML output, and can help automate the importation of comments into the Inside Mac documentation database.

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