Project

General

Profile

Generating the Documentation

The documentation pages for JeeLib, etc. are generated by Doxygen. Here’s how to do it:

Macintosh

You need to install Doxygen. By far the easiest on Mac, is to use the Homebrew package installer.

Once you’ve installed homebrew (which is itself a one-line command, see the link above), type:

brew install doxygen

To generate the documentation for say, JeeLib, enter the following commands:

git clone https://github.com/jcw/jeelib.git
cd jeelib
doxygen
open html/index.html

That’s it, your browser should open and display the main documentation page for JeeLib.

Other platforms

TBD…