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
-
Download the source or binary distribution of Doxygen.
-
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
-
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
.
- The installer may install dot in
-
Make sure Inkpad and InkpadDoxygen projects belong to the same folder. You can clone or download Inkpad project to
../Inkpad
.
- `cd' to this directory containing the file of 'build.sh'.
- Type './build.sh' to copy source files and run Doxygen automatically.