Documentation is one such task which we as developers, find it boring to do in spite of knowing its importance. So, like we always do, we will take help from a tool.
Doxygen is a tool used for writing software reference documentation.
The documentation is written within code as we develop, and is relatively easy to keep up to date.
Doxygen is a free software and can be used with C, C++, C#, Fortran, Java, Objective-C, PHP, Python, IDL (CORBA and Microsoft flavors), VHDL, and to some extent D.
Refer this for more information [[http://en.wikipedia.org/wiki/Doxygen]] and [[http://www.stack.nl/~dimitri/doxygen/]]
In order to generate a document using Doxygen tool, one has to write the comments in a specific way in the project files.
Ex:
/**
Description of the method
@param param1 The first parameter
@param param2 The second parameter
@returns the returned object description
*/
/** */
Steps to generate the document
Once you are done with writing the comments in your code follow these steps on how to go about using the Doxygen tool.
1.Download the latest Doxygen version onto your machine and then install it.
You can download it from here: [[http://www.icewalkers.com/Linux/Software/57870/Doxygen.html]]
2. After installation you will see a window as shown below.
Wizard -
- Specify the working and the source code directories i.e; the project folder (for both it will be the same)
- Select scan recursively
- Specify one destination folder where you want the document file to be saved
- In Project section: Select javadoc autobrief
- In Build section: Select Extract All
- In LaTeX section: Deselect generate latex
5.Go to the destination folder and open the index.html file.
And Ta Daa
A complete documentation of your project is ready in a matter of few minutes.











