Documentation Framework like JavaDoc for Objective C

Question

Does Objective C have a documentation framework similar to JavaDoc where documentation can be generated from the source code?

There isn't one specific to Objective-C, but I use Doxygen. Apple uses HeaderDoc, but pretty much nobody else does anymore. — Quinn Taylor, Dec 16 '09 at 02:01

score 15 · Accepted Answer · edited Mar 26 '19 at 11:50

15

Doxygen! You can use it for many languages, including Objective-c

edited Mar 26 '19 at 11:50

albert

8,285
3
19
32

answered Dec 16 '09 at 00:23

David Robles

9,477
8
37
47

2

Definitely the best option. If you'd like to go even further, I've written a script that will convert Doxygen's output to look more like Apple's API docs: http://github.com/mattball/doxyclean – Matt Ball Dec 16 '09 at 04:13

Diego Palomar · Answer 2 · 2013-10-14T15:53:43.493

Good news for all! :D Finally after waiting a long time Apple has introduced a parser comments for our projects. According to the new features in XCode 5:

Project documentation from framework API reference documentation and structured comments in your own source code are displayed in the quick help panel and in code completion popover views. Doxygen and HeaderDoc structured comments are supported formats.

and from the Clang 3.2 release notes:

Clang parses the comments and can detect syntactic and semantic errors in comments. These warnings are off by default. Pass -Wdocumentation flag to enable warnings about documentation comments.

If you want to see an example of this new feature I recommend you take a look at the following article: Documentation in Xcode 5

score 6 · Answer 3 · edited Dec 25 '18 at 17:40

6

Doxygen is quite popular among Obj-C developers.

edited Dec 25 '18 at 17:40

albert

8,285
3
19
32

answered Dec 16 '09 at 00:23

Ole Begemann

135,006
31
278
256

score 3 · Answer 4 · answered Jun 28 '11 at 13:20

3

You could have a look to HeaderDoc wich is the apple documentation framework similar to Java.

answered Jun 28 '11 at 13:20

morel sebastien

146
1
2

score 1 · Answer 5 · answered Mar 22 '13 at 04:00

Appledoc has become very popular. . . version 1 was based on Doxygen, whereas version 2 was written from the ground up.

It doesn't quite have all the features of Doxygen (charts, enums, C++ classes, etc), but what it does offer is beautifully formatted docs in HTML of IDE integrated format.

Also interesting to note is the following:

The CocoaPods tool includes Appledoc documentation for the libraries that it installs. Quite handy.

Documentation Framework like JavaDoc for Objective C

5 Answers5

Linked