---

Supporting API Lookup in Documentation Sets

One of the key features of the Xcode Documentation window is fast API search, the ability to quickly filter large lists of API symbols to find a particular symbol and its associated documentation. If your documentation set contains reference documentation for API symbols or other tokens, you can support fast API lookup for that documentation set by including one or more Tokens.xml files.

The tokens file associates symbols or tokens with their primary reference documentation. It supports fast API lookup and enables documentation access shortcuts from the code editor, such as:

• Option–double-click to jump to the documentation for the currently selected symbol

• Access to essential information about the symbol—such as availability, a summary description, and so forth—through the Research Assistant

Documentation sets can have more than one tokens file; however, if a documentation set lacks a tokens file, Xcode supports only browsing and full-text searches in the Documentation window for that documentation set—fast API search is disabled.

A tokens file consists of a series of token definitions. Each token definition represents information about a single symbol. This chapter shows how to create a token definition to describe a symbol for lookup, how to provide information about that symbol for use with the Research Assistant, and how to organize large numbers of token definitions.

Contents:

Defining a Symbol for Lookup
Providing Additional Information About a Symbol
Managing Symbol Information in Large Documentation Sets
Example Tokens.xml File

---