Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to do the documentation in objective C? [closed]

Could anyone share the the ways to do the documentation in objective C? Is there any standard way like it is in java?

like image 472
Winston Chen Avatar asked Jul 30 '10 18:07

Winston Chen


1 Answers

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

like image 185
Diego Palomar Avatar answered Oct 21 '22 05:10

Diego Palomar