Use the Documentation

This section requires embedXcode+.

Once generated and if the .docset option has been selected, the documentation is now fully integrated into Xcode and available through multiple ways:

  • directly from the code thanks to Quick help,

  • or using the Documentation and API Reference window.

Use the Quick Help

Documentation is available directly from the code thanks to Quick help.

  • Select a function or place the cursor on a function, here blink.



  • Press Alt while the cursor is hovering the function.

The cursor turns into an interrogation mark:

  • While pressing Alt, click on the name of the function blink.

A contextual help pops-up.

If you click on the blue link LocalLibrary.h in the help balloon, Xcode opens the library at the definition of the function:

When the cursor selects a function, the Quick Help pane on the right provides all the information available for the function, here blink.

  • Click on the blue link LocalLibrary.h in the quick help pane. Xcode opens the library at the definition of the function:

Use the Documentation and API Reference

The documentation is also available on the Documentation and API Reference.

  • Call the menu Help > Documentation and API Reference.

The Documentation window opens.

On the column on the left, select the documentation, here embed1 Reference Manual and navigates using the sections and the hyperlinks.