Add extra note to position kit's source()

qgis · Dec 10, 2018 · ccb9a61bd9f6bf69d2974ed981765f709314c290 · ccb9a61
1 parent ffded6f
commit ccb9a61bd9f6bf69d2974ed981765f709314c290
Unified Split

Showing with 4 additions and 1 deletion.

+4 −1 src/quickgui/qgsquickpositionkit.h
diff --git a/src/quickgui/qgsquickpositionkit.h b/src/quickgui/qgsquickpositionkit.h
@@ -165,7 +165,10 @@ class QUICK_EXPORT QgsQuickPositionKit : public QObject
     //! \copydoc QgsQuickPositionKit::simulatePositionLongLatRad
     void setSimulatePositionLongLatRad( const QVector<double> &simulatePositionLongLatRad );
 
-    //! Returns pointer to the internal QGeoPositionInfoSource object used to receive GPS location.
+    /**
+     * Returns pointer to the internal QGeoPositionInfoSource object used to receive GPS location.
+     * \note The returned pointer is only valid until sourceChanged() signal is emitted
+     */
     QGeoPositionInfoSource *source() const;
 
     /**