diff options
| author | Anonymous <anon@nokia.com> | 2012-03-22 17:23:21 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-23 02:10:30 +0100 |
| commit | cb33529297cf8017826ae812ab9554a46b669a2c (patch) | |
| tree | 0c86d0612cf2ffd7ceda8a397d43a3a344003f3f /src/imports/location/qdeclarativegeolocation.cpp | |
| parent | 468eb9f211dc3b48588bd905ff281e23424fc3cf (diff) | |
| download | qtlocation-cb33529297cf8017826ae812ab9554a46b669a2c.tar.gz | |
Many documentation improvements
Courtesy of the Caped Crusader:
QDeclarativeGeoAddress
- fixed "brief" description of Address element
- removed reference to "the plugin" from text property description
QDeclarativeBoundingBox
- added description of BoundingBox element
- added example of usage
QDeclarativeBoundingCircle
- added description of BoundingCircle element
- added example of usage
- added note about change signal semantics from center coordinate
QDeclarativeCoordinate
-> NOT DONE: adding "general terminology" (azimuth etc etc)
- added important note about change signal notification semantics (incl. Position-exception)
- added documentation about what constitutes "validity" of lat/long
- added units for the azimuth (degrees, not radians)
- QGeoCoordinatePrivate::atDistanceAndAzimuth() does: double azimuthRad = qgeocoordinate_degToRad(azimuth);
QDeclarativeGeoLocation
- changed "coordinate" property documentation
QDeclarativePosition
- updated description to underline it's temporal nature
- updated property descriptions to underline read-only nature of Position
QDeclarativePositionSource
-> NOT DONE: updating the "active" property documentation to clarify "is/should-be" semantics.
- updated description to avoid implying that you must specify an updateInterval.
- updated description to clarify onPositionChanged is a signal-handler.
- added description of NMEA data
- added note that the "position" property is read-only.
- clarified scope and description of positioning method enum values
- clarified scope of error enum values
- added documentation for onPositionChanged signal handler.
- added documentation for update() regarding timeout value and activation.
Places.qdoc
- shortened a long line, lengthened a short line.
- clarified save/remove documentation
Change-Id: I6793906b7f5ebf7ccc5432d85822506466341057
Reviewed-by: Aaron McCarthy <aaron.mccarthy@nokia.com>
Diffstat (limited to 'src/imports/location/qdeclarativegeolocation.cpp')
| -rw-r--r-- | src/imports/location/qdeclarativegeolocation.cpp | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/imports/location/qdeclarativegeolocation.cpp b/src/imports/location/qdeclarativegeolocation.cpp index 65acfe39..79776434 100644 --- a/src/imports/location/qdeclarativegeolocation.cpp +++ b/src/imports/location/qdeclarativegeolocation.cpp @@ -177,7 +177,7 @@ QDeclarativeGeoAddress *QDeclarativeGeoLocation::address() /*! \qmlproperty Coordinate QtLocation5::Location::coordinate - This property holds display coordinates of the location. + This property holds the exact geographical coordinate of the location. Note: this property's changed() signal is currently emitted only if the whole element changes, not if only the contents of the element change. |