Looking Up Documentation for an API Symbol

Find concise reference documentation for an API symbol without moving away from your source file.

bullet
To look up documentation for an API symbol
  1. With a source file open, click the Symbol inspector button in the utility area.

  2. Place the insertion point in an API symbol in the source editor.

    ../Art/doc_api_symbol_1_2x.png
  3. View the documentation under Quick Help in the Symbol inspector.

  4. To view more detailed information, click the Reference link in Quick Help.

    ../Art/doc_api_symbol_2_2x.png

When you place the insertion point in a symbol, summary reference information appears in the Symbol inspector in the utility area.

The information includes links to:

  • Complete reference documentation for the symbol

  • The header file where the symbol is declared

  • Related programming guides

  • Related sample code