Qt wiki will be updated on October 12th 2023 starting at 11:30 AM (EEST) and the maintenance will last around 2-3 hours. During the maintenance the site will be unavailable.

Qt5APIDocumentation

From Qt Wiki
Revision as of 10:56, 31 March 2015 by Henri Vikki (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
This article may require cleanup to meet the Qt Wiki's quality standards. Reason: Auto-imported from ExpressionEngine.
Please improve this article if you can. Remove the {{cleanup}} tag and add this page to Updated pages list after it's clean.

Essentially, for each module we need:

  • A - landing page (using the command) see specifications
  • B - example page
  • C - c++ class list (using the command)
  • D - qml type list (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 and 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 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.

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

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)

Qt Add-ons

Git repo Module Responsible Status (A,B,C,D) URL Comment qdocconf Release
qt3d Qt 3D AC http://doc-snapshot.qt.io/5.0/qt3d-index.html OK
qtbase Qt Concurrent Morten? Qt 5.0
qtbase Qt D-Bus Thiago Qt 5.0
qtbase Qt OpenGL Qt 5.0
qtbase Qt Print Support Qt 5.0
qtbase Qt Widgets Jan-Arve, Jens http://doc-snapshot.qt.io/5.0/qtwidgets-index.html Qt 5.0
qtbase Qt XML Qt 5.0
qtconnectivity Qt Bluetooth Jerome ABC http://doc-snapshot.qt.io/5.0/qtbluetooth-index.html OK
qtgraphicaleffects Qt Graphical Effects Jerome AD http://doc-snapshot.qt.io/5.0/qtgraphicaleffects-index.html doesn't need example page; no C++ class OK Qt 5.0
qtimageformats Qt Image Formats Qt 5.0
qtlocation Qt Location
qtquick1 Qt Quick 1 Qt 5.0
qtscript Qt Script Qt 5.0
qtsensors Qt Sensors Geir AB
qtsvg Qt SVG Geir Qt 5.0
qtsystems Qt System Info Geir
qttools Qt Designer Qt 5.0
qttools Qt Help Qt 5.0
qttools Qt UI Tools Qt 5.0
qtwayland Qt Wayland Paul
qtxmlpatterns Qt XML Patterns Qt 5.0

Additional Modules

Git repo Module Responsible Status URL Comment qdocconf Release
qtactiveqt Active Qt Leena On hold, as I cannot test this on my Mac Qt 5.0
qtfeedback Qt Feedback
qtjsbackend Qt 5.0
qtjsondb Qt JSON DB
qtlalr Qt QLALR
qtpim Qt Contacts Jerome ACD http://doc-snapshot.qt.io/5.0/qtcontacts-index.html OK
qtpim Qt Organizer Jerome ACD http://doc-snapshot.qt.io/5.0/qtorganizer-index.html OK
qtpim Qt Versit Jerome AC http://doc-snapshot.qt.io/5.0/qtversit-index.html OK
qtqa Qt QA
qtrepotools
qtsystems Qt Publish and Subscribe Geir
qtsystems Qt Service Framework Geir