Documentation

Ed Preston edited this page Oct 14, 2013 · 2 revisions
Clone this wiki locally

Generating Documentation

The example projects contain a "build target" called "Documentation" for generating documentation from the source files. This assumes that Doxygen is installed into the default location, /usr/local/bin/doxygen, under OS X 10.6 or above. Documents will be created under the "Documentation" folder in the root of the repository.

Installing Doxygen

This section will guide you through installing and configuring Doxygen under OS X, like a boss.

In the terminal application, navigate to the repository directory then issue the following commands in sequence to configure, build, and install Doxygen into the default location;

    ./configure
    make
    sudo make install

Doxygen is now installed. Use the "build target" in the project files to generate documentation from within Xcode. Keep the "doxygen" repository that was created to easily update Doxygen in the future.

Updating Doxygen

To keep Doxygen up to date, syncronize the repository in GitHub for Mac, then navigate to the repository directory using the terminal application and enter the following:

    make distclean
    ./configure
    make
    sudo make install

These commands will delete intermediary files, configure your copy of the Doxygen code, build a fresh copy, and install it into your system.