Skip to content
Permalink
Browse files

Remove redundant (and outdated) docstrings from overriden members

  • Loading branch information
nyalldawson committed Sep 13, 2016
1 parent ae9023f commit 3223150db69e8ff498c30b94c2c8647492b660ec
@@ -40,16 +40,9 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer
*/
static QgsSymbolLayer* create( const QgsStringMap& properties = QgsStringMap() );

/** Virtual constructor */
virtual QgsArrowSymbolLayer* clone() const override;

/** Get the sub symbol used for filling */
virtual QgsSymbol* subSymbol() override { return mSymbol.data(); }

/** Set the sub symbol used for filling. Takes ownership. */
virtual bool setSubSymbol( QgsSymbol* symbol ) override;

/** Return a list of attributes required to render this feature */
virtual QSet<QString> usedAttributes() const override;

/** Get current arrow width */
@@ -140,28 +133,11 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer
/** Set the arrow type */
void setArrowType( ArrowType type ) { mArrowType = type; }

/**
* Should be reimplemented by subclasses to return a string map that
* contains the configuration information for the symbol layer. This
* is used to serialize a symbol layer perstistently.
*/
QgsStringMap properties() const override;

/**
* Returns a string that represents this layer type. Used for serialization.
* Should match with the string used to register this symbol layer in the registry.
*/
QString layerType() const override;

/** Prepare the rendering */
void startRender( QgsSymbolRenderContext& context ) override;

/** End of the rendering */
void stopRender( QgsSymbolRenderContext& context ) override;

/** Main drawing method */
void renderPolyline( const QPolygonF& points, QgsSymbolRenderContext& context ) override;

void setColor( const QColor& c ) override;
virtual QColor color() const override;

@@ -82,30 +82,16 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer

virtual ~QgsCategorizedSymbolRenderer();

//! @note available in python as symbolForFeature2
virtual QgsSymbol* symbolForFeature( QgsFeature& feature, QgsRenderContext& context ) override;

//! @note available in python as originalSymbolForFeature2
virtual QgsSymbol* originalSymbolForFeature( QgsFeature& feature, QgsRenderContext& context ) override;

virtual void startRender( QgsRenderContext& context, const QgsFields& fields ) override;

virtual void stopRender( QgsRenderContext& context ) override;

virtual QList<QString> usedAttributes() override;

virtual QString dump() const override;

virtual QgsCategorizedSymbolRenderer* clone() const override;

virtual void toSld( QDomDocument& doc, QDomElement &element, QgsStringMap props = QgsStringMap() ) const override;

//! returns bitwise OR-ed capabilities of the renderer
virtual Capabilities capabilities() override { return SymbolLevels | RotationField | Filter; }

virtual QString filter( const QgsFields& fields = QgsFields() ) override;

//! @note available in python as symbols2
virtual QgsSymbolList symbols( QgsRenderContext& context ) override;

/** Update all the symbols but leave categories and colors. This method also sets the source
@@ -147,19 +133,10 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer
//! create renderer from XML element
static QgsFeatureRenderer* create( QDomElement& element );

//! store renderer info to XML element
virtual QDomElement save( QDomDocument& doc ) override;

//! return a list of symbology items for the legend
virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize ) override;

//! return a list of item text / symbol
//! @note not available in python bindings
virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString& rule = QString() ) override;

//! @note added in 2.10
QgsLegendSymbolListV2 legendSymbolItemsV2() const override;

virtual QSet< QString > legendKeysForFeature( QgsFeature& feature, QgsRenderContext& context ) override;

/** Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying
@@ -207,22 +184,10 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer
void setScaleMethod( QgsSymbol::ScaleMethod scaleMethod );
QgsSymbol::ScaleMethod scaleMethod() const { return mScaleMethod; }

//! items of symbology items in legend should be checkable
//! @note added in 2.5
virtual bool legendSymbolItemsCheckable() const override;

//! item in symbology was checked
// @note added in 2.5
virtual bool legendSymbolItemChecked( const QString& key ) override;

virtual void setLegendSymbolItem( const QString& key, QgsSymbol* symbol ) override;

//! item in symbology was checked
// @note added in 2.5
virtual void checkLegendSymbolItem( const QString& key, bool state = true ) override;

//! If supported by the renderer, return classification attribute for the use in legend
//! @note added in 2.6
virtual QString legendClassificationAttribute() const override { return classAttribute(); }

//! creates a QgsCategorizedSymbolRenderer from an existing renderer.
@@ -340,36 +340,15 @@ class CORE_EXPORT QgsCptCityBrowserModel : public QAbstractItemModel
~QgsCptCityBrowserModel();

// implemented methods from QAbstractItemModel for read-only access

/** Used by other components to obtain information about each item provided by the model.
In many models, the combination of flags should include Qt::ItemIsEnabled and Qt::ItemIsSelectable. */
virtual Qt::ItemFlags flags( const QModelIndex &index ) const override;

/** Used to supply item data to views and delegates. Generally, models only need to supply data
for Qt::DisplayRole and any application-specific user roles, but it is also good practice
to provide data for Qt::ToolTipRole, Qt::AccessibleTextRole, and Qt::AccessibleDescriptionRole.
See the Qt::ItemDataRole enum documentation for information about the types associated with each role. */
virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;

/** Provides views with information to show in their headers. The information is only retrieved
by views that can display header information. */
virtual QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;

/** Provides the number of rows of data exposed by the model. */
virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const override;

/** Provides the number of columns of data exposed by the model. List models do not provide this function
because it is already implemented in QAbstractListModel. */
virtual int columnCount( const QModelIndex &parent = QModelIndex() ) const override;

/** Returns the index of the item in the model specified by the given row, column and parent index. */
virtual QModelIndex index( int row, int column, const QModelIndex & parent = QModelIndex() ) const override;

QModelIndex findItem( QgsCptCityDataItem *item, QgsCptCityDataItem *parent = nullptr ) const;

/** Returns the parent of the model item with the given index.
* If the item has no parent, an invalid QModelIndex is returned.
*/
virtual QModelIndex parent( const QModelIndex &index ) const override;

/** Returns a list of mime that can describe model indexes */
@@ -73,18 +73,9 @@ class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer
QColor borderColor() const { return mBorderColor; }
void setBorderColor( const QColor& borderColor ) { mBorderColor = borderColor; }

/** Get outline color.
* @note added in 2.1 */
QColor outlineColor() const override { return borderColor(); }
/** Set outline color.
* @note added in 2.1 */
void setOutlineColor( const QColor& color ) override { setBorderColor( color ); }

/** Get fill color.
* @note added in 2.1 */
QColor fillColor() const override { return color(); }
/** Set fill color.
* @note added in 2.1 */
void setFillColor( const QColor& color ) override { setColor( color ); }

Qt::PenStyle borderStyle() const { return mBorderStyle; }
@@ -136,27 +136,15 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer

virtual ~QgsGraduatedSymbolRenderer();

//! @note labelForLowerUpper in python bindings
virtual QgsSymbol* symbolForFeature( QgsFeature& feature, QgsRenderContext &context ) override;
//! @note originalSymbolForFeature2 in python bindings
virtual QgsSymbol* originalSymbolForFeature( QgsFeature& feature, QgsRenderContext &context ) override;

virtual void startRender( QgsRenderContext& context, const QgsFields& fields ) override;

virtual void stopRender( QgsRenderContext& context ) override;

virtual QList<QString> usedAttributes() override;

virtual QString dump() const override;

virtual QgsGraduatedSymbolRenderer* clone() const override;

virtual void toSld( QDomDocument& doc, QDomElement &element, QgsStringMap props = QgsStringMap() ) const override;

//! returns bitwise OR-ed capabilities of the renderer
virtual Capabilities capabilities() override { return SymbolLevels | RotationField | Filter; }

//! @note symbol2 in python bindings
virtual QgsSymbolList symbols( QgsRenderContext &context ) override;

QString classAttribute() const { return mAttrName; }
@@ -265,19 +253,10 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer
//! create renderer from XML element
static QgsFeatureRenderer* create( QDomElement& element );

//! store renderer info to XML element
virtual QDomElement save( QDomDocument& doc ) override;

//! return a list of symbology items for the legend
virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize ) override;

//! return a list of item text / symbol
//! @note not available in python bindings
virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString& rule = QString() ) override;

//! @note added in 2.10
QgsLegendSymbolListV2 legendSymbolItemsV2() const override;

virtual QSet< QString > legendKeysForFeature( QgsFeature& feature, QgsRenderContext& context ) override;

/** Returns the renderer's source symbol, which is the base symbol used for the each classes' symbol before applying
@@ -353,22 +332,10 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer
void setScaleMethod( QgsSymbol::ScaleMethod scaleMethod );
QgsSymbol::ScaleMethod scaleMethod() const { return mScaleMethod; }

//! items of symbology items in legend should be checkable
//! @note added in 2.5
virtual bool legendSymbolItemsCheckable() const override;

//! item in symbology was checked
//! @note added in 2.6
virtual bool legendSymbolItemChecked( const QString& key ) override;

//! item in symbology was checked
//! @note added in 2.6
virtual void checkLegendSymbolItem( const QString& key, bool state = true ) override;

virtual void setLegendSymbolItem( const QString& key, QgsSymbol* symbol ) override;

//! If supported by the renderer, return classification attribute for the use in legend
//! @note added in 2.6
virtual QString legendClassificationAttribute() const override { return classAttribute(); }

//! creates a QgsGraduatedSymbolRenderer from an existing renderer.
@@ -48,9 +48,7 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer

virtual ~QgsInvertedPolygonRenderer();

/** Used to clone this feature renderer.*/
virtual QgsInvertedPolygonRenderer* clone() const override;

virtual void startRender( QgsRenderContext& context, const QgsFields& fields ) override;

/** Renders a given feature.
@@ -70,31 +68,25 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer
*/
virtual void stopRender( QgsRenderContext& context ) override;

/** @returns a textual representation of the renderer */
virtual QString dump() const override;

/** Proxy that will call this method on the embedded renderer. */
virtual QList<QString> usedAttributes() override;
/** Proxy that will call this method on the embedded renderer. */
virtual Capabilities capabilities() override;
/** Proxy that will call this method on the embedded renderer.
* @note available in python bindings as symbol2
*/
virtual QgsSymbolList symbols( QgsRenderContext& context ) override;
/** Proxy that will call this method on the embedded renderer.
* @note available in python bindings as symbolForFeature2
*/
virtual QgsSymbol* symbolForFeature( QgsFeature& feature, QgsRenderContext& context ) override;
/** Proxy that will call this method on the embedded renderer.
* @note available in python bindings as originalSymbolForFeature2
*/
virtual QgsSymbol* originalSymbolForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
/** Proxy that will call this method on the embedded renderer.
* @note available in python bindings as symbolsForFeature
*/
virtual QgsSymbolList symbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
/** Proxy that will call this method on the embedded renderer.
* @note available in python bindings as originalSymbolsForFeature2
*/
virtual QgsSymbolList originalSymbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;
/** Proxy that will call this method on the embedded renderer. */
@@ -104,17 +96,12 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer
*/
virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString& rule = "" ) override;
/** Proxy that will call this method on the embedded renderer.
* @note available in python bindings as willRenderFeature2
*/
virtual bool willRenderFeature( QgsFeature& feat, QgsRenderContext& context ) override;

/** Creates a renderer out of an XML, for loading*/
static QgsFeatureRenderer* create( QDomElement& element );

/** Creates an XML representation of the renderer. Used for saving purpose
* @param doc the XML document where to create the XML subtree
* @returns the created XML subtree
*/
virtual QDomElement save( QDomDocument& doc ) override;

void setEmbeddedRenderer( QgsFeatureRenderer* subRenderer ) override;
@@ -582,11 +582,7 @@ class CORE_EXPORT QgsFontMarkerSymbolLayer : public QgsMarkerSymbolLayer
QChar character() const { return mChr; }
void setCharacter( QChar ch ) { mChr = ch; }

/** Get outline color.
* @note added in 2.16 */
QColor outlineColor() const override { return mOutlineColor; }
/** Set outline color.
* @note added in 2.16 */
void setOutlineColor( const QColor& color ) override { mOutlineColor = color; }

/** Get outline width.
@@ -434,52 +434,20 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer

virtual QgsSymbolList symbols( QgsRenderContext& context ) override;

//! store renderer info to XML element
virtual QDomElement save( QDomDocument& doc ) override;

//! return a list of symbology items for the legend
virtual QgsLegendSymbologyList legendSymbologyItems( QSize iconSize ) override;

//! items of symbology items in legend should be checkable
//! @note added in 2.5
virtual bool legendSymbolItemsCheckable() const override;

//! items of symbology items in legend is checked
//! @note added in 2.5
virtual bool legendSymbolItemChecked( const QString& key ) override;

//! item in symbology was checked
//! @note added in 2.5
virtual void checkLegendSymbolItem( const QString& key, bool state = true ) override;

virtual void setLegendSymbolItem( const QString& key, QgsSymbol* symbol ) override;

//! return a list of item text / symbol
//! @note not available in python bindings
virtual QgsLegendSymbolList legendSymbolItems( double scaleDenominator = -1, const QString& rule = "" ) override;

//! Return a list of symbology items for the legend. Better choice than legendSymbolItems().
//! Default fallback implementation just uses legendSymbolItems() implementation
//! @note added in 2.6
virtual QgsLegendSymbolListV2 legendSymbolItemsV2() const override;

//! for debugging
virtual QString dump() const override;

//! return whether the renderer will render a feature or not.
//! Must be called between startRender() and stopRender() calls.
virtual bool willRenderFeature( QgsFeature& feat, QgsRenderContext& context ) override;

//! return list of symbols used for rendering the feature.
//! For renderers that do not support MoreSymbolsPerFeature it is more efficient
//! to use symbolForFeature()
virtual QgsSymbolList symbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;

virtual QgsSymbolList originalSymbolsForFeature( QgsFeature& feat, QgsRenderContext& context ) override;

virtual QSet<QString> legendKeysForFeature( QgsFeature& feature, QgsRenderContext& context ) override;

//! returns bitwise OR-ed capabilities of the renderer
virtual Capabilities capabilities() override { return MoreSymbolsPerFeature | Filter | ScaleDependent; }

/////

0 comments on commit 3223150

Please sign in to comment.
You can’t perform that action at this time.