Doxygen使用教程

1. 安装

   sudo apt-get install doxygen doxygen-gui 

2. 运行

   运行可视化工具

   doxywizard

   加载保存好的配置文件

   doxywizard Doxyfile

3. 配置
   第一步配置Wizard：
   Project:
   
   Mode:
   
   Output
   
4. 第二步配置Expert：
   Project:
   
   Build:
   
   第三步运行：生成index.html
   
5. 注释书写规范

       /** 
        * @file 文件名
        * @brief 简易说明
        * @details 详细说明
        * @author 作者
        * @version 版本
        * @date 日期
        */
   
       /**
        * 我的自订类别详细说明 ...
        */
       class MyClass {
           public:
               int member1 ; ///< 第一个member说明 ...
               int member2:  ///< 第二个member说明 ...
               int member_function(int a, int b);
       };
        
       /**
        * @brief member_function函数简易说明 ...
        * 函数详细说明 ...
        *
        * @param a 参数a的说明
        * @param b 参数b的说明
        *
        * @return 传回a+b。
        */ 
       int MyClass::member_function( int a, int b ) 
       {
           return a+b ;
       }