Skip to content

Commit

Permalink
[sipify] Don't autocreate Docstrings for overridden members
Browse files Browse the repository at this point in the history 
Skip the autocreated Docstrings with rtype annotations if the
member is overridden - better to use the base class
Docstring in this case.
  • Loading branch information
@nyalldawson
nyalldawson committed Apr 17, 2017
1 parent 96d5b9d commit 6a72c94
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 192 deletions.
3 changes: 0 additions & 3 deletions python/core/annotations/qgshtmlannotation.sip
View file
Expand Up @@ -32,9 +32,6 @@ class QgsHtmlAnnotation: QgsAnnotation
~QgsHtmlAnnotation();

QSizeF minimumFrameSize() const;
%Docstring
:rtype: QSizeF
%End

void setSourceFile( const QString &htmlFile );
%Docstring
Expand Down
6 changes: 0 additions & 6 deletions python/core/qgsattributeeditorelement.sip
View file
Expand Up @@ -264,9 +264,6 @@ class QgsAttributeEditorField : QgsAttributeEditorElement
%End

virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/;
%Docstring
:rtype: QgsAttributeEditorElement
%End

};

Expand Down Expand Up @@ -317,9 +314,6 @@ class QgsAttributeEditorRelation : QgsAttributeEditorElement
%End

virtual QgsAttributeEditorElement *clone( QgsAttributeEditorElement *parent ) const /Factory/;
%Docstring
:rtype: QgsAttributeEditorElement
%End

bool showLinkButton() const;
%Docstring
Expand Down
102 changes: 0 additions & 102 deletions python/core/qgscolorramp.sip
View file
Expand Up @@ -153,30 +153,12 @@ Creates a new QgsColorRamp from a map of properties
%End

virtual int count() const;
%Docstring
:rtype: int
%End
virtual double value( int index ) const;
%Docstring
:rtype: float
%End
virtual QColor color( double value ) const;
%Docstring
:rtype: QColor
%End
virtual QString type() const;
%Docstring
:rtype: str
%End
virtual void invert();
virtual QgsGradientColorRamp *clone() const;
%Docstring
:rtype: QgsGradientColorRamp
%End
virtual QgsStringMap properties() const;
%Docstring
:rtype: QgsStringMap
%End

QColor color1() const;
%Docstring
Expand Down Expand Up @@ -316,29 +298,11 @@ class QgsLimitedRandomColorRamp : QgsColorRamp
%End

virtual double value( int index ) const;
%Docstring
:rtype: float
%End
virtual QColor color( double value ) const;
%Docstring
:rtype: QColor
%End
virtual QString type() const;
%Docstring
:rtype: str
%End
virtual QgsLimitedRandomColorRamp *clone() const /Factory/;
%Docstring
:rtype: QgsLimitedRandomColorRamp
%End
virtual QgsStringMap properties() const;
%Docstring
:rtype: QgsStringMap
%End
int count() const;
%Docstring
:rtype: int
%End

static QList<QColor> randomColors( int count,
int hueMax = DEFAULT_RANDOM_HUE_MAX, int hueMin = DEFAULT_RANDOM_HUE_MIN,
Expand Down Expand Up @@ -457,19 +421,10 @@ class QgsRandomColorRamp: QgsColorRamp
QgsRandomColorRamp();

int count() const;
%Docstring
:rtype: int
%End

double value( int index ) const;
%Docstring
:rtype: float
%End

QColor color( double value ) const;
%Docstring
:rtype: QColor
%End

virtual void setTotalColorCount( const int colorCount );
%Docstring
Expand All @@ -481,19 +436,10 @@ class QgsRandomColorRamp: QgsColorRamp
%End

QString type() const;
%Docstring
:rtype: str
%End

virtual QgsRandomColorRamp *clone() const /Factory/;
%Docstring
:rtype: QgsRandomColorRamp
%End

virtual QgsStringMap properties() const;
%Docstring
:rtype: QgsStringMap
%End

protected:

Expand Down Expand Up @@ -558,26 +504,11 @@ QgsColorRamp interface
:rtype: float
%End
virtual QColor color( double value ) const;
%Docstring
:rtype: QColor
%End
virtual QString type() const;
%Docstring
:rtype: str
%End
virtual void invert();
virtual QgsPresetSchemeColorRamp *clone() const /Factory/;
%Docstring
:rtype: QgsPresetSchemeColorRamp
%End
virtual QgsStringMap properties() const;
%Docstring
:rtype: QgsStringMap
%End
int count() const;
%Docstring
:rtype: int
%End

QString schemeName() const;
%Docstring
Expand All @@ -586,13 +517,7 @@ QgsColorScheme interface
%End
QgsNamedColorList fetchColors( const QString &context = QString(),
const QColor &baseColor = QColor() );
%Docstring
:rtype: QgsNamedColorList
%End
bool isEditable() const;
%Docstring
:rtype: bool
%End

};

Expand Down Expand Up @@ -630,30 +555,12 @@ class QgsColorBrewerColorRamp : QgsColorRamp
%End

virtual double value( int index ) const;
%Docstring
:rtype: float
%End
virtual QColor color( double value ) const;
%Docstring
:rtype: QColor
%End
virtual QString type() const;
%Docstring
:rtype: str
%End
virtual void invert();
virtual QgsColorBrewerColorRamp *clone() const /Factory/;
%Docstring
:rtype: QgsColorBrewerColorRamp
%End
virtual QgsStringMap properties() const;
%Docstring
:rtype: QgsStringMap
%End
virtual int count() const;
%Docstring
:rtype: int
%End

QString schemeName() const;
%Docstring
Expand Down Expand Up @@ -750,26 +657,17 @@ class QgsCptCityColorRamp : QgsGradientColorRamp
%End

virtual QString type() const;
%Docstring
:rtype: str
%End

virtual void invert();

virtual QgsCptCityColorRamp *clone() const /Factory/;
%Docstring
:rtype: QgsCptCityColorRamp
%End
void copy( const QgsCptCityColorRamp *other );
QgsGradientColorRamp *cloneGradientRamp() const /Factory/;
%Docstring
:rtype: QgsGradientColorRamp
%End

virtual QgsStringMap properties() const;
%Docstring
:rtype: QgsStringMap
%End

QString schemeName() const;
%Docstring
Expand Down
54 changes: 0 additions & 54 deletions python/core/qgspropertytransformer.sip
View file
Expand Up @@ -348,29 +348,11 @@ class QgsGenericNumericTransformer : QgsPropertyTransformer
// QgsGenericNumericTransformer &operator=( const QgsGenericNumericTransformer &other );

virtual Type transformerType() const;
%Docstring
:rtype: Type
%End
virtual QgsGenericNumericTransformer *clone();
%Docstring
:rtype: QgsGenericNumericTransformer
%End
virtual QVariant toVariant() const;
%Docstring
:rtype: QVariant
%End
virtual bool loadVariant( const QVariant &definition );
%Docstring
:rtype: bool
%End
virtual QVariant transform( const QgsExpressionContext &context, const QVariant &value ) const;
%Docstring
:rtype: QVariant
%End
virtual QString toExpression( const QString &baseExpression ) const;
%Docstring
:rtype: str
%End

static QgsGenericNumericTransformer *fromExpression( const QString &expression, QString &baseExpression /Out/, QString &fieldName /Out/ ) /Factory/;
%Docstring
Expand Down Expand Up @@ -503,29 +485,11 @@ class QgsSizeScaleTransformer : QgsPropertyTransformer
// QgsSizeScaleTransformer &operator=( const QgsSizeScaleTransformer &other );

virtual Type transformerType() const;
%Docstring
:rtype: Type
%End
virtual QgsSizeScaleTransformer *clone() /Factory/;
%Docstring
:rtype: QgsSizeScaleTransformer
%End
virtual QVariant toVariant() const;
%Docstring
:rtype: QVariant
%End
virtual bool loadVariant( const QVariant &definition );
%Docstring
:rtype: bool
%End
virtual QVariant transform( const QgsExpressionContext &context, const QVariant &value ) const;
%Docstring
:rtype: QVariant
%End
virtual QString toExpression( const QString &baseExpression ) const;
%Docstring
:rtype: str
%End

static QgsSizeScaleTransformer *fromExpression( const QString &expression, QString &baseExpression /Out/, QString &fieldName /Out/ ) /Factory/;
%Docstring
Expand Down Expand Up @@ -662,29 +626,11 @@ Copy constructor
// QgsColorRampTransformer &operator=( const QgsColorRampTransformer &other );

virtual Type transformerType() const;
%Docstring
:rtype: Type
%End
virtual QgsColorRampTransformer *clone() /Factory/;
%Docstring
:rtype: QgsColorRampTransformer
%End
virtual QVariant toVariant() const;
%Docstring
:rtype: QVariant
%End
virtual bool loadVariant( const QVariant &definition );
%Docstring
:rtype: bool
%End
virtual QVariant transform( const QgsExpressionContext &context, const QVariant &value ) const;
%Docstring
:rtype: QVariant
%End
virtual QString toExpression( const QString &baseExpression ) const;
%Docstring
:rtype: str
%End

QColor color( double value ) const;
%Docstring
Expand Down
12 changes: 0 additions & 12 deletions python/core/qgsvectorlayer.sip
View file
Expand Up @@ -822,9 +822,6 @@ Return the provider type for this layer
%End

bool readSld( const QDomNode &node, QString &errorMessage );
%Docstring
:rtype: bool
%End

long featureCount( const QString &legendKey ) const;
%Docstring
Expand Down Expand Up @@ -1069,9 +1066,6 @@ Returns true if the provider is in editing mode
%End

virtual bool isSpatial() const;
%Docstring
:rtype: bool
%End

virtual bool isModified() const;
%Docstring
Expand Down Expand Up @@ -1644,9 +1638,6 @@ Returns the current transparency for the vector layer
%End

QString htmlMetadata() const;
%Docstring
:rtype: str
%End


void setSimplifyMethod( const QgsVectorSimplifyMethod &simplifyMethod );
Expand Down Expand Up @@ -1715,9 +1706,6 @@ Returns the current transparency for the vector layer
%End

QgsExpressionContext createExpressionContext() const;
%Docstring
:rtype: QgsExpressionContext
%End

QgsEditFormConfig editFormConfig() const;
%Docstring
Expand Down
3 changes: 0 additions & 3 deletions python/core/raster/qgsrasterfilewritertask.sip
View file
Expand Up @@ -54,9 +54,6 @@ class QgsRasterFileWriterTask : QgsTask
protected:

virtual bool run();
%Docstring
:rtype: bool
%End
virtual void finished( bool result );

};
Expand Down
3 changes: 0 additions & 3 deletions python/gui/symbology-ng/characterwidget.sip
View file
Expand Up @@ -28,9 +28,6 @@ class CharacterWidget : QWidget
%End

QSize sizeHint() const;
%Docstring
:rtype: QSize
%End

int columns() const;
%Docstring
Expand Down

0 comments on commit 6a72c94

Please sign in to comment.