Doxygen Document Generation Tool

http://blog.csdn.net/lostaway/article/details/6446786

Doxygen is a cross-platform document generation tool that supports C + + and many other languages. Like JavaDoc, Doxygen extracts annotations that conform to the Doxygen annotation specification directly from the source file, generating the document [1].

1. Installation 1.1 installation Doxygen 1.7.4 (Windows)

Address: Ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.7.4.windows.bin.zip

1.2 Installing Graphviz 2.28.0 (Windows)

Address: Http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.28.0.msi

[2] Graphviz is an open source toolkit, launched by the AT and T Labs, to draw a graph of the dot language script description. Doxygen uses Graphviz to automatically generate a call graph between classes and between files, such that the toolkit is not installed without this functionality.

1.3 Installing Windows help Workshop 1.32

Address: Http://download.microsoft.com/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe

This tool will not say much, generate the CHM help document. Doxygen uses it to generate documents in CHM format.

2. Configuration Run Doxywizard start configuration

Doxygen 1.7.4 The main interface as shown in 1.

Description

Doxygen working directory (1:) Is the directory that is used to store the configuration file, and there is no use for it.

Select Output Topics under the wizard tab

The relevant configuration instructions are shown in 2.

Select Diagrams Topics under the wizard tab

The relevant configuration instructions are shown in 3.

If you have previously installed the Graphviz Toolkit, you can enable this option.

Select Project Topics under the Expert tab

The relevant configuration instructions are shown in 4.

Description: Encoding format, UTF-8 is preferred.

Select Input Topics under the Expert tab

The relevant configuration instructions are shown in 5.

Description

The input source file is encoded in the same encoding format as the source file. If the source file is not UTF-8 encoded it's best to turn around.

Select the HTML Topics under the Expert tab

The relevant configuration instructions are shown in 6.

Description

If you select the Prepare for compressed HTML (. chm) option in the Wizard's Output Topics, you will be asked to select the location of the Hhc.exe program here. Hhc.exe can be found under the Windows Help Workshop installation directory.

There are also a lot of options in the Expert label that need to be customized to your requirements. Personal preference problems will not be described, we can check the Doxygen document what, there is a detailed introduction of each option.

Select the Run label

The relevant configuration instructions are shown in 7.

Click the Run doxygen button and Doxygen will fetch the code from the source to generate the document in your custom format. The next job is to learn Doxygen's annotated specifications, and refer to the Doxygen QuickStart, section 2nd, "Common annotation syntax." Slowly you can experience the convenience of Doxygen.

Doxygen the problem of generating CHM document garbled

Because the default encoding for Windows is not UTF-8, the Doxygen generated CHM file directories and file title bars are garbled. General troubleshooting steps can refer to the "Doxygen QuickStart" for troubleshooting directory garbled problems. One thing to add here is that it's best to convert INDEX.HHC, INDEX.HHK, index.hhp to UTF-8 format. So the title bar and what is not garbled.

Reference

[1] Http://zh.wikipedia.org/wiki/Doxygen Wikipedia-doxygen

[2] Http://zh.wikipedia.org/wiki/Graphviz Wikipedia-graphviz

[3] http://hi.baidu.com/soulmachine/blog/item/6055ad017a9a1606738da58c.html Doxygen Quick Start

Appendix

Add a few pieces:

(GO) Doxygen document Generation tool