Doxygen
From HotDec
Contents |
Getting Started
Windows
Binaries are available here. Simply download the windows binary and install it onto your system.
Debian / Ubuntu
Doxygen also has an optional GUI to get doxygen with the gui do
sudo apt-get install doxygen-gui
otherwise do
sudo apt-get install doxygen
Linux
Binaries and source are available here. If you wish to build from source, simply download the source code and follow the instructions on the doxygen site or the quick install instructions below.
tar xvzf doxygen-$VERSION.src.tar.gz cd doxygen-$VERSION ./configure --with-doxywizard make install
Commenting Style
While Doxygen can read many different comment styles the most consistent style is the Javadocs Style. Using Javadoc style comments will allow us to comment consistently. Simple Example:
/**
* Sets the tool tip text.
*
* @param text the text of the tool tip
*/
public void setToolTipText(String text) {
In the above example we see a short description of the function followed by information on the parameter the function takes. @param is a predefined javadoc variable and when Doxygen sees it, it will place this information in the right place with the right styling. Many other variables can also be used.
* @param <parameter_name> <parameter_descreption> * @return <information on what is being returned> * @exception <information about exceptions being thrown> * @throws <synonym to exception> * @author <author name> * @version <version information> * @see <related methods, classes or files>
More information on how to comment for JavaDocs can be found on Sun's Website.
