3

Possible Duplicate:
How to do the documentation in objective C?

Is it possible to write class/method documentation in Objective-C in a way that Xcode 4 displays them in the quick help, and/or generates a doc document from it in the style of Apple's own documentation?

Community
  • 1
  • 1
fzwo
  • 9,842
  • 3
  • 37
  • 57
  • Possible dupes: http://stackoverflow.com/questions/3374535/how-to-do-the-documentation-in-objective-c http://stackoverflow.com/questions/813529/documentation-generator-for-objective-c http://stackoverflow.com/questions/3525038/what-tools-might-i-use-for-generating-documentation-for-an-xcode-project http://stackoverflow.com/questions/5144087/available-documentation-tools-for-xcode – Hagelin Jun 03 '11 at 11:27

3 Answers3

4

Displaying it live - not that I know of.

But as for generating Apple like documentation, the best I have found is appledoc which I've been using for a year now. If accepts a wide range of commenting styles including Javadoc styles and can generate very Apple like documentation which it can also install directly into your Xcode help system.

drekka
  • 20,957
  • 14
  • 79
  • 135
2

I don't know if it still works for Xcode 4 but for Xcode 3 you could generate API doc sets using doxygen.

Apple has a set by step guide: Using doxygen to Create Xcode Documentation Sets on how to do it.

albert
  • 8,285
  • 3
  • 19
  • 32
JeremyP
  • 84,577
  • 15
  • 123
  • 161
  • Wow, docSets looks like a big beast. I don't think I'll want to do this in my (for the moment) one-man project. I might have a look into Doxygen. – fzwo Jun 03 '11 at 11:32
  • @fzwo: Actually it's pretty easy. You use Doxygen to generate the API docs and then there are a couple of extra steps to create an Apple doc set. These can be integrated into the build process. – JeremyP Jun 03 '11 at 15:22
0

There is also the appledoc tool available from GitHub. Makes nice docsets.

Abizern
  • 146,289
  • 39
  • 203
  • 257