为 QDoc 安装 Clang

开始使用 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 警告

为 QDoc 安装 Clang

© 2024 Qt 公司有限公司。本文档中的文档贡献是其各自所有者的版权。本文档是根据自由软件基金会发布的 GNU 自由文档许可证版本 1.3 许可的。Qt 及其相应标志是 Finland 和/或其他国家的 Qt 公司的商标。所有其他商标均为其各自所有者的财产。