Xcode 3 Unleashed

Chapter 15. Documentation in Xcode

<feature><title>In This Chapter</title>

• Generating Documentation Automatically

• Customizing HeaderDoc

• Shell Script Targets

• Extending the Documentation Window

• Adding to the Research Assistant

</feature>

The users of the finished executable are not the only consumers of a software project. Sooner or later, other developers will have to work with our source code, and they deserve our pity no less than end users. Even the simplest application develops its own API, and it us up to us, who created it, to document it.

Along the way, we’ll be exploring Xcode’s own documentation system: how to use it, and how to extend it.

HeaderDoc

The easiest tool for producing useful documentation from source code is HeaderDoc. As the name ...