Skip to content
Permalink
Browse files

Remove some doxygen comments from overridden methods (pt 2)

  • Loading branch information
nyalldawson committed Dec 31, 2016
1 parent 46a69df commit 5b36dfcfb24307fce12e87d9511770c9d5c8b664
@@ -60,7 +60,6 @@ class CORE_EXPORT QgsTopologyPreservingSimplifier : public QgsAbstractGeometrySi
*/
QgsTopologyPreservingSimplifier( double tolerance );

//! Returns a simplified version the specified geometry
virtual QgsGeometry simplify( const QgsGeometry& geometry ) const override;

protected:
@@ -65,7 +65,7 @@ class GUI_EXPORT QgsAuthServersEditor : public QWidget, private Ui::QgsAuthServe
void authMessageOut( const QString& message, const QString& authtag, QgsAuthManager::MessageLevel level );

protected:
//! Overridden show event of base widget

void showEvent( QShowEvent *e ) override;

private:
@@ -205,7 +205,6 @@ class GUI_EXPORT QgsAuthSslConfigDialog : public QDialog
QgsAuthSslConfigWidget *sslCustomConfigWidget() { return mSslConfigWdgt; }

public slots:
//! Overridden base dialog accept slot
void accept() override;

private slots:
@@ -89,7 +89,6 @@ class GUI_EXPORT QgsAuthSslImportDialog : public QDialog, private Ui::QgsAuthSsl
~QgsAuthSslImportDialog();

public slots:
//! Overridden slot of base dialog
void accept() override;

private slots:
@@ -65,7 +65,7 @@ class GUI_EXPORT QgsAuthTrustedCAsDialog : public QDialog, private Ui::QgsAuthTr
void authMessageOut( const QString& message, const QString& authtag, QgsAuthManager::MessageLevel level );

protected:
//! Overridden widget show event

void showEvent( QShowEvent *e ) override;

private:
@@ -32,7 +32,7 @@ class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit
public:
explicit QgsDateTimeEdit( QWidget *parent = nullptr );

//! determines if the widget allows setting null date/time.
//! Determines if the widget allows setting null date/time.
void setAllowNull( bool allowNull );
bool allowNull() const {return mAllowNull;}

@@ -48,8 +48,10 @@ class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit
*/
QDateTime dateTime() const;

//! Set the current date as NULL
//! @note if the widget is not configured to accept NULL dates, this will have no effect
/**
* Set the current date as NULL
* @note if the widget is not configured to accept NULL dates, this will have no effect
*/
virtual void clear() override;

/** Resets the widget to show no value (ie, an "unknown" state).
@@ -259,7 +259,6 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private
*/
QgsMapMouseEvent::SnappingMode snappingMode() { return mSnappingMode; }

//! key press event on the dock
void keyPressEvent( QKeyEvent* e ) override;

//! determines if CAD tools are enabled or if map tools behaves "nomally"
@@ -71,17 +71,10 @@ class GUI_EXPORT QgsAnnotationItem: public QgsMapCanvasItem, public QgsAnnotatio

virtual void setMapPosition( const QgsPoint& pos );
QgsPoint mapPosition() const override { return mMapPosition; }

virtual QPointF relativePosition() const override;

virtual double scaleFactor() const override;

virtual bool showItem() const override { return isVisible(); }

/** Sets the CRS of the map position.
@param crs the CRS to set */
virtual void setMapPositionCrs( const QgsCoordinateReferenceSystem& crs );
//! Returns the CRS of the map position.
QgsCoordinateReferenceSystem mapPositionCrs() const override { return mMapPositionCrs; }

void setFrameSize( QSizeF size );
@@ -34,15 +34,11 @@ class GUI_EXPORT QgsFormAnnotationItem: public QObject, public QgsAnnotationItem
~QgsFormAnnotationItem();

void paint( QPainter * painter ) override;

//! paint function called by map canvas
void paint( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = nullptr ) override;

QSizeF minimumFrameSize() const override;
//! Returns the optimal frame size
QSizeF preferredFrameSize() const;

//! Reimplemented from QgsAnnotationItem
void setMapPosition( const QgsPoint& pos ) override;

void setDesignerForm( const QString& uiFile );
@@ -36,13 +36,10 @@ class GUI_EXPORT QgsHtmlAnnotationItem: public QObject, public QgsAnnotationItem
~QgsHtmlAnnotationItem();

void paint( QPainter * painter ) override;

//! paint function called by map canvas
void paint( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = nullptr ) override;

QSizeF minimumFrameSize() const override;

//! Reimplemented from QgsAnnotationItem
void setMapPosition( const QgsPoint& pos ) override;

void setHTMLPage( const QString& htmlFile );
@@ -39,7 +39,6 @@ class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem
//! function to be implemented by derived classes
virtual void paint( QPainter * painter ) = 0;

//! paint function called by map canvas
virtual void paint( QPainter * painter,
const QStyleOptionGraphicsItem * option,
QWidget * widget = nullptr ) override;
@@ -58,7 +57,6 @@ class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem
//! called on changed extent or resize event to update position of the item
virtual void updatePosition();

//! default implementation for canvas items
virtual QRectF boundingRect() const override;

//! returns canvas item rectangle in map units
@@ -53,11 +53,11 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit

~QgsMapToolAdvancedDigitizing();

//! catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method
//! Catch the mouse press event, filters it, transforms it to map coordinates and send it to virtual method
virtual void canvasPressEvent( QgsMapMouseEvent* e ) override;
//! catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method
//! Catch the mouse release event, filters it, transforms it to map coordinates and send it to virtual method
virtual void canvasReleaseEvent( QgsMapMouseEvent* e ) override;
//! catch the mouse move event, filters it, transforms it to map coordinates and send it to virtual method
//! Catch the mouse move event, filters it, transforms it to map coordinates and send it to virtual method
virtual void canvasMoveEvent( QgsMapMouseEvent* e ) override;

/**
@@ -40,13 +40,9 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing
//! constructor
QgsMapToolCapture( QgsMapCanvas* canvas, QgsAdvancedDigitizingDockWidget* cadDockWidget, CaptureMode mode = CaptureNone );


virtual ~QgsMapToolCapture();

//! active the tool
virtual void activate() override;

//! deactive the tool
virtual void deactivate() override;

//! Adds a whole curve (e.g. circularstring) to the captured geometry. Curve must be in map CRS
@@ -59,12 +55,6 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing
*/
const QgsCompoundCurve* captureCurve() const { return &mCaptureCurve; }


/**
* Update the rubberband according to mouse position
*
* @param e The mouse event
*/
virtual void cadCanvasMoveEvent( QgsMapMouseEvent * e ) override;

/**
@@ -34,14 +34,8 @@ class GUI_EXPORT QgsMapToolEmitPoint : public QgsMapTool
QgsMapToolEmitPoint( QgsMapCanvas* canvas );

virtual Flags flags() const override { return QgsMapTool::AllowZoomRect; }

//! Overridden mouse move event
virtual void canvasMoveEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse press event - emits the signal
virtual void canvasPressEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse release event
virtual void canvasReleaseEvent( QgsMapMouseEvent* e ) override;

signals:
@@ -93,18 +93,10 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
virtual ~QgsMapToolIdentify();

virtual Flags flags() const override { return QgsMapTool::AllowZoomRect; }

//! Overridden mouse move event
virtual void canvasMoveEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse press event
virtual void canvasPressEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse release event
virtual void canvasReleaseEvent( QgsMapMouseEvent* e ) override;

virtual void activate() override;

virtual void deactivate() override;

/** Performs the identification.
@@ -33,14 +33,8 @@ class GUI_EXPORT QgsMapToolPan : public QgsMapTool
QgsMapToolPan( QgsMapCanvas* canvas );

virtual Flags flags() const override { return QgsMapTool::Transient | QgsMapTool::AllowZoomRect; }

//! Mouse press event
virtual void canvasPressEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse move event
virtual void canvasMoveEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse release event
virtual void canvasReleaseEvent( QgsMapMouseEvent* e ) override;

private:
@@ -38,14 +38,8 @@ class GUI_EXPORT QgsMapToolTouch : public QgsMapTool

void activate() override;
void deactivate() override;

//! Overridden mouse move event
virtual void canvasMoveEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse release event
virtual void canvasReleaseEvent( QgsMapMouseEvent* e ) override;

//! Overridden Mouse double click event.
virtual void canvasDoubleClickEvent( QgsMapMouseEvent* e ) override;

virtual Flags flags() const override { return QgsMapTool::Transient | QgsMapTool::AllowZoomRect; }
@@ -32,20 +32,12 @@ class GUI_EXPORT QgsMapToolZoom : public QgsMapTool
public:
//! constructor
QgsMapToolZoom( QgsMapCanvas* canvas, bool zoomOut );

~QgsMapToolZoom();

virtual Flags flags() const override { return QgsMapTool::Transient; }

//! Overridden mouse move event
virtual void canvasMoveEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse press event
virtual void canvasPressEvent( QgsMapMouseEvent* e ) override;

//! Overridden mouse release event
virtual void canvasReleaseEvent( QgsMapMouseEvent* e ) override;

virtual void deactivate() override;

protected:
@@ -36,7 +36,7 @@ class GUI_EXPORT QgsNewHttpConnection : public QDialog, private Ui::QgsNewHttpCo

~QgsNewHttpConnection();
public slots:
//! Saves the connection to ~/.qt/qgisrc
// Saves the connection to ~/.qt/qgisrc
void accept() override;

void on_txtName_textChanged( const QString & );
@@ -108,10 +108,10 @@ class GUI_EXPORT QgsProjectionSelector : public QWidget, private Ui::QgsProjecti
void pushProjectionToFront();

protected:
//! Used to ensure the projection list view is actually populated
// Used to ensure the projection list view is actually populated
void showEvent( QShowEvent * theEvent ) override;

//! Used to manage column sizes
// Used to manage column sizes
void resizeEvent( QResizeEvent * theEvent ) override;

private:
@@ -44,7 +44,7 @@ class GUI_EXPORT QgsUserInputDockWidget : public QgsDockWidget
void addUserInputWidget( QWidget* widget );

protected:
//! will not display the dock if it contains no widget
// will not display the dock if it contains no widget
void paintEvent( QPaintEvent *event ) override;

private slots:
@@ -40,9 +40,7 @@ class GUI_EXPORT QgsArrowSymbolLayerWidget: public QgsSymbolLayerWidget, private
*/
static QgsSymbolLayerWidget* create( const QgsVectorLayer* layer ) { return new QgsArrowSymbolLayerWidget( layer ); }

//! Set the symbol layer
virtual void setSymbolLayer( QgsSymbolLayer* layer ) override;
//! Get the current symbol layer
virtual QgsSymbolLayer* symbolLayer() override;

private:
@@ -44,9 +44,7 @@ class GUI_EXPORT QgsHeatmapRendererWidget : public QgsRendererWidget, private Ui
*/
QgsHeatmapRendererWidget( QgsVectorLayer* layer, QgsStyle* style, QgsFeatureRenderer* renderer );

//! @returns the current feature renderer
virtual QgsFeatureRenderer* renderer() override;

virtual void setContext( const QgsSymbolWidgetContext& context ) override;

private:
@@ -46,7 +46,6 @@ class GUI_EXPORT QgsInvertedPolygonRendererWidget : public QgsRendererWidget, pr
*/
QgsInvertedPolygonRendererWidget( QgsVectorLayer* layer, QgsStyle* style, QgsFeatureRenderer* renderer );

//! @returns the current feature renderer
virtual QgsFeatureRenderer* renderer() override;

void setContext( const QgsSymbolWidgetContext& context ) override;
@@ -132,7 +132,7 @@ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRe
*/
void connectValueChanged( const QList<QWidget *> &widgets, const char *slot );

//! Reimplements dialog keyPress event so we can ignore it
// Reimplements dialog keyPress event so we can ignore it
void keyPressEvent( QKeyEvent * event ) override;

QgsVectorLayer* mLayer;
@@ -55,9 +55,7 @@ class GUI_EXPORT QgsRuleBasedRendererModel : public QAbstractItemModel
int role = Qt::DisplayRole ) const override;
virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
virtual int columnCount( const QModelIndex & = QModelIndex() ) const override;
//! provide model index for parent's child item
virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
//! provide parent model index
virtual QModelIndex parent( const QModelIndex &index ) const override;

// editing support
@@ -274,7 +274,7 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog
QgsSymbol* symbol();

protected:
//! Reimplements dialog keyPress event so we can ignore it
// Reimplements dialog keyPress event so we can ignore it
void keyPressEvent( QKeyEvent * e ) override;

void loadSymbol();

0 comments on commit 5b36dfc

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