Documentation++

qgis · Jan 20, 2018 · 2b61591 · 2b61591
1 parent bfd0f21
commit 2b61591
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/python/gui/qgsmapmouseevent.sip.in b/python/gui/qgsmapmouseevent.sip.in
@@ -79,6 +79,11 @@ Will only be useful after snapPoint has previously been called.
 %Docstring
 Returns the matching data from the most recently snapped point.
 
+.. note::
+
+   This method returns the most recent snap match. It must
+   follow a call to snapPoint() in order to have a recent snap result available.
+
 :return: the snapping data structure
 
 .. versionadded:: 2.14

diff --git a/src/gui/qgsmapmouseevent.h b/src/gui/qgsmapmouseevent.h
@@ -89,6 +89,8 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent
 
     /**
       * Returns the matching data from the most recently snapped point.
+      * \note This method returns the most recent snap match. It must
+      * follow a call to snapPoint() in order to have a recent snap result available.
       * \returns the snapping data structure
       * \since QGIS 2.14
       */