Fix messy doxygen blocks which mess with sipify script

Fixes #38291
qgis · Aug 20, 2020 · f496173 · f496173
1 parent a7a5d78
commit f496173
Show file tree

Hide file tree

Showing 205 changed files with 1,220 additions and 934 deletions.
diff --git a/python/analysis/auto_generated/interpolation/qgsgridfilewriter.sip.in b/python/analysis/auto_generated/interpolation/qgsgridfilewriter.sip.in
@@ -10,8 +10,12 @@
 
 
 
+
 class QgsGridFileWriter
 {
+%Docstring
+A class that does interpolation to a grid and writes the results to an ascii grid.
+%End
 
 %TypeHeaderCode
 #include "qgsgridfilewriter.h"

diff --git a/python/analysis/auto_generated/raster/qgsaspectfilter.sip.in b/python/analysis/auto_generated/raster/qgsaspectfilter.sip.in
@@ -12,7 +12,7 @@
 class QgsAspectFilter: QgsDerivativeFilter
 {
 %Docstring
-Calculates aspect values in a window of 3x3 cells based on first order derivatives in x- and y- directions. Direction is clockwise starting from north*
+Calculates aspect values in a window of 3x3 cells based on first order derivatives in x- and y- directions. Direction is clockwise starting from north.
 %End
 
 %TypeHeaderCode
@@ -24,10 +24,6 @@ Calculates aspect values in a window of 3x3 cells based on first order derivativ
      virtual float processNineCellWindow( float *x11, float *x21, float *x31,
                                  float *x12, float *x22, float *x32,
                                  float *x13, float *x23, float *x33 );
-%Docstring
-Calculates output value from nine input values. The input values and the output value can be equal to the
-nodata value if not present or outside of the border. Must be implemented by subclasses*
-%End
 
 
 };

diff --git a/python/analysis/auto_generated/raster/qgsderivativefilter.sip.in b/python/analysis/auto_generated/raster/qgsderivativefilter.sip.in
@@ -12,7 +12,7 @@
 class QgsDerivativeFilter : QgsNineCellFilter
 {
 %Docstring
-Adds the ability to calculate derivatives in x- and y-directions. Needs to be subclassed (e.g. for slope and aspect)*
+Adds the ability to calculate derivatives in x- and y-directions. Needs to be subclassed (e.g. for slope and aspect).
 %End
 
 %TypeHeaderCode

diff --git a/python/analysis/auto_generated/raster/qgshillshadefilter.sip.in b/python/analysis/auto_generated/raster/qgshillshadefilter.sip.in
@@ -22,10 +22,6 @@ class QgsHillshadeFilter: QgsDerivativeFilter
      virtual float processNineCellWindow( float *x11, float *x21, float *x31,
                                  float *x12, float *x22, float *x32,
                                  float *x13, float *x23, float *x33 );
-%Docstring
-Calculates output value from nine input values. The input values and the output value can be equal to the
-nodata value if not present or outside of the border. Must be implemented by subclasses*
-%End
 
     float lightAzimuth() const;
     void setLightAzimuth( float azimuth );

diff --git a/python/analysis/auto_generated/raster/qgsrelief.sip.in b/python/analysis/auto_generated/raster/qgsrelief.sip.in
@@ -13,7 +13,7 @@
 class QgsRelief
 {
 %Docstring
-Produces colored relief rasters from DEM*
+Produces colored relief rasters from DEM.
 %End
 
 %TypeHeaderCode
@@ -38,7 +38,7 @@ Starts the calculation, reads from mInputFile and stores the result in mOutputFi
 
 :param feedback: feedback object that receives update and that is checked for cancellation.
 
-:return: 0 in case of success*
+:return: 0 in case of success
 %End
 
     double zFactor() const;
@@ -53,7 +53,7 @@ Starts the calculation, reads from mInputFile and stores the result in mOutputFi
 %Docstring
 Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression
 
-:return: true in case of success*
+:return: true in case of success
 %End
 
     bool exportFrequencyDistributionToCsv( const QString &file );

diff --git a/python/analysis/auto_generated/raster/qgsruggednessfilter.sip.in b/python/analysis/auto_generated/raster/qgsruggednessfilter.sip.in
@@ -13,7 +13,8 @@ class QgsRuggednessFilter: QgsNineCellFilter
 {
 %Docstring
 Calculates the ruggedness index based on a 3x3 moving window.
-Algorithm from Riley et al. 1999: A terrain ruggedness index that quantifies topographic heterogeneity*
+
+Algorithm from Riley et al. 1999: A terrain ruggedness index that quantifies topographic heterogeneity
 %End
 
 %TypeHeaderCode
@@ -27,10 +28,6 @@ Algorithm from Riley et al. 1999: A terrain ruggedness index that quantifies top
      virtual float processNineCellWindow( float *x11, float *x21, float *x31,
                                  float *x12, float *x22, float *x32,
                                  float *x13, float *x23, float *x33 );
-%Docstring
-Calculates output value from nine input values. The input values and the output value can be equal to the
-nodata value if not present or outside of the border. Must be implemented by subclasses*
-%End
 
 };
 

diff --git a/python/analysis/auto_generated/raster/qgsslopefilter.sip.in b/python/analysis/auto_generated/raster/qgsslopefilter.sip.in
@@ -12,7 +12,7 @@
 class QgsSlopeFilter: QgsDerivativeFilter
 {
 %Docstring
-Calculates slope values in a window of 3x3 cells based on first order derivatives in x- and y- directions*
+Calculates slope values in a window of 3x3 cells based on first order derivatives in x- and y- directions.
 %End
 
 %TypeHeaderCode
@@ -24,10 +24,6 @@ Calculates slope values in a window of 3x3 cells based on first order derivative
      virtual float processNineCellWindow( float *x11, float *x21, float *x31,
                                  float *x12, float *x22, float *x32,
                                  float *x13, float *x23, float *x33 );
-%Docstring
-Calculates output value from nine input values. The input values and the output value can be equal to the
-nodata value if not present or outside of the border. Must be implemented by subclasses*
-%End
 
 
 };

diff --git a/python/analysis/auto_generated/raster/qgstotalcurvaturefilter.sip.in b/python/analysis/auto_generated/raster/qgstotalcurvaturefilter.sip.in
@@ -12,7 +12,7 @@
 class QgsTotalCurvatureFilter: QgsNineCellFilter
 {
 %Docstring
-Calculates total curvature as described by Wilson, Gallant (2000): terrain analysis*
+Calculates total curvature as described by Wilson, Gallant (2000): terrain analysis.
 %End
 
 %TypeHeaderCode
@@ -26,10 +26,6 @@ Calculates total curvature as described by Wilson, Gallant (2000): terrain analy
      virtual float processNineCellWindow( float *x11, float *x21, float *x31,
                                  float *x12, float *x22, float *x32,
                                  float *x13, float *x23, float *x33 );
-%Docstring
-Calculates total curvature from nine input values. The input values and the output value can be equal to the
-nodata value if not present or outside of the border. Must be implemented by subclasses*
-%End
 };
 
 /************************************************************************

diff --git a/python/core/auto_generated/diagram/qgsdiagram.sip.in b/python/core/auto_generated/diagram/qgsdiagram.sip.in
@@ -12,7 +12,7 @@
 class QgsDiagram /NoDefaultCtors/
 {
 %Docstring
-Base class for all diagram types*
+Base class for all diagram types.
 %End
 
 %TypeHeaderCode

diff --git a/python/core/auto_generated/geometry/qgscompoundcurve.sip.in b/python/core/auto_generated/geometry/qgscompoundcurve.sip.in
@@ -71,7 +71,7 @@ Returns a new line string geometry corresponding to a segmentized approximation
 of the curve.
 
 :param tolerance: segmentation tolerance
-:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve*
+:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve
 %End
 
     virtual QgsCompoundCurve *snappedToGrid( double hSpacing, double vSpacing, double dSpacing = 0, double mSpacing = 0 ) const /Factory/;

diff --git a/python/core/auto_generated/geometry/qgscurve.sip.in b/python/core/auto_generated/geometry/qgscurve.sip.in
@@ -161,7 +161,7 @@ Returns a reversed copy of the curve, where the direction of the curve has been
 Returns a geometry without curves. Caller takes ownership
 
 :param tolerance: segmentation tolerance
-:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve*
+:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve
 %End
 
     virtual int vertexCount( int part = 0, int ring = 0 ) const;

diff --git a/python/core/auto_generated/geometry/qgscurvepolygon.sip.in b/python/core/auto_generated/geometry/qgscurvepolygon.sip.in
@@ -114,7 +114,7 @@ Returns a new polygon geometry corresponding to a segmentized approximation
 of the curve.
 
 :param tolerance: segmentation tolerance
-:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve*
+:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve
 %End
 
     virtual void setExteriorRing( QgsCurve *ring /Transfer/ );
@@ -232,7 +232,7 @@ direction.
 Returns a geometry without curves. Caller takes ownership
 
 :param tolerance: segmentation tolerance
-:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve*
+:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve
 %End
 
     virtual double vertexAngle( QgsVertexId vertex ) const;

diff --git a/python/core/auto_generated/geometry/qgsgeometrycollection.sip.in b/python/core/auto_generated/geometry/qgsgeometrycollection.sip.in
@@ -203,7 +203,7 @@ An IndexError will be raised if no geometry with the specified index exists.
 Returns a geometry without curves. Caller takes ownership
 
 :param tolerance: segmentation tolerance
-:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve*
+:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve
 %End
 
     virtual double vertexAngle( QgsVertexId vertex ) const;

diff --git a/python/core/auto_generated/geometry/qgslinestring.sip.in b/python/core/auto_generated/geometry/qgslinestring.sip.in
@@ -388,7 +388,7 @@ Closes the line string by appending the first point to the end of the line, if i
 %Docstring
 Returns the geometry converted to the more generic curve type :py:class:`QgsCompoundCurve`
 
-:return: the converted geometry. Caller takes ownership*
+:return: the converted geometry. Caller takes ownership
 %End
 
     void extend( double startDistance, double endDistance );
@@ -459,7 +459,7 @@ Returns a new line string geometry corresponding to a segmentized approximation
 of the curve.
 
 :param tolerance: segmentation tolerance
-:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve*
+:param toleranceType: maximum segmentation angle or maximum difference between approximation and curve
 %End
 
     virtual int numPoints() const;

diff --git a/python/core/auto_generated/geometry/qgsmultilinestring.sip.in b/python/core/auto_generated/geometry/qgsmultilinestring.sip.in
@@ -68,7 +68,7 @@ An IndexError will be raised if no line string with the specified index exists.
 %Docstring
 Returns the geometry converted to the more generic curve type :py:class:`QgsMultiCurve`
 
-:return: the converted geometry. Caller takes ownership*
+:return: the converted geometry. Caller takes ownership
 %End
 
 

diff --git a/python/core/auto_generated/geometry/qgsmultipolygon.sip.in b/python/core/auto_generated/geometry/qgsmultipolygon.sip.in
@@ -68,7 +68,7 @@ An IndexError will be raised if no polygon with the specified index exists.
 %Docstring
 Returns the geometry converted to the more generic curve type :py:class:`QgsMultiSurface`
 
-:return: the converted geometry. Caller takes ownership*
+:return: the converted geometry. Caller takes ownership
 %End
 
     virtual QgsAbstractGeometry *boundary() const /Factory/;

diff --git a/python/core/auto_generated/geometry/qgspoint.sip.in b/python/core/auto_generated/geometry/qgspoint.sip.in
@@ -419,7 +419,7 @@ Angle undefined. Always returns 0.0
 
 :param vertex: the vertex id
 
-:return: 0.0*
+:return: 0.0
 %End
 
     virtual int vertexCount( int /*part*/ = 0, int /*ring*/ = 0 ) const;

diff --git a/python/core/auto_generated/geometry/qgspolygon.sip.in b/python/core/auto_generated/geometry/qgspolygon.sip.in
@@ -51,7 +51,7 @@ Ownership of ``exterior`` and ``rings`` is transferred to the polygon.
 %Docstring
 Returns the geometry converted to the more generic curve type :py:class:`QgsCurvePolygon`
 
-:return: the converted geometry. Caller takes ownership*
+:return: the converted geometry. Caller takes ownership
 %End
 
     virtual void addInteriorRing( QgsCurve *ring /Transfer/ );

diff --git a/python/core/auto_generated/gps/qgsgpsdconnection.sip.in b/python/core/auto_generated/gps/qgsgpsdconnection.sip.in
@@ -13,7 +13,7 @@
 class QgsGpsdConnection: QgsNmeaConnection
 {
 %Docstring
-Evaluates NMEA sentences coming from gpsd*
+Evaluates NMEA sentences coming from gpsd
 %End
 
 %TypeHeaderCode

diff --git a/python/core/auto_generated/layertree/qgslayertreemodellegendnode.sip.in b/python/core/auto_generated/layertree/qgslayertreemodellegendnode.sip.in
@@ -119,7 +119,7 @@ Returns whether a forced column break should occur before the node.
     virtual void invalidateMapBasedData();
 %Docstring
 Notification from model that information from associated map view has changed.
-Default implementation does nothing. *
+Default implementation does nothing.
 %End
 
     struct ItemContext

diff --git a/python/core/auto_generated/qgsapplication.sip.in b/python/core/auto_generated/qgsapplication.sip.in
@@ -199,7 +199,7 @@ Returns the path to the authors file.
 %Docstring
 Returns the path to the contributors file.
 Contributors are people who have submitted patches
-but don't have commit access. *
+but don't have commit access.
 %End
 
     static QString developersMapFilePath();
@@ -531,7 +531,7 @@ the CSS into a head -> script tag instead.
     static QString showSettings();
 %Docstring
 Convenience function to get a summary of the paths used in this
-application instance useful for debugging mainly.*
+application instance useful for debugging mainly.
 %End
 
     static void registerOgrDrivers();

diff --git a/python/core/auto_generated/qgsdataitem.sip.in b/python/core/auto_generated/qgsdataitem.sip.in
@@ -84,7 +84,10 @@ The default implementation returns ``False``, subclasses must implement this met
     virtual QVector<QgsDataItem *> createChildren() /Factory/;
 %Docstring
 Create children. Children are not expected to have parent set.
-This method MUST BE THREAD SAFE. *
+
+.. warning::
+
+   This method MUST BE THREAD SAFE.
 %End
 
     enum State
@@ -292,13 +295,13 @@ Sets the capabilities for the data item.
     QgsDataItem *parent() const;
 %Docstring
 Gets item parent. QgsDataItem maintains its own items hierarchy, it does not use
-QObject hierarchy. *
+QObject hierarchy.
 %End
 
     void setParent( QgsDataItem *parent );
 %Docstring
 Set item parent and connect / disconnect parent to / from item signals.
-It does not add itself to parents children (mChildren) *
+It does not add itself to parents children (mChildren)
 %End
     QVector<QgsDataItem *> children() const;
     virtual QIcon icon();
@@ -396,7 +399,7 @@ item is in Populating state (:py:func:`~QgsDataItem.createChildren` running in a
 the :py:func:`~QgsDataItem.deferredDelete` returns ``True`` and item will be deleted once Populating finished.
 Items with slow :py:func:`~QgsDataItem.reateChildren` (for example network or database based) may
 check during :py:func:`~QgsDataItem.createChildren` if :py:func:`~QgsDataItem.deferredDelete` returns ``True`` and return from
-:py:func:`~QgsDataItem.createChildren` immediately because result will be useless. *
+:py:func:`~QgsDataItem.createChildren` immediately because result will be useless.
 %End
 
 

diff --git a/python/core/auto_generated/qgslogger.sip.in b/python/core/auto_generated/qgslogger.sip.in
@@ -44,7 +44,7 @@ Goes to qDebug.
 :param debuglevel:
 :param file: file name where the message comes from
 :param function: function where the message comes from
-:param line: place in file where the message comes from*
+:param line: place in file where the message comes from
 %End
 
     static void debug( const QString &var, int val, int debuglevel = 1, const char *file = 0, const char *function = 0, int line = -1 );
@@ -72,7 +72,7 @@ Goes to qFatal
     static int debugLevel();
 %Docstring
 Reads the environment variable QGIS_DEBUG and converts it to int. If QGIS_DEBUG is not set,
-the function returns 1 if QGISDEBUG is defined and 0 if not*
+the function returns 1 if QGISDEBUG is defined and 0 if not.
 %End
 
     static void logMessageToFile( const QString &message );
@@ -83,7 +83,7 @@ Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any. *
     static QString logFile();
 %Docstring
 Reads the environment variable QGIS_LOG_FILE. Returns NULL if the variable is not set,
-otherwise returns a file name for writing log messages to.*
+otherwise returns a file name for writing log messages to.
 %End
 
 };

diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in
@@ -1659,7 +1659,7 @@ passwords or drivers prefixes ("HDF5:")
 Read custom properties from project file.
 
 :param layerNode: note to read from
-:param keyStartsWith: reads only properties starting with the specified string (or all if the string is empty)*
+:param keyStartsWith: reads only properties starting with the specified string (or all if the string is empty)
 %End
 
     void writeCustomProperties( QDomNode &layerNode, QDomDocument &doc ) const;

diff --git a/python/core/auto_generated/qgsmapsettings.sip.in b/python/core/auto_generated/qgsmapsettings.sip.in
@@ -593,7 +593,7 @@ serialization */
 %Docstring
 Sets the segmentation tolerance applied when rendering curved geometries
 
-:param tolerance: the segmentation tolerance*
+:param tolerance: the segmentation tolerance
 %End
     double segmentationTolerance() const;
 %Docstring
@@ -604,7 +604,7 @@ Gets the segmentation tolerance applied when rendering curved geometries
 %Docstring
 Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
 
-:param type: the segmentation tolerance typename*
+:param type: the segmentation tolerance typename
 %End
     QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const;
 %Docstring

diff --git a/python/core/auto_generated/qgspythonrunner.sip.in b/python/core/auto_generated/qgspythonrunner.sip.in
@@ -45,7 +45,7 @@ Eval a Python statement
 %Docstring
 Assign an instance of Python runner so that :py:func:`~QgsPythonRunner.run` can be used.
 This method should be called during app initialization.
-Takes ownership of the object, deletes previous instance. *
+Takes ownership of the object, deletes previous instance.
 %End
 
   protected:

diff --git a/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in b/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in
@@ -17,7 +17,7 @@ typedef QList< QgsVectorLayerJoinInfo > QgsVectorJoinList;
 class QgsVectorLayerJoinBuffer : QObject, QgsFeatureSink
 {
 %Docstring
-Manages joined fields for a vector layer*
+Manages joined fields for a vector layer.
 %End
 
 %TypeHeaderCode