What is Doxygen; what role does it have?
Doxygen is an open source cross-platform, document system described in a JavaDoc-like style, fully supporting C, C ++, Java, Objective-C and IDL languages , and partially supporting PHP and C #. The syntax of comments is compatible with Qt-Doc, KDoc, and JavaDoc. Doxgen can start from a set of archived source files and generate online browsers in HTML format, or offline LATEX and RTF reference manuals.
Doxygen is a program file generation tool that can convert specific comments in the program into description files. Usually when we write a program, we will write comments more or less, but for others, we have to directly explore the comments in the program, which is as hard as salvaging the Titanic. Most useful comments belong to the descriptions of functions, categories, etc. Therefore, if you can reorganize the comments into a pure reference manual according to the structure of the program itself, it will reduce a lot of burden for those who use your program code later. However, conversely, the work of organizing documents is a heavy burden for you.
Doxygen is when you write a comment, according to some of the rules set by it. Then, he can help you produce beautiful documents. Therefore, the use of Doxygen can be divided into two parts. The first is to write comments in a specific format, and the second is to use Doxygen's tools to generate documents.
Environment construction; software download
- Doxygen download-download address: http://www.onlinedown.net/soft/117010.htm
- htmlhelp download-download address: http://msdn.microsoft.com/en-us/library/ms669985.aspx (If you want your Doxygen to automatically generate chm, then please download HTML Help Workshop, we will use hcc. exe file and related dll.)
- Graphviz download-download address: http://www.skycn.com/soft/appid/6971.html (graphviz is an open source toolkit launched by AT & T Labs, used to draw the graphics described by the DOT language script. Doxygen uses graphviz automatically generates call relationship graphs between classes and files. If you do not need this function, you can not install the toolkit.)
Environment construction; software application
After installing, start to configure Doxygen tool and run Doxywizard. The following interface will appear
Environment construction; configure working directory
Click Select to choose your own Doxygen installation directory
Configure Wizard tab; configure Project
First modify the Project name, select the directory to scan the source code, Source code directory :, check Scan recursively (recursive scanning), and then select the output directory.
Configure Model
In the Mode under Wizard's Topics, select All Entities to output relatively complete functions. Whether or not the source code is included depends on your own situation. Choose your language below. Here the author is using C ++
In Output, please check if you need to output chm format.
Choose to use GraphViz package in Diagrams to output UML
Article reference: https://blog.csdn.net/Andy_93/article/details/53125776
