Skip to content

Commit 7eab74f

Browse files
committed
Fix use of trailing */ in dox, which messes with sipify Python documentation output
1 parent 9834859 commit 7eab74f

36 files changed

+185
-121
lines changed

python/core/auto_generated/qgsbrowsermodel.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ items, i.e. it does not fetch children.
113113
:param matchFlag: supported is Qt.MatchExactly and Qt.MatchStartsWith which has reverse meaning, i.e. find
114114
item with the longest match from start with path (to get as close/deep as possible to deleted item).
115115

116-
:return: model index, invalid if item not found *
116+
:return: model index, invalid if item not found
117117
%End
118118

119119

python/core/auto_generated/qgsgml.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class QgsGml : QObject
1717
This class reads data from a WFS server or alternatively from a GML file. It
1818
uses the expat XML parser and an event based model to keep performance high.
1919
The parsing starts when the first data arrives, it does not wait until the
20-
request is finished *
20+
request is finished
2121
%End
2222

2323
%TypeHeaderCode

python/core/auto_generated/qgsgmlschema.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Supports only UTF-8, UTF-16, ISO-8859-1, US-ASCII XML encodings.
5757

5858
:param data: GML data
5959

60-
:return: true in case of success *
60+
:return: true in case of success
6161
%End
6262

6363
QStringList typeNames() const;

python/core/auto_generated/qgspluginlayerregistry.sip.in

-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ Constructor for QgsPluginLayerRegistry.
7272
QStringList pluginLayerTypes();
7373
%Docstring
7474
List all known layer types
75-
\since QGIS *
7675
%End
7776

7877
bool addPluginLayerType( QgsPluginLayerType *pluginLayerType /Transfer/ );

python/core/auto_generated/qgspointlocator.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Configure render context - if not null, it will use to index only visible featu
9797
Prepare the index for queries. Does nothing if the index already exists.
9898
If the number of features is greater than the value of maxFeaturesToIndex, creation of index is stopped
9999
to make sure we do not run out of memory. If maxFeaturesToIndex is -1, no limits are used. Returns
100-
false if the creation of index has been prematurely stopped due to the limit of features, otherwise true *
100+
false if the creation of index has been prematurely stopped due to the limit of features, otherwise true
101101
%End
102102

103103
bool hasIndex() const;

python/core/auto_generated/qgssqlstatement.sip.in

+17-17
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Returns parser error
4848
%Docstring
4949
Performs basic validity checks. Basically checking that columns referencing
5050
a table, references a specified table. Returns true if the validation is
51-
successful *
51+
successful
5252
%End
5353

5454

@@ -177,7 +177,7 @@ Returns a quoted version of a string (in single quotes)
177177
class Node
178178
{
179179
%Docstring
180-
Abstract node class *
180+
Abstract node class
181181
%End
182182

183183
%TypeHeaderCode
@@ -299,7 +299,7 @@ Dump list
299299
class NodeUnaryOperator : QgsSQLStatement::Node
300300
{
301301
%Docstring
302-
Unary logicial/arithmetical operator ( NOT, - ) *
302+
Unary logicial/arithmetical operator ( NOT, - )
303303
%End
304304

305305
%TypeHeaderCode
@@ -336,7 +336,7 @@ Operand
336336
class NodeBinaryOperator : QgsSQLStatement::Node
337337
{
338338
%Docstring
339-
Binary logical/arithmetical operator (AND, OR, =, +, ...) *
339+
Binary logical/arithmetical operator (AND, OR, =, +, ...)
340340
%End
341341

342342
%TypeHeaderCode
@@ -389,7 +389,7 @@ Is left associative ?
389389
class NodeInOperator : QgsSQLStatement::Node
390390
{
391391
%Docstring
392-
'x IN (y, z)' operator *
392+
'x IN (y, z)' operator
393393
%End
394394

395395
%TypeHeaderCode
@@ -431,7 +431,7 @@ Values list
431431
class NodeBetweenOperator : QgsSQLStatement::Node
432432
{
433433
%Docstring
434-
'X BETWEEN y and z' operator *
434+
'X BETWEEN y and z' operator
435435
%End
436436

437437
%TypeHeaderCode
@@ -477,7 +477,7 @@ Maximum bound
477477
class NodeFunction : QgsSQLStatement::Node
478478
{
479479
%Docstring
480-
Function with a name and arguments node *
480+
Function with a name and arguments node
481481
%End
482482

483483
%TypeHeaderCode
@@ -515,7 +515,7 @@ Returns arguments
515515
class NodeLiteral : QgsSQLStatement::Node
516516
{
517517
%Docstring
518-
Literal value (integer, integer64, double, string) *
518+
Literal value (integer, integer64, double, string)
519519
%End
520520

521521
%TypeHeaderCode
@@ -546,7 +546,7 @@ The value of the literal.
546546
class NodeColumnRef : QgsSQLStatement::Node
547547
{
548548
%Docstring
549-
Reference to a column *
549+
Reference to a column
550550
%End
551551

552552
%TypeHeaderCode
@@ -605,7 +605,7 @@ Clone with same type return
605605
class NodeSelectedColumn : QgsSQLStatement::Node
606606
{
607607
%Docstring
608-
Selected column *
608+
Selected column
609609
%End
610610

611611
%TypeHeaderCode
@@ -651,7 +651,7 @@ Clone with same type return
651651
class NodeCast : QgsSQLStatement::Node
652652
{
653653
%Docstring
654-
CAST operator *
654+
CAST operator
655655
%End
656656

657657
%TypeHeaderCode
@@ -688,7 +688,7 @@ Type
688688
class NodeTableDef : QgsSQLStatement::Node
689689
{
690690
%Docstring
691-
Table definition *
691+
Table definition
692692
%End
693693

694694
%TypeHeaderCode
@@ -732,7 +732,7 @@ Clone with same type return
732732
class NodeJoin : QgsSQLStatement::Node
733733
{
734734
%Docstring
735-
Join definition *
735+
Join definition
736736
%End
737737

738738
%TypeHeaderCode
@@ -787,7 +787,7 @@ Clone with same type return
787787
class NodeColumnSorted : QgsSQLStatement::Node
788788
{
789789
%Docstring
790-
Column in a ORDER BY *
790+
Column in a ORDER BY
791791
%End
792792

793793
%TypeHeaderCode
@@ -828,7 +828,7 @@ Clone with same type return
828828
class NodeSelect : QgsSQLStatement::Node
829829
{
830830
%Docstring
831-
SELECT node *
831+
SELECT node
832832
%End
833833

834834
%TypeHeaderCode
@@ -899,7 +899,7 @@ Returns the list of order by columns
899899
{
900900
%Docstring
901901
Support for visitor pattern - algorithms dealing with the statement
902-
may be implemented without modifying the Node classes *
902+
may be implemented without modifying the Node classes
903903
%End
904904

905905
%TypeHeaderCode
@@ -964,7 +964,7 @@ Visit NodeCast
964964
class RecursiveVisitor: QgsSQLStatement::Visitor
965965
{
966966
%Docstring
967-
A visitor that recursively explores all children *
967+
A visitor that recursively explores all children
968968
%End
969969

970970
%TypeHeaderCode

python/core/auto_generated/qgsvectorlayer.sip.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -433,14 +433,14 @@ Joins another vector layer to this layer
433433

434434
.. note::
435435

436-
since 2.6 returns bool indicating whether the join can be added *
436+
since 2.6 returns bool indicating whether the join can be added
437437
%End
438438

439439
bool removeJoin( const QString &joinLayerId );
440440
%Docstring
441441
Removes a vector layer join
442442

443-
:return: true if join was found and successfully removed *
443+
:return: true if join was found and successfully removed
444444
%End
445445

446446
QgsVectorLayerJoinBuffer *joinBuffer();

python/core/auto_generated/qgsvectorlayereditbuffer.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Changes values of attributes (but does not commit it).
7272
virtual bool addAttribute( const QgsField &field );
7373
%Docstring
7474
Add an attribute field (but does not commit it)
75-
returns true if the field was added *
75+
returns true if the field was added
7676
%End
7777

7878
virtual bool deleteAttribute( int attr );

python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ Joins another vector layer to this layer
3232

3333
:param joinInfo: join object containing join layer id, target and source field
3434

35-
:return: (since 2.6) whether the join was successfully added *
35+
:return: (since 2.6) whether the join was successfully added
3636
%End
3737

3838
bool removeJoin( const QString &joinLayerId );
3939
%Docstring
4040
Removes a vector layer join
4141

42-
:return: true if join was found and successfully removed *
42+
:return: true if join was found and successfully removed
4343
%End
4444

4545
void updateFields( QgsFields &fields );

python/core/auto_generated/raster/qgsrasterblock.sip.in

+13-13
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Returns true if the block may contain no data. It does not guarantee
103103
that it really contains any no data. It can be used to speed up processing.
104104
Not the difference between this method and hasNoDataValue().
105105

106-
:return: true if the block may contain no data *
106+
:return: true if the block may contain no data
107107
%End
108108

109109
void setNoDataValue( double noDataValue );
@@ -142,7 +142,7 @@ Gets byte array representing a value.
142142
:param dataType: data type
143143
:param value: value
144144

145-
:return: byte array representing the value *
145+
:return: byte array representing the value
146146
%End
147147

148148
double value( int row, int column ) const;
@@ -180,7 +180,7 @@ Read a single color
180180
:param row: row index
181181
:param column: column index
182182

183-
:return: color *
183+
:return: color
184184
%End
185185

186186
QRgb color( qgssize index ) const;
@@ -189,7 +189,7 @@ Read a single value
189189

190190
:param index: data matrix index (long type in Python)
191191

192-
:return: color *
192+
:return: color
193193
%End
194194

195195
bool isNoData( int row, int column ) const;
@@ -235,7 +235,7 @@ Set value on position
235235
:param column: column index
236236
:param value: the value to be set
237237

238-
:return: true on success *
238+
:return: true on success
239239
%End
240240

241241
bool setValue( qgssize index, double value );
@@ -245,7 +245,7 @@ Set value on index (indexed line by line)
245245
:param index: data matrix index (long type in Python)
246246
:param value: the value to be set
247247

248-
:return: true on success *
248+
:return: true on success
249249
%End
250250

251251
bool setColor( int row, int column, QRgb color );
@@ -256,7 +256,7 @@ Set color on position
256256
:param column: column index
257257
:param color: the color to be set, QRgb value
258258

259-
:return: true on success *
259+
:return: true on success
260260
%End
261261

262262
bool setColor( qgssize index, QRgb color );
@@ -266,7 +266,7 @@ Set color on index (indexed line by line)
266266
:param index: data matrix index (long type in Python)
267267
:param color: the color to be set, QRgb value
268268

269-
:return: true on success *
269+
:return: true on success
270270
%End
271271

272272

@@ -277,7 +277,7 @@ Set no data on pixel
277277
:param row: row index
278278
:param column: column index
279279

280-
:return: true on success *
280+
:return: true on success
281281
%End
282282

283283
bool setIsNoData( qgssize index );
@@ -286,21 +286,21 @@ Set no data on pixel
286286

287287
:param index: data matrix index (long type in Python)
288288

289-
:return: true on success *
289+
:return: true on success
290290
%End
291291

292292
bool setIsNoData();
293293
%Docstring
294294
Set the whole block to no data
295295

296-
:return: true on success *
296+
:return: true on success
297297
%End
298298

299299
bool setIsNoDataExcept( QRect exceptRect );
300300
%Docstring
301301
Set the whole block to no data except specified rectangle
302302

303-
:return: true on success *
303+
:return: true on success
304304
%End
305305

306306
void setIsData( int row, int column );
@@ -375,7 +375,7 @@ Convert data to different type.
375375

376376
:param destDataType: dest data type
377377

378-
:return: true on success *
378+
:return: true on success
379379
%End
380380

381381
QImage image() const;

python/core/auto_generated/raster/qgsrasterdataprovider.sip.in

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Starts the image download
3737

3838
.. note::
3939

40-
Make sure to connect to "finish" and "error" before starting *
40+
Make sure to connect to "finish" and "error" before starting
4141
%End
4242

4343
signals:
@@ -46,7 +46,7 @@ Starts the image download
4646
%Docstring
4747
Emitted when the download completes
4848

49-
:param legend: The downloaded legend image *
49+
:param legend: The downloaded legend image
5050
%End
5151
void progress( qint64 received, qint64 total );
5252
%Docstring
@@ -189,7 +189,7 @@ Returns a list of user no data value ranges.
189189
virtual QStringList subLayers() const;
190190
%Docstring
191191
Returns the sublayers of this layer - useful for providers that manage
192-
their own layers, such as WMS *
192+
their own layers, such as WMS
193193
%End
194194

195195
virtual bool supportsLegendGraphic() const;

python/core/auto_generated/raster/qgsrasterinterface.sip.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ Returns data type for the band specified by number
171171
virtual Qgis::DataType sourceDataType( int bandNo ) const;
172172
%Docstring
173173
Returns source data type for the band specified by number,
174-
source data type may be shorter than dataType *
174+
source data type may be shorter than dataType
175175
%End
176176

177177
virtual QgsRectangle extent() const;
@@ -221,7 +221,7 @@ Caller is responsible to free the memory returned.
221221
virtual bool setInput( QgsRasterInterface *input );
222222
%Docstring
223223
Set input.
224-
Returns true if set correctly, false if cannot use that input *
224+
Returns true if set correctly, false if cannot use that input
225225
%End
226226

227227
virtual QgsRasterInterface *input() const;

0 commit comments

Comments
 (0)