Fix use of trailing */ in dox, which messes with sipify Python docume…

…ntation output
qgis · Feb 25, 2019 · 7eab74f · 7eab74f
1 parent 9834859
commit 7eab74f
Show file tree

Hide file tree

Showing 36 changed files with 185 additions and 121 deletions.
diff --git a/python/core/auto_generated/qgsbrowsermodel.sip.in b/python/core/auto_generated/qgsbrowsermodel.sip.in
@@ -113,7 +113,7 @@ items, i.e. it does not fetch children.
 :param matchFlag: supported is Qt.MatchExactly and Qt.MatchStartsWith which has reverse meaning, i.e. find
                   item with the longest match from start with path (to get as close/deep as possible to deleted item).
 
-:return: model index, invalid if item not found *
+:return: model index, invalid if item not found
 %End
 
 

diff --git a/python/core/auto_generated/qgsgml.sip.in b/python/core/auto_generated/qgsgml.sip.in
@@ -17,7 +17,7 @@ class QgsGml : QObject
 This class reads data from a WFS server or alternatively from a GML file. It
 uses the expat XML parser and an event based model to keep performance high.
 The parsing starts when the first data arrives, it does not wait until the
-request is finished *
+request is finished
 %End
 
 %TypeHeaderCode

diff --git a/python/core/auto_generated/qgsgmlschema.sip.in b/python/core/auto_generated/qgsgmlschema.sip.in
@@ -57,7 +57,7 @@ Supports only UTF-8, UTF-16, ISO-8859-1, US-ASCII XML encodings.
 
 :param data: GML data
 
-:return: true in case of success *
+:return: true in case of success
 %End
 
     QStringList typeNames() const;

diff --git a/python/core/auto_generated/qgspluginlayerregistry.sip.in b/python/core/auto_generated/qgspluginlayerregistry.sip.in
@@ -72,7 +72,6 @@ Constructor for QgsPluginLayerRegistry.
     QStringList pluginLayerTypes();
 %Docstring
 List all known layer types
-\since QGIS *
 %End
 
     bool addPluginLayerType( QgsPluginLayerType *pluginLayerType /Transfer/ );

diff --git a/python/core/auto_generated/qgspointlocator.sip.in b/python/core/auto_generated/qgspointlocator.sip.in
@@ -97,7 +97,7 @@ Configure render context  - if not null, it will use to index only visible featu
 Prepare the index for queries. Does nothing if the index already exists.
 If the number of features is greater than the value of maxFeaturesToIndex, creation of index is stopped
 to make sure we do not run out of memory. If maxFeaturesToIndex is -1, no limits are used. Returns
-false if the creation of index has been prematurely stopped due to the limit of features, otherwise true *
+false if the creation of index has been prematurely stopped due to the limit of features, otherwise true
 %End
 
     bool hasIndex() const;

diff --git a/python/core/auto_generated/qgssqlstatement.sip.in b/python/core/auto_generated/qgssqlstatement.sip.in
@@ -48,7 +48,7 @@ Returns parser error
 %Docstring
 Performs basic validity checks. Basically checking that columns referencing
 a table, references a specified table. Returns true if the validation is
-successful *
+successful
 %End
 
 
@@ -177,7 +177,7 @@ Returns a quoted version of a string (in single quotes)
     class Node
 {
 %Docstring
-Abstract node class *
+Abstract node class
 %End
 
 %TypeHeaderCode
@@ -299,7 +299,7 @@ Dump list
     class NodeUnaryOperator : QgsSQLStatement::Node
 {
 %Docstring
-Unary logicial/arithmetical operator ( NOT, - ) *
+Unary logicial/arithmetical operator ( NOT, - )
 %End
 
 %TypeHeaderCode
@@ -336,7 +336,7 @@ Operand
     class NodeBinaryOperator : QgsSQLStatement::Node
 {
 %Docstring
-Binary logical/arithmetical operator (AND, OR, =, +, ...) *
+Binary logical/arithmetical operator (AND, OR, =, +, ...)
 %End
 
 %TypeHeaderCode
@@ -389,7 +389,7 @@ Is left associative ?
     class NodeInOperator : QgsSQLStatement::Node
 {
 %Docstring
-'x IN (y, z)' operator *
+'x IN (y, z)' operator
 %End
 
 %TypeHeaderCode
@@ -431,7 +431,7 @@ Values list
     class NodeBetweenOperator : QgsSQLStatement::Node
 {
 %Docstring
-'X BETWEEN y and z' operator *
+'X BETWEEN y and z' operator
 %End
 
 %TypeHeaderCode
@@ -477,7 +477,7 @@ Maximum bound
     class NodeFunction : QgsSQLStatement::Node
 {
 %Docstring
-Function with a name and arguments node *
+Function with a name and arguments node
 %End
 
 %TypeHeaderCode
@@ -515,7 +515,7 @@ Returns arguments
     class NodeLiteral : QgsSQLStatement::Node
 {
 %Docstring
-Literal value (integer, integer64, double, string) *
+Literal value (integer, integer64, double, string)
 %End
 
 %TypeHeaderCode
@@ -546,7 +546,7 @@ The value of the literal.
     class NodeColumnRef : QgsSQLStatement::Node
 {
 %Docstring
-Reference to a column *
+Reference to a column
 %End
 
 %TypeHeaderCode
@@ -605,7 +605,7 @@ Clone with same type return
     class NodeSelectedColumn : QgsSQLStatement::Node
 {
 %Docstring
-Selected column *
+Selected column
 %End
 
 %TypeHeaderCode
@@ -651,7 +651,7 @@ Clone with same type return
     class NodeCast : QgsSQLStatement::Node
 {
 %Docstring
-CAST operator *
+CAST operator
 %End
 
 %TypeHeaderCode
@@ -688,7 +688,7 @@ Type
     class NodeTableDef : QgsSQLStatement::Node
 {
 %Docstring
-Table definition *
+Table definition
 %End
 
 %TypeHeaderCode
@@ -732,7 +732,7 @@ Clone with same type return
     class NodeJoin : QgsSQLStatement::Node
 {
 %Docstring
-Join definition *
+Join definition
 %End
 
 %TypeHeaderCode
@@ -787,7 +787,7 @@ Clone with same type return
     class NodeColumnSorted : QgsSQLStatement::Node
 {
 %Docstring
-Column in a ORDER BY *
+Column in a ORDER BY
 %End
 
 %TypeHeaderCode
@@ -828,7 +828,7 @@ Clone with same type return
     class NodeSelect : QgsSQLStatement::Node
 {
 %Docstring
-SELECT node *
+SELECT node
 %End
 
 %TypeHeaderCode
@@ -899,7 +899,7 @@ Returns the list of order by columns
 {
 %Docstring
 Support for visitor pattern - algorithms dealing with the statement
-may be implemented without modifying the Node classes *
+may be implemented without modifying the Node classes
 %End
 
 %TypeHeaderCode
@@ -964,7 +964,7 @@ Visit NodeCast
     class RecursiveVisitor: QgsSQLStatement::Visitor
 {
 %Docstring
-A visitor that recursively explores all children *
+A visitor that recursively explores all children
 %End
 
 %TypeHeaderCode

diff --git a/python/core/auto_generated/qgsvectorlayer.sip.in b/python/core/auto_generated/qgsvectorlayer.sip.in
@@ -433,14 +433,14 @@ Joins another vector layer to this layer
 
 .. note::
 
-   since 2.6 returns bool indicating whether the join can be added *
+   since 2.6 returns bool indicating whether the join can be added
 %End
 
     bool removeJoin( const QString &joinLayerId );
 %Docstring
 Removes a vector layer join
 
-:return: true if join was found and successfully removed *
+:return: true if join was found and successfully removed
 %End
 
     QgsVectorLayerJoinBuffer *joinBuffer();

diff --git a/python/core/auto_generated/qgsvectorlayereditbuffer.sip.in b/python/core/auto_generated/qgsvectorlayereditbuffer.sip.in
@@ -72,7 +72,7 @@ Changes values of attributes (but does not commit it).
     virtual bool addAttribute( const QgsField &field );
 %Docstring
 Add an attribute field (but does not commit it)
-returns true if the field was added *
+returns true if the field was added
 %End
 
     virtual bool deleteAttribute( int attr );

diff --git a/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in b/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in
@@ -32,14 +32,14 @@ Joins another vector layer to this layer
 
 :param joinInfo: join object containing join layer id, target and source field
 
-:return: (since 2.6) whether the join was successfully added *
+:return: (since 2.6) whether the join was successfully added
 %End
 
     bool removeJoin( const QString &joinLayerId );
 %Docstring
 Removes a vector layer join
 
-:return: true if join was found and successfully removed *
+:return: true if join was found and successfully removed
 %End
 
     void updateFields( QgsFields &fields );

diff --git a/python/core/auto_generated/raster/qgsrasterblock.sip.in b/python/core/auto_generated/raster/qgsrasterblock.sip.in
@@ -103,7 +103,7 @@ Returns true if the block may contain no data. It does not guarantee
 that it really contains any no data. It can be used to speed up processing.
 Not the difference between this method and hasNoDataValue().
 
-:return: true if the block may contain no data *
+:return: true if the block may contain no data
 %End
 
     void setNoDataValue( double noDataValue );
@@ -142,7 +142,7 @@ Gets byte array representing a value.
 :param dataType: data type
 :param value: value
 
-:return: byte array representing the value *
+:return: byte array representing the value
 %End
 
     double value( int row, int column ) const;
@@ -180,7 +180,7 @@ Read a single color
 :param row: row index
 :param column: column index
 
-:return: color *
+:return: color
 %End
 
     QRgb color( qgssize index ) const;
@@ -189,7 +189,7 @@ Read a single value
 
 :param index: data matrix index (long type in Python)
 
-:return: color *
+:return: color
 %End
 
     bool isNoData( int row, int column ) const;
@@ -235,7 +235,7 @@ Set value on position
 :param column: column index
 :param value: the value to be set
 
-:return: true on success *
+:return: true on success
 %End
 
     bool setValue( qgssize index, double value );
@@ -245,7 +245,7 @@ Set value on index (indexed line by line)
 :param index: data matrix index (long type in Python)
 :param value: the value to be set
 
-:return: true on success *
+:return: true on success
 %End
 
     bool setColor( int row, int column, QRgb color );
@@ -256,7 +256,7 @@ Set color on position
 :param column: column index
 :param color: the color to be set, QRgb value
 
-:return: true on success *
+:return: true on success
 %End
 
     bool setColor( qgssize index, QRgb color );
@@ -266,7 +266,7 @@ Set color on index (indexed line by line)
 :param index: data matrix index (long type in Python)
 :param color: the color to be set, QRgb value
 
-:return: true on success *
+:return: true on success
 %End
 
 
@@ -277,7 +277,7 @@ Set no data on pixel
 :param row: row index
 :param column: column index
 
-:return: true on success *
+:return: true on success
 %End
 
     bool setIsNoData( qgssize index );
@@ -286,21 +286,21 @@ Set no data on pixel
 
 :param index: data matrix index (long type in Python)
 
-:return: true on success *
+:return: true on success
 %End
 
     bool setIsNoData();
 %Docstring
 Set the whole block to no data
 
-:return: true on success *
+:return: true on success
 %End
 
     bool setIsNoDataExcept( QRect exceptRect );
 %Docstring
 Set the whole block to no data except specified rectangle
 
-:return: true on success *
+:return: true on success
 %End
 
     void setIsData( int row, int column );
@@ -375,7 +375,7 @@ Convert data to different type.
 
 :param destDataType: dest data type
 
-:return: true on success *
+:return: true on success
 %End
 
     QImage image() const;

diff --git a/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in b/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in
@@ -37,7 +37,7 @@ Starts the image download
 
 .. note::
 
-   Make sure to connect to "finish" and "error" before starting *
+   Make sure to connect to "finish" and "error" before starting
 %End
 
   signals:
@@ -46,7 +46,7 @@ Starts the image download
 %Docstring
 Emitted when the download completes
 
-:param legend: The downloaded legend image *
+:param legend: The downloaded legend image
 %End
     void progress( qint64 received, qint64 total );
 %Docstring
@@ -189,7 +189,7 @@ Returns a list of user no data value ranges.
     virtual QStringList subLayers() const;
 %Docstring
 Returns the sublayers of this layer - useful for providers that manage
-their own layers, such as WMS *
+their own layers, such as WMS
 %End
 
     virtual bool supportsLegendGraphic() const;

diff --git a/python/core/auto_generated/raster/qgsrasterinterface.sip.in b/python/core/auto_generated/raster/qgsrasterinterface.sip.in
@@ -171,7 +171,7 @@ Returns data type for the band specified by number
     virtual Qgis::DataType sourceDataType( int bandNo ) const;
 %Docstring
 Returns source data type for the band specified by number,
-source data type may be shorter than dataType *
+source data type may be shorter than dataType
 %End
 
     virtual QgsRectangle extent() const;
@@ -221,7 +221,7 @@ Caller is responsible to free the memory returned.
     virtual bool setInput( QgsRasterInterface *input );
 %Docstring
 Set input.
-Returns true if set correctly, false if cannot use that input *
+Returns true if set correctly, false if cannot use that input
 %End
 
     virtual QgsRasterInterface *input() const;