Skip to content

Commit

Permalink
Documentation++
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Jan 20, 2018
1 parent bfd0f21 commit 2b61591
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
5 changes: 5 additions & 0 deletions python/gui/qgsmapmouseevent.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/gui/qgsmapmouseevent.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down

0 comments on commit 2b61591

Please sign in to comment.