Skip to content

Commit

Permalink
Merge pull request #58141 from nyalldawson/see
Browse files Browse the repository at this point in the history
Use \see not \sa
  • Loading branch information
troopa81 authored Jul 17, 2024
2 parents 105aabd + 1f27af6 commit 57595b4
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ May return empty collection until :py:func:`~QgsPointCloudDataProvider.pointClou
%Docstring
Triggers loading of the point cloud index

\sa :py:func:`~QgsPointCloudDataProvider.index`
.. seealso:: :py:func:`index`
%End

virtual void generateIndex( ) = 0;
Expand All @@ -112,7 +112,7 @@ Triggers generation of the point cloud index

emits :py:func:`~QgsPointCloudDataProvider.indexGenerationStateChanged`

\sa :py:func:`~QgsPointCloudDataProvider.index`
.. seealso:: :py:func:`index`
%End


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ may keep advanced digitizing allowed all the time.

If ``True`` is returned, that does not mean that advanced digitizing is actually active,
because it is up to the user to enable/disable it when it is allowed.
\sa :py:func:`~QgsMapToolAdvancedDigitizing.setAdvancedDigitizingAllowed`

.. seealso:: :py:func:`setAdvancedDigitizingAllowed`
%End

bool isAutoSnapEnabled() const;
Expand All @@ -99,7 +100,8 @@ Returns whether mouse events (press/move/release) should automatically try to sn
(according to the snapping configuration of map canvas) before passing the mouse coordinates
to the tool. This may be desirable default behavior for some map tools, but not for other map tools.
It is therefore possible to configure the behavior by the map tool.
\sa :py:func:`~QgsMapToolAdvancedDigitizing.isAutoSnapEnabled`

.. seealso:: :py:func:`isAutoSnapEnabled`
%End

protected:
Expand All @@ -108,14 +110,16 @@ It is therefore possible to configure the behavior by the map tool.
%Docstring
Sets whether functionality of advanced digitizing dock widget is currently allowed.
This method is protected because it should be a decision of the map tool and not from elsewhere.
\sa :py:func:`~QgsMapToolAdvancedDigitizing.isAdvancedDigitizingAllowed`

.. seealso:: :py:func:`isAdvancedDigitizingAllowed`
%End

void setAutoSnapEnabled( bool enabled );
%Docstring
Sets whether mouse events (press/move/release) should automatically try to snap mouse position
This method is protected because it should be a decision of the map tool and not from elsewhere.
\sa :py:func:`~QgsMapToolAdvancedDigitizing.isAutoSnapEnabled`

.. seealso:: :py:func:`isAutoSnapEnabled`
%End


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ May return empty collection until :py:func:`~QgsPointCloudDataProvider.pointClou
%Docstring
Triggers loading of the point cloud index

\sa :py:func:`~QgsPointCloudDataProvider.index`
.. seealso:: :py:func:`index`
%End

virtual void generateIndex( ) = 0;
Expand All @@ -112,7 +112,7 @@ Triggers generation of the point cloud index

emits :py:func:`~QgsPointCloudDataProvider.indexGenerationStateChanged`

\sa :py:func:`~QgsPointCloudDataProvider.index`
.. seealso:: :py:func:`index`
%End


Expand Down
12 changes: 8 additions & 4 deletions python/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ may keep advanced digitizing allowed all the time.

If ``True`` is returned, that does not mean that advanced digitizing is actually active,
because it is up to the user to enable/disable it when it is allowed.
\sa :py:func:`~QgsMapToolAdvancedDigitizing.setAdvancedDigitizingAllowed`

.. seealso:: :py:func:`setAdvancedDigitizingAllowed`
%End

bool isAutoSnapEnabled() const;
Expand All @@ -99,7 +100,8 @@ Returns whether mouse events (press/move/release) should automatically try to sn
(according to the snapping configuration of map canvas) before passing the mouse coordinates
to the tool. This may be desirable default behavior for some map tools, but not for other map tools.
It is therefore possible to configure the behavior by the map tool.
\sa :py:func:`~QgsMapToolAdvancedDigitizing.isAutoSnapEnabled`

.. seealso:: :py:func:`isAutoSnapEnabled`
%End

protected:
Expand All @@ -108,14 +110,16 @@ It is therefore possible to configure the behavior by the map tool.
%Docstring
Sets whether functionality of advanced digitizing dock widget is currently allowed.
This method is protected because it should be a decision of the map tool and not from elsewhere.
\sa :py:func:`~QgsMapToolAdvancedDigitizing.isAdvancedDigitizingAllowed`

.. seealso:: :py:func:`isAdvancedDigitizingAllowed`
%End

void setAutoSnapEnabled( bool enabled );
%Docstring
Sets whether mouse events (press/move/release) should automatically try to snap mouse position
This method is protected because it should be a decision of the map tool and not from elsewhere.
\sa :py:func:`~QgsMapToolAdvancedDigitizing.isAutoSnapEnabled`

.. seealso:: :py:func:`isAutoSnapEnabled`
%End


Expand Down
8 changes: 4 additions & 4 deletions src/3d/chunks/qgschunkloader_p.h
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ class QgsChunkLoaderFactory : public QObject
*
* The default implementation returns true. This only needs to be implemented when the factory
* would otherwise need to do blocking network requests in createChildren() to avoid GUI freeze.
* \sa prepareChildren()
* \sa createChildren()
* \see prepareChildren()
* \see createChildren()
*/
virtual bool canCreateChildren( QgsChunkNode *node ) { Q_UNUSED( node ); return true; }

Expand All @@ -98,8 +98,8 @@ class QgsChunkLoaderFactory : public QObject
*
* The default implementation does nothing. This only needs to be implemented when the factory
* would otherwise need to do blocking network requests in createChildren() to avoid GUI freeze.
* \sa canCreateChildren()
* \sa createChildren()
* \see canCreateChildren()
* \see createChildren()
*/
virtual void prepareChildren( QgsChunkNode *node ) { Q_UNUSED( node ); }

Expand Down
4 changes: 2 additions & 2 deletions src/core/pointcloud/qgspointclouddataprovider.h
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ class CORE_EXPORT QgsPointCloudDataProvider: public QgsDataProvider
/**
* Triggers loading of the point cloud index
*
* \sa index()
* \see index()
*/
virtual void loadIndex( ) = 0;

Expand All @@ -145,7 +145,7 @@ class CORE_EXPORT QgsPointCloudDataProvider: public QgsDataProvider
*
* emits indexGenerationStateChanged()
*
* \sa index()
* \see index()
*/
virtual void generateIndex( ) = 0;

Expand Down
6 changes: 5 additions & 1 deletion src/core/symbology/qgsstyle.h
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,11 @@ class CORE_EXPORT QgsStyle : public QObject
*
* The enumerator is used for identifying the entity being operated on when generic
* database functions are being run.
* \sa rename(), remove(), symbolsOfFavorite(), symbolsWithTag(), symbolsOfSmartgroup()
* \see rename()
* \see remove()
* \see symbolsOfFavorite()
* \see symbolsWithTag()
* \see symbolsOfSmartgroup()
*/
enum StyleEntity
{
Expand Down
8 changes: 4 additions & 4 deletions src/gui/qgsmaptooladvanceddigitizing.h
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit
*
* If TRUE is returned, that does not mean that advanced digitizing is actually active,
* because it is up to the user to enable/disable it when it is allowed.
* \sa setAdvancedDigitizingAllowed()
* \see setAdvancedDigitizingAllowed()
*/
bool isAdvancedDigitizingAllowed() const { return mAdvancedDigitizingAllowed; }

Expand All @@ -92,7 +92,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit
* (according to the snapping configuration of map canvas) before passing the mouse coordinates
* to the tool. This may be desirable default behavior for some map tools, but not for other map tools.
* It is therefore possible to configure the behavior by the map tool.
* \sa isAutoSnapEnabled()
* \see isAutoSnapEnabled()
*/
bool isAutoSnapEnabled() const { return mAutoSnapEnabled; }

Expand All @@ -101,14 +101,14 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit
/**
* Sets whether functionality of advanced digitizing dock widget is currently allowed.
* This method is protected because it should be a decision of the map tool and not from elsewhere.
* \sa isAdvancedDigitizingAllowed()
* \see isAdvancedDigitizingAllowed()
*/
void setAdvancedDigitizingAllowed( bool allowed ) { mAdvancedDigitizingAllowed = allowed; }

/**
* Sets whether mouse events (press/move/release) should automatically try to snap mouse position
* This method is protected because it should be a decision of the map tool and not from elsewhere.
* \sa isAutoSnapEnabled()
* \see isAutoSnapEnabled()
*/
void setAutoSnapEnabled( bool enabled ) { mAutoSnapEnabled = enabled; }

Expand Down

0 comments on commit 57595b4

Please sign in to comment.