Fix doxygen warnings/missing docs

qgis · Oct 24, 2016 · 2fab1b8 · 2fab1b8
1 parent 2fb8695
commit 2fab1b8
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 10 deletions.
diff --git a/src/analysis/vector/qgszonalstatistics.h b/src/analysis/vector/qgszonalstatistics.h
@@ -52,8 +52,11 @@ class ANALYSIS_EXPORT QgsZonalStatistics
     };
     Q_DECLARE_FLAGS( Statistics, Statistic )
 
+    /**
+     * Constructor for QgsZonalStatistics.
+     */
     QgsZonalStatistics( QgsVectorLayer* polygonLayer, const QString& rasterFile, const QString& attributePrefix = "", int rasterBand = 1,
-                        QgsZonalStatistics::Statistics stats = Statistics( Count | Sum | Mean ) );
+                        Statistics stats = Statistics( Count | Sum | Mean ) );
 
     /** Starts the calculation
       @return 0 in case of success*/

diff --git a/src/core/qgsdataitem.h b/src/core/qgsdataitem.h
@@ -186,13 +186,18 @@ class CORE_EXPORT QgsDataItem : public QObject
     };
     Q_DECLARE_FLAGS( Capabilities, Capability )
 
-    // This will _write_ selected crs in data source
-    virtual bool setCrs( const QgsCoordinateReferenceSystem& crs )
-    { Q_UNUSED( crs ); return false; }
+    /**
+     * Writes the selected crs into data source. The original data source will be modified when calling this
+     * method.
+     */
+    virtual bool setCrs( const QgsCoordinateReferenceSystem& crs ) { Q_UNUSED( crs ); return false; }
 
     // ### QGIS 3 - rename to capabilities()
     virtual Capabilities capabilities2() const { return mCapabilities; }
 
+    /**
+     * Sets the capabilities for the data item.
+     */
     virtual void setCapabilities( Capabilities capabilities ) { mCapabilities = capabilities; }
 
     // static methods
@@ -236,7 +241,12 @@ class CORE_EXPORT QgsDataItem : public QObject
 
   protected:
     virtual void populate( const QVector<QgsDataItem*>& children );
+
+    /**
+     * Refresh the items from a specified list of child items.
+     */
     virtual void refresh( const QVector<QgsDataItem *> &children );
+
     /** The item is scheduled to be deleted. E.g. if deleteLater() is called when
      * item is in Populating state (createChildren() running in another thread),
      * the deferredDelete() returns true and item will be deleted once Populating finished.
@@ -555,8 +565,15 @@ class CORE_EXPORT QgsZipItem : public QgsDataCollectionItem
 
     static QString vsiPrefix( const QString& uri ) { return qgsVsiPrefix( uri ); }
 
+    /**
+     * Creates a new data item from the specified path.
+     */
     static QgsDataItem* itemFromPath( QgsDataItem* parent, const QString &path, const QString &name );
-    //! @note available in python as itemFromFilePath
+
+    /**
+    * Creates a new data item from the specified path.
+    * @note available in python as itemFromFilePath
+    */
     static QgsDataItem* itemFromPath( QgsDataItem* parent, const QString& filePath, const QString& name, const QString& path );
 
     static const QIcon &iconZip();

diff --git a/src/gui/qgsdialog.h b/src/gui/qgsdialog.h
@@ -31,6 +31,10 @@ class GUI_EXPORT QgsDialog : public QDialog
 {
     Q_OBJECT
   public:
+
+    /**
+     * Constructor for QgsDialog.
+     */
     QgsDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags,
                QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Close,
                Qt::Orientation orientation = Qt::Horizontal );

diff --git a/src/gui/qgsmaplayeractionregistry.h b/src/gui/qgsmaplayeractionregistry.h
@@ -45,13 +45,13 @@ class GUI_EXPORT QgsMapLayerAction : public QAction
 
     //! Creates a map layer action which can run on any layer
     //! @note using AllActions as a target probably does not make a lot of sense. This default action was settled for API compatiblity reasons.
-    QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayerAction::Targets targets = AllActions, const QIcon& icon = QIcon() );
+    QgsMapLayerAction( const QString& name, QObject *parent, Targets targets = AllActions, const QIcon& icon = QIcon() );
 
     //! Creates a map layer action which can run only on a specific layer
-    QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayer* layer, QgsMapLayerAction::Targets targets = AllActions, const QIcon& icon = QIcon() );
+    QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayer* layer, Targets targets = AllActions, const QIcon& icon = QIcon() );
 
     //! Creates a map layer action which can run on a specific type of layer
-    QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayer::LayerType layerType, QgsMapLayerAction::Targets targets = AllActions, const QIcon& icon = QIcon() );
+    QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayer::LayerType layerType, Targets targets = AllActions, const QIcon& icon = QIcon() );
 
     ~QgsMapLayerAction();
 

diff --git a/src/gui/qgsmaptoolidentify.h b/src/gui/qgsmaptoolidentify.h
@@ -123,7 +123,7 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
     @param mode Identification mode. Can use Qgis default settings or a defined mode.
     @param layerType Only performs identification in a certain type of layers (raster, vector). Default value is AllLayers.
     @return a list of IdentifyResult*/
-    QList<IdentifyResult> identify( int x, int y, IdentifyMode mode, QgsMapToolIdentify::LayerType layerType = AllLayers );
+    QList<IdentifyResult> identify( int x, int y, IdentifyMode mode, LayerType layerType = AllLayers );
 
     //! return a pointer to the identify menu which will be used in layer selection mode
     //! this menu can also be customized
@@ -147,7 +147,7 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
     @param layerList Performs the identification within the given list of layers.
     @param layerType Only performs identification in a certain type of layers (raster, vector).
     @return a list of IdentifyResult*/
-    QList<IdentifyResult> identify( int x, int y, IdentifyMode mode,  const QList<QgsMapLayer*>& layerList, QgsMapToolIdentify::LayerType layerType = AllLayers );
+    QList<IdentifyResult> identify( int x, int y, IdentifyMode mode,  const QList<QgsMapLayer*>& layerList, LayerType layerType = AllLayers );
 
     QgsIdentifyMenu* mIdentifyMenu;
 

diff --git a/src/gui/symbology-ng/qgssvgselectorwidget.h b/src/gui/symbology-ng/qgssvgselectorwidget.h
@@ -276,6 +276,10 @@ class GUI_EXPORT QgsSvgSelectorDialog : public QDialog
 {
     Q_OBJECT
   public:
+
+    /**
+     * Constructor for QgsSvgSelectorDialog.
+     */
     QgsSvgSelectorDialog( QWidget* parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags,
                           QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Close | QDialogButtonBox::Ok,
                           Qt::Orientation orientation = Qt::Horizontal );

diff --git a/src/plugins/qgisplugin.h b/src/plugins/qgisplugin.h
@@ -73,6 +73,9 @@ class QgisPlugin
     };
 
 
+    /**
+     * Constructor for QgisPlugin
+     */
     QgisPlugin( QString const & name = "",
                 QString const & description = "",
                 QString const & category = "",