How does the new Xcode 5 documentation parsing work?

Question

I noticed that Xcode 5 now automatically parses documentation by method. For instance:

/** Fetches a conversation with user. @param user The other user in the conversation. @return A conversation */ + (Conversation *)conversationWithUser:(User *)user; 

It supports multiple @ tokens (I don’t know how to call them). For instance:

• @warning
• @note

However, I still haven't found a way or what format, so I can add bold , italic, or link text.

Does anyone know what kind of document format it is?

Answer 1

I learned how to get bold and italics. It uses this Doxygen format . It does not seem to recognize all the commands, but some work:

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

\b will be in bold. \a gives italics and \c monospace text.

Answer 2

In accordance with the new features of Xcode 5 (Under Documentation):

Project documentation from the reference documentation for the basic API and structured comments in your own source code is displayed in the quick access panel and in the code replenishment. Supported formats Doxygen and HeaderDoc are supported formats.

You can check out the Doc User Guide for users .

Apparently, it uses a subset of these functions, many of them do not work.

Answer 3

It is not completed. It does not support all doxygen tags at the moment - only a basic subset.

At the same time, you can use flags like -Wdocumentation and -Wdocumentation-unknown-command (or better, start with -Weverything and reduce), and clang will notify you if it encounters something unrecognized or distorted. If you want a complete list of available tags, I would check the trunk.