From 1f27af64a97d4f1cb8248a5918188cb9e480b604 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Wed, 17 Jul 2024 09:02:51 +1000 Subject: [PATCH] Use \see not \sa So that sipify docstring processing works --- .../pointcloud/qgspointclouddataprovider.sip.in | 4 ++-- .../qgsmaptooladvanceddigitizing.sip.in | 12 ++++++++---- .../pointcloud/qgspointclouddataprovider.sip.in | 4 ++-- .../qgsmaptooladvanceddigitizing.sip.in | 12 ++++++++---- src/3d/chunks/qgschunkloader_p.h | 8 ++++---- src/core/pointcloud/qgspointclouddataprovider.h | 4 ++-- src/core/symbology/qgsstyle.h | 6 +++++- src/gui/qgsmaptooladvanceddigitizing.h | 8 ++++---- 8 files changed, 35 insertions(+), 23 deletions(-) diff --git a/python/PyQt6/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in b/python/PyQt6/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in index c3ba0ab60654..c703823c1194 100644 --- a/python/PyQt6/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in +++ b/python/PyQt6/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in @@ -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; @@ -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 diff --git a/python/PyQt6/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in b/python/PyQt6/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in index d1725e465ba5..837d12105e77 100644 --- a/python/PyQt6/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in +++ b/python/PyQt6/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in @@ -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; @@ -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: @@ -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 diff --git a/python/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in b/python/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in index fe9f0fb135d8..796d866ea798 100644 --- a/python/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in +++ b/python/core/auto_generated/pointcloud/qgspointclouddataprovider.sip.in @@ -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; @@ -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 diff --git a/python/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in b/python/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in index d1725e465ba5..837d12105e77 100644 --- a/python/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in +++ b/python/gui/auto_generated/qgsmaptooladvanceddigitizing.sip.in @@ -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; @@ -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: @@ -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 diff --git a/src/3d/chunks/qgschunkloader_p.h b/src/3d/chunks/qgschunkloader_p.h index dfde48c0d0af..02692501739b 100644 --- a/src/3d/chunks/qgschunkloader_p.h +++ b/src/3d/chunks/qgschunkloader_p.h @@ -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; } @@ -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 ); } diff --git a/src/core/pointcloud/qgspointclouddataprovider.h b/src/core/pointcloud/qgspointclouddataprovider.h index 27d8ab8ec47d..686144daccf3 100644 --- a/src/core/pointcloud/qgspointclouddataprovider.h +++ b/src/core/pointcloud/qgspointclouddataprovider.h @@ -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; @@ -145,7 +145,7 @@ class CORE_EXPORT QgsPointCloudDataProvider: public QgsDataProvider * * emits indexGenerationStateChanged() * - * \sa index() + * \see index() */ virtual void generateIndex( ) = 0; diff --git a/src/core/symbology/qgsstyle.h b/src/core/symbology/qgsstyle.h index fe530e76bcac..bc73b14c6626 100644 --- a/src/core/symbology/qgsstyle.h +++ b/src/core/symbology/qgsstyle.h @@ -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 { diff --git a/src/gui/qgsmaptooladvanceddigitizing.h b/src/gui/qgsmaptooladvanceddigitizing.h index 752fb19b8a0a..f20954cf7ed1 100644 --- a/src/gui/qgsmaptooladvanceddigitizing.h +++ b/src/gui/qgsmaptooladvanceddigitizing.h @@ -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; } @@ -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; } @@ -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; }