Qt5APIDocumentation: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
h1. Qt 5 API Documentation
h1. Qt 5 API Documentation


Essentially, for each module we need:<br />* '''A''' - landing page (using the command) [[QtLandingPage | see specifications]]<br />* '''B''' - example page<br />* '''C''' - c++ class list (using the command)<br />* '''D''' - qml type list (command)
Essentially, for each module we need:
* '''A''' - landing page (using the command) [[QtLandingPage | see specifications]]
* '''B''' - example page
* '''C''' - c++ class list (using the command)
* '''D''' - qml type list (command)


For example: Qt 3D:<br />* -module name is 'Qt 3D'<br />* -library in the module is 'Qt3D'<br />* -landing page is qt3d-index.html with title 'Qt 3D' (http://doc-snapshot.qt.io/5.0/qt3d-index.html)<br />* -c++ list has title 'Qt 3D C++ Classes'<br />* -qml list has title 'Qt 3D QML Types'<br />* -qt3d-examples.html for the example page
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'.<br />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.
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 =====
===== qdocconf files =====


Each module needs a "qdocconf":http://doc-snapshot.qt.io/qdoc/qdoc-guide-conf.html file to generate a documentation set for each module.<br />Because of the [[Qt_Documentation_Structure | documentation structure]], there is a common qdocconf file and template modules may use.
Each module needs a "qdocconf":http://doc-snapshot.qt.io/qdoc/qdoc-guide-conf.html file to generate a documentation set for each module.
Because of the [[Qt_Documentation_Structure | documentation structure]], there is a common qdocconf file and template modules may use.


* [[Qt5ModuleQDocconf]]
* [[Qt5ModuleQDocconf]]
Line 21: Line 33:
The [[:Category:Developing_Qt::Documentation|Documentation]] page has information about contributing to the documentation.
The [[:Category:Developing_Qt::Documentation|Documentation]] page has information about contributing to the documentation.


=== Essentials<br />{background:#009900}. |''. Git repo |''. Module |''. Responsible |''. Status (A,B,C,D) |''. URL |''. Comment |''. qdocconf |''. Release |<br />| qtbase | Qt Core | Thiago | | http://doc-snapshot.qt.io/5.0/qtcore-index.html | | | Qt 5.0 |<br />| qtbase | Qt GUI | Samuel | ABC | http://doc-snapshot.qt.io/5.0/qtgui-overview.html | | | Qt 5.0 |<br />| qtbase | Qt Network | Jerome | ABCD | http://doc-snapshot.qt.io/5.0/qtnetwork-index.html | | OK | Qt 5.0 |<br />| qtbase | Qt SQL |Jerome | ABCD | http://doc-snapshot.qt.io/5.0/qtsql-index.html | | OK | Qt 5.0 |<br />| qtbase | Qt Test | Leena | AC | | In Gerrit | OK | Qt 5.0 |<br />| 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 |<br />| qtdeclarative | Qt Quick | Jerome | ABCD | http://doc-snapshot.qt.io/5.0/qtquick-index.html | | OK | Qt 5.0 |<br />| qtmultimedia | Qt Multimedia | Venugopal | ABCD | http://doc-snapshot.qt.io/5.0/qtmultimedia-index.html | | OK | Qt 5.0 |<br />| qtwebkit | Qt WebKit | Pierre | | http://doc-snapshot.qt.io/5.0/qtwebkit-module.html | candidate landing page (needs editing) | | Qt 5.0 | ===
=== Essentials
{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)
(the C++ classes or QML type pages should be linked to from the landing pages, if applicable)


=== Qt Add-ons<br />{background:#009900}. |''. Git repo |''. Module |''. Responsible |''. Status (A,B,C,D)|''. URL |''. Comment |''. qdocconf|''. Release |<br />| qt3d | Qt 3D | | AC | http://doc-snapshot.qt.io/5.0/qt3d-index.html | | OK | |<br />| qtbase | Qt Concurrent | Morten? | | | | | Qt 5.0 |<br />| qtbase | Qt D-Bus | Thiago | | | | | Qt 5.0 |<br />| qtbase | Qt OpenGL | | | | | | Qt 5.0 |<br />| qtbase | Qt Print Support | | | | | | Qt 5.0 |<br />| qtbase | Qt Widgets | Jan-Arve, Jens | ABC |http://doc-snapshot.qt.io/5.0/qtwidgets-index.html | | | Qt 5.0 |<br />| qtbase | Qt XML | | | | | | Qt 5.0 |<br />| qtconnectivity| Qt Bluetooth | Jerome | ABC | http://doc-snapshot.qt.io/5.0/qtbluetooth-index.html | | OK | |<br />| 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 |<br />| qtimageformats | Qt Image Formats | | | | | | Qt 5.0 |<br />| qtlocation | Qt Location | | | | | | |<br />| qtquick1 | Qt Quick 1 | | | | | | Qt 5.0 |<br />| qtscript | Qt Script | | | | | | Qt 5.0 |<br />| qtsensors | Qt Sensors | Geir | AB | | | | |<br />| qtsvg | Qt SVG | Geir | | | | | Qt 5.0 |<br />| qtsystems | Qt System Info | Geir | | | | | |<br />| qttools | Qt Designer | | | | | | Qt 5.0 |<br />| qttools | Qt Help | | | | | | Qt 5.0 |<br />| qttools | Qt UI Tools | | | | | | Qt 5.0 |<br />| qtwayland | Qt Wayland | Paul | | | | | |<br />| qtxmlpatterns | Qt XML Patterns| | | | | | Qt 5.0 | ===
=== Qt Add-ons
{background:#009900}. |''. 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 | ABC |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<br />{background:#009900}. |''. Git repo |''. Module |''. Responsible |''. Status |''. URL |''. Comment |''. qdocconf |''. Release |<br />| qtactiveqt | Active Qt | Leena | | | On hold, as I cannot test this on my Mac | | Qt 5.0 |<br />| qtfeedback | Qt Feedback | | | | | | |<br />| qtjsbackend | | | | | | | Qt 5.0 |<br />| qtjsondb | Qt JSON DB | | | | | | |<br />| qtlalr | Qt QLALR | | | | | | |<br />| qtpim | Qt Contacts | Jerome | ACD | http://doc-snapshot.qt.io/5.0/qtcontacts-index.html | | OK | |<br />| qtpim | Qt Organizer | Jerome | ACD |http://doc-snapshot.qt.io/5.0/qtorganizer-index.html | | OK | |<br />| qtpim | Qt Versit | Jerome | AC | http://doc-snapshot.qt.io/5.0/qtversit-index.html | | OK | |<br />| qtqa | Qt QA | | | | | | |<br />| qtrepotools | | | | | | | |<br />| qtsystems | Qt Publish and Subscribe | Geir | | | | | |<br />| qtsystems | Qt Service Framework | Geir | | | | | | ===
=== Additional Modules
{background:#009900}. |''. 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 | | | | | | ===

Revision as of 12:07, 25 February 2015

h1. Qt 5 API Documentation

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":http://doc-snapshot.qt.io/qdoc/qdoc-guide-conf.html 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 {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)

=== Qt Add-ons {background:#009900}. |. 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 | ABC |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 {background:#009900}. |. 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 | | | | | | ===

Retrieved from "https://wiki.qt.io/index.php?title=Qt5APIDocumentation&oldid=7675"