「Doxygen」- 文档生成工具

  CREATED BY JENKINSBOT

用于 C, C++, Java, Objective-C, Python, IDL 和某些范围的 PHP, C#, D 的文档系统。可以从一组记录的源文件中,生成在线的 class 浏览(HTML 格式)和离线的参考手册(LaTeX 格式)。同时也支持生成 Man 手册、将生成的输出转化为 POstscript、超链接的 PDF、压缩的HTML。文档直接从源文件中提取,即写在代码中的注释。

用「Doxygen」可以做什么?

1)从代码的注释中,生成文档。
2)使用未注释的源码来:分析源码的结构,获取源码的调用图、继承图、关系图。
3)单纯的创建普通文档。

支持的输出格式

HTML、LaTeX、Man pages、Rich Text Format、XML

软件安装

通过包管理器安装(APT、YUM)

# Kali GNU/Linux Rolling
apt-get install doxygen doxygen-gui

# Doxygen手册
apt-get install doxygen-doc

通过源码编译安装(Linux)

参考 BLFS/Doxygen-1.8.11 站点,以获取编译安装的详细过程。

包含的可执行程序

doxygen
是一个基于命令行的程序,用于生成配置文件模板,然后用模板生成文档。
使用doxygen –help来解释命令行参数。

doxywizard
配置和运行doxygen的GUI工具。

doxyindexer
使用由doxygen生成的搜索数据文件,生成名为doxysearch.db的搜索索引文件。
http://www.stack.nl/~dimitri/doxygen/manual/extsearch.html

doxysearch.cgi
用于搜索由doxygen索引的数据的CGI程序。

参考文献

Wikipedia / Doxygen: https://en.wikipedia.org/wiki/Doxygen
Homepage: http://www.stack.nl/~dimitri/doxygen/
Doxygen Manual: http://www.stack.nl/~dimitri/doxygen/manual/index.html
Github Repo: https://github.com/doxygen/doxygen
BLFS/Doxygen-1.8.11