Qt5APIDocumentation

Qt 5 API Documentation

Essentially, for each module we need:

• A – landing page (using the \page command) see specifications
• B – example page
• C – c++ class list (using the \module command)
• D – qml type list (\qmlmodule command)

For example: Qt 3D:

• -module name is ‘Qt 3D’
• -library in the module is ‘Qt3D’
• -landing page is qt3d-index.html with title ‘Qt 3D’ (http://doc-snapshot.qt.io/5.0/qt3d-index.html)
• -c++ list has title ‘Qt 3D C++ Classes’
• -qml list has title ‘Qt 3D QML Types’
• -qt3d-examples.html for the example page

This is to clearly distinguish the pages because \qmlmodule and \module pages confuse people with the word ‘module’ in it. Meaning, lets minimize the generic use of ‘module’.
The other thing to watch out for is the library name versus module name. Avoid ‘Qt3D’ when referring to Qt 3D. Spelling_Module_Names_in_Qt_Documentation lists the names.

qdocconf files

Each module needs a qdocconf [doc-snapshot.qt.io] file to generate a documentation set for each module.
Because of the documentation structure, there is a common qdocconf file and template modules may use.

• Qt5ModuleQDocconf

Process

Each module has a main contact for document issues who can oversee the modularization and documentation issues. This responsible person does not need to be a module maintainer. For classes, an individual may edit documentation for technical and style correctness.

To sign up for the individual, you may sign up at Qt5ClassDocumentationCleanUp.

The Documentation page has information about contributing to the documentation.

Essentials {| class="infotable line" |- style="background: #009900" ! Git repo ! Module ! Responsible ! Status (A,B,C,D) ! URL ! Comment ! qdocconf ! Release |- | qtbase | Qt Core | Thiago | | http://doc-snapshot.qt.io/5.0/qtcore-index.html | | | Qt 5.0 |- | qtbase | Qt GUI | Samuel | ABC | http://doc-snapshot.qt.io/5.0/qtgui-overview.html | | | Qt 5.0 |- | qtbase | Qt Network | Jerome | ABCD | http://doc-snapshot.qt.io/5.0/qtnetwork-index.html | | OK | Qt 5.0 |- | qtbase | Qt SQL | Jerome | ABCD | http://doc-snapshot.qt.io/5.0/qtsql-index.html | | OK | Qt 5.0 |- | qtbase | Qt Test | Leena | AC | | In Gerrit | OK | Qt 5.0 |- | qtdeclarative | Qt QML | Jerome | ABC | http://doc-snapshot.qt.io/5.0/qtqml-index.html | Qt Quick contains the QML types | OK | Qt 5.0 |- | qtdeclarative | Qt Quick | Jerome | ABCD | http://doc-snapshot.qt.io/5.0/qtquick-index.html | | OK | Qt 5.0 |- | qtmultimedia | Qt Multimedia | Venugopal | ABCD | http://doc-snapshot.qt.io/5.0/qtmultimedia-index.html | | OK | Qt 5.0 |- | qtwebkit | Qt WebKit | Pierre | | http://doc-snapshot.qt.io/5.0/qtwebkit-module.html | candidate landing page (needs editing) | | Qt 5.0 |}

(the C++ classes or QML type pages should be linked to from the landing pages, if applicable)