标签：include tor sof http help dia sele 图例 点击
在查找 ffmpeg 文档的时候，发现其文档是根据 Doxygen 生成的。
为了学习方便，这里以 生成 ffmpeg 4.1 文档 为例。
Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。
目前Doxygen可处理的程序语言包含C/C++、Java、Objective-C、IDL等，可产生出来的文档格式有HTML、XML、LaTeX、RTF等，此外还可衍生出不少其它格式，如HTML可以打包成CHM格式，而LaTeX可以通过一些工具产生出PS或是PDF文档等。
下面以 Windwos 的安装与使用为例
安装列表：
安装时，无需特别设置。
Doxygen： 下载地址，http://doxygen.nl/files/doxygen-1.8.17-setup.exe
HTML Help：微软官方用于生成HTML格式的help文件，下载地址，http://go.microsoft.com/fwlink/p/?linkid=14188
Graphviz：一种dot工具可以用来渲染出效果更好的图表，下载地址，https://graphviz.gitlab.io/_pages/Download/windows/graphviz-2.38.msi
Doxygen 有命令行(CMD tool)工具以及界面化(GUI)工具2种。Windows 下常用 界面 设置。
根据实际情况填写以下位置，点击next。
在Select the desired extraction mode ：
1.选择 All Entities
2.勾选 Include cross-referenced source code in the ouput
在Select programing languge the optimize the results for ：
根据实际项目的需要选择对应的语言
选择：Optimize for C or PHP output
点击next。
在Select the output format(s) to generate
1.勾选HTML
2.选择：prepare for compressed HTML(.chm)
不勾选 Latex
这里不打算使用 LaTex 工具进行输出 有关文档。
点击next。
在Diagrams to generate：
选择 Use built-in class diagram generator
勾选Dot graphs to generate下所有项目
标签：include tor sof http help dia sele 图例 点击
原文地址：https://www.cnblogs.com/schips/p/12199684.html
