Drop some more no value documentation

2025-10-05 00:09:32 -04:00 · 2024-07-23 15:02:57 +10:00 · 2024-07-23 15:02:57 +10:00 · 6d829ff7b4
commit 6d829ff7b4
parent 04251e396c
42 changed files with 12 additions and 133 deletions
--- a/python/PyQt6/core/auto_generated/auth/qgsauthconfig.sip.in
+++ b/python/PyQt6/core/auto_generated/auth/qgsauthconfig.sip.in
@ -33,7 +33,6 @@ Construct a configuration for an authentication method


    bool operator==( const QgsAuthMethodConfig &other ) const;
-
    bool operator!=( const QgsAuthMethodConfig &other ) const;

    const QString id() const;
--- a/python/PyQt6/core/auto_generated/mesh/qgsmesh3daveraging.sip.in
+++ b/python/PyQt6/core/auto_generated/mesh/qgsmesh3daveraging.sip.in
@ -343,9 +343,6 @@ The elevation will be truncated at the surface and bed levels.
  public:

    QgsMeshElevationAveragingMethod();
-%Docstring
-Ctor
-%End

    QgsMeshElevationAveragingMethod( double startElevation, double endElevation );
 %Docstring
--- a/python/PyQt6/core/auto_generated/mesh/qgsmeshdataset.sip.in
+++ b/python/PyQt6/core/auto_generated/mesh/qgsmeshdataset.sip.in
@ -47,6 +47,7 @@ Returns a dataset index within :py:func:`~QgsMeshDatasetIndex.group`
 %Docstring
 Returns whether index is valid, ie at least groups is set
 %End
+
    bool operator == ( QgsMeshDatasetIndex other ) const;
    bool operator != ( QgsMeshDatasetIndex other ) const;
 };
--- a/python/PyQt6/core/auto_generated/pointcloud/qgspointcloudattribute.sip.in
+++ b/python/PyQt6/core/auto_generated/pointcloud/qgspointcloudattribute.sip.in
@ -40,9 +40,6 @@ pair of name and size in bytes
    };

    QgsPointCloudAttribute();
-%Docstring
-Ctor
-%End
    QgsPointCloudAttribute( const QString &name, DataType type );
 %Docstring
 Ctor
@ -110,10 +107,8 @@ Collection of point cloud attributes
 #include "qgspointcloudattribute.h"
 %End
  public:
+
    QgsPointCloudAttributeCollection();
-%Docstring
-Ctor
-%End
    QgsPointCloudAttributeCollection( const QVector<QgsPointCloudAttribute> &attributes );
 %Docstring
 Ctor with given attributes
--- a/python/PyQt6/core/auto_generated/pointcloud/qgspointcloudblock.sip.in
+++ b/python/PyQt6/core/auto_generated/pointcloud/qgspointcloudblock.sip.in
@ -32,6 +32,7 @@ Base class for storing raw data from point cloud nodes
 %Docstring
 Ctor
 %End
+
    virtual ~QgsPointCloudBlock();

    QgsPointCloudBlock *clone() const /Factory/;
--- a/python/PyQt6/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in
+++ b/python/PyQt6/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in
@ -598,7 +598,6 @@ pieces of information about CRS.
 %End

    bool operator==( const QgsCoordinateReferenceSystem &srs ) const;
-
    bool operator!=( const QgsCoordinateReferenceSystem &srs ) const;

    bool readXml( const QDomNode &node );
--- a/python/PyQt6/core/auto_generated/project/qgsprojectversion.sip.in
+++ b/python/PyQt6/core/auto_generated/project/qgsprojectversion.sip.in
@ -64,15 +64,10 @@ Returns ``True`` if this is a NULL project version.
 %End

    bool operator==( const QgsProjectVersion &other ) const;
-
    bool operator!=( const QgsProjectVersion &other ) const;
-
    bool operator>=( const QgsProjectVersion &other ) const;
-
    bool operator>( const QgsProjectVersion &other ) const;
-
    bool operator<( const QgsProjectVersion &other ) const;
-
    bool operator<=( const QgsProjectVersion &other ) const;

 };
--- a/python/PyQt6/core/auto_generated/qgssimplifymethod.sip.in
+++ b/python/PyQt6/core/auto_generated/qgssimplifymethod.sip.in
@ -73,7 +73,6 @@ Creates a geometry simplifier according to specified method
 %End

    bool operator==( const QgsSimplifyMethod &v ) const;
-
    bool operator!=( const QgsSimplifyMethod &v ) const;

  protected:
--- a/python/PyQt6/core/auto_generated/raster/qgsrasterminmaxorigin.sip.in
+++ b/python/PyQt6/core/auto_generated/raster/qgsrasterminmaxorigin.sip.in
@ -56,9 +56,6 @@ itself the min/max values.
    };

    QgsRasterMinMaxOrigin();
-%Docstring
-Default constructor.
-%End

    bool operator ==( const QgsRasterMinMaxOrigin &other ) const;

--- a/python/core/auto_generated/auth/qgsauthconfig.sip.in
+++ b/python/core/auto_generated/auth/qgsauthconfig.sip.in
@ -33,7 +33,6 @@ Construct a configuration for an authentication method


    bool operator==( const QgsAuthMethodConfig &other ) const;
-
    bool operator!=( const QgsAuthMethodConfig &other ) const;

    const QString id() const;
--- a/python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in
+++ b/python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in
@ -343,9 +343,6 @@ The elevation will be truncated at the surface and bed levels.
  public:

    QgsMeshElevationAveragingMethod();
-%Docstring
-Ctor
-%End

    QgsMeshElevationAveragingMethod( double startElevation, double endElevation );
 %Docstring
--- a/python/core/auto_generated/mesh/qgsmeshdataset.sip.in
+++ b/python/core/auto_generated/mesh/qgsmeshdataset.sip.in
@ -47,6 +47,7 @@ Returns a dataset index within :py:func:`~QgsMeshDatasetIndex.group`
 %Docstring
 Returns whether index is valid, ie at least groups is set
 %End
+
    bool operator == ( QgsMeshDatasetIndex other ) const;
    bool operator != ( QgsMeshDatasetIndex other ) const;
 };
--- a/python/core/auto_generated/pointcloud/qgspointcloudattribute.sip.in
+++ b/python/core/auto_generated/pointcloud/qgspointcloudattribute.sip.in
@ -40,9 +40,6 @@ pair of name and size in bytes
    };

    QgsPointCloudAttribute();
-%Docstring
-Ctor
-%End
    QgsPointCloudAttribute( const QString &name, DataType type );
 %Docstring
 Ctor
@ -110,10 +107,8 @@ Collection of point cloud attributes
 #include "qgspointcloudattribute.h"
 %End
  public:
+
    QgsPointCloudAttributeCollection();
-%Docstring
-Ctor
-%End
    QgsPointCloudAttributeCollection( const QVector<QgsPointCloudAttribute> &attributes );
 %Docstring
 Ctor with given attributes
--- a/python/core/auto_generated/pointcloud/qgspointcloudblock.sip.in
+++ b/python/core/auto_generated/pointcloud/qgspointcloudblock.sip.in
@ -32,6 +32,7 @@ Base class for storing raw data from point cloud nodes
 %Docstring
 Ctor
 %End
+
    virtual ~QgsPointCloudBlock();

    QgsPointCloudBlock *clone() const /Factory/;
--- a/python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in
+++ b/python/core/auto_generated/proj/qgscoordinatereferencesystem.sip.in
@ -598,7 +598,6 @@ pieces of information about CRS.
 %End

    bool operator==( const QgsCoordinateReferenceSystem &srs ) const;
-
    bool operator!=( const QgsCoordinateReferenceSystem &srs ) const;

    bool readXml( const QDomNode &node );
--- a/python/core/auto_generated/project/qgsprojectversion.sip.in
+++ b/python/core/auto_generated/project/qgsprojectversion.sip.in
@ -64,15 +64,10 @@ Returns ``True`` if this is a NULL project version.
 %End

    bool operator==( const QgsProjectVersion &other ) const;
-
    bool operator!=( const QgsProjectVersion &other ) const;
-
    bool operator>=( const QgsProjectVersion &other ) const;
-
    bool operator>( const QgsProjectVersion &other ) const;
-
    bool operator<( const QgsProjectVersion &other ) const;
-
    bool operator<=( const QgsProjectVersion &other ) const;

 };
--- a/python/core/auto_generated/qgssimplifymethod.sip.in
+++ b/python/core/auto_generated/qgssimplifymethod.sip.in
@ -73,7 +73,6 @@ Creates a geometry simplifier according to specified method
 %End

    bool operator==( const QgsSimplifyMethod &v ) const;
-
    bool operator!=( const QgsSimplifyMethod &v ) const;

  protected:
--- a/python/core/auto_generated/raster/qgsrasterminmaxorigin.sip.in
+++ b/python/core/auto_generated/raster/qgsrasterminmaxorigin.sip.in
@ -56,9 +56,6 @@ itself the min/max values.
    };

    QgsRasterMinMaxOrigin();
-%Docstring
-Default constructor.
-%End

    bool operator ==( const QgsRasterMinMaxOrigin &other ) const;

--- a/src/3d/qgs3danimationsettings.h
+++ b/src/3d/qgs3danimationsettings.h
@ -38,7 +38,7 @@ class QgsReadWriteContext;
 class _3D_EXPORT Qgs3DAnimationSettings
 {
  public:
-    //! ctor
+
    Qgs3DAnimationSettings();

    //! keyframe definition
--- a/src/3d/qgs3daxissettings.h
+++ b/src/3d/qgs3daxissettings.h
@ -48,10 +48,7 @@ class _3D_EXPORT Qgs3DAxisSettings

    Qgs3DAxisSettings() = default;

-    //! Returns true if both objects are equal
    bool operator==( Qgs3DAxisSettings const &rhs ) const;
-
-    //! Returns true if objects are not equal
    bool operator!=( Qgs3DAxisSettings const &rhs ) const;

    //! Reads settings from a DOM \a element
--- a/src/core/actions/qgsactionscope.h
+++ b/src/core/actions/qgsactionscope.h
@ -65,9 +65,6 @@ class CORE_EXPORT QgsActionScope
     */
    explicit QgsActionScope( const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope = QgsExpressionContextScope() );

-    /**
-     * Compares two action scopes
-     */
    bool operator==( const QgsActionScope &other ) const;

    /**
--- a/src/core/auth/qgsauthconfig.h
+++ b/src/core/auth/qgsauthconfig.h
@ -51,10 +51,7 @@ class CORE_EXPORT QgsAuthMethodConfig

    // TODO c++20 - replace with = default

-    //! Operator used to compare configs' equality
    bool operator==( const QgsAuthMethodConfig &other ) const;
-
-    //! Operator used to compare configs' inequality
    bool operator!=( const QgsAuthMethodConfig &other ) const;

    /**
--- a/src/core/elevation/qgsprofilerequest.h
+++ b/src/core/elevation/qgsprofilerequest.h
@ -51,9 +51,6 @@ class CORE_EXPORT QgsProfileRequest

    ~QgsProfileRequest();

-    /**
-     * Assignment operator
-     */
    QgsProfileRequest &operator=( const QgsProfileRequest &other );

    bool operator==( const QgsProfileRequest &other ) const;
--- a/src/core/geometry/qgslinesegment.h
+++ b/src/core/geometry/qgslinesegment.h
@ -220,13 +220,11 @@ class CORE_EXPORT QgsLineSegment2D

    // TODO c++20 - replace with = default

-    //! Equality operator
    bool operator==( const QgsLineSegment2D &other ) const SIP_HOLDGIL
    {
      return mStart == other.mStart && mEnd == other.mEnd;
    }

-    //! Inequality operator
    bool operator!=( const QgsLineSegment2D &other ) const SIP_HOLDGIL
    {
      return mStart != other.mStart || mEnd != other.mEnd;
--- a/src/core/geometry/qgsrectangle.h
+++ b/src/core/geometry/qgsrectangle.h
@ -540,10 +540,6 @@ class CORE_EXPORT QgsRectangle
     */
    QString asPolygon() const;

-    /**
-     * Comparison operator
-     * \returns TRUE if rectangles are equal
-     */
    bool operator==( const QgsRectangle &r1 ) const
    {
      if ( isNull() ) return r1.isNull();
@ -554,19 +550,11 @@ class CORE_EXPORT QgsRectangle
             qgsDoubleNear( r1.yMinimum(), yMinimum() );
    }

-    /**
-     * Comparison operator
-     * \returns FALSE if rectangles are equal
-     */
    bool operator!=( const QgsRectangle &r1 ) const
    {
      return ( ! operator==( r1 ) );
    }

-    /**
-     * Assignment operator
-     * \param r1 QgsRectangle to assign from
-     */
    QgsRectangle &operator=( const QgsRectangle &r1 )
    {
      if ( &r1 != this )
--- a/src/core/mesh/qgsmesh3daveraging.h
+++ b/src/core/mesh/qgsmesh3daveraging.h
@ -368,7 +368,6 @@ class CORE_EXPORT QgsMeshElevationAveragingMethod: public QgsMesh3DAveragingMeth
 {
  public:

-    //! Ctor
    QgsMeshElevationAveragingMethod();

    /**
--- a/src/core/mesh/qgsmeshdataset.h
+++ b/src/core/mesh/qgsmeshdataset.h
@ -60,9 +60,8 @@ class CORE_EXPORT QgsMeshDatasetIndex
    int dataset() const;
    //! Returns whether index is valid, ie at least groups is set
    bool isValid() const;
-    //! Equality operator
+
    bool operator == ( QgsMeshDatasetIndex other ) const;
-    //! Inequality operator
    bool operator != ( QgsMeshDatasetIndex other ) const;
  private:
    int mGroupIndex = -1;
--- a/src/core/mesh/qgsmeshtracerenderer.h
+++ b/src/core/mesh/qgsmeshtracerenderer.h
@ -650,7 +650,6 @@ class CORE_EXPORT QgsMeshVectorTraceAnimationGenerator
    //! Sets the visual persistence of the tail
    void setTailPersitence( double p );

-    //! Assignment operator
    QgsMeshVectorTraceAnimationGenerator &operator=( const QgsMeshVectorTraceAnimationGenerator &other );

  private:
--- a/src/core/mesh/qgstriangularmesh.h
+++ b/src/core/mesh/qgstriangularmesh.h
@ -51,9 +51,8 @@ class QgsRectangle;
 class CORE_EXPORT QgsTriangularMesh // TODO rename to QgsRendererMesh in QGIS 4
 {
  public:
-    //! Ctor
+
    QgsTriangularMesh();
-    //! Dtor
    ~QgsTriangularMesh();

    /**
--- a/src/core/pointcloud/qgspointcloudattribute.h
+++ b/src/core/pointcloud/qgspointcloudattribute.h
@ -55,7 +55,6 @@ class CORE_EXPORT QgsPointCloudAttribute
      Double, //!< Double 8 bytes
    };

-    //! Ctor
    QgsPointCloudAttribute();
    //! Ctor
    QgsPointCloudAttribute( const QString &name, DataType type );
@ -141,7 +140,7 @@ class CORE_EXPORT QgsPointCloudAttribute
 class CORE_EXPORT QgsPointCloudAttributeCollection
 {
  public:
-    //! Ctor
+
    QgsPointCloudAttributeCollection();
    //! Ctor with given attributes
    QgsPointCloudAttributeCollection( const QVector<QgsPointCloudAttribute> &attributes );
--- a/src/core/pointcloud/qgspointcloudblock.h
+++ b/src/core/pointcloud/qgspointcloudblock.h
@ -42,7 +42,7 @@ class CORE_EXPORT QgsPointCloudBlock
    QgsPointCloudBlock( int count,
                        const QgsPointCloudAttributeCollection &attributes,
                        const QByteArray &data, const QgsVector3D &scale, const QgsVector3D &offset );
-    //! Dtor
+
    virtual ~QgsPointCloudBlock() = default;

    /**
--- a/src/core/pointcloud/qgspointcloudindex.h
+++ b/src/core/pointcloud/qgspointcloudindex.h
@ -68,7 +68,6 @@ class CORE_EXPORT IndexedPointCloudNode

    // TODO c++20 - replace with = default

-    //! Compares nodes
    bool operator==( IndexedPointCloudNode other ) const
    {
      return mD == other.d() && mX == other.x() && mY == other.y() && mZ == other.z();
@ -122,7 +121,6 @@ class CORE_EXPORT QgsPointCloudCacheKey
    //! Ctor
    QgsPointCloudCacheKey( const IndexedPointCloudNode &n, const QgsPointCloudRequest &request, const QgsPointCloudExpression &expression, const QString &uri );

-    //! Compares keys
    bool operator==( const QgsPointCloudCacheKey &other ) const;

    //! Returns the key's IndexedPointCloudNode
--- a/src/core/pointcloud/qgspointcloudrequest.h
+++ b/src/core/pointcloud/qgspointcloudrequest.h
@ -41,10 +41,9 @@
 class CORE_EXPORT QgsPointCloudRequest
 {
  public:
-    //! Ctor
+
    QgsPointCloudRequest();

-    //! Equality operator
    bool operator==( const QgsPointCloudRequest &other ) const;

    //! Returns attributes
--- a/src/core/proj/qgscoordinatereferencesystem.h
+++ b/src/core/proj/qgscoordinatereferencesystem.h
@ -549,18 +549,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
     */
    Q_DECL_DEPRECATED long findMatchingProj() SIP_DEPRECATED;

-    /**
-     * Overloaded == operator used to compare to CRS's.
-     *
-     *  Internally it will use authid() for comparison.
-     */
    bool operator==( const QgsCoordinateReferenceSystem &srs ) const;
-
-    /**
-     * Overloaded != operator used to compare to CRS's.
-     *
-     *  Returns opposite bool value to operator ==
-     */
    bool operator!=( const QgsCoordinateReferenceSystem &srs ) const;

    /**
--- a/src/core/project/qgsprojectversion.h
+++ b/src/core/project/qgsprojectversion.h
@ -74,34 +74,11 @@ class CORE_EXPORT QgsProjectVersion
     */
    bool isNull() const;

-    /**
-     * Boolean equal operator
-     */
    bool operator==( const QgsProjectVersion &other ) const;
-
-    /**
-     * Boolean not equal operator
-     */
    bool operator!=( const QgsProjectVersion &other ) const;
-
-    /**
-     * Boolean >= operator
-     */
    bool operator>=( const QgsProjectVersion &other ) const;
-
-    /**
-     * Boolean > operator
-     */
    bool operator>( const QgsProjectVersion &other ) const;
-
-    /**
-     * Boolean < operator
-     */
    bool operator<( const QgsProjectVersion &other ) const;
-
-    /**
-     * Boolean <= operator
-     */
    bool operator<=( const QgsProjectVersion &other ) const;

  private:
--- a/src/core/qgsattributetableconfig.h
+++ b/src/core/qgsattributetableconfig.h
@ -311,9 +311,6 @@ class CORE_EXPORT QgsAttributeTableConfig
     */
    bool hasSameColumns( const QgsAttributeTableConfig &other ) const;

-    /**
-     * Compare this configuration to other.
-     */
    bool operator!= ( const QgsAttributeTableConfig &other ) const;

  private:
--- a/src/core/qgsmaplayerdependency.h
+++ b/src/core/qgsmaplayerdependency.h
@ -68,7 +68,6 @@ class CORE_EXPORT QgsMapLayerDependency

    // TODO c++20 - replace with = default

-    //! Comparison operator
    bool operator==( const QgsMapLayerDependency &other ) const
    {
      return layerId() == other.layerId() && origin() == other.origin() && type() == other.type();
--- a/src/core/qgssimplifymethod.h
+++ b/src/core/qgssimplifymethod.h
@ -60,10 +60,7 @@ class CORE_EXPORT QgsSimplifyMethod
    //! Creates a geometry simplifier according to specified method
    static QgsAbstractGeometrySimplifier *createGeometrySimplifier( const QgsSimplifyMethod &simplifyMethod );

-    //! Equality operator
    bool operator==( const QgsSimplifyMethod &v ) const;
-
-    //! Inequality operator
    bool operator!=( const QgsSimplifyMethod &v ) const;

  protected:
--- a/src/core/qgssnappingconfig.h
+++ b/src/core/qgssnappingconfig.h
@ -204,9 +204,6 @@ class CORE_EXPORT QgsSnappingConfig
         */
        void setMaximumScale( double maxScale );

-        /**
-         * Compare this configuration to other.
-         */
        bool operator!= ( const QgsSnappingConfig::IndividualLayerSettings &other ) const;

        // TODO c++20 - replace with = default
@ -395,9 +392,6 @@ class CORE_EXPORT QgsSnappingConfig
     */
    void clearIndividualLayerSettings();

-    /**
-     * Compare this configuration to other.
-     */
    bool operator!= ( const QgsSnappingConfig &other ) const;

    /**
--- a/src/core/qgsvector.h
+++ b/src/core/qgsvector.h
@ -203,13 +203,11 @@ class CORE_EXPORT QgsVector
     */
    QgsVector normalized() const SIP_THROW( QgsException );

-    //! Equality operator
    bool operator==( QgsVector other ) const SIP_HOLDGIL
    {
      return qgsDoubleNear( mX, other.mX ) && qgsDoubleNear( mY, other.mY );
    }

-    //! Inequality operator
    bool operator!=( QgsVector other ) const
    {
      return !qgsDoubleNear( mX, other.mX ) || !qgsDoubleNear( mY, other.mY );
--- a/src/core/raster/qgsrasterminmaxorigin.h
+++ b/src/core/raster/qgsrasterminmaxorigin.h
@ -83,10 +83,8 @@ class CORE_EXPORT QgsRasterMinMaxOrigin
      Estimated
    };

-    //! \brief Default constructor.
    QgsRasterMinMaxOrigin();

-    //! \brief Equality operator.
    bool operator ==( const QgsRasterMinMaxOrigin &other ) const;

    //////// Getter methods /////////////////////
--- a/src/core/symbology/qgssymbollayerreference.h
+++ b/src/core/symbology/qgssymbollayerreference.h
@ -88,7 +88,6 @@ class CORE_EXPORT QgsSymbolLayerId

    // TODO c++20 - replace with = default

-    //! Equality operator
    bool operator==( const QgsSymbolLayerId &other ) const
    {
      return ( mSymbolKey == other.mSymbolKey && mIndexPath == other.mIndexPath );
@ -174,7 +173,6 @@ class CORE_EXPORT QgsSymbolLayerReference
     */
    QString symbolLayerIdV2() const { return mSymbolLayerId; }

-    //! Comparison operator
    bool operator==( const QgsSymbolLayerReference &other ) const
    {
      return mLayerId == other.mLayerId