How to properly document a method in Objective C?

Question

Objective-C

I want to document my code the way it's done in the source code of the language; so that when you press Option and click on the method, you can see something like this:



Tried using Javadoc and documented the method like this:

/**
 Method get something
 @param string some parameter
 @return returns something
 */
+ (NSString *)getOpenOrdersCount;

And it turns out like this:



Can you give an example of how to document the code so that when an option is pressed and clicked, a window with full data (not only declared) is visible?

Answer 1

This feature is in the new Xcode 5. For Xcode 4 - appledoc and doxygen.

It has a lot of changes in general - see What's New in Xcode 5 in the list of videos from WWDC 2013

Answer 2

As Stackoverflow suggests, Objective C doesn't have a built-in documentation capability. As one option, the Apple developers site shows working with the Doxygen utility , which will help you create convenient documentation.