mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-17 00:04:02 -04:00
Remove some junk lines from docstrings
This commit is contained in:
parent
38850bdb94
commit
3d6ea5972b
@ -1492,7 +1492,6 @@ The ``method`` argument dictates which validator to utilize.
|
|||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
Available in Python bindings since QGIS 1.6
|
Available in Python bindings since QGIS 1.6
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
static QgsGeometry unaryUnion( const QVector<QgsGeometry> &geometries );
|
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
|
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.
|
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.
|
Labeling on top leaves more horizontal space for the widget itself.
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
void setLabelOnTop( int idx, bool onTop );
|
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
|
the previous line while if it is set to false, the widget will receive its label
|
||||||
on the left hand side.
|
on the left hand side.
|
||||||
Labeling on top leaves more horizontal space for the widget itself.
|
Labeling on top leaves more horizontal space for the widget itself.
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
|
|
||||||
|
@ -21,7 +21,6 @@ A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest i
|
|||||||
additional filters to the request.
|
additional filters to the request.
|
||||||
|
|
||||||
.. versionadded:: 2.14
|
.. versionadded:: 2.14
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%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 context of a rendering operation defines properties such as
|
||||||
the conversion ratio between screen and map units, the extents
|
the conversion ratio between screen and map units, the extents
|
||||||
to be rendered etc.
|
to be rendered etc.
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%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.
|
-Assign sensible defaults for the red, green, blue and gray bands.
|
||||||
|
|
||||||
-
|
-
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
~QgsRasterLayer();
|
~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.
|
:param qword: is the query string to search the symbols or colorramps.
|
||||||
|
|
||||||
:return: A QStringList of the matched symbols or colorramps
|
:return: A QStringList of the matched symbols or colorramps
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
QStringList tagsOfSymbol( StyleEntity type, const QString &symbol );
|
QStringList tagsOfSymbol( StyleEntity type, const QString &symbol );
|
||||||
|
@ -13,7 +13,6 @@ class QgsBlendModeComboBox : QComboBox
|
|||||||
{
|
{
|
||||||
%Docstring
|
%Docstring
|
||||||
A combobox which lets the user select blend modes from a predefined list
|
A combobox which lets the user select blend modes from a predefined list
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -19,7 +19,6 @@ class QgsCheckableComboBox : QComboBox
|
|||||||
QComboBox subclass which allows selecting multiple items.
|
QComboBox subclass which allows selecting multiple items.
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -13,7 +13,6 @@ class QgsEncodingFileDialog: QFileDialog
|
|||||||
{
|
{
|
||||||
%Docstring
|
%Docstring
|
||||||
A file dialog which lets the user select the preferred encoding type for a data provider.
|
A file dialog which lets the user select the preferred encoding type for a data provider.
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
@ -53,7 +52,6 @@ class QgsEncodingSelectionDialog: QDialog
|
|||||||
A dialog which presents the user with a choice of file encodings.
|
A dialog which presents the user with a choice of file encodings.
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%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.
|
If the aspect ratio isn't fixed, the width and height will be set to zero.
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
public slots:
|
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
|
:param ratio: aspect ratio's width and height
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
signals:
|
signals:
|
||||||
|
@ -24,7 +24,6 @@ class QgsExternalResourceWidget : QWidget
|
|||||||
%Docstring
|
%Docstring
|
||||||
Widget to display file path with a push button for an "open file" dialog
|
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.
|
It can also be used to display a picture or a web page.
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -19,7 +19,6 @@ handling custom null value representations.
|
|||||||
When using QgsFilterLineEdit the value(), setValue() and clearValue() methods should be used
|
When using QgsFilterLineEdit the value(), setValue() and clearValue() methods should be used
|
||||||
instead of QLineEdit's text(), setText() and clear() methods, and the valueChanged()
|
instead of QLineEdit's text(), setText() and clear() methods, and the valueChanged()
|
||||||
signal should be used instead of textChanged().
|
signal should be used instead of textChanged().
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%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.
|
To unset a fixed aspect ratio, set the width and height to zero.
|
||||||
|
|
||||||
:param ratio: aspect ratio's width and height
|
:param ratio: aspect ratio's width and height
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
QSize ratio() const;
|
QSize ratio() const;
|
||||||
%Docstring
|
%Docstring
|
||||||
Returns the current fixed aspect ratio to be used when dragging extent onto the canvas.
|
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.
|
If the aspect ratio isn't fixed, the width and height will be set to zero.
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
QgsRectangle extent() const;
|
QgsRectangle extent() const;
|
||||||
|
@ -17,7 +17,6 @@ QLineEdit subclass with built in support for showing/hiding
|
|||||||
entered password.
|
entered password.
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -14,7 +14,6 @@ class QgsScaleComboBox : QComboBox
|
|||||||
%Docstring
|
%Docstring
|
||||||
A combobox which lets the user select map scale from predefined list
|
A combobox which lets the user select map scale from predefined list
|
||||||
and highlights nearest to current scale value
|
and highlights nearest to current scale value
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -16,7 +16,6 @@ class QgsScaleWidget : QWidget
|
|||||||
%Docstring
|
%Docstring
|
||||||
A combobox which lets the user select map scale from predefined list
|
A combobox which lets the user select map scale from predefined list
|
||||||
and highlights nearest to current scale value
|
and highlights nearest to current scale value
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
@ -28,7 +27,6 @@ and highlights nearest to current scale value
|
|||||||
%Docstring
|
%Docstring
|
||||||
QgsScaleWidget creates a combobox which lets the user select map scale from predefined list
|
QgsScaleWidget creates a combobox which lets the user select map scale from predefined list
|
||||||
and highlights nearest to current scale value
|
and highlights nearest to current scale value
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
void setShowCurrentScaleButton( bool showCurrentScaleButton );
|
void setShowCurrentScaleButton( bool showCurrentScaleButton );
|
||||||
|
@ -18,7 +18,6 @@ class QgsAccessControl : QgsFeatureFilterProvider
|
|||||||
%Docstring
|
%Docstring
|
||||||
A helper class that centralize the restrictions given by all the
|
A helper class that centralize the restrictions given by all the
|
||||||
access control filter plugins.
|
access control filter plugins.
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -16,12 +16,12 @@ class QgsConfigCache : QObject
|
|||||||
{
|
{
|
||||||
%Docstring
|
%Docstring
|
||||||
*************************************************************************
|
*************************************************************************
|
||||||
*
|
|
||||||
This program is free software; you can redistribute it and/or modify *
|
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 *
|
it under the terms of the GNU General Public License as published by *
|
||||||
the Free Software Foundation; either version 2 of the License, or *
|
the Free Software Foundation; either version 2 of the License, or *
|
||||||
(at your option) any later version. *
|
(at your option) any later version. *
|
||||||
*
|
|
||||||
**************************************************************************
|
**************************************************************************
|
||||||
%End
|
%End
|
||||||
|
|
||||||
|
@ -17,7 +17,6 @@ class QgsFeatureFilter : QgsFeatureFilterProvider
|
|||||||
A feature filter provider allowing to set filter expressions on a per-layer basis.
|
A feature filter provider allowing to set filter expressions on a per-layer basis.
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -16,7 +16,6 @@ class QgsFeatureFilterProviderGroup : QgsFeatureFilterProvider
|
|||||||
A filter filter provider grouping several filter providers.
|
A filter filter provider grouping several filter providers.
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
*
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -168,6 +168,10 @@ sub processDoxygenLine {
|
|||||||
# replace nullptr with None (nullptr means nothing to Python devs)
|
# replace nullptr with None (nullptr means nothing to Python devs)
|
||||||
$line =~ s/\bnullptr\b/None/g;
|
$line =~ s/\bnullptr\b/None/g;
|
||||||
|
|
||||||
|
if ( $line eq '*' ) {
|
||||||
|
$line = '';
|
||||||
|
}
|
||||||
|
|
||||||
# if inside multi-line parameter, ensure additional lines are indented
|
# if inside multi-line parameter, ensure additional lines are indented
|
||||||
if ($line ne '') {
|
if ($line ne '') {
|
||||||
if ( $line !~ m/\s*[\\:]?(param|note|since|return|deprecated|warning)/ ) {
|
if ( $line !~ m/\s*[\\:]?(param|note|since|return|deprecated|warning)/ ) {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user