20200805 Ubuntu Doxygen 生成文档简单说明

约定不等于承诺〃 2023-03-06 05:18 6阅读 0赞

[更多用法，官方文档][Link 1]

//! xxx
    类似
    //! \brief xxx
    
    /*!
    	xxxx //可以在界面中显示 more 这样的连接
    */
    
    \brief 介绍
    \remark 备注
    \param 参数介绍
    \see \sa xxx() 链接某个函数
    
    //!< 变量介绍
    int a; //!< xxxx
    
    同时支持 MarkDown 语法

#### doxygen gui 可直接下载通过命令行的方式 ####

sudo apt install doxygen-gui

#### 启动 运行 doxywizard ####

#### 配置 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0ODkwOTUz_size_16_color_FFFFFF_t_70]  
Step1 导出目录  
Project name : 生成的工程名字  
source code directory: 需要转化的目标文件路径  
Scan recursively 递归检索

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0ODkwOTUz_size_16_color_FFFFFF_t_70 1]  
OUTPUT\_LANGUAGE: 语言随意选择  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0ODkwOTUz_size_16_color_FFFFFF_t_70 2]  
Build 导出的内容选择（EXTRACT\_PRIVATE 导出私有类)

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0ODkwOTUz_size_16_color_FFFFFF_t_70 3]  
点击 Run doxygen 就可以导出内容

[Link 1]: https://www.doxygen.nl/manual/markdown.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0ODkwOTUz_size_16_color_FFFFFF_t_70]: /images/20230208/b120053375174fe0863c80988a0d98e2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0ODkwOTUz_size_16_color_FFFFFF_t_70 1]: /images/20230208/da9679ccabee45c189c05ce54229de4b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0ODkwOTUz_size_16_color_FFFFFF_t_70 2]: /images/20230208/9a208d97bd194690bf8539a1c58a497c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI0ODkwOTUz_size_16_color_FFFFFF_t_70 3]: /images/20230208/ef9d10a1b8e949798937892b38c5be21.png