fix doc warnings

qgis · Dec 16, 2021 · 7f2350f · 7f2350f
1 parent 3449acc
commit 7f2350f
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 33 deletions.
diff --git a/python/core/auto_generated/editform/qgsattributeeditorrelation.sip.in b/python/core/auto_generated/editform/qgsattributeeditorrelation.sip.in
@@ -33,6 +33,7 @@ This element will load a relation editor onto the form.
       ZoomToChildFeature,
       AllButtons
     };
+
     typedef QFlags<QgsAttributeEditorRelation::Button> Buttons;
 
 

diff --git a/python/core/auto_generated/settings/qgssettingsentry.sip.in b/python/core/auto_generated/settings/qgssettingsentry.sip.in
@@ -262,9 +262,6 @@ Get settings default value.
 %End
 
     virtual SettingsType settingsType() const;
-%Docstring
-\copydoc :py:class:`QgsSettingsEntryBase`.settingsType
-%End
 };
 
 
@@ -336,9 +333,6 @@ Get settings default value.
 %End
 
     virtual SettingsType settingsType() const;
-%Docstring
-\copydoc :py:class:`QgsSettingsEntryBase`.settingsType
-%End
 
     void setMinLength( int minLength );
 %Docstring
@@ -435,9 +429,6 @@ Get settings default value.
 %End
 
     virtual SettingsType settingsType() const;
-%Docstring
-\copydoc :py:class:`QgsSettingsEntryBase`.settingsType
-%End
 
 };
 
@@ -510,9 +501,6 @@ Get settings default value.
 %End
 
     virtual SettingsType settingsType() const;
-%Docstring
-\copydoc :py:class:`QgsSettingsEntryBase`.settingsType
-%End
 };
 
 
@@ -585,9 +573,6 @@ Get settings default value.
 %End
 
     virtual SettingsType settingsType() const;
-%Docstring
-\copydoc :py:class:`QgsSettingsEntryBase`.settingsType
-%End
 
     void setMinValue( qlonglong minValue );
 %Docstring
@@ -684,9 +669,6 @@ Get settings default value.
 %End
 
     virtual SettingsType settingsType() const;
-%Docstring
-\copydoc :py:class:`QgsSettingsEntryBase`.settingsType
-%End
 
     void setMinValue( double minValue );
 %Docstring
@@ -803,9 +785,6 @@ The ``dynamicKeyParts`` argument specifies the list of dynamic parts of the sett
 %End
 
     virtual QgsSettingsEntryBase::SettingsType settingsType() const;
-%Docstring
-\copydoc :py:class:`QgsSettingsEntryBase`.settingsType
-%End
 
 };
 
@@ -878,9 +857,6 @@ Get settings default value.
 %End
 
     virtual SettingsType settingsType() const;
-%Docstring
-\copydoc :py:class:`QgsSettingsEntryBase`.settingsType
-%End
 
 };
 

diff --git a/python/gui/auto_generated/mesh/qgsmeshlayerproperties.sip.in b/python/gui/auto_generated/mesh/qgsmeshlayerproperties.sip.in
@@ -29,6 +29,9 @@ Contains information, source and style tabs
 Constructor
 
 :param lyr: Mesh map layer for which properties will be displayed
+:param canvas:
+:param parent:
+:param fl:
 %End
 
     void addPropertiesPageFactory( const QgsMapLayerConfigWidgetFactory *factory );

diff --git a/src/core/editform/qgsattributeeditorrelation.h b/src/core/editform/qgsattributeeditorrelation.h
@@ -39,7 +39,7 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
        * \deprecated since QGIS 3.18 use QgsRelationEditorWidget::Button instead
        * \since QGIS 3.16
        */
-    enum Q_DECL_DEPRECATED Button
+    enum Button
     {
       Link = 1 << 1, //!< Link button
       Unlink = 1 << 2, //!< Unlink button
@@ -50,6 +50,9 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
       ZoomToChildFeature = 1 << 7, //!< Zoom to child feature
       AllButtons = Link | Unlink | SaveChildEdits | AddChildFeature | DuplicateChildFeature | DeleteChildFeature | ZoomToChildFeature //!< All buttons
     };
+    // TODO QGIS 4: remove
+    // this could not be tagged with Q_DECL_DEPRECATED due to Doxygen warning
+
     Q_NOWARN_DEPRECATED_PUSH
     Q_ENUM( Button )
     Q_DECLARE_FLAGS( Buttons, Button )

diff --git a/src/core/settings/qgssettingsentry.h b/src/core/settings/qgssettingsentry.h
@@ -318,7 +318,6 @@ class CORE_EXPORT QgsSettingsEntryVariant : public QgsSettingsEntryBase
      */
     QVariant defaultValue() const;
 
-    //! \copydoc QgsSettingsEntryBase::settingsType
     virtual SettingsType settingsType() const override;
 };
 
@@ -408,7 +407,6 @@ class CORE_EXPORT QgsSettingsEntryString : public QgsSettingsEntryBase
      */
     QString defaultValue() const;
 
-    //! \copydoc QgsSettingsEntryBase::settingsType
     virtual SettingsType settingsType() const override;
 
     /**
@@ -523,7 +521,6 @@ class CORE_EXPORT QgsSettingsEntryStringList : public QgsSettingsEntryBase
      */
     QStringList defaultValue() const;
 
-    //! \copydoc QgsSettingsEntryBase::settingsType
     virtual SettingsType settingsType() const override;
 
 };
@@ -609,7 +606,6 @@ class CORE_EXPORT QgsSettingsEntryBool : public QgsSettingsEntryBase
      */
     bool defaultValue() const;
 
-    //! \copydoc QgsSettingsEntryBase::settingsType
     virtual SettingsType settingsType() const override;
 };
 
@@ -699,7 +695,6 @@ class CORE_EXPORT QgsSettingsEntryInteger : public QgsSettingsEntryBase
      */
     qlonglong defaultValue() const;
 
-    //! \copydoc QgsSettingsEntryBase::settingsType
     virtual SettingsType settingsType() const override;
 
     /**
@@ -821,7 +816,6 @@ class CORE_EXPORT QgsSettingsEntryDouble : public QgsSettingsEntryBase
      */
     double defaultValue() const;
 
-    //! \copydoc QgsSettingsEntryBase::settingsType
     virtual SettingsType settingsType() const override;
 
     /**
@@ -1021,7 +1015,6 @@ class CORE_EXPORT QgsSettingsEntryEnumFlag : public QgsSettingsEntryBase
       }
     }
 
-    //! \copydoc QgsSettingsEntryBase::settingsType
     virtual QgsSettingsEntryBase::SettingsType settingsType() const override
     {
       return QgsSettingsEntryBase::SettingsType::EnumFlag;
@@ -1114,7 +1107,6 @@ class CORE_EXPORT QgsSettingsEntryColor : public QgsSettingsEntryBase
      */
     QColor defaultValue() const;
 
-    //! \copydoc QgsSettingsEntryBase::settingsType
     virtual SettingsType settingsType() const override;
 
 };

diff --git a/src/gui/mesh/qgsmeshlayerproperties.h b/src/gui/mesh/qgsmeshlayerproperties.h
@@ -49,6 +49,9 @@ class GUI_EXPORT QgsMeshLayerProperties : public QgsOptionsDialogBase, private U
     /**
      * \brief Constructor
      * \param lyr Mesh map layer for which properties will be displayed
+     * \param canvas
+     * \param parent
+     * \param fl
      */
     QgsMeshLayerProperties( QgsMapLayer *lyr, QgsMapCanvas *canvas, QWidget *parent = nullptr, Qt::WindowFlags = QgsGuiUtils::ModalDialogFlags );