This tag tells HeaderDoc that whenever the named token appears in a declaration, the token should be deleted and the “Availability:“ attribute for that declaration should be set to the string that follows.
The name of the class.
The full name of the category, as declared in the header. For example, “MyClass(MyCategory)”. HeaderDoc uses the “MyClass” portion of the name to identify the associated class.
The name of the protocol.
Specifies the name of the constant.
Name of the macro.
The name of the function.
Note: For historical reasons, you can also mark up function-like macros with the
The name of the enumeration. This is usually enum's tag, if it has one. Otherwise, supply a name you want to have the constants grouped under in the documentation.
The member fields should be enumerated with the
The name of the framework. Must be in a file ending in
@functiongroup My Function Group
The name of the function group.
The name under which the API is categorized. Leave the name blank to just use the header filename.
The following additional subtags are available:
The name of the Objective-C method.
Note: For historical reasons, you can also mark up C++ methods with the
The name of the Objective-C property.
The name of the structure. (Also known as the structure’s tag.)
The name of the defined type.
The name of the union. (Also known as the union's tag.)
The name of a global variable or class member variable.