Skip to content

Commit 2fab1b8

Browse files
nyalldawsonnyalldawson
committedOct 24, 2016
Fix doxygen warnings/missing docs
1 parent 2fb8695 commit 2fab1b8

File tree

7 files changed

+41
-10
lines changed

7 files changed

+41
-10
lines changed
 

‎src/analysis/vector/qgszonalstatistics.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,11 @@ class ANALYSIS_EXPORT QgsZonalStatistics
5252
};
5353
Q_DECLARE_FLAGS( Statistics, Statistic )
5454

55+
/**
56+
* Constructor for QgsZonalStatistics.
57+
*/
5558
QgsZonalStatistics( QgsVectorLayer* polygonLayer, const QString& rasterFile, const QString& attributePrefix = "", int rasterBand = 1,
56-
QgsZonalStatistics::Statistics stats = Statistics( Count | Sum | Mean ) );
59+
Statistics stats = Statistics( Count | Sum | Mean ) );
5760

5861
/** Starts the calculation
5962
@return 0 in case of success*/

‎src/core/qgsdataitem.h

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -186,13 +186,18 @@ class CORE_EXPORT QgsDataItem : public QObject
186186
};
187187
Q_DECLARE_FLAGS( Capabilities, Capability )
188188

189-
// This will _write_ selected crs in data source
190-
virtual bool setCrs( const QgsCoordinateReferenceSystem& crs )
191-
{ Q_UNUSED( crs ); return false; }
189+
/**
190+
* Writes the selected crs into data source. The original data source will be modified when calling this
191+
* method.
192+
*/
193+
virtual bool setCrs( const QgsCoordinateReferenceSystem& crs ) { Q_UNUSED( crs ); return false; }
192194

193195
// ### QGIS 3 - rename to capabilities()
194196
virtual Capabilities capabilities2() const { return mCapabilities; }
195197

198+
/**
199+
* Sets the capabilities for the data item.
200+
*/
196201
virtual void setCapabilities( Capabilities capabilities ) { mCapabilities = capabilities; }
197202

198203
// static methods
@@ -236,7 +241,12 @@ class CORE_EXPORT QgsDataItem : public QObject
236241

237242
protected:
238243
virtual void populate( const QVector<QgsDataItem*>& children );
244+
245+
/**
246+
* Refresh the items from a specified list of child items.
247+
*/
239248
virtual void refresh( const QVector<QgsDataItem *> &children );
249+
240250
/** The item is scheduled to be deleted. E.g. if deleteLater() is called when
241251
* item is in Populating state (createChildren() running in another thread),
242252
* the deferredDelete() returns true and item will be deleted once Populating finished.
@@ -555,8 +565,15 @@ class CORE_EXPORT QgsZipItem : public QgsDataCollectionItem
555565

556566
static QString vsiPrefix( const QString& uri ) { return qgsVsiPrefix( uri ); }
557567

568+
/**
569+
* Creates a new data item from the specified path.
570+
*/
558571
static QgsDataItem* itemFromPath( QgsDataItem* parent, const QString &path, const QString &name );
559-
//! @note available in python as itemFromFilePath
572+
573+
/**
574+
* Creates a new data item from the specified path.
575+
* @note available in python as itemFromFilePath
576+
*/
560577
static QgsDataItem* itemFromPath( QgsDataItem* parent, const QString& filePath, const QString& name, const QString& path );
561578

562579
static const QIcon &iconZip();

‎src/gui/qgsdialog.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ class GUI_EXPORT QgsDialog : public QDialog
3131
{
3232
Q_OBJECT
3333
public:
34+
35+
/**
36+
* Constructor for QgsDialog.
37+
*/
3438
QgsDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags,
3539
QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Close,
3640
Qt::Orientation orientation = Qt::Horizontal );

‎src/gui/qgsmaplayeractionregistry.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ class GUI_EXPORT QgsMapLayerAction : public QAction
4545

4646
//! Creates a map layer action which can run on any layer
4747
//! @note using AllActions as a target probably does not make a lot of sense. This default action was settled for API compatiblity reasons.
48-
QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayerAction::Targets targets = AllActions, const QIcon& icon = QIcon() );
48+
QgsMapLayerAction( const QString& name, QObject *parent, Targets targets = AllActions, const QIcon& icon = QIcon() );
4949

5050
//! Creates a map layer action which can run only on a specific layer
51-
QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayer* layer, QgsMapLayerAction::Targets targets = AllActions, const QIcon& icon = QIcon() );
51+
QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayer* layer, Targets targets = AllActions, const QIcon& icon = QIcon() );
5252

5353
//! Creates a map layer action which can run on a specific type of layer
54-
QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayer::LayerType layerType, QgsMapLayerAction::Targets targets = AllActions, const QIcon& icon = QIcon() );
54+
QgsMapLayerAction( const QString& name, QObject *parent, QgsMapLayer::LayerType layerType, Targets targets = AllActions, const QIcon& icon = QIcon() );
5555

5656
~QgsMapLayerAction();
5757

‎src/gui/qgsmaptoolidentify.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
123123
@param mode Identification mode. Can use Qgis default settings or a defined mode.
124124
@param layerType Only performs identification in a certain type of layers (raster, vector). Default value is AllLayers.
125125
@return a list of IdentifyResult*/
126-
QList<IdentifyResult> identify( int x, int y, IdentifyMode mode, QgsMapToolIdentify::LayerType layerType = AllLayers );
126+
QList<IdentifyResult> identify( int x, int y, IdentifyMode mode, LayerType layerType = AllLayers );
127127

128128
//! return a pointer to the identify menu which will be used in layer selection mode
129129
//! this menu can also be customized
@@ -147,7 +147,7 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool
147147
@param layerList Performs the identification within the given list of layers.
148148
@param layerType Only performs identification in a certain type of layers (raster, vector).
149149
@return a list of IdentifyResult*/
150-
QList<IdentifyResult> identify( int x, int y, IdentifyMode mode, const QList<QgsMapLayer*>& layerList, QgsMapToolIdentify::LayerType layerType = AllLayers );
150+
QList<IdentifyResult> identify( int x, int y, IdentifyMode mode, const QList<QgsMapLayer*>& layerList, LayerType layerType = AllLayers );
151151

152152
QgsIdentifyMenu* mIdentifyMenu;
153153

‎src/gui/symbology-ng/qgssvgselectorwidget.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,10 @@ class GUI_EXPORT QgsSvgSelectorDialog : public QDialog
276276
{
277277
Q_OBJECT
278278
public:
279+
280+
/**
281+
* Constructor for QgsSvgSelectorDialog.
282+
*/
279283
QgsSvgSelectorDialog( QWidget* parent = nullptr, Qt::WindowFlags fl = QgisGui::ModalDialogFlags,
280284
QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Close | QDialogButtonBox::Ok,
281285
Qt::Orientation orientation = Qt::Horizontal );

‎src/plugins/qgisplugin.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ class QgisPlugin
7373
};
7474

7575

76+
/**
77+
* Constructor for QgisPlugin
78+
*/
7679
QgisPlugin( QString const & name = "",
7780
QString const & description = "",
7881
QString const & category = "",

0 commit comments

Comments
 (0)