Installing the Docset - nothirst/TICoreDataSync GitHub Wiki

How to install the included TICoreDataSync framework docset for use by Xcode

Most of the TICoreDataSync headers include appledoc-style comments. The output generated by appledoc can be seen in the framework’s Class Reference.

Accessing the Docset

The easiest way to access the docset is via the hosted documentation on GitHub: http://nothirst.github.io/TICoreDataSync/

Generating the Docset

If you have appledoc installed on your system, you can generate the docset yourself. Doing so will install the docset into Xcode. Navigate to the root of the TICoreDataSync repository, and execute:

appledoc .

This will generate the docset, and install it automatically.

If you don’t have appledoc installed, you can find out more information either at the GitHub repository:

http://github.com/tomaz/appledoc

or via the developer’s site:

http://gentlebytes.com/appledoc/