I've noticed that Xcode 5 now parses method documentation automatically. For example:
/**
Fetches a conversation with user.
@param user The other user in the conversation.
@return A conversation
*/
+ (Conversation *)conversationWithUser:(User *)user;
It supports multiple @
tokens (don't know how to call them). For example:
@warning
@note
However, I still haven't found a way or what format this is, so that I can add bold text, or italics, or links.
Does anyone know what documentation format this is?
I found out how to get bold and italics. It uses this doxygen format. It doesn't seem to recognize all commands, but some work:
/**
Resumes \b network operation queues.
*/
- (void)resume;
The \b
there would make network bold. \a
yields italics and \c
monospaced text.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With