QDoc命令大全,让你轻松掌握Qt文档生成!
Qt是一个跨平台的C++应用程序开发框架,其文档生成工具QDoc可以帮助开发者自动生成可浏览的API文档。本篇文章将介绍QDoc常用命令及其用法。
qdoc
qdoc是启动QDoc的入口命令,它会加载所有需要的模块和插件来生成文档。其常用参数如下:
- -outputdir
: 指定输出目录 - -config : 指定配置文件
- -indexdir
: 指定索引目录 - -pass =: 设置预处理器宏定义或者使用已有的定义
- -parser : 指定解析器类型(html、xml、intf等)
以下是一个例子:
qdoc -outputdir doc -config myconfig.qdocconf -pass MY_VERSION=1.0.0 -parser html
\ingroup
\ingroup命令可以将接下来的所有类、函数、变量等成员添加到指定组中,方便进行分类和查找。其用法如下:
/**
* @ingroup MyGroup
*/
class MyClass {
...
};