Details
-
User Story
-
Resolution: Unresolved
-
P2: Important
-
None
-
6.9, 6.10
-
framework-content 14
Description
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:
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.
Attachments
Issue Links
- mentioned in
-
Page Loading...