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
– Quinn Taylor, Commented Dec 16, 2009 at 2:01

albert · Accepted Answer · 2019-03-26 11:50:27Z

15

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

edited Mar 26, 2019 at 11:50

albert

9,2103 gold badges24 silver badges42 bronze badges

answered Dec 16, 2009 at 0:23

David Robles

9,63710 gold badges41 silver badges47 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Matt Ball Over a year ago

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: github.com/mattball/doxyclean

Diego Palomar · Accepted Answer · 2013-10-14 15:53:43Z

10

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

edited Oct 14, 2013 at 15:53

answered Oct 14, 2013 at 15:48

Diego Palomar

7,0612 gold badges36 silver badges42 bronze badges

Comments

albert · Accepted Answer · 2018-12-25 17:40:59Z

6

Doxygen is quite popular among Obj-C developers.

edited Dec 25, 2018 at 17:40

albert

9,2103 gold badges24 silver badges42 bronze badges

answered Dec 16, 2009 at 0:23

Ole Begemann

136k32 gold badges281 silver badges258 bronze badges

Comments

morel sebastien · Accepted Answer · 2011-06-28 13:20:56Z

3

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

answered Jun 28, 2011 at 13:20

morel sebastien

1461 silver badge2 bronze badges

Comments

Jasper Blues · Accepted Answer · 2013-03-22 04:00:15Z

1

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.

answered Mar 22, 2013 at 4:00

Jasper Blues

28.9k22 gold badges110 silver badges191 bronze badges

Collectives™ on Stack Overflow

Documentation Framework like JavaDoc for Objective C

5 Answers 5

1 Comment

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

1 Comment

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related