qdoc:Qt文档是如何生成的

最新推荐文章于 2024-09-12 12:00:00 发布

Terrarily

最新推荐文章于 2024-09-12 12:00:00 发布

阅读量1.5k

点赞数 1

文章标签： qt

本文链接：https://blog.csdn.net/weixin_42510813/article/details/120199621

版权

Qdoc是一个用于生成软件文档的工具，主要处理Qt工程中的qdoc注释。它根据qdocconf文件解析源代码和.qdoc文件，生成HTML或DITA XML文档。Qdoc支持standard mode和single mode，其中single mode由于避免重复遍历源代码和索引文件，速度更快。QDoc的工作流程包括读取qdocconf文件、构建主树、解释注释并格式化输出。

摘要由CSDN通过智能技术生成

Qdoc是开发者用于在软件工程中生成文档的一个工具。

它根据qdocconf文件的指示，从工程的源文件中提取qdoc类型注释，并以html页面或者DITA XML2文档的形式格式化到文件中。

Qdoc在.cpp和.qdoc文件中查找注释，而不会在.h文件中查找。一条qdoc注释往往以一个前置声明符号（!）开始

Qdoc把以.qdocconf结尾的参数理解为QDoc configure file，configure file是使用者用以告诉qdoc何处存放源代码文件、头文件以及.qdoc文件，同时它也指定了以何种格式（HTML、DITA XML…）输出结果，以及输出文件的位置，以及其它信息。

qdoc的目的文件是qhp文件，得到qhp文件后，使用以下命令对qhp文件打包

  %qtbin%\qhelpgenerator.exe %localpath%\testdoc.qhp

然后就可以把它上传到 assistant程序，或者使用QtHelp打开。

使用qdoc 命令生成文档

这种方法适用于构建不依赖其他项目(有依赖项的处理方式见下文)的单独项目, 当用户写好注释相关文件时，以以下方式编写 qdocconf文件。

在qdocconf中写入最小信息集

作为兼容， 必须添加
include(compat.qdocconf)
文档的输出路径
outputdir = html
指定和cpp源文件相对应的头文件路径。
headerdirs = .
指定包含了 qdoc 文件和 .cpp 文件的路径
sourcedirs = .
指定包含了示例源代码的路径
exampledirs = .
指定使用到的图片路径
imagedirs = ./images
指定qhp输出文件的内容
qhp.projects = testdoc 工程名称
qhp.testdoc.file = testdoc.qhp 输出名称
qhp.testdoc.namespace = com.gsp.1.0 命名空间
qhp.testdoc.virtualFolder = testdoc 依赖项引用它时&#