appledoc

What is appledoc?

appledoc is command line tool that helps Objective-C developers generate Apple-like source code documentation from specially formatted source code comments. It’s designed to take as readable source code comments as possible for the input and use comments as well as surrounding source code to generate visually appealing documentation in the form of HTML as well as fully indexed and browsable Xcode documentation set. Although there are several tools that can create HTML documentation for Objective-C, all of those known to me fall short in meeting the minimum of goals described below.

Main goals of appledoc:

• Human-readable source code comments.
• Simple cross references to objects and members.
• Generate Apple-like source code HTML documentation.
• Generate and install fully indexed and browsable Xcode documentation set.
• Single tool to drive generation from source code parsing to documentation set installation.
• Easily customizable output.
• 100% Objective-C implementation for easy debugging.

Overview