/Qt 5.11

Getting Started with QDoc

Qt uses QDoc to generate its documentation set into HTML and DITA 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
  • Documentation in C++, QML, and .qdoc files

Note: From Qt 5.11, QDoc requires clang from LLVM 3.9 for parsing C++ header and source files, and for parsing the function signatures in \fn commands. See Installing clang for QDoc for details.

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 Manual.


  1. Installing clang for QDoc
  2. Creating QDoc Configuration Files
  3. Writing Documentation
  4. Categories of Documentation
  5. QML Documentation Example

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.