doc(Deprecated): Fix missing \deprecated instruction

qgis · Dec 11, 2024 · 0e804d1 · 0e804d1
1 parent 6502e28
commit 0e804d1
Show file tree

Hide file tree

Showing 18 changed files with 84 additions and 6 deletions.
diff --git a/python/PyQt6/core/auto_generated/browser/qgsdirectoryitem.sip.in b/python/PyQt6/core/auto_generated/browser/qgsdirectoryitem.sip.in
@@ -109,6 +109,10 @@ If ``color`` is an invalid color then the default icon color will be used.
 
  virtual QWidget *paramWidget() /Factory,Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.20
+%End
     virtual bool hasDragEnabled() const;
     virtual QgsMimeDataUtils::UriList mimeUris() const;
 
@@ -217,8 +221,6 @@ Browser parameter widget implementation for directory items.
 
 
 
-
-
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *

diff --git a/python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in b/python/PyQt6/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -165,6 +165,8 @@ Sets the underlying geometry store. Ownership of geometry is transferred.
 .. seealso:: :py:func:`get`
 
 .. seealso:: :py:func:`constGet`
+
+.. deprecated:: 3.0
 %End
 
     bool isNull() const /HoldGIL/;

diff --git a/python/PyQt6/core/auto_generated/layout/qgslayoutitemmap.sip.in b/python/PyQt6/core/auto_generated/layout/qgslayoutitemmap.sip.in
@@ -361,8 +361,14 @@ The caller takes responsibility for deleting the returned object.
 
     virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget );
 
+
  virtual int numberExportLayers() const /Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.10
+%End
+
     virtual void startLayeredExport();
 
     virtual void stopLayeredExport();

diff --git a/python/PyQt6/core/auto_generated/raster/qgsbilinearrasterresampler.sip.in b/python/PyQt6/core/auto_generated/raster/qgsbilinearrasterresampler.sip.in
@@ -23,8 +23,15 @@ Bilinear Raster Resampler
   public:
 
     QgsBilinearRasterResampler();
+
  virtual void resample( const QImage &srcImage, QImage &dstImage ) /Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.12
+
+   Use :py:func:`~QgsBilinearRasterResampler.resampleV2` instead.
+%End
 
     virtual QImage resampleV2( const QImage &source, const QSize &size );
 

diff --git a/python/PyQt6/core/auto_generated/raster/qgscubicrasterresampler.sip.in b/python/PyQt6/core/auto_generated/raster/qgscubicrasterresampler.sip.in
@@ -27,8 +27,15 @@ Cubic Raster Resampler.
 
     virtual QImage resampleV2( const QImage &source, const QSize &size );
 
+
  virtual void resample( const QImage &srcImage, QImage &dstImage ) /Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.12
+
+   Use :py:func:`~QgsCubicRasterResampler.resampleV2` instead.
+%End
     virtual QString type() const;
 
     virtual int tileBufferPixels() const;

diff --git a/python/PyQt6/core/auto_generated/scalebar/qgsnumericscalebarrenderer.sip.in b/python/PyQt6/core/auto_generated/scalebar/qgsnumericscalebarrenderer.sip.in
@@ -42,6 +42,12 @@ A scale bar style that draws text in the form of '1:XXXXX'.
 
  virtual QSizeF calculateBoxSize( const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const /Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.14
+
+   Use the one with render context instead.
+%End
 
 };
 

diff --git a/python/core/auto_generated/browser/qgsdirectoryitem.sip.in b/python/core/auto_generated/browser/qgsdirectoryitem.sip.in
@@ -109,6 +109,10 @@ If ``color`` is an invalid color then the default icon color will be used.
 
  virtual QWidget *paramWidget() /Factory,Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.20
+%End
     virtual bool hasDragEnabled() const;
     virtual QgsMimeDataUtils::UriList mimeUris() const;
 
@@ -217,8 +221,6 @@ Browser parameter widget implementation for directory items.
 
 
 
-
-
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *

diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -165,6 +165,8 @@ Sets the underlying geometry store. Ownership of geometry is transferred.
 .. seealso:: :py:func:`get`
 
 .. seealso:: :py:func:`constGet`
+
+.. deprecated:: 3.0
 %End
 
     bool isNull() const /HoldGIL/;

diff --git a/python/core/auto_generated/layout/qgslayoutitemmap.sip.in b/python/core/auto_generated/layout/qgslayoutitemmap.sip.in
@@ -361,8 +361,14 @@ The caller takes responsibility for deleting the returned object.
 
     virtual void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget );
 
+
  virtual int numberExportLayers() const /Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.10
+%End
+
     virtual void startLayeredExport();
 
     virtual void stopLayeredExport();

diff --git a/python/core/auto_generated/raster/qgsbilinearrasterresampler.sip.in b/python/core/auto_generated/raster/qgsbilinearrasterresampler.sip.in
@@ -23,8 +23,15 @@ Bilinear Raster Resampler
   public:
 
     QgsBilinearRasterResampler();
+
  virtual void resample( const QImage &srcImage, QImage &dstImage ) /Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.12
+
+   Use :py:func:`~QgsBilinearRasterResampler.resampleV2` instead.
+%End
 
     virtual QImage resampleV2( const QImage &source, const QSize &size );
 

diff --git a/python/core/auto_generated/raster/qgscubicrasterresampler.sip.in b/python/core/auto_generated/raster/qgscubicrasterresampler.sip.in
@@ -27,8 +27,15 @@ Cubic Raster Resampler.
 
     virtual QImage resampleV2( const QImage &source, const QSize &size );
 
+
  virtual void resample( const QImage &srcImage, QImage &dstImage ) /Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.12
+
+   Use :py:func:`~QgsCubicRasterResampler.resampleV2` instead.
+%End
     virtual QString type() const;
 
     virtual int tileBufferPixels() const;

diff --git a/python/core/auto_generated/scalebar/qgsnumericscalebarrenderer.sip.in b/python/core/auto_generated/scalebar/qgsnumericscalebarrenderer.sip.in
@@ -42,6 +42,12 @@ A scale bar style that draws text in the form of '1:XXXXX'.
 
  virtual QSizeF calculateBoxSize( const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const /Deprecated/;
 
+%Docstring
+
+.. deprecated:: 3.14
+
+   Use the one with render context instead.
+%End
 
 };
 

diff --git a/src/core/browser/qgsdirectoryitem.h b/src/core/browser/qgsdirectoryitem.h
@@ -120,6 +120,9 @@ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem
      */
     static void setCustomColor( const QString &directory, const QColor &color );
 
+    /**
+     * \deprecated QGIS 3.20
+     */
     Q_DECL_DEPRECATED QWidget *paramWidget() override SIP_FACTORY SIP_DEPRECATED;
     bool hasDragEnabled() const override { return true; }
     QgsMimeDataUtils::UriList mimeUris() const override;
@@ -273,5 +276,3 @@ class CORE_EXPORT QgsProjectHomeItem : public QgsDirectoryItem
 #endif
 
 #endif // QGSDATAITEM_H
-
-
diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -227,6 +227,7 @@ class CORE_EXPORT QgsGeometry
      *
      * \see get()
      * \see constGet()
+     * \deprecated QGIS 3.0
      */
     void set( QgsAbstractGeometry *geometry SIP_TRANSFER ) SIP_DEPRECATED;
 

diff --git a/src/core/layout/qgslayoutitemmap.h b/src/core/layout/qgslayoutitemmap.h
@@ -396,7 +396,12 @@ class CORE_EXPORT QgsLayoutItemMap : public QgsLayoutItem, public QgsTemporalRan
 
     // for now, map items behave a bit differently and don't implement draw. TODO - see if we can avoid this
     void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override;
+
+    /**
+     * \deprecated QGIS 3.10
+     */
     Q_DECL_DEPRECATED int numberExportLayers() const override SIP_DEPRECATED;
+
     void startLayeredExport() override;
     void stopLayeredExport() override;
     bool nextExportPart() override;

diff --git a/src/core/raster/qgsbilinearrasterresampler.h b/src/core/raster/qgsbilinearrasterresampler.h
@@ -35,6 +35,10 @@ class CORE_EXPORT QgsBilinearRasterResampler: public QgsRasterResamplerV2
   public:
 
     QgsBilinearRasterResampler() = default;
+
+    /**
+     * \deprecated QGIS 3.12. Use resampleV2() instead.
+     */
     Q_DECL_DEPRECATED void resample( const QImage &srcImage, QImage &dstImage ) override SIP_DEPRECATED;
 
     QImage resampleV2( const QImage &source, const QSize &size ) override;

diff --git a/src/core/raster/qgscubicrasterresampler.h b/src/core/raster/qgscubicrasterresampler.h
@@ -37,6 +37,10 @@ class CORE_EXPORT QgsCubicRasterResampler: public QgsRasterResamplerV2
     QgsCubicRasterResampler *clone() const override SIP_FACTORY;
 
     QImage resampleV2( const QImage &source, const QSize &size ) override;
+
+    /**
+     * \deprecated QGIS 3.12. Use resampleV2() instead.
+     */
     Q_DECL_DEPRECATED void resample( const QImage &srcImage, QImage &dstImage ) override SIP_DEPRECATED;
     QString type() const override;
     int tileBufferPixels() const override;

diff --git a/src/core/scalebar/qgsnumericscalebarrenderer.h b/src/core/scalebar/qgsnumericscalebarrenderer.h
@@ -46,6 +46,9 @@ class CORE_EXPORT QgsNumericScaleBarRenderer: public QgsScaleBarRenderer
                              const QgsScaleBarSettings &settings,
                              const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const override;
 
+    /**
+     * \deprecated QGIS 3.14. Use the one with render context instead.
+     */
     Q_DECL_DEPRECATED QSizeF calculateBoxSize( const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext ) const override SIP_DEPRECATED ;
 
   private: