Doxygen Is a program file generation tool , You can convert a specific annotation in a program into a description file . It provides a set of annotation methods to facilitate the generation of explanatory documents from the annotations in the code .

1. Doxygen Installation and use

   Need to install doxygen,graphviz. htmlhelp, Be careful ： The installation directory should not contain Chinese characters or other strange characters .Doxygen The download link of the suite is Doxygen Download link of the suite

1.1 Select the configuration source directory and target file directory

1.2 Mode To configure

1.3 Choose to generate chm Help file

1.4 Call graph configuration

   Need to install graphviz

1.5 Configuration of engineering document coding format

1.6 Set the extraction range

  Build page , This page is the key configuration page in generating help information ：

1.7 Input To configure

1.8 chm File settings

1.9 Generated call graph configuration

1.10 Generate chm Help file

   After configuration , Click on RUN->tun doxygen Start generating files . Finally, generate a CHM file

2. Doxygen Annotation syntax

  Doxygen Is a program file generation tool , You can convert a specific annotation in a program into a description file . It provides a set of annotation methods to facilitate the generation of explanatory documents from the annotations in the code .

2.1 Simple notes

     Single-line comments ：///  perhaps  //!

     Multiline comment ：/**  perhaps  /*!

2.2 File Comments

   File comments are usually placed at the beginning of the entire file .

/** * @file  file name  * @brief  brief introduction  * @details  details  * @mainpage  Project overview  * @author  author  * @email  mailbox  * @version  Version number  * @date  year - month - Japan  * @license  Copyright  */

   for example ：

/** * @file Test.h * @brief  Test header file  * @details  This is the test Doxygen * @mainpage  Project overview  * @author zhangsan * @email zhangsan @126.com * @version 1.0.0 * @date 2017-11-17 */

2.3 Class definition comments

   The annotation method of class definition is very simple , Use @brief Fill in the overview of the class later , Fill in the details of the class on a new line . Namespace 、 Structure 、 Consortium 、 Enumeration definitions are annotated in the same way as class definitions .

/** * @brief  A brief overview of classes  *  A detailed overview of classes  */

   for example ：

/** * @brief  Test class  *  Mainly used to demonstrate Doxygen Class annotation  */

class Test{
    

};

   Generate document effects

2.4 Constant / Comments on variables

   Constant / Variables include the following types

• Global constant variable
• Macro definition
• class / Structure / Member variables of the consortium
• Enum members of type

   There are two ways to annotate , You can choose according to the specific situation

1. Comment before code

///  notes 
 Constant / Variable 

   for example ：

///  Cache size 
#define BUFSIZ 1024*4

  2. Post code comments

 Constant / Variable      ///<  notes 

   for example ：

#define BUFSIZ 1024*4 ///<  Cache size 

   Generate document effects

2.5 Function Comments

   Concise notes , Function comments mainly include return value descriptions (@retval) In the third part of . You can add detailed instructions as needed (@detail)、 annotation (@note)、 Be careful (@attention)、 Warning (@warning) Or abnormal (@exception) etc. . Example ：

/** * @brief  Get the status of serial port interrupt  * @param obj  The serial port object to operate  * @param intStatus  The type of serial port interrupt to obtain  * @retval RESET = 0, SET = !RESET */

   Generate document effects

3. Effect display

   Generated .chm The help document is shown in the figure below , You can see the list of generated files , An example of function call relationship is shown in the following figure .

   You can clearly see the calling relationship between functions .