Popular Tags

Who's online

There are currently 0 users and 59 guests online.

User login

This article describes how to create documentation sets that integrate with Xcode 3's documentation reader using the Doxygen tool.

Documentation sets (doc sets) provide a convenient way for an Xcode developer to search API and conceptual documentation (including guides, tutorials, TechNotes, and Q&As), sample code, and anything else provided by the doc set creator. Many developers already use Apple-provided doc sets which ship with Xcode. You can integrate doc sets for your own products into the Xcode Documentation window. By providing your documentation as a doc set, users can take advantage of all the Xcode documentation-viewing features to browse and search for information in your documents.

Xcode 3 searches for user-added documentation sets in the following locations:

  • ~/Library/Developer/Shared/Documentation/DocSets/
  • /Library/Developer/Shared/Documentation/DocSets/

In addition, the API docs provided in a doc set can be hooked up to the Research Assistant in Xcode, which follows your selection in the code editor and offers information on documented API and build settings. Clicking on a symbol brings up a summary of the documentation for that symbol and provides links to the complete documentation.

Your rating: None Average: 1.7 (3 votes)

Search

UPDATES

The site has recently been updated. You may notice some of the following issues:

  • Some URLs no longer work. Please use the search box.
  • File uploads should now be working. If you experience problems, please contact us.