Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Jan 20, 2018
1 parent 5ee4b56 commit 884ccc8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions python/gui/qgsmapmouseevent.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,14 @@ Will only be useful after snapPoint has previously been called.
%Docstring
Returns the matching data from the most recently snapped point.

:return: the snapping data structure

.. versionadded:: 2.14

.. 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
%End

void setMapPoint( const QgsPointXY &point );
Expand Down
4 changes: 2 additions & 2 deletions src/gui/qgsmapmouseevent.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ 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
* \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.
*/
QgsPointLocator::Match mapPointMatch() const { return mSnapMatch; }

Expand Down

0 comments on commit 884ccc8

Please sign in to comment.