Remove "//! Destructor" doxygen comments

This documentation doesn't add any value
qgis · Dec 30, 2016 · 9021bb4 · 9021bb4
1 parent 8319dac
commit 9021bb4
Show file tree

Hide file tree

Showing 119 changed files with 102 additions and 160 deletions.
diff --git a/src/analysis/interpolation/Bezier3D.h b/src/analysis/interpolation/Bezier3D.h
@@ -31,7 +31,7 @@ class ANALYSIS_EXPORT Bezier3D: public ParametricLine
     Bezier3D();
     //! Constructor, par is a pointer to the parent, controlpoly a controlpolygon
     Bezier3D( ParametricLine* par, QVector<Point3D*>* controlpoly );
-    //! Destructor
+
     virtual ~Bezier3D();
     //! Do not use this method, since a Bezier curve does not consist of other curves
     virtual void add( ParametricLine *pl ) override;

diff --git a/src/analysis/interpolation/CloughTocherInterpolator.h b/src/analysis/interpolation/CloughTocherInterpolator.h
@@ -81,7 +81,6 @@ class ANALYSIS_EXPORT CloughTocherInterpolator : public TriangleInterpolator
     CloughTocherInterpolator();
     //! Constructor with a pointer to the triangulation as argument
     CloughTocherInterpolator( NormVecDecorator* tin );
-    //! Destructor
     virtual ~CloughTocherInterpolator();
     //! Calculates the normal vector and assigns it to vec (not implemented at the moment)
     virtual bool calcNormVec( double x, double y, Vector3D* result ) override;

diff --git a/src/analysis/interpolation/LinTriangleInterpolator.h b/src/analysis/interpolation/LinTriangleInterpolator.h
@@ -29,7 +29,6 @@ class ANALYSIS_EXPORT LinTriangleInterpolator : public TriangleInterpolator
     LinTriangleInterpolator();
     //! Constructor with reference to a DualEdgeTriangulation object
     LinTriangleInterpolator( DualEdgeTriangulation* tin );
-    //! Destructor
     virtual ~LinTriangleInterpolator();
     //! Calculates the normal vector and assigns it to vec
     virtual bool calcNormVec( double x, double y, Vector3D* result ) override;

diff --git a/src/analysis/interpolation/ParametricLine.h b/src/analysis/interpolation/ParametricLine.h
@@ -41,7 +41,6 @@ class ANALYSIS_EXPORT ParametricLine
     /** Constructor, par is a pointer to the parent object, controlpoly the controlpolygon
       */
     ParametricLine( ParametricLine* par, QVector<Point3D*>* controlpoly );
-    //! Destructor
     virtual ~ParametricLine();
     virtual void add( ParametricLine* pl ) = 0;
     virtual void calcFirstDer( float t, Vector3D* v ) = 0;

diff --git a/src/analysis/interpolation/Vector3D.h b/src/analysis/interpolation/Vector3D.h
@@ -42,7 +42,7 @@ class ANALYSIS_EXPORT Vector3D
     Vector3D();
     //! Copy constructor
     Vector3D( const Vector3D& v );
-    //! Destructor
+
     ~Vector3D();
     Vector3D& operator=( const Vector3D& v );
     bool operator==( const Vector3D& v ) const;

diff --git a/src/analysis/network/qgsgraphbuilderinterface.h b/src/analysis/network/qgsgraphbuilderinterface.h
@@ -50,7 +50,6 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface
       mDa.setEllipsoidalMode( ctfEnabled );
     }
 
-    //! Destructor
     virtual ~QgsGraphBuilderInterface()
     { }
 

diff --git a/src/analysis/network/qgsgraphdirector.h b/src/analysis/network/qgsgraphdirector.h
@@ -40,7 +40,7 @@ class ANALYSIS_EXPORT QgsGraphDirector : public QObject
     void buildMessage( const QString& ) const;
 
   public:
-    //! Destructor
+
     virtual ~QgsGraphDirector() { }
 
     /**

diff --git a/src/analysis/network/qgsvectorlayerdirector.h b/src/analysis/network/qgsvectorlayerdirector.h
@@ -64,7 +64,6 @@ class ANALYSIS_EXPORT QgsVectorLayerDirector : public QgsGraphDirector
                             const Direction defaultDirection
                           );
 
-    //! Destructor
     virtual ~QgsVectorLayerDirector();
 
     /*

diff --git a/src/app/ogr/qgsnewogrconnection.h b/src/app/ogr/qgsnewogrconnection.h
@@ -32,7 +32,7 @@ class QgsNewOgrConnection : public QDialog, private Ui::QgsNewOgrConnectionBase
   public:
     //! Constructor
     QgsNewOgrConnection( QWidget *parent = nullptr, const QString& connType = QString::null, const QString& connName = QString::null, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
-    //! Destructor
+
     ~QgsNewOgrConnection();
     //! Tests the connection using the parameters supplied
     void testConnection();

diff --git a/src/app/pluginmanager/qgsapppluginmanagerinterface.h b/src/app/pluginmanager/qgsapppluginmanagerinterface.h
@@ -34,7 +34,6 @@ class QgsAppPluginManagerInterface : public QgsPluginManagerInterface
     //! Constructor
     explicit QgsAppPluginManagerInterface( QgsPluginManager * pluginManager );
 
-    //! Destructor
     ~QgsAppPluginManagerInterface();
 
     //! remove python plugins from the metadata registry (c++ plugins stay)

diff --git a/src/app/pluginmanager/qgspluginmanager.h b/src/app/pluginmanager/qgspluginmanager.h
@@ -50,7 +50,6 @@ class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManag
     //! Constructor; set pluginsAreEnabled to false in --noplugins mode
     QgsPluginManager( QWidget *parent = nullptr, bool pluginsAreEnabled = true, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
 
-    //! Destructor
     ~QgsPluginManager();
 
     //! Save pointer to python utils and enable Python support

diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h
@@ -151,7 +151,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
     QgisApp( QSplashScreen *splash, bool restorePlugins = true, bool skipVersionCheck = false, QWidget *parent = nullptr, Qt::WindowFlags fl = Qt::Window );
     //! Constructor for unit tests
     QgisApp();
-    //! Destructor
+
     ~QgisApp();
 
     /**

diff --git a/src/app/qgsclipboard.h b/src/app/qgsclipboard.h
@@ -67,7 +67,6 @@ class APP_EXPORT QgsClipboard : public QObject
      */
     QgsClipboard();
 
-    //! Destructor
     virtual ~QgsClipboard();
 
     /**

diff --git a/src/app/qgsdecorationcopyright.h b/src/app/qgsdecorationcopyright.h
@@ -36,7 +36,7 @@ class APP_EXPORT QgsDecorationCopyright : public QgsDecorationItem
 
     //! Constructor
     QgsDecorationCopyright( QObject* parent = nullptr );
-    //! Destructor
+
     virtual ~QgsDecorationCopyright();
 
   public slots:

diff --git a/src/app/qgsdecorationgrid.h b/src/app/qgsdecorationgrid.h
@@ -35,7 +35,7 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem
   public:
     //! Constructor
     QgsDecorationGrid( QObject* parent = nullptr );
-    //! Destructor
+
     virtual ~ QgsDecorationGrid();
 
     enum GridStyle

diff --git a/src/app/qgsdecorationitem.h b/src/app/qgsdecorationitem.h
@@ -41,7 +41,7 @@ class APP_EXPORT QgsDecorationItem: public QObject
 
     //! Constructor
     QgsDecorationItem( QObject* parent = nullptr );
-    //! Destructor
+
     virtual ~ QgsDecorationItem();
 
     void setEnabled( bool enabled ) { mEnabled = enabled; }

diff --git a/src/app/qgsdecorationnortharrow.h b/src/app/qgsdecorationnortharrow.h
@@ -34,7 +34,7 @@ class APP_EXPORT QgsDecorationNorthArrow: public QgsDecorationItem
   public:
     //! Constructor
     QgsDecorationNorthArrow( QObject* parent = nullptr );
-    //! Destructor
+
     virtual ~QgsDecorationNorthArrow();
 
   public slots:

diff --git a/src/app/qgsdecorationscalebar.h b/src/app/qgsdecorationscalebar.h
@@ -34,7 +34,7 @@ class APP_EXPORT QgsDecorationScaleBar: public QgsDecorationItem
   public:
     //! Constructor
     QgsDecorationScaleBar( QObject* parent = nullptr );
-    //! Destructor
+
     virtual ~ QgsDecorationScaleBar();
 
   public slots:

diff --git a/src/app/qgsoptions.cpp b/src/app/qgsoptions.cpp
@@ -929,7 +929,7 @@ QgsOptions::QgsOptions( QWidget *parent, Qt::WindowFlags fl )
   restoreOptionsBaseUi();
 }
 
-//! Destructor
+
 QgsOptions::~QgsOptions()
 {
   delete mSettings;

diff --git a/src/app/qgsoptions.h b/src/app/qgsoptions.h
@@ -46,7 +46,7 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
      * @param modal true for modal dialog
      */
     QgsOptions( QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
-    //! Destructor
+
     ~QgsOptions();
 
     /** Sets the page with the specified widget name as the current page

diff --git a/src/app/qgsprojectproperties.h b/src/app/qgsprojectproperties.h
@@ -43,7 +43,7 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
     //! Constructor
     QgsProjectProperties( QgsMapCanvas* mapCanvas, QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags );
 
-    //! Destructor
+
     ~QgsProjectProperties();
 
     /** Gets the currently select map units

diff --git a/src/app/qgsrasterlayerproperties.h b/src/app/qgsrasterlayerproperties.h
@@ -48,7 +48,7 @@ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private
      * @param ml Map layer for which properties will be displayed
      */
     QgsRasterLayerProperties( QgsMapLayer *lyr, QgsMapCanvas* theCanvas, QWidget *parent = nullptr, Qt::WindowFlags = QgisGui::ModalDialogFlags );
-    //! \brief Destructor
+
     ~QgsRasterLayerProperties();
 
     //! Synchronize state with associated raster layer

diff --git a/src/app/qgssnappingwidget.h b/src/app/qgssnappingwidget.h
@@ -55,7 +55,7 @@ class APP_EXPORT QgsSnappingWidget : public QWidget
      */
     QgsSnappingWidget( QgsProject* project, QgsMapCanvas* canvas, QWidget* parent = nullptr );
 
-    //! Destructor
+
     virtual ~QgsSnappingWidget();
 
     /**

diff --git a/src/app/qgsstatusbarmagnifierwidget.h b/src/app/qgsstatusbarmagnifierwidget.h
@@ -40,7 +40,7 @@ class APP_EXPORT QgsStatusBarMagnifierWidget : public QWidget
       */
     QgsStatusBarMagnifierWidget( QWidget* parent = nullptr );
 
-    //! Destructor
+
     virtual ~QgsStatusBarMagnifierWidget();
 
     void setDefaultFactor( double factor );

diff --git a/src/app/qgsstatusbarscalewidget.h b/src/app/qgsstatusbarscalewidget.h
@@ -39,7 +39,7 @@ class APP_EXPORT QgsStatusBarScaleWidget : public QWidget
   public:
     explicit QgsStatusBarScaleWidget( QgsMapCanvas* canvas, QWidget *parent = 0 );
 
-    //! Destructor
+
     virtual ~QgsStatusBarScaleWidget();
 
     /**

diff --git a/src/app/qgstipfactory.h b/src/app/qgstipfactory.h
@@ -33,7 +33,7 @@ class APP_EXPORT QgsTipFactory : public QObject
   public:
     //! Constructor
     QgsTipFactory();
-    //! Destructor
+
     ~QgsTipFactory();
 
     /** Get a random tip (generic or gui-centric)

diff --git a/src/core/composer/qgscomposernodesitem.h b/src/core/composer/qgscomposernodesitem.h
@@ -45,7 +45,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem
      */
     QgsComposerNodesItem( const QString &mTagName, const QPolygonF &polygon, QgsComposition* c );
 
-    //! Destructor
+
     ~QgsComposerNodesItem();
 
     /** Add a node in current shape.

diff --git a/src/core/composer/qgscomposerpolygon.h b/src/core/composer/qgscomposerpolygon.h
@@ -45,7 +45,7 @@ class CORE_EXPORT QgsComposerPolygon: public QgsComposerNodesItem
      */
     QgsComposerPolygon( const QPolygonF &polygon, QgsComposition* c );
 
-    //! Destructor
+
     ~QgsComposerPolygon();
 
     //! Overridden to return shape name

diff --git a/src/core/composer/qgscomposerpolyline.h b/src/core/composer/qgscomposerpolyline.h
@@ -44,7 +44,7 @@ class CORE_EXPORT QgsComposerPolyline: public QgsComposerNodesItem
      */
     QgsComposerPolyline( const QPolygonF &polyline, QgsComposition* c );
 
-    //! Destructor
+
     ~QgsComposerPolyline();
 
     //! Overridden to return shape name

diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -95,7 +95,7 @@ class CORE_EXPORT QgsGeometry
      */
     explicit QgsGeometry( QgsAbstractGeometry* geom );
 
-    //! Destructor
+
     ~QgsGeometry();
 
     /** Returns the underlying geometry store.

diff --git a/src/core/qgsattributeeditorelement.h b/src/core/qgsattributeeditorelement.h
@@ -56,7 +56,7 @@ class CORE_EXPORT QgsAttributeEditorElement
         , mShowLabel( true )
     {}
 
-    //! Destructor
+
     virtual ~QgsAttributeEditorElement() {}
 
     /**
@@ -155,7 +155,7 @@ class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement
         , mColumnCount( 1 )
     {}
 
-    //! Destructor
+
     virtual ~QgsAttributeEditorContainer();
 
     /**
@@ -269,7 +269,7 @@ class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement
         , mIdx( idx )
     {}
 
-    //! Destructor
+
     virtual ~QgsAttributeEditorField() {}
 
     /**
@@ -322,7 +322,7 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
         , mShowUnlinkButton( true )
     {}
 
-    //! Destructor
+
     virtual ~QgsAttributeEditorRelation() {}
 
     /**

diff --git a/src/core/qgscontexthelp.h b/src/core/qgscontexthelp.h
@@ -45,7 +45,7 @@ class CORE_EXPORT QgsContextHelp : public QObject
   private:
     //! Constructor
     QgsContextHelp();
-    //! Destructor
+
     ~QgsContextHelp();
 
     QProcess *start();

diff --git a/src/core/qgscredentials.h b/src/core/qgscredentials.h
@@ -37,7 +37,7 @@
 class CORE_EXPORT QgsCredentials
 {
   public:
-    //! virtual destructor
+
     virtual ~QgsCredentials();
 
     bool get( const QString& realm, QString &username, QString &password, const QString& message = QString::null );

diff --git a/src/core/qgsdistancearea.h b/src/core/qgsdistancearea.h
@@ -41,7 +41,7 @@ class CORE_EXPORT QgsDistanceArea
     //! Constructor
     QgsDistanceArea();
 
-    //! Destructor
+
     ~QgsDistanceArea();
 
     //! Copy constructor

diff --git a/src/core/qgsfeature.h b/src/core/qgsfeature.h
@@ -172,7 +172,7 @@ class CORE_EXPORT QgsFeature
     bool operator!=( const QgsFeature& other ) const;
 
 
-    //! Destructor
+
     virtual ~QgsFeature();
 
     /** Get the feature ID for this feature.

diff --git a/src/core/qgsfeaturefilterprovider.h b/src/core/qgsfeaturefilterprovider.h
@@ -40,7 +40,7 @@ class CORE_EXPORT QgsFeatureFilterProvider
     //! Constructor
     QgsFeatureFilterProvider() {}
 
-    //! Destructor
+
     virtual ~QgsFeatureFilterProvider() {}
 
     /** Add additional filters to the feature request to further restrict the features returned by the request.

diff --git a/src/core/qgsfield.h b/src/core/qgsfield.h
@@ -89,7 +89,7 @@ class CORE_EXPORT QgsField
      */
     QgsField& operator =( const QgsField &other );
 
-    //! Destructor
+
     virtual ~QgsField();
 
     bool operator==( const QgsField& other ) const;

diff --git a/src/core/qgslabelingengine.h b/src/core/qgslabelingengine.h
@@ -43,7 +43,7 @@ class CORE_EXPORT QgsAbstractLabelProvider
   public:
     //! Construct the provider with default values
     QgsAbstractLabelProvider( const QString& layerId = QString(), const QString& providerId = QString() );
-    //! Vritual destructor
+
     virtual ~QgsAbstractLabelProvider() {}
 
     //! Associate provider with a labeling engine (should be only called internally from QgsLabelingEngine)

diff --git a/src/core/qgsmessageoutput.h b/src/core/qgsmessageoutput.h
@@ -42,7 +42,6 @@ class CORE_EXPORT QgsMessageOutput
     //! message can be in plain text or in html format
     enum MessageType { MessageText, MessageHtml };
 
-    //! virtual destructor
     virtual ~QgsMessageOutput();
 
     //! set message, it won't be displayed until

diff --git a/src/core/qgsnetworkaccessmanager.h b/src/core/qgsnetworkaccessmanager.h
@@ -52,7 +52,7 @@ class CORE_EXPORT QgsNetworkAccessManager : public QNetworkAccessManager
 
     QgsNetworkAccessManager( QObject *parent = nullptr );
 
-    //! destructor
+
     ~QgsNetworkAccessManager();
 
     //! insert a factory into the proxy factories list

diff --git a/src/core/qgsowsconnection.h b/src/core/qgsowsconnection.h
@@ -43,7 +43,7 @@ class CORE_EXPORT QgsOwsConnection : public QObject
      */
     QgsOwsConnection( const QString & theService, const QString & theConnName );
 
-    //! Destructor
+
     ~QgsOwsConnection();
 
     //! Returns the list of connections for the specified service

diff --git a/src/core/qgsrectangle.h b/src/core/qgsrectangle.h
@@ -43,7 +43,7 @@ class CORE_EXPORT QgsRectangle
     QgsRectangle( const QRectF & qRectF );
     //! Copy constructor
     QgsRectangle( const QgsRectangle &other );
-    //! Destructor
+
     ~QgsRectangle();
     //! Set the rectangle from two QgsPoints. The rectangle is
     //! normalised after construction.