doxygen 软件文档生成

__pop_

已于 2022-06-14 16:55:31 修改

阅读量321

点赞数

CC 4.0 BY-SA版权

分类专栏：杂七杂八总览文章标签： vim linux 编辑器

于 2021-08-25 15:36:35 首次发布

本文链接：https://blog.csdn.net/u011011827/article/details/119912588

杂七杂八总览专栏收录该内容

134 篇文章

订阅专栏

本文档详细介绍了如何利用Doxygen工具在Windows和Linux环境下为C/C++项目生成专业文档。首先，介绍了Doxygen的基本语法，包括函数、宏的注释方式。接着，讲解了在Windows下安装Doxygen、Graphviz和htmlhelpworkshop，并说明它们的作用。在Linux中，通过`doxygen -g`创建配置文件，并提供了配置示例。最后，演示了如何运行Doxygen生成HTML文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

文章目录

doxygen 语法

vim 脚本

Plugin 'vim-scripts/DoxygenToolkit.vim'

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

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

Windows 下的 doxygen

参考

软件下载

以 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