Objective-C: making documentation

Question

Hello.

I've been developing for Visual Studio and C# for a long time. Now, I'm developing with XCode and Objective-C.

On C# I can use /// <summary> to generate documentation. Is there any kind of mechanism like that on XCode to generate documentation? And what kind of comments should I use?

Thank you.

Answer 1

Have you tried using Doxygen? That claims to support Objective-C. There's even a walkthrough on ADC.

Answer 2

There's also AppleDoc to render your Doxygen comments into a style usable by Xcode

Answer 3

As a said, my fav pattern :)

   ///////////////////////////////////////////////////////////////////////
   /// \brief setX
   /// \param x offset of the image.
   /// \return a new image as an QImage.
   /////////////////////////////////////////////////////////////////////////
    QImage  setX(int x);

Answer 4

You need HeaderDoc which is recommended by Apple for code documentation.

Here's an example.

/*!
 This is a method.

 @param    param1    This is first parameter.

 @result
 This method returns nothing.

 @discussion
 This is an example.


 */
- (void)someMethodWithParam1:(NSInteger)param1
{
}

Manual: http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html