-
User Story
-
Resolution: Unresolved
-
P2: Important
-
None
-
6.9, 6.10
-
framework-content 14, framework-content 15, framework-content 16, framework-content 17
Review and unify the documentation for the Qt Application Examples.
Proposed structure:
Overview
Purpose of example. Which Qt technologies are used? What Qt features are shown?
h3 Launching
Look for template in qtbase -> https://github.com/qt/qtbase/blob/dev/doc/global/includes/examples-run.qdocinc
mention also limitations of target platforms, if there are any.
h3 Walkthrough
UI walkthrough (optional)
h3 <Feature A>
Explain the implementation of the feature in the code.
h3 <Feature B>
...
Furthermore, the example should get appropriate tags.
Note from intranet page, https://qtgroup.atlassian.net/wiki/spaces/QTRD/pages/123814308/Documentation+and+Tools+OKR+s+-+2025+June-Sept#General :
Highlight purpose (best practices and use cases, modules used, target platforms). Link to further documentation where needed.
Also, tags will be added to all examples as part of the bigger tagging initiative.
- mentioned in
-
Page Loading...
1.
|
Revise Car Configurator example |
|
In Progress | Safiyyah Moosa |
2.
|
Revise File System Explorer example |
|
Reported | Qt Documentation Team |
3.
|
Revise Getting Started Programming with Qt Quick example |
|
In Progress | Jaishree Vyas |
4.
|
Revise Media Player example |
|
In Review | Jerome Pasion |
5.
|
Revise Photo Surface example |
|
In Review | Andreas Eliasson |
6.
|
Revise Qt Quick Demo - RESTful API client example |
|
In Progress | Andreas Eliasson |
7.
|
Revise Robot Arm example |
|
In Review | Andreas Eliasson |
8.
|
Revise Same Game example |
|
Reported | Qt Documentation Team |
9.
|
Revise Thermostat example |
|
In Review | Andreas Eliasson |
10.
|
Revise To Do List example |
|
In Review | Andreas Eliasson |
11.
|
Revise WebEngine Quick Nano Browser example |
|
Reported | Qt Documentation Team |
12.
|
Revise Window Embedding example |
|
Reported | Qt Documentation Team |
| For Gerrit Dashboard: QTBUG-136955 | ||||||
|---|---|---|---|---|---|---|
| # | Subject | Branch | Project | Status | CR | V |
| 669378,1 | Doc: Revise Calqlatr example | 6.9 | qt/qtdoc | Status: NEW | 0 | 0 |
| 669524,1 | Doc: Revise coffee machine example | tqtc/lts-6.5 | qt/tqtc-qtdoc | Status: NEW | 0 | 0 |
| 670273,1 | Doc: Revise Satellite Info example | tqtc/lts-6.5 | qt/tqtc-qtpositioning | Status: NEW | 0 | 0 |
| 671156,1 | Doc: Revise Dice example | tqtc/lts-6.5 | qt/tqtc-qtdoc | Status: NEW | 0 | 0 |
| 672738,2 | Doc: Revise To-do list example | dev | qt/qtdoc | Status: NEW | 0 | 0 |
| 672934,1 | Doc: REvise car configurator example | dev | qt/qtdoc | Status: NEW | 0 | 0 |
| 673061,2 | Doc: Update Media Player example documentation | dev | qt/qtdoc | Status: NEW | 0 | 0 |
| 673382,3 | Doc: Revise Photo Surface example | dev | qt/qtdoc | Status: NEW | 0 | 0 |
| 673397,2 | Doc: Revise Thermostat example | dev | qt/qtdoc | Status: NEW | 0 | 0 |
| 673710,2 | Doc: Revise Robot Arm example | dev | qt/qtdoc | Status: NEW | 0 | 0 |