QDoc 快速入门

Qt uses QDoc to generate its documentation set into HTML and DocBook XML formats. QDoc uses a set of configuration files to generate documentation from QDoc comments. The comments have types called topics that determine whether a comment is a class documentation or a property documentation. A comment may also have mark up to enhance the layout and formatting of the final output.

There are three essential materials for generating documentation with QDoc:

  • QDoc binary
  • qdocconf configuration files
  • 文档编制 in C++ , QML ,和 .qdoc 文件

注意: QDoc requires Clang for parsing C++ header and source files, and for parsing the function signatures in \fn commands. See 为 QDoc 安装 Clang 了解细节。

This section intends to cover the basic necessities for creating a documentation set. Additionally, the guide presents special considerations and options to documenting non-C++ API documentation as well as QML documentation. Finally, the guide will provide a sample project documentation and an example of a QML type documentation.

For specific QDoc information, consult the QDoc 手册 .

章节

  1. 为 QDoc 安装 Clang
  2. Creating QDoc Configuration Files
  3. Writing Documentation
  4. Categories of Documentation
  5. How to Resolve QDoc Warnings

为 QDoc 安装 Clang

内容