Doxygen is a package, which autogenerates documentation based on the comments you have added. It is just that you have to comment the code properly, and it will take the lead
Installation
sudo apt-get install doxygen
Compiling
Step 2 : Generate Configuration file
doxygen -g abc.config
Step 3 : Generate Documentation
doxygen abc.config
The last step will generate sample documentation in latex, html automatically, which we can view,modify.
How to write code(to include)
/* * This function description will be * included in final source. * @param input1 Used for task1 */
and further use /// for including the comment pertaining to variable description in final documentation.
References
http://www.doxygen.org/
No comments:
Post a Comment