doxygen 软件文档生成

doxygen 语法

• vim 脚本

Plugin 'vim-scripts/DoxygenToolkit.vim'

.vim/bundle/DoxygenToolkit.vim/plugin/DoxygenToolkit.vim

文件描述 : DoxAuthor // 只有加了 doxygen 文件描述的 文件 才会被解析
函数描述 : Dox
宏描述   : ///

Windows 下的 doxygen

• 参考

软件下载

• Doxygen
• Graphviz
• html help workshop

以 Doxygen 为 界面, 以 Graphviz 和 html help workshop 为后端
	Graphviz 负责解析
	html help workshop 负责生成

工程配置

Doxygen  会创建一个工程
	该工程有工程目录
	input 就是你的  源码目录
	output 就是你的 软件文档生成目录
配置完可以生成一个配置文件

Linux 下的 doxygen

// 生成配置文件 Doxyfile
doxygen -g –s

修改配置文件
PROJECT_NAME           = "XXX_lib"
PROJECT_NUMBER         = "1.0 beta"
PROJECT_BRIEF          = "Used to control XXX"
PROJECT_LOGO           = "doc/avatar.png"
OUTPUT_DIRECTORY       = doc

INPUT                  = inc src

FILE_PATTERNS          = *.c *.h

GENERATE_LATEX         = NO

生成 html
doxygen // 会在 doc 文件夹 生成 html/index.html