doxygen official manual

doxygen is a useful auxiliary tool for programmers. It can make it easier to add batch code to the program. It is compatible with mainstream programming languages ​​​​such as C++, C, Java, Objective-C, Python, etc. The doxygen Chinese provided by the editor The manual contains basic introduction, grammar skills and advanced skills, etc., allowing you to get started quickly. You are welcome to download it if you need it.

Basic introduction

Doxygen already supports generating ANSI-encoded chm directory files (index.hhc)! Doxygen is usually used to generate English documents. Generating Chinese documents requires modifying the input and output encoding systems, which can change the parsing method and generate Chinese documents. . However, you must be aware that Doxygen needs to perform grammatical parsing when extracting information from comments. These parsings are based on English, and it is impossible to support Chinese at this level.

Doxygen is a documentation generator for C++, C, Java, Objective-C, Python, IDL (CORBA and Microsoft flavors), Fortran, VHDL, PHP, C# and D languages. Can run on most Unix-like systems, as well as Mac OS X operating systems and Microsoft Windows. The initial version of Doxygen borrowed some code from the older version of DOC++; subsequently, the Doxygen source code was rewritten by Dimitri van Heesch.

The doxygen manual is divided into three parts, each containing several chapters.

The first part is the user guide

1. Installation, discusses how to download, compile, and install doxygen on your platform.
2. Let’s start by telling you how to quickly generate the first doxygen document.
3. Code documentation, demonstrating several ways in which code can be documented.
4. List, showing several ways to create a list.
5. Combination, showing how to combine some work together.
6. Contains formulas, showing how to insert formulas in the document.
7. Graphs and charts, describing the charts and graphs generated by doxygen.
8. Preprocessing and parsing how doxygen handles macro definitions.
9. Generate automatic links that show how to place links to files, classes, and members in the document.
10. Output format, showing how to generate various output formats supported by doxygen.
11. Search, showing several ways to search in HTML documents.
12. Custom output, analyze how to generate customized output in doxygen.
13. Custom commands, showing how to define and use custom commands in your comments.
14. Connect to external documents and explain how to let doxygen create links to external generated documents.
15. FAQ, answers to frequently asked questions.
16. Troubleshooting, it tells you what to do when something goes wrong.

The second part is a reference guide

1. Features, showing an overview of doxygen’s functions.
2. Doxygen history, informing doxygen of changes during the development process and what it has been doing.
3. Doxygen usage, tell how to use doxygen.
4. Doxytag usage, tell how to use doxytag.
5. Usage of doxywizard, tell how to use doxywizard.
6. Installdox usage, tell how to use the generated installdox script in doxygen if you use tag files.
7. Configuration, telling how to adjust doxygen to generate the documentation you need.
8. Special command words, giving an overview of the special commands that can be used in the document.
9. HTML command words, which provide an overview of the HTML commands that can be used in the document.
10. XML command words, which provide an overview of C#-style XML commands that can be used in documents.

The third part provides some information for doxygen developers (omitted)

1. Internal structure of doxygen, giving an overall overview of the internal structure of doxygen.
2. Perl module output format, showing how to use the output of PerlMod.
3. Internationalization, analyzing how to add output support for new languages.