Skip to content
Permalink
Browse files

Remove some junk lines from docstrings

  • Loading branch information
nyalldawson committed May 24, 2018
1 parent 38850bd commit 3d6ea5972bc71cfb316834911f6caea5d70b98d2
@@ -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 );
@@ -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


@@ -21,7 +21,6 @@ A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest i
additional filters to the request.

.. versionadded:: 2.14
*
%End

%TypeHeaderCode
@@ -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
@@ -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();
@@ -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 );
@@ -13,7 +13,6 @@ class QgsBlendModeComboBox : QComboBox
{
%Docstring
A combobox which lets the user select blend modes from a predefined list
*
%End

%TypeHeaderCode
@@ -19,7 +19,6 @@ class QgsCheckableComboBox : QComboBox
QComboBox subclass which allows selecting multiple items.

.. versionadded:: 3.0
*
%End

%TypeHeaderCode
@@ -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
@@ -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:
@@ -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
@@ -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
@@ -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;
@@ -17,7 +17,6 @@ QLineEdit subclass with built in support for showing/hiding
entered password.

.. versionadded:: 3.0
*
%End

%TypeHeaderCode
@@ -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
@@ -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 );
@@ -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
@@ -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

@@ -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
@@ -16,7 +16,6 @@ class QgsFeatureFilterProviderGroup : QgsFeatureFilterProvider
A filter filter provider grouping several filter providers.

.. versionadded:: 3.0
*
%End

%TypeHeaderCode
@@ -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)/ ) {

0 comments on commit 3d6ea59

Please sign in to comment.
You can’t perform that action at this time.