How to document NSNotifications properly with headerdoc?

182 views Asked by At

The documentation for UIApplication contains a section Notification where all related NSNotifications are listed.

Unfortunately, the header files available in Xcode don't contain the corresponding comments.

The HeaderDoc User Guide shows how the @group tag can be used to group items together, explaining a result similar to the UIApplication documentation.

Grouping tags allow you to organize functions, methods, and variables into collections. In HTML output mode, the table of contents (left column) is organized into these groups. Also, the body content (right side) contains a documentation for each group. That documentation block contains the group’s name, discussion, and a list of any functions, data types, or variables contained within that group, along with their abstracts.

However, when I try using the @group tag, I receive a warning Unknown command tag name, and the @group tag is not highlighted in dark green, making it seem to not be recognized by Xcode.

1

There are 1 answers

0
Etan On

The warning was only temporary, because the notifications themselves have not yet been documented. As soon as I started documenting the notifications, the warning disappeared.

However, Xcode still doesn't show the group tag in dark green like the other headerdoc tags.