InkpadDoxygen

This project is used to generate Inkpad documentation with Doxygen.

This project is distributed under the Mozilla Public License v2.0. Contributors and sponsors are welcome.

Author: Zhang Yungui

Setup Doxygen and GraphViz

1. Download the source or binary distribution of Doxygen.

2. For the binary distribution, drag and drop Doxygen.app to your Applications folder to install Doxygen. For the source distribution, install Doxygen as following steps:

   ./configure; make && sudo make install

3. Download and install GraphViz to create better looking documentation.

   • The installer may install dot in /usr/local/graphviz-x.y/bin or /usr/local/graphviz-devel/bin.
   • Set DOT_PATH to the above path, the default value is /usr/local/graphviz-devel/bin.

4. Make sure Inkpad and InkpadDoxygen projects belong to the same folder. You can clone or download Inkpad project to ../Inkpad.

Generate documentation

1. `cd' to this directory containing the file of 'build.sh'.
2. Type './build.sh' to copy source files and run Doxygen automatically.