Как работает новый синтаксический анализ документации Xcode 5?

Question

Я заметил, что Xcode 5 теперь автоматически анализирует документацию по методу. Например:

/** 
Fetches a conversation with user. 

@param user The other user in the conversation. 

@return A conversation 
*/ 
+ (Conversation *)conversationWithUser:(User *)user; 

Он поддерживает несколько @ маркеров (не знаю, как назвать их). Например:

• @warning
• @note

Однако я до сих пор не нашли способ или какой формат это, так что я могу добавить жирный текст или курсивом , или ссылки.

Кто-нибудь знает, какой формат документации это?

Answer 1

В соответствии с новыми возможностями в XCode 5 (Под документации):

Проектной документации от рамки справочной API документации и структурированных комментариев в своем исходном коде, отображается в панели быстрой помощи и в коде завершение просмотров. Поддерживаемые форматы Doxygen и HeaderDoc.

Вы можете проверить Header Doc User guide.

По-видимому, он использует подмножество этих функций, многие из которых не работают.

Answer 2

Это не полный. На данный момент он не поддерживает все теги doxygen - только базовое подмножество.

В то же время, вы можете использовать флаги как -Wdocumentation и -Wdocumentation-unknown-command (или лучше, начните с -Weverything и уменьшить), и лязг сообщит вам, если он встречает то, что является непризнанным или неправильно. Если вам нужен полный список доступных тегов, я бы проверял багажник.

Answer 3

Я узнал, как получить выделение жирным шрифтом или курсивом. Он использует this Doxygen format. Это, кажется, не признают, все команды, но некоторые работы:

/** 
Resumes \b network operation queues. 
*/ 
- (void)resume; 

\b было бы сделать сеть жирным шрифтом. \a дает курсив и \c моноширинный текст.