Generating Documentation for OWA-EPANET 2.3
You must have Doxygen version 1.13 installed on your machine to generate documentation for the OWA-EPANET Toolkit. Assuming this is the case, open a terminal window, navigate to the project's doc directory and issue the command doxygen. This will generate HTML documentation placed in a sub-directory named html. From that directory you can launch the index.html file to view the full documentation in a web browser.
To generate a Windows compiled HTML Help file you must have Microsoft's HTML Help Workshop installed. Then follow these steps:
- Open a terminal window and navigate to the project's
docdirectory. - Edit the configuration file
Doxyfile-chmby entering the location where the Help Workshop system was installed next to theHHC_LOCATIONsetting. - Issue the command
doxygen Doxyfile-chmto generate a compiled Help file namedowa-epanet.chmin thedocdirectory. - You can delete the
html-chmsub-directory created by Doxygen.
Doxygen uses the special comments placed in the project's epanet2_2.h and epanet2_enums.h header files to document EPANET's API. It also uses supplementary material contained in the following files of the project's doc directory to generate additional pages of documentation:
main.dox: generates the Overview section.toolkit-usage.dox: generates the Usage section.toolkit-examples.dox: generates the Examples section.toolkit-files.dox: generates the Toolkit Files section.toolkit-input.dox: generates the Input File sub-section.toolkit-units.dox: generates the Measurement Units section.toolkit-topics.dox: defines the contents of the API Reference section.
Finally, a group of special Doxygen files are used to customize the format of the generated documentation. These include the following:
Doxyfile: the Doxygen configuration file for HTML outputDoxyfile-chm: the Doxygen configuration file for HTML Help outputDoxygenLayout.xml: sets the title of the automatically generated Topics section to API Reference and hides the Files section in the tree view pane of the document.doxygen-awsome.css: applies a custom theme provided by doxygen-awesome to produce a more modern visual style for HTML output.newfooter.html: replaces the default Doxygen footer in HTML output with a custom one.