Logo Questions Linux Laravel Mysql Ubuntu Git Menu
HTML CSS JAVASCRIPT SQL PYTHON PHP BOOTSTRAP JAVA JQUERY R React Kotlin
 

Documentation Framework like JavaDoc for Objective C

Tags:

objective-c

documentation-generation

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

like image 814
Casebash Avatar asked Dec 16 '09 00:12

Casebash

People also ask

Is there a JavaDoc for C?

There are several tools that works like JavaDoc for C++ The most popular tool is probably doxygen. It can handle JavaDoc-like comments, and also several languages (e.g., C++, C, Java, Objective-C, Python, PHP, C#).

Does C++ have a JavaDoc?

Does C++ have anything similar to javadoc? Yes. Here are a few (listed alphabetically by tool name): ccdoc supports javadoc-like syntax with various extensions.

Is JavaDoc still used?

Javadoc is pretty much the accepted standard for documenting java code.

What is Objective-C runtime?

The Objective-C runtime is a runtime library that provides support for the dynamic properties of the Objective-C language, and as such is linked to by all Objective-C apps. Objective-C runtime library support functions are implemented in the shared library found at /usr/lib/libobjc.

3 Answers

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

like image 163
David Robles Avatar answered Oct 26 '22 13:10

David Robles

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 43
Diego Palomar Avatar answered Oct 26 '22 14:10

Diego Palomar

Doxygen is quite popular among Obj-C developers.

like image 32
Ole Begemann Avatar answered Oct 26 '22 15:10

Ole Begemann
Sign in to Comment

Related questions

UIButton Click Not working when its triggered from static library
Access C++ Enum from Swift
How to set navigation bar to transparent in iOS 11
Covering window of UIAppDelegate with an overlay make user can't touch on extensions of UIActivityViewController when it's displayed
EKEventEditViewController Add and Cancel buttons not responding
iOS 11 EXC_BAD_ACCESS KERN_INVALID_ADDRESS on dealloc
How to use OCMock to verify that an asynchronous method does not get called in Objective C?
iOS AdMob : Error No Ad to Show
Swift try inside Objective-C block
Extend @objc protocol with Hashable in Swift
Objective C code for background processes
A C++ header file in a CocoaPod is unable to import from a framework
UITableView reloadSection and reloadRowsAtIndexPaths causes weird animation
UISearchDisplayController and UITableView prototype cell crash
_UIButtonBarStackView: breaking constraint when becomeFirstResponder sent
How do I join an NSSet's elements to create an NSString?
Help me out With Error _deflateInit2_
Adding constraints programmatically in Objective-C
UIStringDrawing methods don't seem to be thread safe in iOS 6
NSURLSessionConfiguration timeoutIntervalForRequest vs NSURLSession timeoutInterval

Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!