Loading...

XML

Word

Printable

Details

Type: Technical task
Resolution: Done
Priority: P2: Important
Fix Version/s: 5.3.0
Component/s: Documentation
Labels:
None

Description

The list of highlighted examples, shown by default at the top in Qt Creator / Examples, needs to be updated. Each highlighted example should look good, work on all platforms (unless it demonstrates a feature specific to a platform), and have documentation discussing the features used in the example/demo at least in a high level. The screenshot (first image in example docs) should also look good. Draft list of examples to highlight, with actions needed:

Example	Notes	Status
Qt Quick Demo - Calqlatr	Scaling issues on mobile platforms. Add documentation.	Docs added in https://codereview.qt-project.org/84521
Qt Quick Demo - Clocks	Pure QML, cannot be deployed to all platforms as-is. Add documentation.	In Progress. Docs added in: https://codereview.qt-project.org/95299
Qt Quick Demo - Maroon in Trouble	Visual issues on mobile platforms; ~~QTBUG-37742~~. Add documentation.	Docs added in https://codereview.qt-project.org/86451
Qt Quick Demo - Photo Surface	OK. Add documentation.	Docs added in https://codereview.qt-project.org/84869
Qt Quick Demo - Photo Viewer	Fine-tune visuals. Add documentation.	Docs added in: https://codereview.qt-project.org/94662
Qt Quick Demo - RSS News	Redesign UI using Qt Quick Controls + Layouts. Add documentation.	App updated: https://codereview.qt-project.org/87261. Docs added in https://codereview.qt-project.org/88603.
Qt Quick Demo - Same Game	Test on mobile platforms; depends on fixing ~~QTBUG-32195~~ though. Add documentation.	Works on Android with Qt.5.3.1 if the project file is updated with QML import dependency info., which is the enginio plugin in this case. From Qt 5.4, this is not required as androiddeployqt will use qmlimportscanner to detect QML import dependencies for the app. Regarding the documentation of the example, there is a QML tutorial based on the SameGame example so I don't see a need to update it. The example doc itself is very thin but we can add a link to the tutorial in there for those who want to know more about this example.
Qt Quick Demo - StocQt	UI Redesign, Investigate use of Qt Quick Controls, Calendar Control, Crashes on Android. Add documentation.	With the updated code in 5.4 branch, the app works fine on Android. Documentation added in https://codereview.qt-project.org/#/c/93797/.
Qt Quick Demo - Tweet Search	Scaling issues on mobile, fine-tune visuals. Documentation looks pretty good. Check the brief and the overview.	The docs are good enough.
Flickr (Positioning)	Multiple visual issues, no highlight if not fixable. Documentation looks pretty good. Check the brief.	Updated the example to scale the photos based on pixel density of the display. https://codereview.qt-project.org/#/c/95817/
Qt Quick System Dialog Examples	OK (Desktop). Add overview and section headings to documentation.
Qt Quick Examples - Shader Effects	Improve look & feel. Replace text with a Qt logo on white background? Replace inbuilt slider with one from Controls. Add overview and section headings to documentation.	The example does apply the effects on the Qt Logo besides the text, "Qt". Added a patch with the updated \brief in the docs. https://codereview.qt-project.org/#/c/96542/
Qt Quick Examples - Text	OK? Add overview and section headings to documentation.	Documentation looks good.
Qt Quick Examples - Window and Screen	OK? Add overview and section headings to documentation.	Documentation looks good.
Qt Quick Controls - Touch Gallery	Scaling issues on mobile. Add documentation.	Docs added in: https://codereview.qt-project.org/95704
Qt Quick Controls - Gallery	OK? Add documentation.
Qt Quick Controls - Calendar Example	OK? - test on mobile. Add documentation.	Testing on Android and updating documentation - Venu App change: https://codereview.qt-project.org/#/c/89945/ (Integrated) Doc change: https://codereview.qt-project.org/#/c/90496/ (Being reviewed)
Qt Quick Controls - Text Editor Example	OK (Desktop). Add documentation.	Doc change - https://codereview.qt-project.org/#/c/89064/
QML Video Example	Improve visuals. Documentation looks good.
QML Camera Example	Improve visuals? Check the documentation.
QML Video Shader Effects Example	Improve visuals, using Quick Controls? Documentation looks good.	in Progress
Flickr View Example	Drop Highlighting, doesn't work on mobile. Add documentation.	In Progress. This example will not work on Android and iOS as it depends on WebKit, but it works fine on the desktop.
YouTube View Example	Drop Highlighting, doesn't work on mobile. Add section headings to documentation.	In Progress. This example will not work on Android and iOS as it depends on WebKit, but it works fine on the desktop.
Qt Notifier (Android Extras)	Improve looks and the screenshot. Rename? Add documentation.	In Progress. Documentation added in: https://codereview.qt-project.org/96926.
Quick Player (Win Extras)	Rename? Documentation looks good.	In Progress