Doxygen usage notes

Recently, I used doxygen to generate documents. some minor problems have been a bit of a headache. The usage is recorded as follows for future search.

Step 1: Download the Binary Package of doxygen

Doxygen

Http://www.10.xdowns.com/uploadFile/2007-7/doxygen.rar

To enable doxygen to add class diagrams and collaboration diagrams to documents, download and install graphviz for win.

Graphviz 2.18 download:

Http://www.graphviz.org/pub/graphviz/ARCHIVE/graphviz-2.18.exe

After installation, you can start using it.

Step 2: Run doxygen wizard.exe

If you just want to run doxygender through the graphic interface, run doxywizard.exe in the bindirectory of doxygen, then follow the instructions in doxywizard usage section in the doxygen root directory document (doxygen_manual-1.5.2.chm. It mainly includes the source code path, working path, and output path.

Step 3: Click start to generate a document

Finally, some problems encountered during document generation are described as follows:

1. Chinese: Chinese comments are garbled in the document.

Solution: Fill in "gb2312" in input_encodeing on the input option page of the expert, so that the code generated based on the GB text editor can be used normally.

However, another problem that cannot be completely solved is that when the output language is Chinese, all Chinese characters in the left navigation bar are still garbled. Please be sure to inform anyone of the solution!

2. Graphics problems: unable to draw images such as class diagram collaboration diagram.

Solution: first, ensure that graphviz for win is installed. Note that it is not wingraphviz. The latter is a graphviz com package, but doxygen is not developed based on it, so it is useless to install it. Enter the installation path of graphviz in dot_path of expert. Then select the image category to be generated in the digoal of the wizard.

If an error cannot contain the. Map File, set the working directory to HTML and clear all the files in HTML and try again. The cause of this problem is unknown.

3. Question about the CHM output: How to output the. CHM File

On the HTML page of expert: Select "generate_htmlhelp" and fill in the desired CHM File Name in chm_file.

Enter the path of the hhc.exe file in hhc_location. Hhc.exe can be obtained by installing HTML Help Workshop.

HTML Help Workshop address:

Http://www.microsoft.com/downloads/details.aspx? Familyid = 00542534-c8a6-452f-9aa0-d597d16580cc & displaylang = en

In this way, you can use doxygen to generate beautiful documents. In terms of code, doxygen supports multiple format annotation styles, just select the one you like based on manual.