Xcode: show documentation for my custom classes

Viewed 15946

How can I force Xcode to show my own documentation for custom classes, methods, etc.? I'm used to Java and Eclipse, which shows me documentation for my classes as shown here:

Eclipse showing Javadocs documentation

How can I achieve the same in Xcode? Are there special comments that Xcode can recognize and display?

Xcode showing generic documentation for NSObject

5 Answers

Well, it seems that for the classes the question hasn't still been answered, so I'll post my suggestions.

Just before the @interface MyClass : NSObject line in the MyClass.h file you use the comment like you did in your example, but adding some tags to display the text. For example the code below:

/**
 * @class GenericCell
 * @author Average Joe
 * @date 25/11/13
 *
 * @version 1.0
 *
 * @discussion This class is used for the generic lists
 */

will produce the following output: the output of the code above http://imageshack.com/a/img18/2194/kdi0.png

Related