QDoc 入门

Qt 使用 QDoc 将其文档集生成 HTML 和 DocBook XML 格式。 QDoc 使用一组配置文件来生成 QDoc 注释的文档。注释的类型称为 主题,它决定了注释是类文档还是属性文档。注释也可以带有 标记,以增强最终输出的布局和格式。

用 QDoc 生成文档有三样必须:

  • QDoc 二进制文件
  • qdocconf 配置文件
  • C++QML.qdoc 文件中的 文档

注意:QDoc 需要 Clang 来解析 C++ 头文件和源文件,以及解析 \fn 命令中的函数签名。详阅 为 QDoc 安装 Clang

本节旨在涵盖创建文档集的基本需要。此外,该指南还介绍了记录非 C++ API 文档和 QML 文档的特殊注意事项和选项。最后,该指南将提供一个示例项目文档和一个 QML 类型文档的示例。

有关特定的 QDoc 信息,请参阅 QDoc 手册

章节

  1. 为 QDoc 安装 Clang
  2. 创建 QDoc 配置文件
  3. 编写文档
  4. 文档类别
  5. 如何解决 QDoc Warning