Как правильно документировать NSNotifications с headerdoc?
Документация для UIApplication содержит раздел Notification, в котором перечислены все связанные NSNotification s.
К сожалению, файлы заголовка, доступные в XCode, не содержат соответствующие комментарии.
Руководство пользователя HeaderDoc показывает, как @group
тег можно использовать для группировки элементов вместе, объясняя результат, аналогичный документации по UIApplication.
Группировка тегов позволяет вам организовать функции, методы и переменные в коллекции. В режиме вывода HTML оглавление (левый столбец) организовано в эти группы. Кроме того, содержание тела (справа) содержит документацию для каждой группы. Этот блок документации содержит имя группы, обсуждение и список любых функций, типов данных или переменных, содержащихся в этой группе, а также их рефераты.
Тем не менее, когда я пытаюсь использовать @group
тег, я получаю предупреждение Unknown command tag name
и @group
тег не выделяется темно-зеленым цветом, что делает его не распознаваемым Xcode.
1 ответ
Предупреждение было только временным, потому что сами уведомления еще не были задокументированы. Как только я начал документировать уведомления, предупреждение исчезло.
Тем не менее, Xcode по-прежнему не показывает group
тег в темно-зеленом, как и другие теги headerdoc.