Fix see also blocks misformatting

qgis · Dec 30, 2022 · f1f7b7a · f1f7b7a
1 parent 995c0d9
commit f1f7b7a
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 14 deletions.
diff --git a/python/core/auto_generated/layertree/qgslayertreenode.sip.in b/python/core/auto_generated/layertree/qgslayertreenode.sip.in
@@ -53,7 +53,11 @@ Custom properties that have already been used within QGIS:
 - "legend/..." - properties for legend appearance customization
 - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state
 
-.. seealso:: :py:func:`also`
+.. seealso:: :py:class:`QgsLayerTree`
+
+.. seealso:: :py:class:`QgsLayerTreeLayer`
+
+.. seealso:: :py:class:`QgsLayerTreeGroup`
 
 .. versionadded:: 2.4
 %End

diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in
@@ -899,7 +899,9 @@ record in the users style table in their personal qgis.db)
 
 :return: a QString with the style file name
 
-.. seealso:: :py:func:`also`
+.. seealso:: :py:func:`loadNamedStyle`
+
+.. seealso:: :py:func:`saveNamedStyle`
 %End
 
     virtual QString loadDefaultStyle( bool &resultFlag /Out/ );
@@ -912,7 +914,7 @@ record in the users style table in their personal qgis.db)
 :return: - a QString with any status messages
          - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to load the default style.
 
-.. seealso:: :py:func:`also`
+.. seealso:: :py:func:`loadNamedStyle`
 %End
 
     virtual QString loadNamedStyle( const QString &uri, bool &resultFlag /Out/, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories );
@@ -931,7 +933,7 @@ record in the users style table in their personal qgis.db)
 :return: - a QString with any status messages
          - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to load the default style.
 
-.. seealso:: :py:func:`also`
+.. seealso:: :py:func:`loadDefaultStyle`
 %End
 
     virtual bool loadNamedStyleFromDatabase( const QString &db, const QString &uri, QString &qml /Out/ );
@@ -1006,6 +1008,8 @@ record in the users style table in their personal qgis.db)
          - resultFlag: a reference to a flag that will be set to ``False`` if we did not manage to save the default style.
 
 .. seealso:: :py:func:`loadNamedStyle`
+
+.. seealso:: :py:func:`saveNamedStyle`
 %End
 
  virtual QString saveDefaultStyle( bool &resultFlag /Out/ ) /Deprecated/;
@@ -1020,6 +1024,8 @@ record in the users style table in their personal qgis.db)
 
 .. seealso:: :py:func:`loadNamedStyle`
 
+.. seealso:: :py:func:`saveNamedStyle`
+
 .. deprecated:: QGIS 3.26
 %End
 

diff --git a/python/gui/auto_generated/qgsdetaileditemdelegate.sip.in b/python/gui/auto_generated/qgsdetaileditemdelegate.sip.in
@@ -15,7 +15,7 @@ class QgsDetailedItemDelegate : QAbstractItemDelegate
 A custom model/view delegate that can display an icon, heading
 and detail sections.
 
-.. seealso:: :py:func:`also`
+.. seealso:: :py:class:`QgsDetailedItemData`
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/qgsdetaileditemwidget.sip.in b/python/gui/auto_generated/qgsdetaileditemwidget.sip.in
@@ -13,7 +13,9 @@ class QgsDetailedItemWidget : QWidget
 %Docstring(signature="appended")
 A widget renderer for detailed item views.
 
-.. seealso:: :py:func:`also`
+.. seealso:: :py:class:`QgsDetailedItem`
+
+.. seealso:: :py:class:`QgsDetailedItemData`
 %End
 
 %TypeHeaderCode

diff --git a/src/core/layertree/qgslayertreenode.h b/src/core/layertree/qgslayertreenode.h
@@ -69,7 +69,9 @@ class QgsMapLayer;
  * - "legend/..." - properties for legend appearance customization
  * - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state
  *
- * \see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup
+ * \see QgsLayerTree
+ * \see QgsLayerTreeLayer
+ * \see QgsLayerTreeGroup
  * \since QGIS 2.4
  */
 class CORE_EXPORT QgsLayerTreeNode : public QObject

diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h
@@ -1025,7 +1025,8 @@ class CORE_EXPORT QgsMapLayer : public QObject
      * (either as a .qml file on disk or as a
      * record in the users style table in their personal qgis.db)
      * \returns a QString with the style file name
-     * \see also loadNamedStyle() and saveNamedStyle();
+     * \see loadNamedStyle()
+     * \see saveNamedStyle()
      */
     virtual QString styleURI() const;
 
@@ -1036,7 +1037,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
      * \param resultFlag a reference to a flag that will be set to FALSE if
      * we did not manage to load the default style.
      * \returns a QString with any status messages
-     * \see also loadNamedStyle();
+     * \see loadNamedStyle()
      */
     virtual QString loadDefaultStyle( bool &resultFlag SIP_OUT );
 
@@ -1053,7 +1054,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
      * we did not manage to load the default style.
      * \param categories the style categories to be loaded.
      * \returns a QString with any status messages
-     * \see also loadDefaultStyle ();
+     * \see loadDefaultStyle()
      */
     virtual QString loadNamedStyle( const QString &uri, bool &resultFlag SIP_OUT, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories );
 
@@ -1116,7 +1117,8 @@ class CORE_EXPORT QgsMapLayer : public QObject
      * we did not manage to save the default style.
      * \param categories the style categories to be saved (since QGIS 3.26)
      * \returns a QString with any status messages
-     * \see loadNamedStyle() and \see saveNamedStyle()
+     * \see loadNamedStyle()
+     * \see saveNamedStyle()
      */
     virtual QString saveDefaultStyle( bool &resultFlag SIP_OUT, StyleCategories categories );
 
@@ -1127,7 +1129,8 @@ class CORE_EXPORT QgsMapLayer : public QObject
      * \param resultFlag a reference to a flag that will be set to FALSE if
      * we did not manage to save the default style.
      * \returns a QString with any status messages
-     * \see loadNamedStyle() and \see saveNamedStyle()
+     * \see loadNamedStyle()
+     * \see saveNamedStyle()
      * \deprecated since QGIS 3.26
      */
     Q_DECL_DEPRECATED virtual QString saveDefaultStyle( bool &resultFlag SIP_OUT ) SIP_DEPRECATED;

diff --git a/src/gui/qgsdetaileditemdelegate.h b/src/gui/qgsdetaileditemdelegate.h
@@ -32,7 +32,7 @@ class QFont;
  * \ingroup gui
  * \brief A custom model/view delegate that can display an icon, heading
  * and detail sections.
- * \see also QgsDetailedItemData
+ * \see QgsDetailedItemData
  */
 class GUI_EXPORT QgsDetailedItemDelegate : public QAbstractItemDelegate
 {

diff --git a/src/gui/qgsdetaileditemwidget.h b/src/gui/qgsdetaileditemwidget.h
@@ -25,7 +25,8 @@
 /**
  * \ingroup gui
  * \brief A widget renderer for detailed item views.
- * \see also QgsDetailedItem and QgsDetailedItemData.
+ * \see QgsDetailedItem
+ * \see QgsDetailedItemData
  */
 class GUI_EXPORT QgsDetailedItemWidget : public QWidget, private Ui::QgsDetailedItemWidgetBase
 {