如何使用headerdoc正确记录NSNotifications?

时间:2014-02-15 14:15:13

标签: objective-c xcode documentation nsnotification headerdoc

UIApplication的文档包含通知部分,其中列出了所有相关的NSNotification

不幸的是,Xcode中可用的头文件不包含相应的注释。

HeaderDoc User Guide显示@group标记如何用于将项目组合在一起,解释类似于UIApplication文档的结果。

  

分组标记允许您将函数,方法和变量组织到集合中。在HTML输出模式中,目录(左列)被组织到这些组中。此外,正文内容(右侧)包含每个组的文档。该文档块包含组的名称,讨论以及该组中包含的任何函数,数据类型或变量的列表,以及它们的摘要。

但是,当我尝试使用@group标记时,会收到警告Unknown command tag name,并且@group标记未以深绿色突出显示,使其似乎无法被xcode中。

1 个答案:

答案 0 :(得分:0)

警告只是暂时的,因为通知本身尚未记录在案。一旦我开始记录通知,警告就消失了。

然而,Xcode仍然没有像其他headerdoc标签那样以深绿色显示group标签。