doxygen使用笔记

原创已于 2022-02-17 11:25:16 修改 · 719 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#doxygen

于 2020-12-07 00:25:15 首次发布

二把刀运维专栏收录该内容

51 篇文章

订阅专栏

本文介绍Doxygen文档生成工具的安装与使用方法，包括源码安装、使用APT安装等途径，并详细解释如何通过Doxygen生成不同类型的文档模板。

doxygen使用

源码安装

https://www.doxygen.nl/index.html

GIT安装

https://www.doxygen.nl/download.html

git clone https://github.com/doxygen/doxygen.git doxygen.git
cd doxygen.git
mkdir build
cd build
cmake -G "Unix Makefiles" ..
make
make install

cmake 报错 Could NOT find FLEX (missing: FLEX_EXECUTABLE)
$ sudo apt-get install flex

cmake 报错 Could NOT find FLEX (missing: FLEX_EXECUTABLE)
$ sudo apt-get install bison

-_-||… 我还在用gcc5.4,改成C++14呗(有一定风险!)。

cmake 报错 Target "doxygen" requires the language dialect "CXX17"
set(CMAKE_CXX_STANDARD 17) ==> set(CMAKE_CXX_STANDARD 14)

果然编译失败，放弃，apt安装好了

安装

apt-get install -y doxygen

使用文档

https://www.doxygen.nl/download.html

doxgen --help

$ doxygen-帮助
Doxygen版本1.8.13
Dimitri van Heesch版权所有1997-2015

You can use doxygen in a number of ways:

1) Use doxygen to generate a template configuration file:
    doxygen [-s] -g [configName]

    If - is used for configName doxygen will write to standard output.

2) Use doxygen to update an old configuration file:
    doxygen [-s] -u [configName]

3) Use doxygen to generate documentation using an existing configuration file:
    doxygen [configName]

    If - is used for configName doxygen will read from standard input.

4) Use doxygen to generate a template file controlling the layout of the
   generated documentation:
    doxygen -l [layoutFileName.xml]

5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex.
    RTF:        doxygen -w rtf styleSheetFile
    HTML:       doxygen -w html headerFile footerFile styleSheetFile [configFile]
    LaTeX:      doxygen -w latex headerFile footerFile styleSheetFile [configFile]

6) Use doxygen to generate a rtf extensions file
    RTF:   doxygen -e rtf extensionsFile

If -s is specified the comments of the configuration items in the config file will be omitted.
If configName is omitted `Doxyfile' will be used as a default.

-v print version string

翻译一下

$ doxygen-帮助
Doxygen版本1.8.13
Dimitri van Heesch版权所有1997-2015

您可以通过多种方式使用doxygen：

1）使用doxygen生成模板配置文件：
    doxygen [-s] -g [configName]

    如果-用于configName，则doxygen将写入标准输出。

2）使用doxygen更新旧的配置文件：
    doxygen [-s] -u [configName]

3）使用doxygen通过现有配置文件生成文档：
    doxygen [configName]

    如果-用于configName，则doxygen将从标准输入中读取。

4）使用doxygen生成控制模板布局的模板文件
   生成的文档：
    doxygen -l [layoutFileName.xml]

5）使用doxygen为RTF，HTML或Latex生成模板样式表文件。
    RTF：doxygen -w rtf styleSheetFile
    HTML：doxygen -w html headerFile footerFile styleSheetFile [configFile]
    LaTeX：doxygen -w乳胶headerFile footerFile styleSheetFile [configFile]

6）使用doxygen生成rtf扩展文件
    RTF：doxygen -e rtf扩展文件

如果指定了-s，则将忽略配置文件中配置项目的注释。
如果省略configName，则默认使用“ Doxyfile”。

-v打印版本字符串