doxygen相关命令
2024-09-05 10:36:54
主要配置修改
整个程序配置分几个部分
- Project related configuration options
项目相关,包括:- 项目名
- 输出目录
- 输出语言
- 是否显示继承属性
- 是否对C、Java、Fortran等优化
- Build related configuration options
- 是否显示私有、静态变量
- 是否显示 include 文件
- 是否将文件中brief descriptions重新排序
- 显示文件
- 显示作用域
- Configuration options related to warning and progress messages
- Configuration options related to the input files
- 源文件位置
- 字符编码
- 图片位置
- Configuration options related to source browsing
- 是否显示源程序
- 忽略程序注释
- 是否显示调用、被调用相关函数
- Configuration options related to the alphabetical class index
- Configuration options related to the HTML output
- Configuration options related to the LaTeX output
- Configuration options related to the RTF output
- Configuration options related to the man page output
- Configuration options related to the XML output
- Configuration options related to the DOCBOOK output
- Configuration options for the AutoGen Definitions output
- Configuration options related to the Perl module output
- Configuration options related to the preprocessor
- Configuration options related to external references
- Configuration options related to the dot tool
运行使用
doxygen [Doxygen file]
注释
使用JavaDoc风格, 即在C风格注释块开始使用两个星号'*'
/**
* ... 描述 ...
*/
在变量后面放置文档
如果你想对文件、结构体、联合体、类或者枚举的成员进行文档注释的话, 并且要在成员中间添加注释, 而这些注释往往都是在每个成员后面。为此, 你可以使用在注释段中使用'<'标识,例如
int var; /*!< Detailed description after the member */
int var; /**< Detailed description after the member */
int var; //!< Detailed description after the member
//!
int var; ///< Detailed description after the member
///
在变量前方放置文档
/** Detailed description before the member */
int var;
最新文章
- ECS Linux 服务器解除ssh登陆后被锁定或暂停输入输出的终端
- Angular datetime format
- Lua 学习笔记(九)协同程序(线程thread)
- 当struts遇上json,没爱了
- 英文分词算法(Porter stemmer)
- sql server 2008笔记
- Codeforces Round #167 (Div. 2) D. Dima and Two Sequences 排列组合
- json对象和字符串互相转换
- Java中join的使用
- lua语言入门之Sublime Text设置lua的Build System
- int 占一个机器字长
- 转:javascript面向对象编程
- 安装Devstack的DNS问题
- 离开Visual Studio C#的编译(你不知道的C#)
- JavaScript 图
- Android自定义权限
- Forward团队-爬虫豆瓣top250项目-代码设计规范
- HAOI2017 新型城市化 二分图的最大独立集+最大流+强连通缩点
- JavaScript新手学习笔记(一)
- __declspec的用法