Details
-
User Story
-
Resolution: Done
-
P2: Important
-
None
-
None
Description
A lot of the QML elements in Location have only quite minimal documentation and the writing style is not always perfect even in the documentation that is there. Which C++ classes should be documented is not 100% clear either, but this needs looking at. Improved and comprehensive documentation with references to examples is necessary before this is really up to scratch for users.
Attachments
Gerrit Reviews
For Gerrit Dashboard: QTBUG-23435 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
12168,3 | Improving documentation for map objects | master | qt/qtlocation | Status: MERGED | +2 | 0 |
12176,2 | Screenshots of Map circles, polygons, polylines and rectangles | master | qt/qtlocation | Status: MERGED | +2 | 0 |
12180,2 | Improving docs for MapQuickItem, adding screenshots | master | qt/qtlocation | Status: MERGED | +2 | 0 |
12213,1 | Improved docs for Map element, and a screenshot | master | qt/qtlocation | Status: MERGED | +2 | 0 |
12215,1 | Fixes for Peter Yard's feedback on gerrit #12168 (docs for map objs) | master | qt/qtlocation | Status: MERGED | +2 | 0 |
12778,1 | Documentation for GeocodeModel and RouteModel | master | qt/qtlocation | Status: MERGED | +2 | 0 |
12874,2 | Reorganise and clean up examples pages and files | master | qt/qtlocation | Status: MERGED | +2 | 0 |