Remove some junk lines from docstrings

qgis · May 27, 2018 · 3d6ea59 · 3d6ea59
1 parent 38850bd
commit 3d6ea59
Show file tree

Hide file tree

Showing 21 changed files with 6 additions and 26 deletions.
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -1492,7 +1492,6 @@ The ``method`` argument dictates which validator to utilize.
 .. note::
 
    Available in Python bindings since QGIS 1.6
-   *
 %End
 
     static QgsGeometry unaryUnion( const QVector<QgsGeometry> &geometries );

diff --git a/python/core/auto_generated/qgseditformconfig.sip.in b/python/core/auto_generated/qgseditformconfig.sip.in
@@ -178,7 +178,6 @@ If set to false, the widget at the given index will be read-only.
 If this returns true, the widget at the given index will receive its label on the previous line
 while if it returns false, the widget will receive its label on the left hand side.
 Labeling on top leaves more horizontal space for the widget itself.
-*
 %End
 
     void setLabelOnTop( int idx, bool onTop );
@@ -187,7 +186,6 @@ If this is set to true, the widget at the given index will receive its label on
 the previous line while if it is set to false, the widget will receive its label
 on the left hand side.
 Labeling on top leaves more horizontal space for the widget itself.
-*
 %End
 
 

diff --git a/python/core/auto_generated/qgsfeaturefilterprovider.sip.in b/python/core/auto_generated/qgsfeaturefilterprovider.sip.in
@@ -21,7 +21,6 @@ A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest i
 additional filters to the request.
 
 .. versionadded:: 2.14
-                  *
 %End
 
 %TypeHeaderCode

diff --git a/python/core/auto_generated/qgsrendercontext.sip.in b/python/core/auto_generated/qgsrendercontext.sip.in
@@ -19,7 +19,6 @@ Contains information about the context of a rendering operation.
 The context of a rendering operation defines properties such as
 the conversion ratio between screen and map units, the extents
 to be rendered etc.
-*
 %End
 
 %TypeHeaderCode

diff --git a/python/core/auto_generated/raster/qgsrasterlayer.sip.in b/python/core/auto_generated/raster/qgsrasterlayer.sip.in
@@ -132,7 +132,6 @@ The main tasks carried out by the constructor are:
 -Assign sensible defaults for the red, green, blue and gray bands.
 
 -
-*
 %End
 
     ~QgsRasterLayer();

diff --git a/python/core/auto_generated/symbology/qgsstyle.sip.in b/python/core/auto_generated/symbology/qgsstyle.sip.in
@@ -381,7 +381,6 @@ Returns the names of the symbols which have a matching 'substring' in its defini
 :param qword: is the query string to search the symbols or colorramps.
 
 :return: A QStringList of the matched symbols or colorramps
-         *
 %End
 
     QStringList tagsOfSymbol( StyleEntity type, const QString &symbol );

diff --git a/python/gui/auto_generated/qgsblendmodecombobox.sip.in b/python/gui/auto_generated/qgsblendmodecombobox.sip.in
@@ -13,7 +13,6 @@ class QgsBlendModeComboBox : QComboBox
 {
 %Docstring
 A combobox which lets the user select blend modes from a predefined list
-*
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/qgscheckablecombobox.sip.in b/python/gui/auto_generated/qgscheckablecombobox.sip.in
@@ -19,7 +19,6 @@ class QgsCheckableComboBox : QComboBox
 QComboBox subclass which allows selecting multiple items.
 
 .. versionadded:: 3.0
-                  *
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/qgsencodingfiledialog.sip.in b/python/gui/auto_generated/qgsencodingfiledialog.sip.in
@@ -13,7 +13,6 @@ class QgsEncodingFileDialog: QFileDialog
 {
 %Docstring
 A file dialog which lets the user select the preferred encoding type for a data provider.
-*
 %End
 
 %TypeHeaderCode
@@ -53,7 +52,6 @@ class QgsEncodingSelectionDialog: QDialog
 A dialog which presents the user with a choice of file encodings.
 
 .. versionadded:: 3.0
-                  *
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/qgsextentgroupbox.sip.in b/python/gui/auto_generated/qgsextentgroupbox.sip.in
@@ -162,7 +162,6 @@ Returns the current fixed aspect ratio to be used when dragging extent onto the
 If the aspect ratio isn't fixed, the width and height will be set to zero.
 
 .. versionadded:: 3.0
-                  *
 %End
 
   public slots:
@@ -204,7 +203,6 @@ To unset a fixed aspect ratio, set the width and height to zero.
 :param ratio: aspect ratio's width and height
 
 .. versionadded:: 3.0
-                  *
 %End
 
   signals:

diff --git a/python/gui/auto_generated/qgsexternalresourcewidget.sip.in b/python/gui/auto_generated/qgsexternalresourcewidget.sip.in
@@ -24,7 +24,6 @@ class QgsExternalResourceWidget : QWidget
 %Docstring
 Widget to display file path with a push button for an "open file" dialog
 It can also be used to display a picture or a web page.
-*
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/qgsfilterlineedit.sip.in b/python/gui/auto_generated/qgsfilterlineedit.sip.in
@@ -19,7 +19,6 @@ handling custom null value representations.
 When using QgsFilterLineEdit the value(), setValue() and clearValue() methods should be used
 instead of QLineEdit's text(), setText() and clear() methods, and the valueChanged()
 signal should be used instead of textChanged().
-*
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/qgsmaptoolextent.sip.in b/python/gui/auto_generated/qgsmaptoolextent.sip.in
@@ -47,14 +47,12 @@ Sets a fixed aspect ratio to be used when dragging extent onto the canvas.
 To unset a fixed aspect ratio, set the width and height to zero.
 
 :param ratio: aspect ratio's width and height
-              *
 %End
 
     QSize ratio() const;
 %Docstring
 Returns the current fixed aspect ratio to be used when dragging extent onto the canvas.
 If the aspect ratio isn't fixed, the width and height will be set to zero.
-*
 %End
 
     QgsRectangle extent() const;

diff --git a/python/gui/auto_generated/qgspasswordlineedit.sip.in b/python/gui/auto_generated/qgspasswordlineedit.sip.in
@@ -17,7 +17,6 @@ QLineEdit subclass with built in support for showing/hiding
 entered password.
 
 .. versionadded:: 3.0
-                  *
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/qgsscalecombobox.sip.in b/python/gui/auto_generated/qgsscalecombobox.sip.in
@@ -14,7 +14,6 @@ class QgsScaleComboBox : QComboBox
 %Docstring
 A combobox which lets the user select map scale from predefined list
 and highlights nearest to current scale value
-*
 %End
 
 %TypeHeaderCode

diff --git a/python/gui/auto_generated/qgsscalewidget.sip.in b/python/gui/auto_generated/qgsscalewidget.sip.in
@@ -16,7 +16,6 @@ class QgsScaleWidget : QWidget
 %Docstring
 A combobox which lets the user select map scale from predefined list
 and highlights nearest to current scale value
-*
 %End
 
 %TypeHeaderCode
@@ -28,7 +27,6 @@ and highlights nearest to current scale value
 %Docstring
  QgsScaleWidget creates a combobox which lets the user select map scale from predefined list
 and highlights nearest to current scale value
-*
 %End
 
     void setShowCurrentScaleButton( bool showCurrentScaleButton );

diff --git a/python/server/auto_generated/qgsaccesscontrol.sip.in b/python/server/auto_generated/qgsaccesscontrol.sip.in
@@ -18,7 +18,6 @@ class QgsAccessControl : QgsFeatureFilterProvider
 %Docstring
  A helper class that centralize the restrictions given by all the
 access control filter plugins.
-*
 %End
 
 %TypeHeaderCode

diff --git a/python/server/auto_generated/qgsconfigcache.sip.in b/python/server/auto_generated/qgsconfigcache.sip.in
@@ -16,12 +16,12 @@ class QgsConfigCache : QObject
 {
 %Docstring
 *************************************************************************
-*
+
 This program is free software; you can redistribute it and/or modify  *
 it under the terms of the GNU General Public License as published by  *
 the Free Software Foundation; either version 2 of the License, or     *
 (at your option) any later version.                                   *
-*
+
 **************************************************************************
 %End
 

diff --git a/python/server/auto_generated/qgsfeaturefilter.sip.in b/python/server/auto_generated/qgsfeaturefilter.sip.in
@@ -17,7 +17,6 @@ class QgsFeatureFilter : QgsFeatureFilterProvider
  A feature filter provider allowing to set filter expressions on a per-layer basis.
 
 .. versionadded:: 3.0
-                  *
 %End
 
 %TypeHeaderCode

diff --git a/python/server/auto_generated/qgsfeaturefilterprovidergroup.sip.in b/python/server/auto_generated/qgsfeaturefilterprovidergroup.sip.in
@@ -16,7 +16,6 @@ class QgsFeatureFilterProviderGroup : QgsFeatureFilterProvider
  A filter filter provider grouping several filter providers.
 
 .. versionadded:: 3.0
-                  *
 %End
 
 %TypeHeaderCode

diff --git a/scripts/sipify.pl b/scripts/sipify.pl
@@ -168,6 +168,10 @@ sub processDoxygenLine {
     # replace nullptr with None (nullptr means nothing to Python devs)
     $line =~ s/\bnullptr\b/None/g;
 
+    if ( $line eq '*' ) {
+        $line = '';
+    }
+
     # if inside multi-line parameter, ensure additional lines are indented
     if ($line ne '') {
         if ( $line !~ m/\s*[\\:]?(param|note|since|return|deprecated|warning)/ ) {