Preliminaries
This guide assumes you are using Linux Debian. In order to build doxygen document you first need the doxygen software. This can be verified at the command line by typing
dpkg -s doxygen
You should see a response saying Status: install ok installed. If not, install the package through Apper or apt-get from the command line like so:
sudo apt-get install doxygen doxygen-gui graphviz
Check Out the Project
Once doxygen is installed, you are ready to set up a particular project to have documentation built. The first step is to check the project out of the repository. If you are unsure how to do this, see the article on Repository Instructions.
Determine if Doxygen is Configured for the Project
Most Greensea applications have doxygen already configured to build a documentation package from the source code. You can check if this is the case by seeing if there is a directory called "doc" in the root of the project folder. If it is not present, the doxygen configuration needs to be set up. See the article Setting up Doxygen for instructions.
If a doc directory exists, the project has probably been configured to build the documentation. Instructions on rebuilding and migrating from the old to new process are provided in the article Rebuilding Doxygen Documentation.
Building HTML documentation
Using the new method you can create html documentation from the Doxygen markup with the following commands:
cd /path/to/project_wc mkdir build cd build cmake .. make doc google-chrome doc/index.html |
After 'make doc' completes you can copy the 'doc' folder, or just its contents to an alternate location to publish the documentation. You should also be aware that the file build/doxy_warnings.txt contains any warnings or errors Doxygen encountered while processing the source code. This should include undocumented members, etc. If the HTML documentation is not what you expect this file is the first place to look.
