sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-06-20 00:03:07 -04:00
Code Issues Packages Projects Releases Wiki Activity

[sipify] do not take // comments into docstrings

Browse Source
This commit is contained in:
Denis Rouzaud 2017-04-30 14:33:08 +02:00
parent f20b9b96e7
commit 897e2f0410
26 changed files with 13 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
python/core/geometry/qgscompoundcurve.sip
View File

@ -47,10 +47,6 @@ class QgsCompoundCurve: QgsCurve
virtual double length() const;
%Docstring
curve interface
:rtype: float
%End
virtual QgsPointV2 startPoint() const;
virtual QgsPointV2 endPoint() const;
virtual void points( QgsPointSequence &pts /Out/ ) const;

5
python/core/geometry/qgscurvepolygon.sip
View File

@ -46,10 +46,6 @@ class QgsCurvePolygon: QgsSurface
virtual double area() const;
%Docstring
surface interface
:rtype: float
%End
virtual double perimeter() const;
virtual QgsPolygonV2 *surfaceToPolygon() const /Factory/;
@ -57,7 +53,6 @@ surface interface
int numInteriorRings() const;
%Docstring
curve polygon interface
:rtype: int
%End
const QgsCurve *exteriorRing() const;

2
python/core/geometry/qgsgeometry.sip
View File

@ -213,7 +213,6 @@ Returns true if WKB of the geometry is of WKBMulti* type
QgsPoint closestVertex( const QgsPoint &point, int &atVertex /Out/, int &beforeVertex /Out/, int &afterVertex /Out/, double &sqrDist /Out/ ) const;
%Docstring
TODO QGIS 3.0 - rename beforeVertex to previousVertex, afterVertex to nextVertex
:rtype: QgsPoint
%End
@ -473,7 +472,6 @@ not disjoint with existing polygons of the feature
bool topological,
QList<QgsPoint> &topologyTestPoints /Out/ );
%Docstring
TODO QGIS 3.0 returns an enum instead of a magic constant
:rtype: int
%End

8
python/core/geometry/qgsgeometrycollection.sip
View File

@ -44,10 +44,6 @@ class QgsGeometryCollection: QgsAbstractGeometry
virtual bool isEmpty() const;
%Docstring
methods inherited from QgsAbstractGeometry
:rtype: bool
%End
virtual int dimension() const;
virtual QString geometryType() const;
virtual void clear();
@ -107,10 +103,6 @@ Adds a geometry and takes ownership. Returns true in case of success.
virtual bool insertVertex( QgsVertexId position, const QgsPointV2 &vertex );
%Docstring
low-level editing
:rtype: bool
%End
virtual bool moveVertex( QgsVertexId position, const QgsPointV2 &newPos );
virtual bool deleteVertex( QgsVertexId position );

8
python/core/geometry/qgslinestring.sip
View File

@ -161,10 +161,6 @@ Closes the line string by appending the first point to the end of the line, if i
virtual QString geometryType() const;
%Docstring
reimplemented methods
:rtype: str
%End
virtual int dimension() const;
virtual QgsLineString *clone() const /Factory/;
virtual void clear();
@ -186,10 +182,6 @@ reimplemented methods
virtual double length() const;
%Docstring
curve interface
:rtype: float
%End
virtual QgsPointV2 startPoint() const;
virtual QgsPointV2 endPoint() const;

4
python/core/geometry/qgsmulticurve.sip
View File

@ -29,10 +29,6 @@ class QgsMultiCurve: QgsGeometryCollection
virtual QDomElement asGML2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
%Docstring
inherited: QString asWkt( int precision = 17 ) const;
:rtype: QDomElement
%End
virtual QDomElement asGML3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
virtual QString asJSON( int precision = 17 ) const;

4
python/core/geometry/qgsmultilinestring.sip
View File

@ -29,10 +29,6 @@ class QgsMultiLineString: QgsMultiCurve
virtual QDomElement asGML2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
%Docstring
inherited: QString asWkt( int precision = 17 ) const;
:rtype: QDomElement
%End
virtual QDomElement asGML3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
virtual QString asJSON( int precision = 17 ) const;

4
python/core/geometry/qgsmultipoint.sip
View File

@ -29,10 +29,6 @@ class QgsMultiPointV2: QgsGeometryCollection
virtual QDomElement asGML2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
%Docstring
inherited: QString asWkt( int precision = 17 ) const;
:rtype: QDomElement
%End
virtual QDomElement asGML3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
virtual QString asJSON( int precision = 17 ) const;

4
python/core/geometry/qgsmultipolygon.sip
View File

@ -29,10 +29,6 @@ class QgsMultiPolygonV2: QgsMultiSurface
virtual QDomElement asGML2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
%Docstring
inherited: QString asWkt( int precision = 17 ) const;
:rtype: QDomElement
%End
virtual QDomElement asGML3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
virtual QString asJSON( int precision = 17 ) const;

4
python/core/geometry/qgsmultisurface.sip
View File

@ -29,10 +29,6 @@ class QgsMultiSurface: QgsGeometryCollection
virtual QDomElement asGML2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
%Docstring
inherited: QString asWkt( int precision = 17 ) const;
:rtype: QDomElement
%End
virtual QDomElement asGML3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const;
virtual QString asJSON( int precision = 17 ) const;

8
python/core/geometry/qgspointv2.sip
View File

@ -301,10 +301,6 @@ class QgsPointV2: QgsAbstractGeometry
%End
virtual bool isEmpty() const;
%Docstring
implementation of inherited methods
:rtype: bool
%End
virtual QgsRectangle boundingBox() const;
virtual QString geometryType() const;
virtual int dimension() const;
@ -334,10 +330,6 @@ implementation of inherited methods
virtual QgsAbstractGeometry *boundary() const /Factory/;
virtual bool insertVertex( QgsVertexId position, const QgsPointV2 &vertex );
%Docstring
low-level editing
:rtype: bool
%End
virtual bool moveVertex( QgsVertexId position, const QgsPointV2 &newPos );
virtual bool deleteVertex( QgsVertexId position );

11
python/core/geometry/qgspolygon.sip
View File

@ -41,17 +41,9 @@ class QgsPolygonV2: QgsCurvePolygon
virtual QByteArray asWkb() const;
%Docstring
inherited: bool fromWkt( const QString &wkt );
:rtype: QByteArray
%End
virtual QgsPolygonV2 *surfaceToPolygon() const /Factory/;
%Docstring
inherited: QString asJSON( int precision = 17 ) const;
:rtype: QgsPolygonV2
%End
virtual QgsAbstractGeometry *toCurveType() const /Factory/;
@ -64,9 +56,6 @@ inherited: QString asJSON( int precision = 17 ) const;
virtual void addInteriorRing( QgsCurve *ring /Transfer/ );
virtual void setExteriorRing( QgsCurve *ring /Transfer/ );
%Docstring
overridden to handle LineString25D rings
%End
virtual QgsAbstractGeometry *boundary() const /Factory/;

8
python/core/geometry/qgstriangle.sip
View File

@ -51,10 +51,6 @@ class QgsTriangle : QgsPolygonV2
virtual QString geometryType() const;
%Docstring
inherited: bool operator!=( const QgsTriangle& other ) const;
:rtype: str
%End
virtual QgsTriangle *clone() const /Factory/;
virtual void clear();
@ -67,10 +63,6 @@ inherited: bool operator!=( const QgsTriangle& other ) const;
virtual QgsPolygonV2 *surfaceToPolygon() const /Factory/;
%Docstring
inherited: QString asJSON( int precision = 17 ) const;
:rtype: QgsPolygonV2
%End
virtual QgsAbstractGeometry *toCurveType() const /Factory/;

4
python/core/layertree/qgslayertreemodel.sip
View File

@ -48,10 +48,6 @@ The root node is not transferred by the model.
virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;
%Docstring
Implementation of virtual functions from QAbstractItemModel
:rtype: int
%End
virtual int columnCount( const QModelIndex &parent = QModelIndex() ) const;
virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const;

3
python/core/qgscolorramp.sip
View File

@ -681,9 +681,6 @@ class QgsCptCityColorRamp : QgsGradientColorRamp
%End
void setSchemeName( const QString &schemeName );
%Docstring
lazy loading - have to call loadPalette() explicitly
%End
void setVariantName( const QString &variantName );
void setVariantList( const QStringList &variantList );
void setName( const QString &schemeName, const QString &variantName = QString(), const QStringList &variantList = QStringList() );

10
python/core/qgsdatasourceuri.sip
View File

@ -12,9 +12,6 @@
class QgsDataSourceUri
{
%Docstring
(Radim Blazek 4/2012)
%End
%TypeHeaderCode
#include "qgsdatasourceuri.h"
@ -229,9 +226,6 @@ Clears the schema
%End
void setSchema( const QString &schema );
%Docstring
.. versionadded:: 2.11
%End
void setSql( const QString &sql );
%Docstring
@ -255,13 +249,9 @@ Returns the port
%End
QString driver() const;
%Docstring
.. versionadded:: 2.16
:rtype: str
%End
void setDriver( const QString &driver );
%Docstring
.. versionadded:: 2.16
%End
QString password() const;
%Docstring
Returns the password

4
python/core/qgsfieldmodel.sip
View File

@ -108,10 +108,6 @@ class QgsFieldModel : QAbstractItemModel
virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const;
%Docstring
QAbstractItemModel interface
:rtype: QModelIndex
%End
virtual QModelIndex parent( const QModelIndex &child ) const;
virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;

4
python/core/qgsmaplayermodel.sip
View File

@ -119,10 +119,6 @@ returns if the items can be checked or not
virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const;
%Docstring
QAbstractItemModel interface
:rtype: QModelIndex
%End
virtual QModelIndex parent( const QModelIndex &child ) const;
virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;

6
python/core/qgsvectorlayer.sip
View File

@ -965,25 +965,21 @@ changeGeometry() instead.
int addRing( const QList<QgsPoint> &ring, QgsFeatureId *featureId = 0 );
%Docstring
TODO QGIS 3.0 returns an enum instead of a magic constant
:rtype: int
%End
int addRing( QgsCurve *ring /Transfer/, QgsFeatureId *featureId = 0 ) /PyName=addCurvedRing/;
%Docstring
TODO QGIS 3.0 returns an enum instead of a magic constant
:rtype: int
%End
int addPart( const QList<QgsPoint> &ring );
%Docstring
TODO QGIS 3.0 returns an enum instead of a magic constant
:rtype: int
%End
int addPart( const QgsPointSequence &ring ) /PyName=addPartV2/;
%Docstring
TODO QGIS 3.0 returns an enum instead of a magic constant
:rtype: int
%End
@ -1007,13 +1003,11 @@ TODO QGIS 3.0 returns an enum instead of a magic constant
int splitParts( const QList<QgsPoint> &splitLine, bool topologicalEditing = false );
%Docstring
TODO QGIS 3.0 returns an enum instead of a magic constant
:rtype: int
%End
int splitFeatures( const QList<QgsPoint> &splitLine, bool topologicalEditing = false );
%Docstring
TODO QGIS 3.0 returns an enum instead of a magic constant
:rtype: int
%End

3
python/gui/qgsoptionswidgetfactory.sip
View File

@ -37,9 +37,6 @@ class QgsOptionsPageWidget : QWidget
class QgsOptionsWidgetFactory : QObject
{
%Docstring
QGIS crashing when a plugin crashes/exits without deregistering a factory
%End
%TypeHeaderCode
#include "qgsoptionswidgetfactory.h"

1
python/gui/qgsscalewidget.sip
View File

@ -75,7 +75,6 @@ Function to read the min scale
static QString toString( double scale );
%Docstring
be expected.
:rtype: str
%End
static double toDouble( const QString &scaleString, bool *ok = 0 );

10
scripts/sipify.pl
View File

@ -366,9 +366,13 @@ while ($line_idx < $line_count){
# save comments and do not print them, except in SIP_RUN
if ( $SIP_RUN == 0 ){
if ( $line =~ m/^\s*\/\// ){
$line =~ s/^\s*\/\/\!*\s*(.*?)\n?$/$1/;
$comment = processDoxygenLine( $line );
$comment =~ s/\n+$//;
if ($line =~ m/^\s*\/\/\!\s*(.*?)\n?$/){
$comment = processDoxygenLine( $1 );
$comment =~ s/\n+$//;
}
elsif ($lines[$line_idx-1] !~ m/\*\/.*/) {
$comment = '';
}
next;
}
}

4
src/core/qgsdatasourceuri.h
View File

@ -80,13 +80,13 @@ class CORE_EXPORT QgsDataSourceUri
QString quotedTablename() const;
//! Set generic param (generic mode)
// \note if key exists, another is inserted
//! \note if key exists, another is inserted
void setParam( const QString &key, const QString &value );
//! \note available in Python as setParamList
void setParam( const QString &key, const QStringList &value ) SIP_PYNAME( setParamList );
//! Remove generic param (generic mode)
// \note remove all occurrences of key, returns number of params removed
//! \note remove all occurrences of key, returns number of params removed
int removeParam( const QString &key );
//! Get generic param (generic mode)

4
src/core/qgslogger.h
View File

@ -69,11 +69,11 @@ class CORE_EXPORT QgsLogger
static void debug( const QString &var, int val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );
//! Similar to the previous method, but prints a variable double-value pair
// \note not available in Python bindings
//! \note not available in Python bindings
static void debug( const QString &var, double val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );
//! Prints out a variable/value pair for types with overloaded operator<<
// \note not available in Python bindings
//! \note not available in Python bindings
template <typename T> static void debug( const QString &var, T val, const char *file = nullptr, const char *function = nullptr,
int line = -1, int debuglevel = 1 )
{

2
src/core/qgsmaptopixel.h
View File

@ -94,7 +94,7 @@ class CORE_EXPORT QgsMapToPixel
*/
void transformInPlace( double &x, double &y ) const;
// \note not available in Python bindings
//! \note not available in Python bindings
void transformInPlace( float &x, float &y ) const;
/**

2
src/core/qgsvectorlayereditutils.h
View File

@ -128,7 +128,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils
// TODO QGIS 3.0 returns an enum instead of a magic constant
int addPart( const QgsPointSequence &ring, QgsFeatureId featureId );
// \note available in Python bindings as addCurvedPart
//! \note available in Python bindings as addCurvedPart
// TODO QGIS 3.0 returns an enum instead of a magic constant
int addPart( QgsCurve *ring, QgsFeatureId featureId );