生成html文档
我们打开刚才安装的软件Doxywizard
在菜单File中Open 打开刚才下的RT-THREAD中的如下文件rt-thread/documentation/doxygen/Doxyfile
然后直接运行run 就可以了,所有操作完成。
如果想看中文,也可以根据下面的设置来选择中文
打开html文档
找到生成的html文件夹打开index.html文件就可以了
展现效果
接下来我们就可以看到效果图了,可以看到很多src目录下面大家写的一些注释
上面基本就是RT-THREAD的doxygen的使用方法了。是不是很简单,很方便?
下面简单介绍下如何自己写doxygen。
Doxygen 如何写
vscode 插件安装
我们先讲讲doxygen怎么写。传统方法直接用文本编辑器来写,这个我这边就不多介绍了。这边我们用一个工具来帮助我们来写常用的doxygen。打开vscode, 安装插件doxygen
这个插件一共有两种操作
在源码文件中头部输入·/** ,然后直接按回车键,你可以看到自动生成的注释了。
在写好的函数的上面输入/** , 然后也是按回车键,你就看也看到效果了。
doxygen文件生成
只要打开Doxygen工具,选择source 文件夹,之后点击run 就可以了
doxygen配置
doxygen的配置其实有很多很多,这边我就举几个常用的配置。
原作者:Thomas_Fly
|