Doxygen

The latest version of Doxygen is an open source cross-platform. The official version of Doxygen is a documentation system similar to JavaDoc style description, fully supports C, C++, Java, Objective-C and IDL languages, and partially supports PHP and C#. Doxygen starts from a set of archived source files and generates an online class browser in HTML format, or an offline LATEX or RTF reference manual.

Doxygen tool introduction

Doxygen It 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 more or less comments, but for others, directly exploring the comments in the program is as hard as salvaging the Titanic. Most useful comments are descriptions of functions, types, and so on. Therefore, if the comments can be processed and reorganized into a pure reference manual based on the structure of the program itself, it will reduce a lot of burden for people who use your program code later. However, on the other hand, the work of organizing files is a heavy burden for you.

Doxygen file format

* HTML

* XML

* LaTeX

* RTF (MS-Word)

* PostScript

* Unix Man Page

​​And many other formats can be derived from it. Once you have a LaTeX file, you can use some tools to generate PS or PDF files.

In terms of multi-language support, Doxygen currently supports about 2,30 languages. Traditional Chinese is supported since Doxygen 1.2.16. So currently some Open Source Among the program document managers, Doxygen is quite complete. In terms of programming language processing, Doxygen is also one of the few in Borland C++Builder. One of the tools that can still function normally under the syntax of .

The purpose of this article is to give you a general understanding after reading it carefully. So that you can easily get started using Doxygen. As for the detailed use of Doxygen itself, you can refer to the Doxygen Attached documents. In fact, Doxygen's own user manual was produced using Doxygen. You can see that he is actually able to produce far more than Reference Book more complex files.

Doxygen programming language

* C/C++

* Java

*Objective-C

* Python

* IDL (Corba, Microsoft and KDE-DCOP types)

*Fortran

*VHDL

* PHP

* C#

Doxygen FAQ

Configuration file (Doxyfile) error

Problem description:

Newbies may encounter configuration file errors when using Doxygen, causing document generation to fail.

Solution:

Check the configuration file: Make sure that every configuration in the Doxyfile is correct, especially key configuration items such as INPUT and OUTPUT_DIRECTORY.

Use default configuration: If you have problems with the configuration file, you can try to use the default configuration file provided by Doxygen. You can generate a new Doxyfile by command doxygen -g.

Gradual adjustment: Based on the new configuration file, gradually adjust the configuration items until the requirements are met.

Doxygen update log

​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​

Optimize user feedback issues and improve detailed experience