Qt5ModuleQDocconf

Qt 5 Module qdocconf Files

Each module in Qt 5 need a qdocconf file to build its documentation set.

• QDoc Manual [doc-snapshot.qt.io]
• Creating QDoc Configuration Files [doc-snapshot.qt.io]

Sample

Here is a sample qdocconf file from Qt Contacts:
It is located in qt5/qtpim/src/contacts/doc/qtcontacts.qdocconf

Another Example with QML types

Here is another example for a module with QML types. This file is found in qt5/qtmultimedia/src/multimedia/doc

Notes

• Please use CamelCase for module names defined in qhp.projects, as above. This ensures that the module names are correctly added as tags into example manifest file, and the examples can be found in Qt Creator’s Welcome mode by searching for the module

List of valid selector types:

• namespace
• class
• enum
• typedef
• function
• property
• variable
• qmlproperty
• qmlsignal
• qmlsignalhandler
• qmlmethod
• fake

A ‘fake’ type specifies a generic documentation node, and is followed by :subtype specifier. Valid subtypes:

• example
• headerfile
• file
• group
• module
• page
• externalpage
• qmlclass
• qmlpropertygroup
• qmlbasictype