Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How does Xcode 5's new documentation parsing work?

Tags:

xcode

ios

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?

like image 812
Ian Avatar asked Sep 27 '13 19:09

Ian


1 Answers

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.

like image 141
Ian Avatar answered Oct 25 '22 14:10

Ian