本篇博客记录一些从网上收缴来的资源。包括配置安装过程,以及Doxygen文档命令的一些写法。最后详细讲解一个将生成的静态网页托管到github上的过程。
一、 配置安装过程见以下文章::
二、常见的Doxygen命令:
文档中的命令都开始于一个反斜杠(\)(Qt风格)或者是一个at-符号(@)(java风格)
1 文件信息
1) \file 文件名(遵守文件命名规则) --> 文件声明,即当前文件名
2) \author 作者名 --> 作者
3) \version 版本号 --> 版本号
4) \todo 说明文字 --> TODO 列表,在相关页面有它专门一项
注:只能在实现文件(*.c/*.cpp)中使用,
如果相同函数的实现文件与头文件中均有,生成的文档中会有重复项,
可以理解为调用者不应知道实现流程。
5) \date 日期时间 --> 说明文件生成的日期时间
6) \section 章节标题 --> @section LICENSE 版权许可 @