From d9952b63175cb63b56b4a695c1079206f69f0eb5 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Thu, 5 Oct 2017 10:20:06 +1000 Subject: [PATCH 1/4] Initialize pointers to nullptr in headers --- src/3d/chunks/qgschunkboundsentity_p.cpp | 4 +- src/3d/chunks/qgschunkboundsentity_p.h | 2 +- src/3d/chunks/qgschunkedentity_p.h | 8 ++-- src/3d/chunks/qgschunklist_p.h | 4 +- src/3d/chunks/qgschunkqueuejob_p.h | 2 +- src/3d/qgs3dmapscene.h | 8 ++-- src/3d/qgscameracontroller.h | 42 +++++++++---------- src/3d/qgstessellatedpolygongeometry.h | 6 +-- src/3d/symbols/qgsline3dsymbol_p.h | 2 +- src/3d/symbols/qgspolygon3dsymbol_p.h | 2 +- src/3d/terrain/qgsdemterraintileloader_p.cpp | 2 +- src/3d/terrain/qgsdemterraintileloader_p.h | 4 +- src/3d/terrain/qgsflatterraingenerator.cpp | 2 +- src/3d/terrain/qgsterrainentity_p.cpp | 2 +- src/3d/terrain/qgsterrainentity_p.h | 8 ++-- src/3d/terrain/qgsterraintexturegenerator_p.h | 2 +- src/3d/terrain/qgsterraintileloader_p.cpp | 2 +- src/3d/terrain/qgsterraintileloader_p.h | 2 +- src/3d/terrain/quantizedmeshgeometry.h | 10 ++--- .../terrain/quantizedmeshterraingenerator.cpp | 4 +- src/app/3d/qgs3dmapcanvas.h | 8 ++-- src/app/3d/qgs3dmapcanvasdockwidget.h | 4 +- src/app/3d/qgs3dmapconfigwidget.h | 4 +- src/app/3d/qgsvectorlayer3drendererwidget.cpp | 2 +- src/app/3d/qgsvectorlayer3drendererwidget.h | 12 +++--- src/app/composer/qgscomposermanager.h | 2 +- src/app/layout/qgslayoutdesignerdialog.h | 2 +- src/app/nodetool/qgsnodetool.cpp | 4 +- src/app/nodetool/qgsnodetool.h | 2 +- src/app/qgsmapsavedialog.cpp | 4 +- src/app/qgsmapsavedialog.h | 2 +- src/core/expression/qgsexpressionfunction.cpp | 2 +- src/core/processing/qgsprocessingcontext.h | 2 +- src/core/processing/qgsprocessingparameters.h | 2 +- src/core/qgscadutils.h | 2 +- src/core/qgsfeaturesink.h | 2 +- src/gui/qgscurveeditorwidget.h | 2 +- src/gui/qgsdatasourcemanagerdialog.h | 2 +- src/gui/qgsmetadatawidget.cpp | 2 +- .../qgsdatadefinedsizelegendwidget.h | 10 ++--- src/gui/symbology/qgssymbollevelsdialog.h | 2 +- .../geonode/qgsgeonodesourceselect.cpp | 6 +-- src/providers/ogr/qgsgeopackagedataitems.cpp | 4 +- src/providers/ogr/qgsogrdataitems.cpp | 2 +- src/providers/oracle/ocispatial/wkbptr.h | 6 +-- .../postgres/qgspostgreslistener.cpp | 2 +- src/server/qgsserver.h | 2 +- src/server/services/wms/qgswmsrenderer.cpp | 2 +- 48 files changed, 108 insertions(+), 108 deletions(-) diff --git a/src/3d/chunks/qgschunkboundsentity_p.cpp b/src/3d/chunks/qgschunkboundsentity_p.cpp index ff6afe1cf531..78cf6ccaadc1 100644 --- a/src/3d/chunks/qgschunkboundsentity_p.cpp +++ b/src/3d/chunks/qgschunkboundsentity_p.cpp @@ -39,8 +39,8 @@ class LineMeshGeometry : public Qt3DRender::QGeometry void setVertices( QList vertices ); private: - Qt3DRender::QAttribute *mPositionAttribute; - Qt3DRender::QBuffer *mVertexBuffer; + Qt3DRender::QAttribute *mPositionAttribute = nullptr; + Qt3DRender::QBuffer *mVertexBuffer = nullptr; QList mVertices; }; diff --git a/src/3d/chunks/qgschunkboundsentity_p.h b/src/3d/chunks/qgschunkboundsentity_p.h index c46e3010d511..850443685155 100644 --- a/src/3d/chunks/qgschunkboundsentity_p.h +++ b/src/3d/chunks/qgschunkboundsentity_p.h @@ -47,7 +47,7 @@ class QgsChunkBoundsEntity : public Qt3DCore::QEntity void setBoxes( const QList &bboxes ); private: - AABBMesh *mAabbMesh; + AABBMesh *mAabbMesh = nullptr; }; /// @endcond diff --git a/src/3d/chunks/qgschunkedentity_p.h b/src/3d/chunks/qgschunkedentity_p.h index f52b8a5dfba4..6068de5304b5 100644 --- a/src/3d/chunks/qgschunkedentity_p.h +++ b/src/3d/chunks/qgschunkedentity_p.h @@ -100,7 +100,7 @@ class QgsChunkedEntity : public Qt3DCore::QEntity protected: //! root node of the quadtree hierarchy - QgsChunkNode *mRootNode; + QgsChunkNode *mRootNode = nullptr; //! A chunk has been loaded recently? let's display it! bool mNeedsUpdate; //! max. allowed screen space error @@ -108,11 +108,11 @@ class QgsChunkedEntity : public Qt3DCore::QEntity //! maximum allowed depth of quad tree int mMaxLevel; //! factory that creates loaders for individual chunk nodes - QgsChunkLoaderFactory *mChunkLoaderFactory; + QgsChunkLoaderFactory *mChunkLoaderFactory = nullptr; //! queue of chunks to be loaded - QgsChunkList *mChunkLoaderQueue; + QgsChunkList *mChunkLoaderQueue = nullptr; //! queue of chunk to be eventually replaced - QgsChunkList *mReplacementQueue; + QgsChunkList *mReplacementQueue = nullptr; //! list of nodes that are being currently used for rendering QList mActiveNodes; //! number of nodes omitted during frustum culling - for the curious ones diff --git a/src/3d/chunks/qgschunklist_p.h b/src/3d/chunks/qgschunklist_p.h index 81f2a3da552a..c6bd6d2f9440 100644 --- a/src/3d/chunks/qgschunklist_p.h +++ b/src/3d/chunks/qgschunklist_p.h @@ -93,8 +93,8 @@ class QgsChunkList void insertLast( QgsChunkListEntry *entry ); private: - QgsChunkListEntry *mHead; - QgsChunkListEntry *mTail; + QgsChunkListEntry *mHead = nullptr; + QgsChunkListEntry *mTail = nullptr; int mCount; }; diff --git a/src/3d/chunks/qgschunkqueuejob_p.h b/src/3d/chunks/qgschunkqueuejob_p.h index aa817f72606f..191b1973b4c7 100644 --- a/src/3d/chunks/qgschunkqueuejob_p.h +++ b/src/3d/chunks/qgschunkqueuejob_p.h @@ -71,7 +71,7 @@ class QgsChunkQueueJob : public QObject void finished(); protected: - QgsChunkNode *mNode; + QgsChunkNode *mNode = nullptr; }; /** \ingroup 3d diff --git a/src/3d/qgs3dmapscene.h b/src/3d/qgs3dmapscene.h index 6f791fd1da49..c58694d7fca5 100644 --- a/src/3d/qgs3dmapscene.h +++ b/src/3d/qgs3dmapscene.h @@ -77,11 +77,11 @@ class _3D_EXPORT Qgs3DMapScene : public Qt3DCore::QEntity private: const Qgs3DMapSettings &mMap; //! Provides a way to have a synchronous function executed each frame - Qt3DLogic::QFrameAction *mFrameAction; - QgsCameraController *mCameraController; - QgsTerrainEntity *mTerrain; + Qt3DLogic::QFrameAction *mFrameAction = nullptr; + QgsCameraController *mCameraController = nullptr; + QgsTerrainEntity *mTerrain = nullptr; //! Forward renderer provided by 3D window - Qt3DExtras::QForwardRenderer *mForwardRenderer; + Qt3DExtras::QForwardRenderer *mForwardRenderer = nullptr; QList mChunkEntities; //! Keeps track of entities that belong to a particular layer QMap mLayerEntities; diff --git a/src/3d/qgscameracontroller.h b/src/3d/qgscameracontroller.h index 972fca612548..7ca2d50b1e27 100644 --- a/src/3d/qgscameracontroller.h +++ b/src/3d/qgscameracontroller.h @@ -69,7 +69,7 @@ class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity private: //! Camera that is being controlled - Qt3DRender::QCamera *mCamera; + Qt3DRender::QCamera *mCamera = nullptr; //! used for computation of translation when dragging mouse QRect mViewport; //! height of terrain when mouse button was last pressed - for camera control @@ -114,37 +114,37 @@ class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity QPoint mLastMousePos; //! Delegates mouse events to the attached MouseHandler objects - Qt3DInput::QMouseDevice *mMouseDevice; + Qt3DInput::QMouseDevice *mMouseDevice = nullptr; - Qt3DInput::QKeyboardDevice *mKeyboardDevice; + Qt3DInput::QKeyboardDevice *mKeyboardDevice = nullptr; - Qt3DInput::QMouseHandler *mMouseHandler; + Qt3DInput::QMouseHandler *mMouseHandler = nullptr; //! Allows us to define a set of actions that we wish to use //! (it is a component that can be attached to 3D scene) - Qt3DInput::QLogicalDevice *mLogicalDevice; + Qt3DInput::QLogicalDevice *mLogicalDevice = nullptr; - Qt3DInput::QAction *mLeftMouseButtonAction; - Qt3DInput::QActionInput *mLeftMouseButtonInput; + Qt3DInput::QAction *mLeftMouseButtonAction = nullptr; + Qt3DInput::QActionInput *mLeftMouseButtonInput = nullptr; - Qt3DInput::QAction *mMiddleMouseButtonAction; - Qt3DInput::QActionInput *mMiddleMouseButtonInput; + Qt3DInput::QAction *mMiddleMouseButtonAction = nullptr; + Qt3DInput::QActionInput *mMiddleMouseButtonInput = nullptr; - Qt3DInput::QAction *mRightMouseButtonAction; - Qt3DInput::QActionInput *mRightMouseButtonInput; + Qt3DInput::QAction *mRightMouseButtonAction = nullptr; + Qt3DInput::QActionInput *mRightMouseButtonInput = nullptr; - Qt3DInput::QAction *mShiftAction; - Qt3DInput::QActionInput *mShiftInput; + Qt3DInput::QAction *mShiftAction = nullptr; + Qt3DInput::QActionInput *mShiftInput = nullptr; - Qt3DInput::QAxis *mWheelAxis; - Qt3DInput::QAnalogAxisInput *mMouseWheelInput; + Qt3DInput::QAxis *mWheelAxis = nullptr; + Qt3DInput::QAnalogAxisInput *mMouseWheelInput = nullptr; - Qt3DInput::QAxis *mTxAxis; - Qt3DInput::QAxis *mTyAxis; - Qt3DInput::QButtonAxisInput *mKeyboardTxPosInput; - Qt3DInput::QButtonAxisInput *mKeyboardTyPosInput; - Qt3DInput::QButtonAxisInput *mKeyboardTxNegInput; - Qt3DInput::QButtonAxisInput *mKeyboardTyNegInput; + Qt3DInput::QAxis *mTxAxis = nullptr; + Qt3DInput::QAxis *mTyAxis = nullptr; + Qt3DInput::QButtonAxisInput *mKeyboardTxPosInput = nullptr; + Qt3DInput::QButtonAxisInput *mKeyboardTyPosInput = nullptr; + Qt3DInput::QButtonAxisInput *mKeyboardTxNegInput = nullptr; + Qt3DInput::QButtonAxisInput *mKeyboardTyNegInput = nullptr; }; #endif // QGSCAMERACONTROLLER_H diff --git a/src/3d/qgstessellatedpolygongeometry.h b/src/3d/qgstessellatedpolygongeometry.h index b6146c0e5a6e..f810ad016d93 100644 --- a/src/3d/qgstessellatedpolygongeometry.h +++ b/src/3d/qgstessellatedpolygongeometry.h @@ -46,9 +46,9 @@ class QgsTessellatedPolygonGeometry : public Qt3DRender::QGeometry private: QList mPolygons; - Qt3DRender::QAttribute *mPositionAttribute; - Qt3DRender::QAttribute *mNormalAttribute; - Qt3DRender::QBuffer *mVertexBuffer; + Qt3DRender::QAttribute *mPositionAttribute = nullptr; + Qt3DRender::QAttribute *mNormalAttribute = nullptr; + Qt3DRender::QBuffer *mVertexBuffer = nullptr; bool mWithNormals; }; diff --git a/src/3d/symbols/qgsline3dsymbol_p.h b/src/3d/symbols/qgsline3dsymbol_p.h index 71ce39730a36..e68ae0cde247 100644 --- a/src/3d/symbols/qgsline3dsymbol_p.h +++ b/src/3d/symbols/qgsline3dsymbol_p.h @@ -60,7 +60,7 @@ class QgsLine3DSymbolEntityNode : public Qt3DCore::QEntity private: Qt3DRender::QGeometryRenderer *renderer( const Qgs3DMapSettings &map, const QgsLine3DSymbol &symbol, const QgsVectorLayer *layer, const QgsFeatureRequest &req ); - QgsTessellatedPolygonGeometry *mGeometry; + QgsTessellatedPolygonGeometry *mGeometry = nullptr; }; /// @endcond diff --git a/src/3d/symbols/qgspolygon3dsymbol_p.h b/src/3d/symbols/qgspolygon3dsymbol_p.h index 5b3d50d56298..47dec1d1e60b 100644 --- a/src/3d/symbols/qgspolygon3dsymbol_p.h +++ b/src/3d/symbols/qgspolygon3dsymbol_p.h @@ -61,7 +61,7 @@ class QgsPolygon3DSymbolEntityNode : public Qt3DCore::QEntity private: Qt3DRender::QGeometryRenderer *renderer( const Qgs3DMapSettings &map, const QgsPolygon3DSymbol &symbol, const QgsVectorLayer *layer, const QgsFeatureRequest &request ); - QgsTessellatedPolygonGeometry *mGeometry; + QgsTessellatedPolygonGeometry *mGeometry = nullptr; }; /// @endcond diff --git a/src/3d/terrain/qgsdemterraintileloader_p.cpp b/src/3d/terrain/qgsdemterraintileloader_p.cpp index b9a53a155dcb..aca91ba4ffd1 100644 --- a/src/3d/terrain/qgsdemterraintileloader_p.cpp +++ b/src/3d/terrain/qgsdemterraintileloader_p.cpp @@ -76,7 +76,7 @@ Qt3DCore::QEntity *QgsDemTerrainTileLoader::createEntity( Qt3DCore::QEntity *par // create transform - Qt3DCore::QTransform *transform; + Qt3DCore::QTransform *transform = nullptr; transform = new Qt3DCore::QTransform(); entity->addComponent( transform ); diff --git a/src/3d/terrain/qgsdemterraintileloader_p.h b/src/3d/terrain/qgsdemterraintileloader_p.h index fc68d1e6a03d..bcc82606a38d 100644 --- a/src/3d/terrain/qgsdemterraintileloader_p.h +++ b/src/3d/terrain/qgsdemterraintileloader_p.h @@ -98,10 +98,10 @@ class QgsDemHeightMapGenerator : public QObject private: //! raster used to build terrain - QgsRasterLayer *mDtm; + QgsRasterLayer *mDtm = nullptr; //! cloned provider to be used in worker thread - QgsRasterDataProvider *mClonedProvider; + QgsRasterDataProvider *mClonedProvider = nullptr; QgsTilingScheme mTilingScheme; diff --git a/src/3d/terrain/qgsflatterraingenerator.cpp b/src/3d/terrain/qgsflatterraingenerator.cpp index da27be71726b..5823dc0192df 100644 --- a/src/3d/terrain/qgsflatterraingenerator.cpp +++ b/src/3d/terrain/qgsflatterraingenerator.cpp @@ -71,7 +71,7 @@ Qt3DCore::QEntity *FlatTerrainChunkLoader::createEntity( Qt3DCore::QEntity *pare // create transform - Qt3DCore::QTransform *transform; + Qt3DCore::QTransform *transform = nullptr; transform = new Qt3DCore::QTransform(); entity->addComponent( transform ); diff --git a/src/3d/terrain/qgsterrainentity_p.cpp b/src/3d/terrain/qgsterrainentity_p.cpp index 921c0865d78c..7d356b1ef28e 100644 --- a/src/3d/terrain/qgsterrainentity_p.cpp +++ b/src/3d/terrain/qgsterrainentity_p.cpp @@ -45,7 +45,7 @@ class TerrainMapUpdateJobFactory : public QgsChunkQueueJobFactory } private: - QgsTerrainTextureGenerator *mTextureGenerator; + QgsTerrainTextureGenerator *mTextureGenerator = nullptr; }; diff --git a/src/3d/terrain/qgsterrainentity_p.h b/src/3d/terrain/qgsterrainentity_p.h index 7e07e6c3bf09..dadec21d6574 100644 --- a/src/3d/terrain/qgsterrainentity_p.h +++ b/src/3d/terrain/qgsterrainentity_p.h @@ -79,9 +79,9 @@ class QgsTerrainEntity : public QgsChunkedEntity const Qgs3DMapSettings &mMap; //! picker of terrain to know height of terrain when dragging - Qt3DRender::QObjectPicker *mTerrainPicker; - QgsTerrainTextureGenerator *mTextureGenerator; - QgsCoordinateTransform *mTerrainToMapTransform; + Qt3DRender::QObjectPicker *mTerrainPicker = nullptr; + QgsTerrainTextureGenerator *mTextureGenerator = nullptr; + QgsCoordinateTransform *mTerrainToMapTransform = nullptr; std::unique_ptr mUpdateJobFactory; @@ -104,7 +104,7 @@ class TerrainMapUpdateJob : public QgsChunkQueueJob void onTileReady( int jobId, const QImage &image ); private: - QgsTerrainTextureGenerator *mTextureGenerator; + QgsTerrainTextureGenerator *mTextureGenerator = nullptr; int mJobId; }; diff --git a/src/3d/terrain/qgsterraintexturegenerator_p.h b/src/3d/terrain/qgsterraintexturegenerator_p.h index 721296dbb6fb..e94e06a56d77 100644 --- a/src/3d/terrain/qgsterraintexturegenerator_p.h +++ b/src/3d/terrain/qgsterraintexturegenerator_p.h @@ -80,7 +80,7 @@ class QgsTerrainTextureGenerator : public QObject struct JobData { int jobId; - QgsMapRendererSequentialJob *job; + QgsMapRendererSequentialJob *job = nullptr; QgsRectangle extent; QString debugText; }; diff --git a/src/3d/terrain/qgsterraintileloader_p.cpp b/src/3d/terrain/qgsterraintileloader_p.cpp index cd97eb23abea..f4a1f0a34794 100644 --- a/src/3d/terrain/qgsterraintileloader_p.cpp +++ b/src/3d/terrain/qgsterraintileloader_p.cpp @@ -74,7 +74,7 @@ void QgsTerrainTileLoader::createTextureComponent( QgsTerrainTileEntity *entity texture->addTextureImage( textureImage ); texture->setMinificationFilter( Qt3DRender::QTexture2D::Linear ); texture->setMagnificationFilter( Qt3DRender::QTexture2D::Linear ); - Qt3DExtras::QTextureMaterial *material; + Qt3DExtras::QTextureMaterial *material = nullptr; #if QT_VERSION >= 0x050900 material = new Qt3DExtras::QTextureMaterial; material->setTexture( texture ); diff --git a/src/3d/terrain/qgsterraintileloader_p.h b/src/3d/terrain/qgsterraintileloader_p.h index 2c5e26b930e9..68d6609f1ecc 100644 --- a/src/3d/terrain/qgsterraintileloader_p.h +++ b/src/3d/terrain/qgsterraintileloader_p.h @@ -59,7 +59,7 @@ class QgsTerrainTileLoader : public QgsChunkLoader void onImageReady( int jobId, const QImage &image ); private: - QgsTerrainEntity *mTerrain; + QgsTerrainEntity *mTerrain = nullptr; QgsRectangle mExtentMapCrs; QString mTileDebugText; int mTextureJobId; diff --git a/src/3d/terrain/quantizedmeshgeometry.h b/src/3d/terrain/quantizedmeshgeometry.h index 641b89daf066..adbe3db29108 100644 --- a/src/3d/terrain/quantizedmeshgeometry.h +++ b/src/3d/terrain/quantizedmeshgeometry.h @@ -70,11 +70,11 @@ class QuantizedMeshGeometry : public Qt3DRender::QGeometry static void downloadTileIfMissing( int tx, int ty, int tz ); private: - Qt3DRender::QBuffer *mVertexBuffer; - Qt3DRender::QBuffer *mIndexBuffer; - Qt3DRender::QAttribute *mPositionAttribute; - Qt3DRender::QAttribute *mTexCoordAttribute; - Qt3DRender::QAttribute *mIndexAttribute; + Qt3DRender::QBuffer *mVertexBuffer = nullptr; + Qt3DRender::QBuffer *mIndexBuffer = nullptr; + Qt3DRender::QAttribute *mPositionAttribute = nullptr; + Qt3DRender::QAttribute *mTexCoordAttribute = nullptr; + Qt3DRender::QAttribute *mIndexAttribute = nullptr; }; #endif // QUANTIZEDMESHGEOMETRY_H diff --git a/src/3d/terrain/quantizedmeshterraingenerator.cpp b/src/3d/terrain/quantizedmeshterraingenerator.cpp index fdfad06c971a..294649bb10b7 100644 --- a/src/3d/terrain/quantizedmeshterraingenerator.cpp +++ b/src/3d/terrain/quantizedmeshterraingenerator.cpp @@ -59,7 +59,7 @@ class QuantizedMeshTerrainChunkLoader : public TerrainChunkLoader // create transform - Qt3DCore::QTransform *transform; + Qt3DCore::QTransform *transform = nullptr; transform = new Qt3DCore::QTransform(); entity->addComponent( transform ); @@ -83,7 +83,7 @@ class QuantizedMeshTerrainChunkLoader : public TerrainChunkLoader } protected: - QuantizedMeshTile *qmt; + QuantizedMeshTile *qmt = nullptr; QgsMapSettings mapSettings; int tx, ty, tz; QgsRectangle tileRect; diff --git a/src/app/3d/qgs3dmapcanvas.h b/src/app/3d/qgs3dmapcanvas.h index 8fd173977640..1e38ba9a3089 100644 --- a/src/app/3d/qgs3dmapcanvas.h +++ b/src/app/3d/qgs3dmapcanvas.h @@ -47,13 +47,13 @@ class Qgs3DMapCanvas : public QWidget private: //! 3D window with all the 3D magic inside - Qt3DExtras::Qt3DWindow *mWindow3D; + Qt3DExtras::Qt3DWindow *mWindow3D = nullptr; //! Container QWidget that encapsulates mWindow3D so we can use it embedded in ordinary widgets app - QWidget *mContainer; + QWidget *mContainer = nullptr; //! Description of the 3D scene - Qgs3DMapSettings *mMap; + Qgs3DMapSettings *mMap = nullptr; //! Root entity of the 3D scene - Qgs3DMapScene *mScene; + Qgs3DMapScene *mScene = nullptr; }; #endif // QGS3DMAPCANVAS_H diff --git a/src/app/3d/qgs3dmapcanvasdockwidget.h b/src/app/3d/qgs3dmapcanvasdockwidget.h index a48b8496f33c..f99a0cce49dd 100644 --- a/src/app/3d/qgs3dmapcanvasdockwidget.h +++ b/src/app/3d/qgs3dmapcanvasdockwidget.h @@ -43,8 +43,8 @@ class Qgs3DMapCanvasDockWidget : public QgsDockWidget void onMainCanvasColorChanged(); private: - Qgs3DMapCanvas *mCanvas; - QgsMapCanvas *mMainCanvas; + Qgs3DMapCanvas *mCanvas = nullptr; + QgsMapCanvas *mMainCanvas = nullptr; }; #endif // QGS3DMAPCANVASDOCKWIDGET_H diff --git a/src/app/3d/qgs3dmapconfigwidget.h b/src/app/3d/qgs3dmapconfigwidget.h index 8deef3e79d22..88f07dae476a 100644 --- a/src/app/3d/qgs3dmapconfigwidget.h +++ b/src/app/3d/qgs3dmapconfigwidget.h @@ -42,8 +42,8 @@ class Qgs3DMapConfigWidget : public QWidget, private Ui::Map3DConfigWidget void updateMaxZoomLevel(); private: - Qgs3DMapSettings *mMap; - QgsMapCanvas *mMainCanvas; + Qgs3DMapSettings *mMap = nullptr; + QgsMapCanvas *mMainCanvas = nullptr; }; #endif // QGS3DMAPCONFIGWIDGET_H diff --git a/src/app/3d/qgsvectorlayer3drendererwidget.cpp b/src/app/3d/qgsvectorlayer3drendererwidget.cpp index bc89c5917b61..0823750cf71c 100644 --- a/src/app/3d/qgsvectorlayer3drendererwidget.cpp +++ b/src/app/3d/qgsvectorlayer3drendererwidget.cpp @@ -140,7 +140,7 @@ QgsVectorLayer3DRenderer *QgsVectorLayer3DRendererWidget::renderer() int pageIndex = widgetStack->currentIndex(); if ( pageIndex == 1 || pageIndex == 2 || pageIndex == 3 ) { - QgsAbstract3DSymbol *sym; + QgsAbstract3DSymbol *sym = nullptr; if ( pageIndex == 1 ) sym = new QgsLine3DSymbol( widgetLine->symbol() ); else if ( pageIndex == 2 ) diff --git a/src/app/3d/qgsvectorlayer3drendererwidget.h b/src/app/3d/qgsvectorlayer3drendererwidget.h index 27277fc2a384..271916ed04e1 100644 --- a/src/app/3d/qgsvectorlayer3drendererwidget.h +++ b/src/app/3d/qgsvectorlayer3drendererwidget.h @@ -54,12 +54,12 @@ class QgsVectorLayer3DRendererWidget : public QgsMapLayerConfigWidget void onEnabledClicked(); private: - QCheckBox *chkEnabled; - QStackedWidget *widgetStack; - QgsLine3DSymbolWidget *widgetLine; - QgsPoint3DSymbolWidget *widgetPoint; - QgsPolygon3DSymbolWidget *widgetPolygon; - QLabel *widgetUnsupported; + QCheckBox *chkEnabled = nullptr; + QStackedWidget *widgetStack = nullptr; + QgsLine3DSymbolWidget *widgetLine = nullptr; + QgsPoint3DSymbolWidget *widgetPoint = nullptr; + QgsPolygon3DSymbolWidget *widgetPolygon = nullptr; + QLabel *widgetUnsupported = nullptr; std::unique_ptr mRenderer; }; diff --git a/src/app/composer/qgscomposermanager.h b/src/app/composer/qgscomposermanager.h index 46bb38c923f2..c5f776c7ceb2 100644 --- a/src/app/composer/qgscomposermanager.h +++ b/src/app/composer/qgscomposermanager.h @@ -52,7 +52,7 @@ class QgsLayoutManagerModel : public QAbstractListModel void compositionRemoved( const QString &name ); void compositionRenamed( QgsComposition *composition, const QString &newName ); private: - QgsLayoutManager *mLayoutManager; + QgsLayoutManager *mLayoutManager = nullptr; }; /** A dialog that shows the existing composer instances. Lets the user add new diff --git a/src/app/layout/qgslayoutdesignerdialog.h b/src/app/layout/qgslayoutdesignerdialog.h index 14fa50f36aba..1767e4e12cde 100644 --- a/src/app/layout/qgslayoutdesignerdialog.h +++ b/src/app/layout/qgslayoutdesignerdialog.h @@ -198,7 +198,7 @@ class QgsLayoutDesignerDialog: public QMainWindow, private Ui::QgsLayoutDesigner QMap< QString, QToolButton * > mItemGroupToolButtons; QMap< QString, QMenu * > mItemGroupSubmenus; - QgsLayoutAppMenuProvider *mMenuProvider; + QgsLayoutAppMenuProvider *mMenuProvider = nullptr; QgsDockWidget *mItemDock = nullptr; QgsPanelWidgetStack *mItemPropertiesStack = nullptr; diff --git a/src/app/nodetool/qgsnodetool.cpp b/src/app/nodetool/qgsnodetool.cpp index c29ff93ed11f..c0f6555a8d13 100644 --- a/src/app/nodetool/qgsnodetool.cpp +++ b/src/app/nodetool/qgsnodetool.cpp @@ -152,7 +152,7 @@ class OneFeatureFilter : public QgsPointLocator::MatchFilter } private: - const QgsVectorLayer *layer; + const QgsVectorLayer *layer = nullptr; QgsFeatureId fid; }; @@ -162,7 +162,7 @@ class MatchCollectingFilter : public QgsPointLocator::MatchFilter { public: QList matches; - QgsNodeTool *nodetool; + QgsNodeTool *nodetool = nullptr; MatchCollectingFilter( QgsNodeTool *nodetool ) : nodetool( nodetool ) {} diff --git a/src/app/nodetool/qgsnodetool.h b/src/app/nodetool/qgsnodetool.h index c4b1bb37b532..f49f0fb75ce2 100644 --- a/src/app/nodetool/qgsnodetool.h +++ b/src/app/nodetool/qgsnodetool.h @@ -46,7 +46,7 @@ struct Vertex return !operator==( other ); } - QgsVectorLayer *layer; + QgsVectorLayer *layer = nullptr; QgsFeatureId fid; int vertexId; }; diff --git a/src/app/qgsmapsavedialog.cpp b/src/app/qgsmapsavedialog.cpp index cf32bbdc3451..34316c751a7d 100644 --- a/src/app/qgsmapsavedialog.cpp +++ b/src/app/qgsmapsavedialog.cpp @@ -322,8 +322,8 @@ void QgsMapSaveDialog::copyToClipboard() QgsMapSettings ms = QgsMapSettings(); applyMapSettings( ms ); - QPainter *p; - QImage *img; + QPainter *p = nullptr; + QImage *img = nullptr; img = new QImage( ms.outputSize(), QImage::Format_ARGB32 ); if ( img->isNull() ) diff --git a/src/app/qgsmapsavedialog.h b/src/app/qgsmapsavedialog.h index 8922e862b71c..4b5cdd10f60f 100644 --- a/src/app/qgsmapsavedialog.h +++ b/src/app/qgsmapsavedialog.h @@ -92,7 +92,7 @@ class APP_EXPORT QgsMapSaveDialog: public QDialog, private Ui::QgsMapSaveDialog void updateOutputSize(); DialogType mDialogType; - QgsMapCanvas *mMapCanvas; + QgsMapCanvas *mMapCanvas = nullptr; QList< QgsMapDecoration * > mDecorations; QList< QgsAnnotation *> mAnnotations; diff --git a/src/core/expression/qgsexpressionfunction.cpp b/src/core/expression/qgsexpressionfunction.cpp index dbe8e335a8e1..3d7a810581bd 100644 --- a/src/core/expression/qgsexpressionfunction.cpp +++ b/src/core/expression/qgsexpressionfunction.cpp @@ -3033,7 +3033,7 @@ static QVariant fncColorRgba( const QVariantList &values, const QgsExpressionCon QVariant fcnRampColor( const QVariantList &values, const QgsExpressionContext *, QgsExpression *parent, const QgsExpressionNodeFunction * ) { QgsGradientColorRamp expRamp; - const QgsColorRamp *ramp; + const QgsColorRamp *ramp = nullptr; if ( values.at( 0 ).canConvert() ) { expRamp = QgsExpressionUtils::getRamp( values.at( 0 ), parent ); diff --git a/src/core/processing/qgsprocessingcontext.h b/src/core/processing/qgsprocessingcontext.h index 2e4fb87de556..800bdc0c9341 100644 --- a/src/core/processing/qgsprocessingcontext.h +++ b/src/core/processing/qgsprocessingcontext.h @@ -147,7 +147,7 @@ class CORE_EXPORT QgsProcessingContext QString outputName; //! Destination project - QgsProject *project; + QgsProject *project = nullptr; }; diff --git a/src/core/processing/qgsprocessingparameters.h b/src/core/processing/qgsprocessingparameters.h index d019f869a0f6..7506fc540be9 100644 --- a/src/core/processing/qgsprocessingparameters.h +++ b/src/core/processing/qgsprocessingparameters.h @@ -137,7 +137,7 @@ class CORE_EXPORT QgsProcessingOutputLayerDefinition * to automatically load the resulting sink/layer after completing processing. * The default behavior is not to load the result into any project (nullptr). */ - QgsProject *destinationProject; + QgsProject *destinationProject = nullptr; /** * Name to use for sink if it's to be loaded into a destination project. diff --git a/src/core/qgscadutils.h b/src/core/qgscadutils.h index 67d5e5b259b3..caff3c0ad0d2 100644 --- a/src/core/qgscadutils.h +++ b/src/core/qgscadutils.h @@ -54,7 +54,7 @@ class CORE_EXPORT QgsCadUtils struct AlignMapPointContext { //! Snapping utils that will be used to snap point to map. Must not be null - QgsSnappingUtils *snappingUtils; + QgsSnappingUtils *snappingUtils = nullptr; //! Map units/pixel ratio from map canvas. Needed for double mapUnitsPerPixel; diff --git a/src/core/qgsfeaturesink.h b/src/core/qgsfeaturesink.h index a71029c23ad6..6b4867b8217a 100644 --- a/src/core/qgsfeaturesink.h +++ b/src/core/qgsfeaturesink.h @@ -113,7 +113,7 @@ class CORE_EXPORT QgsProxyFeatureSink : public QgsFeatureSink private: - QgsFeatureSink *mSink; + QgsFeatureSink *mSink = nullptr; }; Q_DECLARE_METATYPE( QgsFeatureSink * ) diff --git a/src/gui/qgscurveeditorwidget.h b/src/gui/qgscurveeditorwidget.h index efd82d8ba3fb..f831b7bad01d 100644 --- a/src/gui/qgscurveeditorwidget.h +++ b/src/gui/qgscurveeditorwidget.h @@ -273,7 +273,7 @@ class GUI_EXPORT QgsCurveEditorPlotEventFilter: public QObject private: - QwtPlot *mPlot; + QwtPlot *mPlot = nullptr; QPointF mapPoint( QPointF point ) const; }; ///@endcond diff --git a/src/gui/qgsdatasourcemanagerdialog.h b/src/gui/qgsdatasourcemanagerdialog.h index 574d328957e6..2b673b293115 100644 --- a/src/gui/qgsdatasourcemanagerdialog.h +++ b/src/gui/qgsdatasourcemanagerdialog.h @@ -118,7 +118,7 @@ class GUI_EXPORT QgsDataSourceManagerDialog : public QgsOptionsDialogBase, priva private: void addProviderDialog( QgsAbstractDataSourceWidget *dlg, const QString &providerKey, const QString &providerName, const QIcon &icon, const QString &toolTip = QString() ); void makeConnections( QgsAbstractDataSourceWidget *dlg, const QString &providerKey ); - Ui::QgsDataSourceManagerDialog *ui; + Ui::QgsDataSourceManagerDialog *ui = nullptr; QgsBrowserDockWidget *mBrowserWidget = nullptr; int mPreviousRow; QStringList mPageNames; diff --git a/src/gui/qgsmetadatawidget.cpp b/src/gui/qgsmetadatawidget.cpp index 9afc4de55d9b..211736e5cf26 100644 --- a/src/gui/qgsmetadatawidget.cpp +++ b/src/gui/qgsmetadatawidget.cpp @@ -205,7 +205,7 @@ void QgsMetadataWidget::addContact() const { int row = tabContacts->rowCount(); tabContacts->setRowCount( row + 1 ); - QTableWidgetItem *pCell; + QTableWidgetItem *pCell = nullptr; // Name pCell = new QTableWidgetItem( QString( tr( "unnamed %1" ) ).arg( row + 1 ) ); diff --git a/src/gui/symbology/qgsdatadefinedsizelegendwidget.h b/src/gui/symbology/qgsdatadefinedsizelegendwidget.h index a2fe6be93b24..42e036a98c0e 100644 --- a/src/gui/symbology/qgsdatadefinedsizelegendwidget.h +++ b/src/gui/symbology/qgsdatadefinedsizelegendwidget.h @@ -69,12 +69,12 @@ class GUI_EXPORT QgsDataDefinedSizeLegendWidget : public QgsPanelWidget, private std::unique_ptr mSourceSymbol; //!< Source symbol (without data-defined size set) bool mOverrideSymbol = false; //!< If true, symbol should not be editable because it will be overridden QgsProperty mSizeProperty; //!< Definition of data-defined size of symbol (should have a size scale transformer associated) - QgsLayerTreeModel *mPreviewModel; - QgsLayerTree *mPreviewTree; - QgsLayerTreeLayer *mPreviewLayerNode; - QgsVectorLayer *mPreviewLayer; + QgsLayerTreeModel *mPreviewModel = nullptr; + QgsLayerTree *mPreviewTree = nullptr; + QgsLayerTreeLayer *mPreviewLayerNode = nullptr; + QgsVectorLayer *mPreviewLayer = nullptr; QgsMapCanvas *mMapCanvas = nullptr; - QStandardItemModel *mSizeClassesModel; + QStandardItemModel *mSizeClassesModel = nullptr; }; #ifndef SIP_RUN diff --git a/src/gui/symbology/qgssymbollevelsdialog.h b/src/gui/symbology/qgssymbollevelsdialog.h index a7d0cc117173..b5ed6c3e3bf2 100644 --- a/src/gui/symbology/qgssymbollevelsdialog.h +++ b/src/gui/symbology/qgssymbollevelsdialog.h @@ -66,7 +66,7 @@ class GUI_EXPORT QgsSymbolLevelsWidget : public QgsPanelWidget, private Ui::QgsS //! maximal number of layers from all symbols int mMaxLayers; - QgsFeatureRenderer *mRenderer; + QgsFeatureRenderer *mRenderer = nullptr; QgsLegendSymbolList mList; //! whether symbol layers always should be used (default false) diff --git a/src/providers/geonode/qgsgeonodesourceselect.cpp b/src/providers/geonode/qgsgeonodesourceselect.cpp index 7a51e7100dd6..b1c7d0572cf3 100644 --- a/src/providers/geonode/qgsgeonodesourceselect.cpp +++ b/src/providers/geonode/qgsgeonodesourceselect.cpp @@ -189,7 +189,7 @@ void QgsGeoNodeSourceSelect::connectToGeonodeConnection() if ( !wmsURL.isEmpty() ) { QStandardItem *titleItem = new QStandardItem( layer.title ); - QStandardItem *nameItem; + QStandardItem *nameItem = nullptr; if ( !layer.name.isEmpty() ) { nameItem = new QStandardItem( layer.name ); @@ -216,7 +216,7 @@ void QgsGeoNodeSourceSelect::connectToGeonodeConnection() if ( !wfsURL.isEmpty() ) { QStandardItem *titleItem = new QStandardItem( layer.title ); - QStandardItem *nameItem; + QStandardItem *nameItem = nullptr; if ( !layer.name.isEmpty() ) { nameItem = new QStandardItem( layer.name ); @@ -243,7 +243,7 @@ void QgsGeoNodeSourceSelect::connectToGeonodeConnection() if ( !xyzURL.isEmpty() ) { QStandardItem *titleItem = new QStandardItem( layer.title ); - QStandardItem *nameItem; + QStandardItem *nameItem = nullptr; if ( !layer.name.isEmpty() ) { nameItem = new QStandardItem( layer.name ); diff --git a/src/providers/ogr/qgsgeopackagedataitems.cpp b/src/providers/ogr/qgsgeopackagedataitems.cpp index 6206ee1f2235..192dfa5d5323 100644 --- a/src/providers/ogr/qgsgeopackagedataitems.cpp +++ b/src/providers/ogr/qgsgeopackagedataitems.cpp @@ -219,7 +219,7 @@ bool QgsGeoPackageCollectionItem::handleDrop( const QMimeData *data, Qt::DropAct } else { - QgsMapLayer *srcLayer; + QgsMapLayer *srcLayer = nullptr; bool owner; bool isVector = false; QString error; @@ -362,7 +362,7 @@ bool QgsGeoPackageCollectionItem::deleteGeoPackageRasterLayer( const QString &ur { QString baseUri = pieces.at( 1 ); QString layerName = pieces.at( 2 ); - sqlite3 *handle; + sqlite3 *handle = nullptr; int status = sqlite3_open_v2( baseUri.toUtf8().constData(), &handle, SQLITE_OPEN_READWRITE, nullptr ); if ( status != SQLITE_OK ) { diff --git a/src/providers/ogr/qgsogrdataitems.cpp b/src/providers/ogr/qgsogrdataitems.cpp index 4ead362061c8..630ccee39a76 100644 --- a/src/providers/ogr/qgsogrdataitems.cpp +++ b/src/providers/ogr/qgsogrdataitems.cpp @@ -612,7 +612,7 @@ QGISEXTERN QgsDataItem *dataItem( QString path, QgsDataItem *parentItem ) } // Handle collections // Check if the layer has sublayers by comparing the extension - QgsDataItem *item; + QgsDataItem *item = nullptr; if ( ! ogrSupportedDbLayersExtensions.contains( suffix ) ) { item = new QgsOgrLayerItem( parentItem, name, path, path, QgsLayerItem::Vector ); diff --git a/src/providers/oracle/ocispatial/wkbptr.h b/src/providers/oracle/ocispatial/wkbptr.h index d20cdfca79bd..5807f12904d3 100644 --- a/src/providers/oracle/ocispatial/wkbptr.h +++ b/src/providers/oracle/ocispatial/wkbptr.h @@ -23,10 +23,10 @@ union wkbPtr { void *vPtr = nullptr; - double *dPtr; - int *iPtr; + double *dPtr = nullptr; + int *iPtr = nullptr; unsigned char *ucPtr; - char *cPtr; + char *cPtr = nullptr; }; const int SDO_ARRAY_SIZE = 1024; diff --git a/src/providers/postgres/qgspostgreslistener.cpp b/src/providers/postgres/qgspostgreslistener.cpp index 3a9c35366a62..1303a8fd548a 100644 --- a/src/providers/postgres/qgspostgreslistener.cpp +++ b/src/providers/postgres/qgspostgreslistener.cpp @@ -57,7 +57,7 @@ QgsPostgresListener::~QgsPostgresListener() void QgsPostgresListener::run() { - PGconn *conn; + PGconn *conn = nullptr; conn = PQconnectdb( mConnString.toLocal8Bit() ); PGresult *res = PQexec( conn, "LISTEN qgis" ); diff --git a/src/server/qgsserver.h b/src/server/qgsserver.h index 28c32528d818..73bf869c6856 100644 --- a/src/server/qgsserver.h +++ b/src/server/qgsserver.h @@ -129,7 +129,7 @@ class SERVER_EXPORT QgsServer static QgsServerSettings sSettings; //! cache - QgsConfigCache *mConfigCache; + QgsConfigCache *mConfigCache = nullptr; }; #endif // QGSSERVER_H diff --git a/src/server/services/wms/qgswmsrenderer.cpp b/src/server/services/wms/qgswmsrenderer.cpp index f869d783e702..14a13171f80b 100644 --- a/src/server/services/wms/qgswmsrenderer.cpp +++ b/src/server/services/wms/qgswmsrenderer.cpp @@ -2635,7 +2635,7 @@ namespace QgsWms QPainter *QgsRenderer::layersRendering( const QgsMapSettings &mapSettings, QImage &image, HitTest *hitTest ) const { - QPainter *painter; + QPainter *painter = nullptr; if ( hitTest ) { runHitTest( mapSettings, *hitTest ); From 49b426d951a8c04ca711eaeb0ab486bce7836c28 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Thu, 5 Oct 2017 11:51:04 +1000 Subject: [PATCH 2/4] Make doxygen_space script convert multiline //! comments Because: - the /** format is much more prevalent throughout QGIS - sipify works correctly with /** --- python/analysis/raster/qgsalignraster.sip | 42 +++- python/analysis/raster/qgsrastermatrix.sip | 1 + python/core/composer/qgscomposerlegend.sip | 8 + python/core/dxf/qgsdxfexport.sip | 21 ++ python/core/expression/qgsexpression.sip | 9 +- python/core/expression/qgsexpressionnode.sip | 2 + python/core/layertree/qgslayertreemodel.sip | 49 ++++- .../layertree/qgslayertreemodellegendnode.sip | 1 + python/core/layertree/qgslayertreenode.sip | 18 +- .../layertree/qgslayertreeregistrybridge.sip | 5 +- python/core/layertree/qgslayertreeutils.sip | 6 +- python/core/qgis.sip | 20 +- python/core/qgsapplication.sip | 9 +- python/core/qgsbrowsermodel.sip | 4 +- python/core/qgsdatadefinedsizelegend.sip | 4 +- python/core/qgsdataitem.sip | 6 +- python/core/qgsdataitemprovider.sip | 6 +- python/core/qgsdatasourceuri.sip | 2 + python/core/qgsfeaturerequest.sip | 6 +- python/core/qgsfields.sip | 5 +- python/core/qgsmaphittest.sip | 4 +- python/core/qgsmaplayerrenderer.sip | 1 + python/core/qgsmaplayerstylemanager.sip | 23 +- python/core/qgsmaprendererjob.sip | 19 +- python/core/qgsmapsettings.sip | 32 ++- python/core/qgsmessageoutput.sip | 3 +- python/core/qgsmimedatautils.sip | 6 +- python/core/qgspallabeling.sip | 1 + python/core/qgspointlocator.sip | 29 ++- python/core/qgsrendercontext.sip | 1 + python/core/qgssqlstatement.sip | 9 +- python/core/qgstaskmanager.sip | 20 +- python/core/qgstracer.sip | 16 +- python/core/qgsvectorlayerfeatureiterator.sip | 3 +- python/core/qgsvectorlayerjoinbuffer.sip | 9 +- python/core/qgsvectorlayerlabeling.sip | 3 +- python/core/qgsvirtuallayerdefinition.sip | 17 +- python/core/raster/qgsrasterinterface.sip | 10 +- .../qgscategorizedsymbolrenderer.sip | 5 +- .../qgsgeometrygeneratorsymbollayer.sip | 4 +- .../symbology/qgsgraduatedsymbolrenderer.sip | 24 ++- python/core/symbology/qgslegendsymbolitem.sip | 10 +- .../core/symbology/qgsmarkersymbollayer.sip | 3 + python/core/symbology/qgsrenderer.sip | 6 + python/core/symbology/qgsrendererregistry.sip | 18 +- .../core/symbology/qgsrulebasedrenderer.sip | 8 +- .../symbology/qgssinglesymbolrenderer.sip | 4 +- python/core/symbology/qgssymbol.sip | 6 + .../qgsrelationreferencewidget.sip | 3 +- .../qgslayertreeembeddedwidgetregistry.sip | 4 +- .../layertree/qgslayertreemapcanvasbridge.sip | 6 +- python/gui/layertree/qgslayertreeview.sip | 5 +- .../qgslayertreeviewdefaultactions.sip | 4 + python/gui/qgisinterface.sip | 4 +- .../gui/qgsadvanceddigitizingdockwidget.sip | 8 +- python/gui/qgsattributeformeditorwidget.sip | 3 +- python/gui/qgsidentifymenu.sip | 2 + python/gui/qgsmapcanvas.sip | 43 +++- python/gui/qgsmapcanvastracer.sip | 7 +- python/gui/qgsmaplayeractionregistry.sip | 1 + python/gui/qgsmaptool.sip | 2 + python/gui/qgsmaptoolidentify.sip | 3 +- .../gui/qgssourceselectproviderregistry.sip | 3 +- python/gui/qgssublayersdialog.sip | 6 + .../qgsdatadefinedsizelegendwidget.sip | 6 +- python/gui/symbology/qgsrendererwidget.sip | 2 + .../gui/symbology/qgssymbolselectordialog.sip | 10 +- python/server/qgsserver.sip | 4 +- scripts/doxygen_space.pl | 63 +++++- src/3d/chunks/qgschunklist_p.h | 6 +- src/3d/chunks/qgschunkloader_p.h | 6 +- src/3d/chunks/qgschunkqueuejob_p.h | 8 +- src/3d/qgs3dmapsettings.h | 71 +++--- src/3d/qgs3dutils.cpp | 26 ++- src/3d/qgscameracontroller.h | 12 +- src/3d/terrain/qgsdemterraintilegeometry_p.h | 7 +- src/3d/terrain/qgsdemterraintileloader_p.h | 7 +- src/3d/terrain/qgsterraintexturegenerator_p.h | 6 +- src/3d/terrain/qgsterraintileentity_p.h | 6 +- src/analysis/openstreetmap/qgsosmdatabase.h | 6 +- src/analysis/raster/qgsalignraster.h | 99 ++++++--- src/analysis/raster/qgsrastermatrix.h | 13 +- src/app/composer/qgscomposer.h | 12 +- src/app/nodetool/qgsnodetool.cpp | 6 +- src/app/nodetool/qgsnodetool.h | 75 ++++--- src/app/qgisapp.cpp | 2 +- src/app/qgisapp.h | 14 +- src/app/qgisappinterface.h | 6 +- src/app/qgsdiscoverrelationsdlg.cpp | 2 +- src/app/qgsmapthemes.h | 6 +- src/app/qgsmaptooloffsetpointsymbol.h | 12 +- src/app/qgspluginregistry.h | 6 +- src/app/qgsrasterlayerproperties.cpp | 2 +- src/app/qgsrasterlayerproperties.h | 8 +- src/core/auth/qgsauthmanager.h | 48 +++-- src/core/composer/qgscomposeritemcommand.h | 6 +- src/core/composer/qgscomposerlegend.h | 35 +-- src/core/dxf/qgsdxfexport.h | 46 ++-- src/core/expression/qgsexpression.h | 24 ++- src/core/expression/qgsexpressionnode.h | 20 +- src/core/geometry/qgsgeos.cpp | 4 +- src/core/layertree/qgslayertreemodel.h | 191 ++++++++++------ .../layertree/qgslayertreemodellegendnode.h | 6 +- src/core/layertree/qgslayertreenode.h | 77 ++++--- .../layertree/qgslayertreeregistrybridge.h | 13 +- src/core/layertree/qgslayertreeutils.h | 12 +- src/core/pal/feature.h | 12 +- src/core/qgis.h | 48 +++-- src/core/qgsaggregatecalculator.h | 6 +- src/core/qgsapplication.h | 18 +- src/core/qgsbrowsermodel.h | 7 +- src/core/qgsconnectionpool.h | 18 +- src/core/qgscoordinatereferencesystem.h | 12 +- src/core/qgscoordinatetransform_p.h | 6 +- src/core/qgsdatadefinedsizelegend.h | 8 +- src/core/qgsdataitem.h | 11 +- src/core/qgsdataitemprovider.h | 12 +- src/core/qgsdatasourceuri.h | 12 +- src/core/qgsdiagramrenderer.h | 8 +- src/core/qgsfeatureiterator.h | 6 +- src/core/qgsfeaturerequest.h | 19 +- src/core/qgsfields.h | 14 +- src/core/qgsjsonutils.h | 6 +- src/core/qgslabelfeature.h | 58 +++-- src/core/qgslabelingengine.h | 8 +- src/core/qgslabelingenginesettings.h | 6 +- src/core/qgslogger.h | 12 +- src/core/qgsmaphittest.h | 8 +- src/core/qgsmaplayerrenderer.h | 6 +- src/core/qgsmaplayerstylemanager.h | 42 ++-- src/core/qgsmaprendererjob.h | 38 ++-- src/core/qgsmapsettings.h | 75 ++++--- src/core/qgsmapthemecollection.h | 6 +- src/core/qgsmessageoutput.h | 12 +- src/core/qgsmimedatautils.h | 15 +- src/core/qgspallabeling.h | 12 +- src/core/qgspointlocator.cpp | 12 +- src/core/qgspointlocator.h | 77 ++++--- src/core/qgsproject.h | 6 +- src/core/qgsproviderregistry.h | 6 +- src/core/qgsrendercontext.h | 18 +- src/core/qgsrulebasedlabeling.h | 24 ++- src/core/qgssettings.h | 2 +- src/core/qgssnappingutils.h | 19 +- src/core/qgssqlstatement.cpp | 2 +- src/core/qgssqlstatement.h | 18 +- src/core/qgstaskmanager.h | 74 ++++--- src/core/qgstextrenderer.h | 7 +- src/core/qgstracer.h | 49 +++-- src/core/qgsvectorlayer.cpp | 2 +- src/core/qgsvectorlayer.h | 6 +- src/core/qgsvectorlayerfeatureiterator.h | 6 +- src/core/qgsvectorlayerjoinbuffer.h | 37 ++-- src/core/qgsvectorlayerlabeling.h | 12 +- src/core/qgsvectorlayerrenderer.h | 13 +- src/core/qgsvirtuallayerdefinition.h | 34 +-- src/core/raster/qgsrasterinterface.h | 41 ++-- src/core/raster/qgsrasterlayer.cpp | 4 +- .../symbology/qgscategorizedsymbolrenderer.h | 14 +- .../qgsgeometrygeneratorsymbollayer.h | 8 +- .../symbology/qgsgraduatedsymbolrenderer.h | 78 ++++--- src/core/symbology/qgslegendsymbolitem.h | 32 ++- src/core/symbology/qgsmarkersymbollayer.h | 19 +- src/core/symbology/qgsrenderer.h | 36 ++-- src/core/symbology/qgsrendererregistry.h | 52 +++-- src/core/symbology/qgsrulebasedrenderer.h | 33 ++- src/core/symbology/qgssinglesymbolrenderer.h | 8 +- src/core/symbology/qgssymbol.h | 30 ++- .../attributetable/qgsfeatureselectionmodel.h | 18 +- .../core/qgseditorwidgetautoconf.cpp | 4 +- .../core/qgssearchwidgetwrapper.h | 6 +- .../editorwidgets/qgscolorwidgetfactory.cpp | 2 +- .../qgsrelationreferencewidget.h | 6 +- .../editorwidgets/qgsuuidwidgetfactory.cpp | 2 +- .../qgslayertreeembeddedwidgetregistry.h | 8 +- .../layertree/qgslayertreemapcanvasbridge.h | 19 +- src/gui/layertree/qgslayertreeview.h | 18 +- .../qgslayertreeviewdefaultactions.h | 14 +- src/gui/qgisinterface.h | 12 +- src/gui/qgsadvanceddigitizingdockwidget.h | 58 +++-- src/gui/qgsattributeformeditorwidget.h | 6 +- src/gui/qgscodeeditorsql.h | 4 +- src/gui/qgsdatasourcemanagerdialog.h | 24 ++- src/gui/qgsidentifymenu.h | 18 +- src/gui/qgsmapcanvas.cpp | 2 +- src/gui/qgsmapcanvas.h | 203 ++++++++++++------ src/gui/qgsmapcanvasitem.h | 18 +- src/gui/qgsmapcanvastracer.h | 14 +- src/gui/qgsmaplayeractionregistry.h | 6 +- src/gui/qgsmapmouseevent.h | 6 +- src/gui/qgsmaptool.h | 30 ++- src/gui/qgsmaptoolidentify.h | 6 +- src/gui/qgsowssourceselect.h | 6 +- src/gui/qgsprojectionselectiontreewidget.h | 2 +- src/gui/qgssearchquerybuilder.cpp | 2 +- src/gui/qgssourceselectproviderregistry.h | 13 +- src/gui/qgssublayersdialog.h | 48 +++-- .../qgsdatadefinedsizelegendwidget.h | 11 +- src/gui/symbology/qgsrendererwidget.h | 8 +- src/gui/symbology/qgssmartgroupeditordialog.h | 12 +- src/gui/symbology/qgssymbolselectordialog.h | 26 ++- src/providers/gdal/qgsgdalprovider.cpp | 4 +- src/providers/ogr/qgsogrdbconnection.h | 7 +- src/providers/ogr/qgsogrprovider.cpp | 4 +- .../oracle/qgsoraclesourceselect.cpp | 2 +- src/providers/virtual/qgsvirtuallayerblob.h | 22 +- .../virtual/qgsvirtuallayerqueryparser.h | 24 ++- src/providers/wms/qgstilecache.h | 6 +- src/providers/wms/qgswmscapabilities.h | 18 +- src/python/qgspythonutils.h | 24 ++- src/python/qgspythonutilsimpl.h | 28 ++- src/server/qgshttptransaction.h | 6 +- src/server/qgsserver.h | 7 +- 213 files changed, 2553 insertions(+), 1144 deletions(-) diff --git a/python/analysis/raster/qgsalignraster.sip b/python/analysis/raster/qgsalignraster.sip index 5c5bffa3e2b6..06c17af4e3db 100644 --- a/python/analysis/raster/qgsalignraster.sip +++ b/python/analysis/raster/qgsalignraster.sip @@ -148,9 +148,12 @@ used for rescaling of values (if necessary) struct ProgressHandler { + virtual bool progress( double complete ) = 0; %Docstring -:return: false if the execution should be canceled, true otherwise + Method to be overridden for progress reporting. + \param complete Overall progress of the alignment operation + :return: false if the execution should be canceled, true otherwise :rtype: bool %End @@ -209,44 +212,63 @@ Get the output CRS in WKT format void setClipExtent( double xmin, double ymin, double xmax, double ymax ); %Docstring -No extra clipping is done if the rectangle is null + Configure clipping extent (region of interest). + No extra clipping is done if the rectangle is null %End + void setClipExtent( const QgsRectangle &extent ); %Docstring -No extra clipping is done if the rectangle is null + Configure clipping extent (region of interest). + No extra clipping is done if the rectangle is null %End + QgsRectangle clipExtent() const; %Docstring -No extra clipping is done if the rectangle is null + Get clipping extent (region of interest). + No extra clipping is done if the rectangle is null :rtype: QgsRectangle %End bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) ); %Docstring -:return: true on success (may fail if it is not possible to reproject raster to given CRS) + Set destination CRS, cell size and grid offset from a raster file. + The user may provide custom values for some of the parameters - in such case + only the remaining parameters are calculated. + + If default CRS is used, the parameters are set according to the raster file's geo-transform. + If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order + to determine suitable defaults for cell size and grid offset. + + :return: true on success (may fail if it is not possible to reproject raster to given CRS) :rtype: bool %End + bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) ); %Docstring -See the other variant for details. + Overridden variant for convenience, taking filename instead RasterInfo object. + See the other variant for details. :rtype: bool %End bool checkInputParameters(); %Docstring -:return: true on success, sets error on error (see errorMessage()) + Determine destination extent from the input rasters and calculate derived values + :return: true on success, sets error on error (see errorMessage()) :rtype: bool %End QSize alignedRasterSize() const; %Docstring + Return expected size of the resulting aligned raster .. note:: first need to run checkInputParameters() which returns with success :rtype: QSize %End + QgsRectangle alignedRasterExtent() const; %Docstring + Return expected extent of the resulting aligned raster .. note:: first need to run checkInputParameters() which returns with success @@ -255,13 +277,15 @@ See the other variant for details. bool run(); %Docstring -:return: true on success, sets error on error (see errorMessage()) + Run the alignment process + :return: true on success, sets error on error (see errorMessage()) :rtype: bool %End QString errorMessage() const; %Docstring -Error message is empty if run() succeeded (returned true) + Return error from a previous run() call. + Error message is empty if run() succeeded (returned true) :rtype: str %End diff --git a/python/analysis/raster/qgsrastermatrix.sip b/python/analysis/raster/qgsrastermatrix.sip index d7fa2f8c7110..28b1a0ee523f 100644 --- a/python/analysis/raster/qgsrastermatrix.sip +++ b/python/analysis/raster/qgsrastermatrix.sip @@ -67,6 +67,7 @@ Returns true if matrix is 1x1 (=scalar number) %End + void setData( int cols, int rows, double *data, double nodataValue ); int nColumns() const; diff --git a/python/core/composer/qgscomposerlegend.sip b/python/core/composer/qgscomposerlegend.sip index 40b774a6b1eb..b22a8cf1f182 100644 --- a/python/core/composer/qgscomposerlegend.sip +++ b/python/core/composer/qgscomposerlegend.sip @@ -108,26 +108,34 @@ Sets item box to the whole content void setLegendFilterByMapEnabled( bool enabled ); %Docstring + Set whether legend items should be filtered to show just the ones visible in the associated map .. versionadded:: 2.6 %End + bool legendFilterByMapEnabled() const; %Docstring + Find out whether legend items are filtered to show just the ones visible in the associated map .. versionadded:: 2.6 :rtype: bool %End virtual void updateItem(); %Docstring + Update() overloading. Use it rather than update() .. versionadded:: 2.12 %End void setLegendFilterOutAtlas( bool doFilter ); %Docstring + When set to true, during an atlas rendering, it will filter out legend elements + where features are outside the current atlas feature. .. versionadded:: 2.14 %End bool legendFilterOutAtlas() const; %Docstring + Whether to filter out legend elements outside of the current atlas feature +.. seealso:: setLegendFilterOutAtlas() .. versionadded:: 2.14 :rtype: bool %End diff --git a/python/core/dxf/qgsdxfexport.sip b/python/core/dxf/qgsdxfexport.sip index 04558a436d38..1aaf32aa792b 100644 --- a/python/core/dxf/qgsdxfexport.sip +++ b/python/core/dxf/qgsdxfexport.sip @@ -257,31 +257,52 @@ class QgsDxfExport void writeLine( const QgsPoint &pt1, const QgsPoint &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ); %Docstring + Write line (as a polyline) .. versionadded:: 2.15 %End void writePoint( const QString &layer, const QColor &color, const QgsPoint &pt ) /PyName=writePointV2/; %Docstring + Write point +.. note:: + + available in Python bindings as writePointV2 .. versionadded:: 2.15 %End void writeFilledCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius ) /PyName=writeFillCircleV2/; %Docstring + Write filled circle (as hatch) +.. note:: + + available in Python bindings as writePointV2 .. versionadded:: 2.15 %End void writeCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius, const QString &lineStyleName, double width ) /PyName=writeCircleV2/; %Docstring + Write circle (as polyline) +.. note:: + + available in Python bindings as writeCircleV2 .. versionadded:: 2.15 %End void writeText( const QString &layer, const QString &text, const QgsPoint &pt, double size, double angle, const QColor &color ) /PyName=writeTextV2/; %Docstring + Write text (TEXT) +.. note:: + + available in Python bindings as writeTextV2 .. versionadded:: 2.15 %End void writeMText( const QString &layer, const QString &text, const QgsPoint &pt, double width, double angle, const QColor &color ); %Docstring + Write mtext (MTEXT) +.. note:: + + available in Python bindings as writeMTextV2 .. versionadded:: 2.15 %End diff --git a/python/core/expression/qgsexpression.sip b/python/core/expression/qgsexpression.sip index 7ecca9044a37..407fbf93b08b 100644 --- a/python/core/expression/qgsexpression.sip +++ b/python/core/expression/qgsexpression.sip @@ -245,13 +245,18 @@ Set evaluation error (used internally by evaluation functions) QString expression() const; %Docstring -API calls, dump() will be used to create one instead. + Return the original, unmodified expression string. + If there was none supplied because it was constructed by sole + API calls, dump() will be used to create one instead. :rtype: str %End QString dump() const; %Docstring -expression() instead. + Return an expression string, constructed from the internal + abstract syntax tree. This does not contain any nice whitespace + formatting or comments. In general it is preferable to use + expression() instead. :rtype: str %End diff --git a/python/core/expression/qgsexpressionnode.sip b/python/core/expression/qgsexpressionnode.sip index b11de541159e..a4dd0c1946f5 100644 --- a/python/core/expression/qgsexpressionnode.sip +++ b/python/core/expression/qgsexpressionnode.sip @@ -113,6 +113,7 @@ Takes ownership of the provided node bool hasNamedNodes() const; %Docstring + Returns true if list contains any named nodes .. versionadded:: 2.16 :rtype: bool %End @@ -133,6 +134,7 @@ Takes ownership of the provided node QStringList names() const; %Docstring + Returns a list of names for nodes. Unnamed nodes will be indicated by an empty string in the list. .. versionadded:: 2.16 :rtype: list of str %End diff --git a/python/core/layertree/qgslayertreemodel.sip b/python/core/layertree/qgslayertreemodel.sip index 1b089ffdb7ec..f5d3353d4e5a 100644 --- a/python/core/layertree/qgslayertreemodel.sip +++ b/python/core/layertree/qgslayertreemodel.sip @@ -38,9 +38,11 @@ class QgsLayerTreeModel : QAbstractItemModel sipType = 0; %End public: + explicit QgsLayerTreeModel( QgsLayerTree *rootNode, QObject *parent /TransferThis/ = 0 ); %Docstring -The root node is not transferred by the model. + Construct a new tree model with given layer tree (root node must not be null pointer). + The root node is not transferred by the model. %End ~QgsLayerTreeModel(); @@ -112,7 +114,8 @@ Check whether a flag is enabled QgsLayerTreeNode *index2node( const QModelIndex &index ) const; %Docstring -Returns null pointer if index does not refer to a layer tree node (e.g. it is a legend node) + Return layer tree node for given index. Returns root node for invalid index. + Returns null pointer if index does not refer to a layer tree node (e.g. it is a legend node) :rtype: QgsLayerTreeNode %End QModelIndex node2index( QgsLayerTreeNode *node ) const; @@ -120,37 +123,53 @@ Returns null pointer if index does not refer to a layer tree node (e.g. it is a Return index for a given node. If the node does not belong to the layer tree, the result is undefined :rtype: QModelIndex %End + QList indexes2nodes( const QModelIndexList &list, bool skipInternal = false ) const; %Docstring -@arg skipInternal If true, a node is included in the output list only if no parent node is in the list + Convert a list of indexes to a list of layer tree nodes. + Indices that do not represent layer tree nodes are skipped. + \param skipInternal If true, a node is included in the output list only if no parent node is in the list :rtype: list of QgsLayerTreeNode %End static QgsLayerTreeModelLegendNode *index2legendNode( const QModelIndex &index ); %Docstring + Return legend node for given index. Returns null for invalid index .. versionadded:: 2.6 :rtype: QgsLayerTreeModelLegendNode %End + QModelIndex legendNode2index( QgsLayerTreeModelLegendNode *legendNode ); %Docstring + Return index for a given legend node. If the legend node does not belong to the layer tree, the result is undefined. + If the legend node is belongs to the tree but it is filtered out, invalid model index is returned. .. versionadded:: 2.6 :rtype: QModelIndex %End QList layerLegendNodes( QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent = false ); %Docstring + Return filtered list of active legend nodes attached to a particular layer node + (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true) +.. versionadded:: 2.6 +.. note:: + + Parameter skipNodeEmbeddedInParent added in QGIS 2.18 .. seealso:: layerOriginalLegendNodes() :rtype: list of QgsLayerTreeModelLegendNode %End QList layerOriginalLegendNodes( QgsLayerTreeLayer *nodeLayer ); %Docstring + Return original (unfiltered) list of legend nodes attached to a particular layer node +.. versionadded:: 2.14 .. seealso:: layerLegendNodes() :rtype: list of QgsLayerTreeModelLegendNode %End QgsLayerTreeModelLegendNode *legendNodeEmbeddedInParent( QgsLayerTreeLayer *nodeLayer ) const; %Docstring + Return legend node that may be embedded in parent (i.e. its icon will be used for layer's icon). .. versionadded:: 2.18 :rtype: QgsLayerTreeModelLegendNode %End @@ -171,14 +190,17 @@ Return index for a given node. If the node does not belong to the layer tree, th Return pointer to the root node of the layer tree. Always a non-null pointer. :rtype: QgsLayerTree %End + void setRootGroup( QgsLayerTree *newRootGroup ); %Docstring + Reset the model and use a new root group node .. versionadded:: 2.6 %End void refreshLayerLegend( QgsLayerTreeLayer *nodeLayer ); %Docstring -Not necessary to call when layer's renderer is changed as the model listens to these events. + Force a refresh of legend nodes of a layer node. + Not necessary to call when layer's renderer is changed as the model listens to these events. %End QModelIndex currentIndex() const; @@ -232,36 +254,53 @@ Return at what number of legend nodes the layer node should be collapsed. -1 mea void setLegendFilterByMap( const QgsMapSettings *settings ); %Docstring + Force only display of legend nodes which are valid for given map settings. + Setting null pointer or invalid map settings will disable the functionality. + Ownership of map settings pointer does not change, a copy is made. .. versionadded:: 2.6 %End void setLegendFilter( const QgsMapSettings *settings, bool useExtent = true, const QgsGeometry &polygon = QgsGeometry(), bool useExpressions = true ); %Docstring + Filter display of legend nodes for given map settings + \param settings Map settings. Setting a null pointer or invalid settings will disable any filter. Ownership is not changed, a copy is made + \param useExtent Whether to use the extent of the map settings as a first spatial filter on legend nodes + \param polygon If not empty, this polygon will be used instead of the map extent to filter legend nodes + \param useExpressions Whether to use legend node filter expressions .. versionadded:: 2.14 %End const QgsMapSettings *legendFilterMapSettings() const; %Docstring + Returns the current map settings used for the current legend filter (or null if none is enabled) .. versionadded:: 2.14 :rtype: QgsMapSettings %End void setLegendMapViewData( double mapUnitsPerPixel, int dpi, double scale ); %Docstring + Give the layer tree model hints about the currently associated map view + so that legend nodes that use map units can be scaled currectly .. versionadded:: 2.6 %End + void legendMapViewData( double *mapUnitsPerPixel /Out/, int *dpi /Out/, double *scale /Out/ ) const; %Docstring + Get hints about map view - to be used in legend nodes. Arguments that are not null will receive values. + If there are no valid map view data (from previous call to setLegendMapViewData()), returned values are zeros. .. versionadded:: 2.6 %End QMap layerStyleOverrides() const; %Docstring + Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one .. versionadded:: 2.10 :rtype: QMap %End + void setLayerStyleOverrides( const QMap &overrides ); %Docstring + Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one .. versionadded:: 2.10 %End @@ -272,8 +311,10 @@ Return at what number of legend nodes the layer node should be collapsed. -1 mea void nodeRemovedChildren(); void nodeVisibilityChanged( QgsLayerTreeNode *node ); + void nodeNameChanged( QgsLayerTreeNode *node, const QString &name ); %Docstring + Updates model when node's name has changed .. versionadded:: 3.0 %End diff --git a/python/core/layertree/qgslayertreemodellegendnode.sip b/python/core/layertree/qgslayertreemodellegendnode.sip index f093e75cee9a..93fa2391a41a 100644 --- a/python/core/layertree/qgslayertreemodellegendnode.sip +++ b/python/core/layertree/qgslayertreemodellegendnode.sip @@ -200,6 +200,7 @@ class QgsSymbolLegendNode : QgsLayerTreeModelLegendNode void setIconSize( QSize sz ); %Docstring + Set the icon size .. versionadded:: 2.10 %End QSize iconSize() const; diff --git a/python/core/layertree/qgslayertreenode.sip b/python/core/layertree/qgslayertreenode.sip index 4a714d53fc1d..5ffc489d9749 100644 --- a/python/core/layertree/qgslayertreenode.sip +++ b/python/core/layertree/qgslayertreenode.sip @@ -101,21 +101,28 @@ Get list of children of the node. Children are owned by the parent virtual QString name() const = 0; %Docstring + Return name of the node .. versionadded:: 3.0 :rtype: str %End + virtual void setName( const QString &name ) = 0; %Docstring + Set name of the node. Emits nameChanged signal. .. versionadded:: 3.0 %End static QgsLayerTreeNode *readXml( QDomElement &element ) /Factory/; %Docstring -Does not resolve textual references to layers. Call resolveReferences() afterwards to do it. + Read layer tree from XML. Returns new instance. + Does not resolve textual references to layers. Call resolveReferences() afterwards to do it. :rtype: QgsLayerTreeNode %End + static QgsLayerTreeNode *readXml( QDomElement &element, const QgsProject *project ) /Factory/; %Docstring + Read layer tree from XML. Returns new instance. + Also resolves textual references to layers from the project (calls resolveReferences() internally). .. versionadded:: 3.0 :rtype: QgsLayerTreeNode %End @@ -150,39 +157,46 @@ Create a copy of the node. Returns new instance bool isVisible() const; %Docstring + Returns whether a node is really visible (ie checked and all its ancestors checked as well) .. versionadded:: 3.0 :rtype: bool %End bool itemVisibilityChecked() const; %Docstring + Returns whether a node is checked (independently of its ancestors or children) .. versionadded:: 3.0 :rtype: bool %End void setItemVisibilityChecked( bool checked ); %Docstring + Check or uncheck a node (independently of its ancestors or children) .. versionadded:: 3.0 %End virtual void setItemVisibilityCheckedRecursive( bool checked ); %Docstring + Check or uncheck a node and all its children (taking into account exclusion rules) .. versionadded:: 3.0 %End void setItemVisibilityCheckedParentRecursive( bool checked ); %Docstring + Check or uncheck a node and all its parents .. versionadded:: 3.0 %End bool isItemVisibilityCheckedRecursive() const; %Docstring + Return whether this node is checked and all its children. .. versionadded:: 3.0 :rtype: bool %End bool isItemVisibilityUncheckedRecursive() const; %Docstring + Return whether this node is unchecked and all its children. .. versionadded:: 3.0 :rtype: bool %End @@ -259,8 +273,10 @@ Emitted when a custom property of a node within the tree has been changed or rem %Docstring Emitted when the collapsed/expanded state of a node within the tree has been changed %End + void nameChanged( QgsLayerTreeNode *node, QString name ); %Docstring + Emitted when the name of the node is changed .. versionadded:: 3.0 %End diff --git a/python/core/layertree/qgslayertreeregistrybridge.sip b/python/core/layertree/qgslayertreeregistrybridge.sip index 3acc4fd15bd5..3dfc428b3569 100644 --- a/python/core/layertree/qgslayertreeregistrybridge.sip +++ b/python/core/layertree/qgslayertreeregistrybridge.sip @@ -49,12 +49,15 @@ Create the instance that synchronizes given project with a layer tree root void setLayerInsertionPoint( QgsLayerTreeGroup *parentGroup, int index ); %Docstring -By default it is root group with zero index. + Set where the new layers should be inserted - can be used to follow current selection. + By default it is root group with zero index. %End signals: + void addedLayersToLayerTree( const QList &layers ); %Docstring + Tell others we have just added layers to the tree (used in QGIS to auto-select first newly added layer) .. versionadded:: 2.6 %End diff --git a/python/core/layertree/qgslayertreeutils.sip b/python/core/layertree/qgslayertreeutils.sip index eef75dcfb66a..d34a3f5e7cba 100644 --- a/python/core/layertree/qgslayertreeutils.sip +++ b/python/core/layertree/qgslayertreeutils.sip @@ -101,7 +101,11 @@ Test if one of the layers in a group has an expression filter static QgsLayerTreeLayer *insertLayerBelow( QgsLayerTreeGroup *group, const QgsMapLayer *refLayer, QgsMapLayer *layerToInsert ); %Docstring -:return: the new tree layer + Insert a QgsMapLayer just below another one + \param group the tree group where layers are (can be the root group) + \param refLayer the reference layer + \param layerToInsert the new layer to insert just below the reference layer + :return: the new tree layer :rtype: QgsLayerTreeLayer %End }; diff --git a/python/core/qgis.sip b/python/core/qgis.sip index fc9bbba32ea5..42449b0a2795 100644 --- a/python/core/qgis.sip +++ b/python/core/qgis.sip @@ -131,19 +131,27 @@ Hash for QVariant QString qgsDoubleToString( double a, int precision = 17 ); %Docstring -\param precision number of decimal places to retain + Returns a string representation of a double + \param a double value + \param precision number of decimal places to retain :rtype: str %End bool qgsDoubleNear( double a, double b, double epsilon = 4 * DBL_EPSILON ); %Docstring -\param epsilon maximum difference allowable between doubles + Compare two doubles (but allow some difference) + \param a first double + \param b second double + \param epsilon maximum difference allowable between doubles :rtype: bool %End bool qgsFloatNear( float a, float b, float epsilon = 4 * FLT_EPSILON ); %Docstring -\param epsilon maximum difference allowable between floats + Compare two floats (but allow some difference) + \param a first float + \param b second float + \param epsilon maximum difference allowable between floats :rtype: bool %End @@ -189,12 +197,18 @@ int qgsPermissiveToInt( QString string, bool &ok ); bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs ); %Docstring + Compares two QVariant values and returns whether the first is less than the second. + Useful for sorting lists of variants, correctly handling sorting of the various + QVariant data types (such as strings, numeric values, dates and times) .. seealso:: qgsVariantGreaterThan() :rtype: bool %End bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs ); %Docstring + Compares two QVariant values and returns whether the first is greater than the second. + Useful for sorting lists of variants, correctly handling sorting of the various + QVariant data types (such as strings, numeric values, dates and times) .. seealso:: qgsVariantLessThan() :rtype: bool %End diff --git a/python/core/qgsapplication.sip b/python/core/qgsapplication.sip index 8183fab7ad68..3d62b6a87c7f 100644 --- a/python/core/qgsapplication.sip +++ b/python/core/qgsapplication.sip @@ -328,19 +328,22 @@ Returns the path to the default theme directory. static QString iconPath( const QString &iconFile ); %Docstring -First it tries to use the active theme path, then default theme path + Returns path to the desired icon file. + First it tries to use the active theme path, then default theme path :rtype: str %End static QIcon getThemeIcon( const QString &name ); %Docstring -default theme if the active theme does not have the required icon. + Helper to get a theme icon. It will fall back to the + default theme if the active theme does not have the required icon. :rtype: QIcon %End static QPixmap getThemePixmap( const QString &name ); %Docstring -default theme if the active theme does not have the required icon. + Helper to get a theme icon as a pixmap. It will fall back to the + default theme if the active theme does not have the required icon. :rtype: QPixmap %End diff --git a/python/core/qgsbrowsermodel.sip b/python/core/qgsbrowsermodel.sip index d913e71290ec..e51de6c29ecc 100644 --- a/python/core/qgsbrowsermodel.sip +++ b/python/core/qgsbrowsermodel.sip @@ -139,9 +139,11 @@ Refresh item children %Docstring Emitted when item children fetch was finished %End + void connectionsChanged(); %Docstring -notify the provider dialogs of a changed connection + Connections changed in the browser, forwarded to the widget and used to + notify the provider dialogs of a changed connection %End public slots: diff --git a/python/core/qgsdatadefinedsizelegend.sip b/python/core/qgsdatadefinedsizelegend.sip index 4c04d170fa45..948c6749783c 100644 --- a/python/core/qgsdatadefinedsizelegend.sip +++ b/python/core/qgsdatadefinedsizelegend.sip @@ -160,7 +160,9 @@ Generates legend symbol items according to the configuration void drawCollapsedLegend( QgsRenderContext &context, QSize *outputSize /Out/ = 0, int *labelXOffset /Out/ = 0 ) const; %Docstring -Does nothing if legend is not configured as collapsed. + Draw the legend if using LegendOneNodeForAll and optionally output size of the legend and x offset of labels (in painter units). + If the painter in context is null, it only does size calculation without actual rendering. + Does nothing if legend is not configured as collapsed. %End QImage collapsedLegendImage( QgsRenderContext &context, const QColor &backgroundColor = Qt::transparent, double paddingMM = 1 ) const; diff --git a/python/core/qgsdataitem.sip b/python/core/qgsdataitem.sip index d11b59395688..64ff57597d7d 100644 --- a/python/core/qgsdataitem.sip +++ b/python/core/qgsdataitem.sip @@ -343,9 +343,13 @@ Refresh connections: update GUI and emit signal void endRemoveItems(); void dataChanged( QgsDataItem *item ); void stateChanged( QgsDataItem *item, QgsDataItem::State oldState ); + void connectionsChanged(); %Docstring -open browsers + Emitted when the provider's connections of the child items have changed + This signal is normally forwarded to the app in order to refresh the connection + item in the provider dialogs and to refresh the connection items in the other + open browsers %End protected slots: diff --git a/python/core/qgsdataitemprovider.sip b/python/core/qgsdataitemprovider.sip index e5b783afd3e3..6d83570d9fe0 100644 --- a/python/core/qgsdataitemprovider.sip +++ b/python/core/qgsdataitemprovider.sip @@ -47,13 +47,15 @@ Return combination of flags from QgsDataProvider.DataCapabilities virtual QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem ) = 0 /Factory/; %Docstring -Caller takes responsibility of deleting created items. + Create a new instance of QgsDataItem (or null) for given path and parent item. + Caller takes responsibility of deleting created items. :rtype: QgsDataItem %End virtual QVector createDataItems( const QString &path, QgsDataItem *parentItem ); %Docstring -Caller takes responsibility of deleting created items. + Create a vector of instances of QgsDataItem (or null) for given path and parent item. + Caller takes responsibility of deleting created items. :rtype: list of QgsDataItem %End diff --git a/python/core/qgsdatasourceuri.sip b/python/core/qgsdatasourceuri.sip index f352b1876fa8..1bf691a973af 100644 --- a/python/core/qgsdatasourceuri.sip +++ b/python/core/qgsdatasourceuri.sip @@ -70,6 +70,7 @@ quoted table name void setParam( const QString &key, const QString &value ); %Docstring + Set generic param (generic mode) .. note:: if key exists, another is inserted @@ -83,6 +84,7 @@ quoted table name int removeParam( const QString &key ); %Docstring + Remove generic param (generic mode) .. note:: remove all occurrences of key, returns number of params removed diff --git a/python/core/qgsfeaturerequest.sip b/python/core/qgsfeaturerequest.sip index c6f753b6ec11..57b8d5c33e3d 100644 --- a/python/core/qgsfeaturerequest.sip +++ b/python/core/qgsfeaturerequest.sip @@ -512,7 +512,8 @@ Set flags that affect how features will be fetched QgsFeatureRequest &setSubsetOfAttributes( const QgsAttributeList &attrs ); %Docstring -To disable fetching attributes, reset the FetchAttributes flag (which is set by default) + Set a subset of attributes that will be fetched. Empty list means that all attributes are used. + To disable fetching attributes, reset the FetchAttributes flag (which is set by default) :rtype: QgsFeatureRequest %End @@ -537,11 +538,14 @@ Set a subset of attributes by names that will be fetched QgsFeatureRequest &setSimplifyMethod( const QgsSimplifyMethod &simplifyMethod ); %Docstring + Set a simplification method for geometries that will be fetched .. versionadded:: 2.2 :rtype: QgsFeatureRequest %End + const QgsSimplifyMethod &simplifyMethod() const; %Docstring + Get simplification method for geometries that will be fetched .. versionadded:: 2.2 :rtype: QgsSimplifyMethod %End diff --git a/python/core/qgsfields.sip b/python/core/qgsfields.sip index cb7ee057a73f..65f82dd457b4 100644 --- a/python/core/qgsfields.sip +++ b/python/core/qgsfields.sip @@ -117,7 +117,9 @@ Return number of items bool exists( int i ) const; %Docstring -:return: True if the field exists + Return if a field index is valid + \param i Index of the field which needs to be checked + :return: True if the field exists :rtype: bool %End @@ -264,6 +266,7 @@ Get field's origin index (its meaning is specific to each type of origin) QgsAttributeList allAttributesList() const; %Docstring + Utility function to get list of attribute indexes .. versionadded:: 2.4 :rtype: QgsAttributeList %End diff --git a/python/core/qgsmaphittest.sip b/python/core/qgsmaphittest.sip index 99c16483426a..333b072f8d67 100644 --- a/python/core/qgsmaphittest.sip +++ b/python/core/qgsmaphittest.sip @@ -26,7 +26,9 @@ class QgsMapHitTest QgsMapHitTest( const QgsMapSettings &settings, const QgsGeometry &polygon = QgsGeometry(), const QgsMapHitTest::LayerFilterExpression &layerFilterExpression = QgsMapHitTest::LayerFilterExpression() ); %Docstring -\param layerFilterExpression Expression string for each layer id to evaluate in order to refine the symbol selection + \param settings Map settings used to evaluate symbols + \param polygon Polygon geometry to refine the hit test + \param layerFilterExpression Expression string for each layer id to evaluate in order to refine the symbol selection %End QgsMapHitTest( const QgsMapSettings &settings, const QgsMapHitTest::LayerFilterExpression &layerFilterExpression ); diff --git a/python/core/qgsmaplayerrenderer.sip b/python/core/qgsmaplayerrenderer.sip index a9b7bc5c56fe..88082aac7450 100644 --- a/python/core/qgsmaplayerrenderer.sip +++ b/python/core/qgsmaplayerrenderer.sip @@ -50,6 +50,7 @@ Do the rendering (based on data stored in the class) virtual QgsFeedback *feedback() const; %Docstring + Access to feedback object of the layer renderer (may be null) .. versionadded:: 3.0 :rtype: QgsFeedback %End diff --git a/python/core/qgsmaplayerstylemanager.sip b/python/core/qgsmaplayerstylemanager.sip index d3933a1177bc..ef62a65b4d54 100644 --- a/python/core/qgsmaplayerstylemanager.sip +++ b/python/core/qgsmaplayerstylemanager.sip @@ -150,22 +150,29 @@ Return data of a stored style - accessed by its unique name bool addStyle( const QString &name, const QgsMapLayerStyle &style ); %Docstring -:return: true on success (name is unique and style is valid) + Add a style with given name and data + :return: true on success (name is unique and style is valid) :rtype: bool %End + bool addStyleFromLayer( const QString &name ); %Docstring -:return: true on success + Add style by cloning the current one + :return: true on success :rtype: bool %End + bool removeStyle( const QString &name ); %Docstring -:return: true on success (style exists and it is not the last one) + Remove a stored style + :return: true on success (style exists and it is not the last one) :rtype: bool %End + bool renameStyle( const QString &name, const QString &newName ); %Docstring -:return: true on success (style exists and new name is unique) + Rename a stored style to a different name + :return: true on success (style exists and new name is unique) :rtype: bool %End @@ -174,15 +181,19 @@ Return data of a stored style - accessed by its unique name Return name of the current style :rtype: str %End + bool setCurrentStyle( const QString &name ); %Docstring -:return: true on success + Set a different style as the current style - will apply it to the layer + :return: true on success :rtype: bool %End bool setOverrideStyle( const QString &styleDef ); %Docstring -Each call must be paired with restoreOverrideStyle() + Temporarily apply a different style to the layer. The argument + can be either a style name or a full QML style definition. + Each call must be paired with restoreOverrideStyle() :rtype: bool %End bool restoreOverrideStyle(); diff --git a/python/core/qgsmaprendererjob.sip b/python/core/qgsmaprendererjob.sip index 7b212a34f706..c55079c76d99 100644 --- a/python/core/qgsmaprendererjob.sip +++ b/python/core/qgsmaprendererjob.sip @@ -49,12 +49,14 @@ class QgsMapRendererJob : QObject virtual void start() = 0; %Docstring -Does nothing if the rendering is already in progress. + Start the rendering job and immediately return. + Does nothing if the rendering is already in progress. %End virtual void cancel() = 0; %Docstring -Does nothing if the rendering is not active. + Stop the rendering job - does not return until the job has terminated. + Does nothing if the rendering is not active. %End virtual void cancelWithoutBlocking() = 0; @@ -95,12 +97,18 @@ Tell whether the rendering job is currently running in background. void setFeatureFilterProvider( const QgsFeatureFilterProvider *f ); %Docstring -before the render job. +.. versionadded:: 3.0 + Set the feature filter provider used by the QgsRenderContext of + each LayerRenderJob. + Ownership is not transferred and the provider must not be deleted + before the render job. %End const QgsFeatureFilterProvider *featureFilterProvider() const; %Docstring -each LayerRenderJob. +.. versionadded:: 3.0 + Returns the feature filter provider used by the QgsRenderContext of + each LayerRenderJob. :rtype: QgsFeatureFilterProvider %End @@ -123,7 +131,8 @@ List of errors that happened during the rendering job - available when the rende void setCache( QgsMapRendererCache *cache ); %Docstring -Does not take ownership of the object. + Assign a cache to be used for reading and storing rendered images of individual layers. + Does not take ownership of the object. %End int renderingTime() const; diff --git a/python/core/qgsmapsettings.sip b/python/core/qgsmapsettings.sip index 87a183f9f559..74434edfd3f8 100644 --- a/python/core/qgsmapsettings.sip +++ b/python/core/qgsmapsettings.sip @@ -37,12 +37,19 @@ class QgsMapSettings QgsRectangle extent() const; %Docstring -of output size. Use visibleExtent() to get the resulting extent. + Return geographical coordinates of the rectangle that should be rendered. + The actual visible extent used for rendering could be slightly different + since the given extent may be expanded in order to fit the aspect ratio + of output size. Use visibleExtent() to get the resulting extent. :rtype: QgsRectangle %End + void setExtent( const QgsRectangle &rect, bool magnified = true ); %Docstring -of output size. Use visibleExtent() to get the resulting extent. + Set coordinates of the rectangle which should be rendered. + The actual visible extent used for rendering could be slightly different + since the given extent may be expanded in order to fit the aspect ratio + of output size. Use visibleExtent() to get the resulting extent. %End QSize outputSize() const; @@ -72,7 +79,8 @@ Set the size of the resulting map image double outputDpi() const; %Docstring -Default value is 96 + Return DPI used for conversion between real world units (e.g. mm) and pixels + Default value is 96 :rtype: float %End void setOutputDpi( double dpi ); @@ -90,32 +98,42 @@ Set DPI used for conversion between real world units (e.g. mm) and pixels double magnificationFactor() const; %Docstring + Return the magnification factor. +.. versionadded:: 2.16 .. seealso:: setMagnificationFactor() :rtype: float %End QStringList layerIds() const; %Docstring -The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + Get list of layer IDs for map rendering + The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) :rtype: list of str %End + QList layers() const; %Docstring -The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + Get list of layers for map rendering + The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) :rtype: list of QgsMapLayer %End + void setLayers( const QList &layers ); %Docstring -The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + Set list of layers for map rendering. The layers must be registered in QgsProject. + The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) %End QMap layerStyleOverrides() const; %Docstring + Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one .. versionadded:: 2.8 :rtype: QMap %End + void setLayerStyleOverrides( const QMap &overrides ); %Docstring + Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one .. versionadded:: 2.8 %End @@ -248,8 +266,10 @@ Check whether the map settings are valid and can be used for rendering Return the actual extent derived from requested extent that takes takes output image size into account :rtype: QgsRectangle %End + QPolygonF visiblePolygon() const; %Docstring + Return the visible area as a polygon (may be rotated) .. versionadded:: 2.8 :rtype: QPolygonF %End diff --git a/python/core/qgsmessageoutput.sip b/python/core/qgsmessageoutput.sip index b7c4e5a7bf52..4bb957b1e282 100644 --- a/python/core/qgsmessageoutput.sip +++ b/python/core/qgsmessageoutput.sip @@ -67,7 +67,8 @@ display the message to the user and deletes itself static QgsMessageOutput *createMessageOutput(); %Docstring -(don't forget to delete it then if showMessage(bool) is not used showMessage(bool) deletes the instance) + function that returns new class derived from QgsMessageOutput + (don't forget to delete it then if showMessage(bool) is not used showMessage(bool) deletes the instance) :rtype: QgsMessageOutput %End diff --git a/python/core/qgsmimedatautils.sip b/python/core/qgsmimedatautils.sip index 7ab7b35dfb05..a299de08992a 100644 --- a/python/core/qgsmimedatautils.sip +++ b/python/core/qgsmimedatautils.sip @@ -30,6 +30,7 @@ Constructs URI from encoded data bool isValid() const; %Docstring + Returns whether the object contains valid data .. versionadded:: 3.0 :rtype: bool %End @@ -60,9 +61,12 @@ Returns encoded representation of the object %Docstring Type of URI. Recognized types: "vector" / "raster" / "plugin" / "custom" %End + QString providerKey; %Docstring -For "custom" type: key of its QgsCustomDropHandler + For "vector" / "raster" type: provider id. + For "plugin" type: plugin layer type name. + For "custom" type: key of its QgsCustomDropHandler %End QString name; %Docstring diff --git a/python/core/qgspallabeling.sip b/python/core/qgspallabeling.sip index d07909aa1db1..d0872b333d98 100644 --- a/python/core/qgspallabeling.sip +++ b/python/core/qgspallabeling.sip @@ -764,6 +764,7 @@ class QgsPalLabeling static bool staticWillUseLayer( QgsVectorLayer *layer ); %Docstring + called to find out whether the layer is used for labeling .. versionadded:: 2.4 :rtype: bool %End diff --git a/python/core/qgspointlocator.sip b/python/core/qgspointlocator.sip index eedceb5c22ab..1dee88f40b74 100644 --- a/python/core/qgspointlocator.sip +++ b/python/core/qgspointlocator.sip @@ -33,30 +33,37 @@ class QgsPointLocator : QObject const QgsRectangle *extent = 0 ); %Docstring Construct point locator for a layer. - @arg destinationCrs if a valid QgsCoordinateReferenceSystem is passed then the locator will + \param destinationCrs if a valid QgsCoordinateReferenceSystem is passed then the locator will do the searches on data reprojected to the given CRS - @arg extent if not null, will index only a subset of the layer + \param extent if not null, will index only a subset of the layer %End ~QgsPointLocator(); QgsVectorLayer *layer() const; %Docstring + Get associated layer .. versionadded:: 2.14 :rtype: QgsVectorLayer %End + QgsCoordinateReferenceSystem destinationCrs() const; %Docstring + Get destination CRS - may be an invalid QgsCoordinateReferenceSystem if not doing OTF reprojection .. versionadded:: 2.14 :rtype: QgsCoordinateReferenceSystem %End + const QgsRectangle *extent() const; %Docstring + Get extent of the area point locator covers - if null then it caches the whole layer .. versionadded:: 2.14 :rtype: QgsRectangle %End + void setExtent( const QgsRectangle *extent ); %Docstring + Configure extent - if not null, it will index only that area .. versionadded:: 2.14 %End @@ -120,13 +127,15 @@ construct invalid match double distance() const; %Docstring -units depending on what class returns it (geom.cache: layer units, map canvas snapper: dest crs units) + for vertex / edge match + units depending on what class returns it (geom.cache: layer units, map canvas snapper: dest crs units) :rtype: float %End QgsPointXY point() const; %Docstring -coords depending on what class returns it (geom.cache: layer coords, map canvas snapper: dest coords) + for vertex / edge match + coords depending on what class returns it (geom.cache: layer coords, map canvas snapper: dest coords) :rtype: QgsPointXY %End @@ -173,17 +182,22 @@ Only for a valid edge match - obtain endpoints of the edge Match nearestVertex( const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter = 0 ); %Docstring -Optional filter may discard unwanted matches. + Find nearest vertex to the specified point - up to distance specified by tolerance + Optional filter may discard unwanted matches. :rtype: Match %End + Match nearestEdge( const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter = 0 ); %Docstring -Optional filter may discard unwanted matches. + Find nearest edge to the specified point - up to distance specified by tolerance + Optional filter may discard unwanted matches. :rtype: Match %End + MatchList edgesInRect( const QgsRectangle &rect, QgsPointLocator::MatchFilter *filter = 0 ); %Docstring -Optional filter may discard unwanted matches. + Find edges within a specified recangle + Optional filter may discard unwanted matches. :rtype: MatchList %End MatchList edgesInRect( const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter = 0 ); @@ -202,6 +216,7 @@ find out if the point is in any polygons int cachedGeometryCount() const; %Docstring + Return how many geometries are cached in the index .. versionadded:: 2.14 :rtype: int %End diff --git a/python/core/qgsrendercontext.sip b/python/core/qgsrendercontext.sip index 438b597d3032..4e51dbd71106 100644 --- a/python/core/qgsrendercontext.sip +++ b/python/core/qgsrendercontext.sip @@ -73,6 +73,7 @@ class QgsRenderContext static QgsRenderContext fromMapSettings( const QgsMapSettings &mapSettings ); %Docstring + create initialized QgsRenderContext instance from given QgsMapSettings .. versionadded:: 2.4 :rtype: QgsRenderContext %End diff --git a/python/core/qgssqlstatement.sip b/python/core/qgssqlstatement.sip index 2b5b430c8dbd..851e5dacfcf0 100644 --- a/python/core/qgssqlstatement.sip +++ b/python/core/qgssqlstatement.sip @@ -65,13 +65,18 @@ Returns root node of the statement. Root node is null is parsing has failed QString statement() const; %Docstring -API calls, dump() will be used to create one instead. + Return the original, unmodified statement string. + If there was none supplied because it was constructed by sole + API calls, dump() will be used to create one instead. :rtype: str %End QString dump() const; %Docstring -statement() instead. + Return statement string, constructed from the internal + abstract syntax tree. This does not contain any nice whitespace + formatting or comments. In general it is preferable to use + statement() instead. :rtype: str %End diff --git a/python/core/qgstaskmanager.sip b/python/core/qgstaskmanager.sip index 49a0f83b64dc..8fd5b2d87552 100644 --- a/python/core/qgstaskmanager.sip +++ b/python/core/qgstaskmanager.sip @@ -425,36 +425,46 @@ Returns true if all dependencies for the specified task are satisfied void progressChanged( long taskId, double progress ); %Docstring -\param progress percent of progress, from 0.0 - 100.0 + Will be emitted when a task reports a progress change + \param taskId ID of task + \param progress percent of progress, from 0.0 - 100.0 %End void finalTaskProgressChanged( double progress ); %Docstring -\param progress percent of progress, from 0.0 - 100.0 + Will be emitted when only a single task remains to complete + and that task has reported a progress change + \param progress percent of progress, from 0.0 - 100.0 %End void statusChanged( long taskId, int status ); %Docstring -\param status new task status + Will be emitted when a task reports a status change + \param taskId ID of task + \param status new task status %End void taskAdded( long taskId ); %Docstring -\param taskId ID of task + Emitted when a new task has been added to the manager + \param taskId ID of task %End void taskAboutToBeDeleted( long taskId ); %Docstring -\param taskId ID of task + Emitted when a task is about to be deleted + \param taskId ID of task %End void allTasksFinished(); %Docstring + Emitted when all tasks are complete .. seealso:: countActiveTasksChanged() %End void countActiveTasksChanged( int count ); %Docstring + Emitted when the number of active tasks changes .. seealso:: countActiveTasks() %End diff --git a/python/core/qgstracer.sip b/python/core/qgstracer.sip index a4f7c215dfb1..7cdbda057d76 100644 --- a/python/core/qgstracer.sip +++ b/python/core/qgstracer.sip @@ -74,7 +74,10 @@ Get maximum possible number of features in graph. If the number is exceeded, gra bool init(); %Docstring -if necessary. + Build the internal data structures. This may take some time + depending on how big the input layers are. It is not necessary + to call this method explicitly - it will be called by findShortestPath() + if necessary. :rtype: bool %End @@ -86,6 +89,8 @@ Whether the internal data structures have been initialized bool hasTopologyProblem() const; %Docstring + Whether there was an error during graph creation due to noding exception, + indicating some input data topology problems .. versionadded:: 2.16 :rtype: bool %End @@ -101,7 +106,9 @@ Whether the internal data structures have been initialized QVector findShortestPath( const QgsPointXY &p1, const QgsPointXY &p2, PathError *error /Out/ = 0 ); %Docstring -:return: array of points - trace of linestrings of other features (empty array one error) + Given two points, find the shortest path and return points on the way. + The optional "error" argument may receive error code (PathError enum) if it is not null + :return: array of points - trace of linestrings of other features (empty array one error) :rtype: list of QgsPointXY %End @@ -112,9 +119,12 @@ Find out whether the point is snapped to a vertex or edge (i.e. it can be used f %End protected: + virtual void configure(); %Docstring -Default implementation does nothing. + Allows derived classes to setup the settings just before the tracer is initialized. + This allows the configuration to be set in a lazy way only when it is really necessary. + Default implementation does nothing. %End protected slots: diff --git a/python/core/qgsvectorlayerfeatureiterator.sip b/python/core/qgsvectorlayerfeatureiterator.sip index 30340517ab34..6446e8eda779 100644 --- a/python/core/qgsvectorlayerfeatureiterator.sip +++ b/python/core/qgsvectorlayerfeatureiterator.sip @@ -116,7 +116,8 @@ fetch next feature, return true on success virtual bool nextFeatureFilterExpression( QgsFeature &f ); %Docstring -while for others filtering is left to the provider implementation. + Overrides default method as we only need to filter features in the edit buffer + while for others filtering is left to the provider implementation. :rtype: bool %End diff --git a/python/core/qgsvectorlayerjoinbuffer.sip b/python/core/qgsvectorlayerjoinbuffer.sip index cd182d3f6162..84f75066c994 100644 --- a/python/core/qgsvectorlayerjoinbuffer.sip +++ b/python/core/qgsvectorlayerjoinbuffer.sip @@ -59,11 +59,13 @@ Saves mVectorJoins to xml under the layer node void readXml( const QDomNode &layer_node ); %Docstring -Does not resolve layer IDs to layers - call resolveReferences() afterwards + Reads joins from project file. + Does not resolve layer IDs to layers - call resolveReferences() afterwards %End void resolveReferences( QgsProject *project ); %Docstring + Resolves layer IDs of joined layers using given project's available layers .. versionadded:: 3.0 %End @@ -89,12 +91,14 @@ Quick way to test if there is any join at all int joinedFieldsOffset( const QgsVectorLayerJoinInfo *info, const QgsFields &fields ); %Docstring + Find out what is the first index of the join within fields. Returns -1 if join is not present .. versionadded:: 2.6 :rtype: int %End static QVector joinSubsetIndices( QgsVectorLayer *joinLayer, const QStringList &joinFieldsSubset ); %Docstring + Return a vector of indices for use in join based on field names from the layer .. versionadded:: 2.6 :rtype: list of int %End @@ -128,6 +132,7 @@ Quick way to test if there is any join at all QgsVectorLayerJoinBuffer *clone() const /Factory/; %Docstring + Create a copy of the join buffer .. versionadded:: 2.6 :rtype: QgsVectorLayerJoinBuffer %End @@ -195,8 +200,10 @@ Quick way to test if there is any join at all %End signals: + void joinedFieldsChanged(); %Docstring + Emitted whenever the list of joined fields changes (e.g. added join or joined layer's fields change) .. versionadded:: 2.6 %End diff --git a/python/core/qgsvectorlayerlabeling.sip b/python/core/qgsvectorlayerlabeling.sip index 272be98c2fe4..f733f081c716 100644 --- a/python/core/qgsvectorlayerlabeling.sip +++ b/python/core/qgsvectorlayerlabeling.sip @@ -56,7 +56,8 @@ Get list of sub-providers within the layer's labeling. virtual QgsPalLayerSettings settings( const QString &providerId = QString() ) const = 0; %Docstring -they are identified by their ID (e.g. in case of rule-based labeling, provider ID == rule key) + Get associated label settings. In case of multiple sub-providers with different settings, + they are identified by their ID (e.g. in case of rule-based labeling, provider ID == rule key) :rtype: QgsPalLayerSettings %End diff --git a/python/core/qgsvirtuallayerdefinition.sip b/python/core/qgsvirtuallayerdefinition.sip index b250e4cac2cf..f382117526e6 100644 --- a/python/core/qgsvirtuallayerdefinition.sip +++ b/python/core/qgsvirtuallayerdefinition.sip @@ -88,7 +88,18 @@ Constructor with an optional file path static QgsVirtualLayerDefinition fromUrl( const QUrl &url ); %Docstring -field=column_name:[int|real|text] represents a field with its name and its type + Constructor to build a definition from a QUrl + The path part of the URL is extracted as well as the following optional keys: + layer_ref=layer_id[:name] represents a live layer referenced by its ID. An optional name can be given + layer=provider:source[:name[:encoding]] represents a layer given by its provider key, its source url (URL-encoded). + An optional name and encoding can be given + geometry=column_name[:type:srid] gives the definition of the geometry column. + Type can be either a WKB type code or a string (point, linestring, etc.) + srid is an integer + uid=column_name is the name of a column with unique integer values. + nogeometry is a flag to force the layer to be a non-geometry layer + query=sql represents the SQL query. Must be URL-encoded + field=column_name:[int|real|text] represents a field with its name and its type :rtype: QgsVirtualLayerDefinition %End @@ -164,7 +175,9 @@ Set the name of the geometry field QgsWkbTypes::Type geometryWkbType() const; %Docstring -QgsWkbTypes.Unknown for unknown types + Get the type of the geometry + QgsWkbTypes.NoGeometry to hide any geometry + QgsWkbTypes.Unknown for unknown types :rtype: QgsWkbTypes.Type %End void setGeometryWkbType( QgsWkbTypes::Type t ); diff --git a/python/core/raster/qgsrasterinterface.sip b/python/core/raster/qgsrasterinterface.sip index dc813e263fb2..69bd08432223 100644 --- a/python/core/raster/qgsrasterinterface.sip +++ b/python/core/raster/qgsrasterinterface.sip @@ -30,26 +30,34 @@ Construct a new raster block feedback object virtual void onNewData(); %Docstring -and a new preview image may be produced + May be emitted by raster data provider to indicate that some partial data are available + and a new preview image may be produced %End bool isPreviewOnly() const; %Docstring + Whether the raster provider should return only data that are already available + without waiting for full result. By default this flag is not enabled. .. seealso:: setPreviewOnly() :rtype: bool %End + void setPreviewOnly( bool preview ); %Docstring + set flag whether the block request is for preview purposes only .. seealso:: isPreviewOnly() %End bool renderPartialOutput() const; %Docstring + Whether our painter is drawing to a temporary image used just by this layer .. seealso:: setRenderPartialOutput() :rtype: bool %End + void setRenderPartialOutput( bool enable ); %Docstring + Set whether our painter is drawing to a temporary image used just by this layer .. seealso:: renderPartialOutput() %End diff --git a/python/core/symbology/qgscategorizedsymbolrenderer.sip b/python/core/symbology/qgscategorizedsymbolrenderer.sip index 587a779d216c..31a4f25448ed 100644 --- a/python/core/symbology/qgscategorizedsymbolrenderer.sip +++ b/python/core/symbology/qgscategorizedsymbolrenderer.sip @@ -116,6 +116,7 @@ return index of category with specified value (-1 if not found) int categoryIndexForLabel( const QString &val ); %Docstring + return index of category with specified label (-1 if not found or not unique) .. versionadded:: 2.5 :rtype: int %End @@ -220,7 +221,9 @@ create renderer from XML element static QgsCategorizedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/; %Docstring -:return: a new renderer if the conversion was possible, otherwise 0. + creates a QgsCategorizedSymbolRenderer from an existing renderer. +.. versionadded:: 2.5 + :return: a new renderer if the conversion was possible, otherwise 0. :rtype: QgsCategorizedSymbolRenderer %End diff --git a/python/core/symbology/qgsgeometrygeneratorsymbollayer.sip b/python/core/symbology/qgsgeometrygeneratorsymbollayer.sip index c875e09705ca..da964f9f0f2f 100644 --- a/python/core/symbology/qgsgeometrygeneratorsymbollayer.sip +++ b/python/core/symbology/qgsgeometrygeneratorsymbollayer.sip @@ -77,7 +77,9 @@ class QgsGeometryGeneratorSymbolLayer : QgsSymbolLayer virtual bool isCompatibleWithSymbol( QgsSymbol *symbol ) const; %Docstring -care about the geometry of its parents. + Will always return true. + This is a hybrid layer, it constructs its own geometry so it does not + care about the geometry of its parents. :rtype: bool %End diff --git a/python/core/symbology/qgsgraduatedsymbolrenderer.sip b/python/core/symbology/qgsgraduatedsymbolrenderer.sip index e98f966db31c..a4cb548845b3 100644 --- a/python/core/symbology/qgsgraduatedsymbolrenderer.sip +++ b/python/core/symbology/qgsgraduatedsymbolrenderer.sip @@ -267,23 +267,35 @@ Moves the category at index position from to index position to. :rtype: Mode %End void setMode( Mode mode ); + void updateClasses( QgsVectorLayer *vlayer, Mode mode, int nclasses ); %Docstring + Recalculate classes for a layer + \param vlayer The layer being rendered (from which data values are calculated) + \param mode The calculation mode + \param nclasses The number of classes to calculate (approximate for some modes) .. versionadded:: 2.6 %End const QgsRendererRangeLabelFormat &labelFormat() const; %Docstring + Return the label format used to generate default classification labels .. versionadded:: 2.6 :rtype: QgsRendererRangeLabelFormat %End + void setLabelFormat( const QgsRendererRangeLabelFormat &labelFormat, bool updateRanges = false ); %Docstring + Set the label format used to generate default classification labels + \param labelFormat The string appended to classification labels + \param updateRanges If true then ranges ending with the old unit string are updated to the new. .. versionadded:: 2.6 %End void calculateLabelPrecision( bool updateRanges = true ); %Docstring + Reset the label decimal places to a numberbased on the minimum class interval + \param updateRanges if true then ranges currently using the default label will be updated .. versionadded:: 2.6 %End @@ -367,17 +379,23 @@ create renderer from XML element void setSymbolSizes( double minSize, double maxSize ); %Docstring + set varying symbol size for classes +.. note:: + + the classes must already be set so that symbols exist .. versionadded:: 2.10 %End double minSymbolSize() const; %Docstring + return the min symbol size when graduated by size .. versionadded:: 2.10 :rtype: float %End double maxSymbolSize() const; %Docstring + return the max symbol size when graduated by size .. versionadded:: 2.10 :rtype: float %End @@ -390,12 +408,14 @@ create renderer from XML element GraduatedMethod graduatedMethod() const; %Docstring + return the method used for graduation (either size or color) .. versionadded:: 2.10 :rtype: GraduatedMethod %End void setGraduatedMethod( GraduatedMethod method ); %Docstring + set the method used for graduation (either size or color) .. versionadded:: 2.10 %End @@ -407,7 +427,9 @@ create renderer from XML element static QgsGraduatedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/; %Docstring -:return: a new renderer if the conversion was possible, otherwise 0. + creates a QgsGraduatedSymbolRenderer from an existing renderer. +.. versionadded:: 2.6 + :return: a new renderer if the conversion was possible, otherwise 0. :rtype: QgsGraduatedSymbolRenderer %End diff --git a/python/core/symbology/qgslegendsymbolitem.sip b/python/core/symbology/qgslegendsymbolitem.sip index 7d09da52ef5c..c8e17d6f635b 100644 --- a/python/core/symbology/qgslegendsymbolitem.sip +++ b/python/core/symbology/qgslegendsymbolitem.sip @@ -32,6 +32,7 @@ class QgsLegendSymbolItem QgsLegendSymbolItem( QgsSymbol *symbol, const QString &label, const QString &ruleKey, bool checkable = false, int scaleMinDenom = -1, int scaleMaxDenom = -1, int level = 0, const QString &parentRuleKey = QString() ); %Docstring + Construct item. Does not take ownership of symbol (makes internal clone) .. versionadded:: 2.8 %End ~QgsLegendSymbolItem(); @@ -70,14 +71,18 @@ Used for older code that identifies legend entries from symbol pointer within re Determine whether given scale is within the scale range. Returns true if scale or scale range is invalid (value <= 0) :rtype: bool %End + int scaleMinDenom() const; %Docstring -Value <= 0 means the range is unbounded on this side + Min scale denominator of the scale range. For range 1:1000 to 1:2000 this will return 1000. + Value <= 0 means the range is unbounded on this side :rtype: int %End + int scaleMaxDenom() const; %Docstring -Value <= 0 means the range is unbounded on this side + Max scale denominator of the scale range. For range 1:1000 to 1:2000 this will return 2000. + Value <= 0 means the range is unbounded on this side :rtype: int %End @@ -89,6 +94,7 @@ Identation level that tells how deep the item is in a hierarchy of items. For fl QString parentRuleKey() const; %Docstring + Key of the parent legend node. For legends with tree hierarchy .. note:: Parameter parentRuleKey added in QGIS 2.8 diff --git a/python/core/symbology/qgsmarkersymbollayer.sip b/python/core/symbology/qgsmarkersymbollayer.sip index 72d014a026db..cd20acc053e2 100644 --- a/python/core/symbology/qgsmarkersymbollayer.sip +++ b/python/core/symbology/qgsmarkersymbollayer.sip @@ -123,6 +123,7 @@ Returns a list of all available shape types. bool prepareMarkerShape( Shape shape ); %Docstring + Prepares the layer for drawing the specified shape (QPolygonF version) .. note:: not available in Python bindings @@ -131,6 +132,7 @@ Returns a list of all available shape types. bool prepareMarkerPath( Shape symbol ); %Docstring + Prepares the layer for drawing the specified shape (QPainterPath version) .. note:: not available in Python bindings @@ -402,6 +404,7 @@ class QgsSimpleMarkerSymbolLayer : QgsSimpleMarkerSymbolLayerBase + private: virtual void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path ) ; }; diff --git a/python/core/symbology/qgsrenderer.sip b/python/core/symbology/qgsrenderer.sip index fa03980dac8a..6129e6c0d03c 100644 --- a/python/core/symbology/qgsrenderer.sip +++ b/python/core/symbology/qgsrenderer.sip @@ -241,6 +241,7 @@ store renderer info to XML element virtual QDomElement writeSld( QDomDocument &doc, const QString &styleName, const QgsStringMap &props = QgsStringMap() ) const; %Docstring + create the SLD UserStyle element following the SLD v1.1 specs with the given name .. versionadded:: 2.8 :rtype: QDomElement %End @@ -266,18 +267,21 @@ used from subclasses to create SLD Rule elements following SLD v1.1 specs virtual bool legendSymbolItemsCheckable() const; %Docstring + items of symbology items in legend should be checkable .. versionadded:: 2.5 :rtype: bool %End virtual bool legendSymbolItemChecked( const QString &key ); %Docstring + items of symbology items in legend is checked .. versionadded:: 2.5 :rtype: bool %End virtual void checkLegendSymbolItem( const QString &key, bool state = true ); %Docstring + item in symbology was checked .. versionadded:: 2.5 %End @@ -291,12 +295,14 @@ used from subclasses to create SLD Rule elements following SLD v1.1 specs virtual QgsLegendSymbolList legendSymbolItems() const; %Docstring + Returns a list of symbology items for the legend .. versionadded:: 2.6 :rtype: QgsLegendSymbolList %End virtual QString legendClassificationAttribute() const; %Docstring + If supported by the renderer, return classification attribute for the use in legend .. versionadded:: 2.6 :rtype: str %End diff --git a/python/core/symbology/qgsrendererregistry.sip b/python/core/symbology/qgsrendererregistry.sip index 29fc11d05a90..1a69607d0462 100644 --- a/python/core/symbology/qgsrendererregistry.sip +++ b/python/core/symbology/qgsrendererregistry.sip @@ -144,30 +144,40 @@ class QgsRendererRegistry bool addRenderer( QgsRendererAbstractMetadata *metadata /Transfer/ ); %Docstring -be added (e.g., a renderer with a duplicate name already exists) + Adds a renderer to the registry. Takes ownership of the metadata object. + \param metadata renderer metadata + :return: true if renderer was added successfully, or false if renderer could not + be added (e.g., a renderer with a duplicate name already exists) :rtype: bool %End bool removeRenderer( const QString &rendererName ); %Docstring -renderer could not be found + Removes a renderer from registry. + \param rendererName name of renderer to remove from registry + :return: true if renderer was successfully removed, or false if matching + renderer could not be found :rtype: bool %End QgsRendererAbstractMetadata *rendererMetadata( const QString &rendererName ); %Docstring -renderer was not found in the registry. + Returns the metadata for a specified renderer. Returns NULL if a matching + renderer was not found in the registry. :rtype: QgsRendererAbstractMetadata %End QStringList renderersList( QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All ) const; %Docstring -\param layerTypes flags to filter the renderers by compatible layer types + Returns a list of available renderers. + \param layerTypes flags to filter the renderers by compatible layer types :rtype: list of str %End QStringList renderersList( const QgsVectorLayer *layer ) const; %Docstring + Returns a list of available renderers which are compatible with a specified layer. + \param layer vector layer .. versionadded:: 2.16 :rtype: list of str %End diff --git a/python/core/symbology/qgsrulebasedrenderer.sip b/python/core/symbology/qgsrulebasedrenderer.sip index ebe611fd19a0..b17c5f3b3f60 100644 --- a/python/core/symbology/qgsrulebasedrenderer.sip +++ b/python/core/symbology/qgsrulebasedrenderer.sip @@ -211,11 +211,14 @@ Constructor takes ownership of the symbol QString ruleKey() const; %Docstring + Unique rule identifier (for identification of rule within renderer) .. versionadded:: 2.6 :rtype: str %End + void setRuleKey( const QString &key ); %Docstring + Override the assigned rule key (should be used just internally by rule-based renderer) .. versionadded:: 2.6 %End @@ -408,6 +411,7 @@ take child rule out, set parent as null QgsRuleBasedRenderer::Rule *findRuleByKey( const QString &key ); %Docstring + Try to find a rule given its unique key .. versionadded:: 2.6 :rtype: QgsRuleBasedRenderer.Rule %End @@ -520,7 +524,9 @@ take a rule and create a list of new rules with intervals of scales given by the static QgsRuleBasedRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/; %Docstring -:return: a new renderer if the conversion was possible, otherwise 0. + creates a QgsRuleBasedRenderer from an existing renderer. +.. versionadded:: 2.5 + :return: a new renderer if the conversion was possible, otherwise 0. :rtype: QgsRuleBasedRenderer %End diff --git a/python/core/symbology/qgssinglesymbolrenderer.sip b/python/core/symbology/qgssinglesymbolrenderer.sip index afe4b20264c6..2174c8a59e6e 100644 --- a/python/core/symbology/qgssinglesymbolrenderer.sip +++ b/python/core/symbology/qgssinglesymbolrenderer.sip @@ -54,7 +54,9 @@ create renderer from XML element static QgsSingleSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/; %Docstring -:return: a new renderer if the conversion was possible, otherwise 0. + creates a QgsSingleSymbolRenderer from an existing renderer. +.. versionadded:: 2.5 + :return: a new renderer if the conversion was possible, otherwise 0. :rtype: QgsSingleSymbolRenderer %End diff --git a/python/core/symbology/qgssymbol.sip b/python/core/symbology/qgssymbol.sip index ed844d274d84..105d398cd795 100644 --- a/python/core/symbology/qgssymbol.sip +++ b/python/core/symbology/qgssymbol.sip @@ -165,6 +165,8 @@ delete layer at specified index and set a new one void drawPreviewIcon( QPainter *painter, QSize size, QgsRenderContext *customContext = 0 ); %Docstring + Draw icon of the symbol that occupyies area given by size using the painter. + Optionally custom context may be given in order to get rendering of symbols that use map units right. .. versionadded:: 2.6 %End @@ -366,6 +368,7 @@ Generate symbol as image void renderVertexMarker( QPointF pt, QgsRenderContext &context, int currentVertexMarkerType, int currentVertexMarkerSize ); %Docstring + Render editing vertex marker at specified point .. versionadded:: 2.16 %End @@ -493,6 +496,9 @@ Current feature being rendered - may be null QgsFields fields() const; %Docstring + Fields of the layer. Currently only available in startRender() calls + to allow symbols with data-defined properties prepare the expressions + (other times fields() returns null) .. versionadded:: 2.4 :rtype: QgsFields %End diff --git a/python/gui/editorwidgets/qgsrelationreferencewidget.sip b/python/gui/editorwidgets/qgsrelationreferencewidget.sip index b809cebda182..5b80ada85733 100644 --- a/python/gui/editorwidgets/qgsrelationreferencewidget.sip +++ b/python/gui/editorwidgets/qgsrelationreferencewidget.sip @@ -120,7 +120,8 @@ determines the open form button is visible in the widget QgsFeature referencedFeature() const; %Docstring -if no feature is related, it returns an invalid feature + return the related feature (from the referenced layer) + if no feature is related, it returns an invalid feature :rtype: QgsFeature %End diff --git a/python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip b/python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip index 88a785611cff..2539c46f6cdc 100644 --- a/python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip +++ b/python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip @@ -39,7 +39,9 @@ Human readable name - may be translatable with tr() virtual QWidget *createWidget( QgsMapLayer *layer, int widgetIndex ) = 0 /Factory/; %Docstring -created (useful when using multiple widgets from the same provider for one layer). + Factory to create widgets. The returned widget is owned by the caller. + The widgetIndex argument may be used to identify which widget is being + created (useful when using multiple widgets from the same provider for one layer). :rtype: QWidget %End diff --git a/python/gui/layertree/qgslayertreemapcanvasbridge.sip b/python/gui/layertree/qgslayertreemapcanvasbridge.sip index 32f2b678cb6f..a57222e69ced 100644 --- a/python/gui/layertree/qgslayertreemapcanvasbridge.sip +++ b/python/gui/layertree/qgslayertreemapcanvasbridge.sip @@ -48,17 +48,21 @@ Constructor: does not take ownership of the layer tree nor canvas void setOvervewCanvas( QgsMapOverviewCanvas *overviewCanvas ); %Docstring + Associates overview canvas with the bridge, so the overview will be updated whenever main canvas is updated .. versionadded:: 3.0 %End + QgsMapOverviewCanvas *overviewCanvas() const; %Docstring + Returns associated overview canvas (may be null) .. versionadded:: 3.0 :rtype: QgsMapOverviewCanvas %End void setAutoSetupOnFirstLayer( bool enabled ); %Docstring -when first layer(s) are added + if enabled, will automatically set full canvas extent and destination CRS + map units + when first layer(s) are added %End bool autoSetupOnFirstLayer() const; %Docstring diff --git a/python/gui/layertree/qgslayertreeview.sip b/python/gui/layertree/qgslayertreeview.sip index 32c019bd9a00..ec634a2b264b 100644 --- a/python/gui/layertree/qgslayertreeview.sip +++ b/python/gui/layertree/qgslayertreeview.sip @@ -98,7 +98,8 @@ Get current group node. If a layer is current node, the function will return par QList selectedNodes( bool skipInternal = false ) const; %Docstring -@arg skipInternal If true, will ignore nodes which have an ancestor in the selection + Return list of selected nodes + \param skipInternal If true, will ignore nodes which have an ancestor in the selection :rtype: list of QgsLayerTreeNode %End QList selectedLayerNodes() const; @@ -121,11 +122,13 @@ Force refresh of layer symbology. Normally not needed as the changes of layer's void expandAllNodes(); %Docstring + Enhancement of QTreeView.expandAll() that also records expanded state in layer tree nodes .. versionadded:: 2.18 %End void collapseAllNodes(); %Docstring + Enhancement of QTreeView.collapseAll() that also records expanded state in layer tree nodes .. versionadded:: 2.18 %End diff --git a/python/gui/layertree/qgslayertreeviewdefaultactions.sip b/python/gui/layertree/qgslayertreeviewdefaultactions.sip index f9960fc67d22..d3c6c072ea50 100644 --- a/python/gui/layertree/qgslayertreeviewdefaultactions.sip +++ b/python/gui/layertree/qgslayertreeviewdefaultactions.sip @@ -83,8 +83,10 @@ Action to check a group and all its parents %Docstring :rtype: QAction %End + QAction *actionMutuallyExclusiveGroup( QObject *parent = 0 ) /Factory/; %Docstring + Action to enable/disable mutually exclusive flag of a group (only one child node may be checked) .. versionadded:: 2.12 :rtype: QAction %End @@ -104,8 +106,10 @@ Action to check a group and all its parents void zoomToGroup(); void makeTopLevel(); void groupSelected(); + void mutuallyExclusiveGroup(); %Docstring + Slot to enable/disable mutually exclusive group flag .. versionadded:: 2.12 %End diff --git a/python/gui/qgisinterface.sip b/python/gui/qgisinterface.sip index 1ac30a40de4e..47a07ea4a558 100644 --- a/python/gui/qgisinterface.sip +++ b/python/gui/qgisinterface.sip @@ -174,7 +174,8 @@ Get pointer to the active layer (layer selected in the legend) virtual bool setActiveLayer( QgsMapLayer * ) = 0; %Docstring -returns true if the layer exists, false otherwise + Set the active layer (layer gets selected in the legend) + returns true if the layer exists, false otherwise :rtype: bool %End @@ -296,6 +297,7 @@ Add toolbar with specified name virtual void addToolBar( QToolBar *toolbar /Transfer/, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0; %Docstring + Add a toolbar .. versionadded:: 2.3 %End diff --git a/python/gui/qgsadvanceddigitizingdockwidget.sip b/python/gui/qgsadvanceddigitizingdockwidget.sip index 2ea305d0d463..4079df74ac67 100644 --- a/python/gui/qgsadvanceddigitizingdockwidget.sip +++ b/python/gui/qgsadvanceddigitizingdockwidget.sip @@ -174,18 +174,23 @@ class QgsAdvancedDigitizingDockWidget : QgsDockWidget bool applyConstraints( QgsMapMouseEvent *e ); %Docstring -:return: false if no solution was found (invalid constraints) + apply the CAD constraints. The will modify the position of the map event in map coordinates by applying the CAD constraints. + :return: false if no solution was found (invalid constraints) :rtype: bool %End bool alignToSegment( QgsMapMouseEvent *e, QgsAdvancedDigitizingDockWidget::CadConstraint::LockMode lockMode = QgsAdvancedDigitizingDockWidget::CadConstraint::HardLock ); %Docstring + align to segment for additional constraint. + If additional constraints are used, this will determine the angle to be locked depending on the snapped segment. .. versionadded:: 3.0 :rtype: bool %End void releaseLocks( bool releaseRepeatingLocks = true ); %Docstring + unlock all constraints + \param releaseRepeatingLocks set to false to preserve the lock for any constraints set to repeating lock mode .. versionadded:: 3.0 %End @@ -324,6 +329,7 @@ return the action used to enable/disable the tools void updateCadPaintItem(); %Docstring + Updates canvas item that displays constraints on the ma .. versionadded:: 3.0 %End diff --git a/python/gui/qgsattributeformeditorwidget.sip b/python/gui/qgsattributeformeditorwidget.sip index 7d13b96e8e93..fc299ccb3ecd 100644 --- a/python/gui/qgsattributeformeditorwidget.sip +++ b/python/gui/qgsattributeformeditorwidget.sip @@ -118,7 +118,8 @@ class QgsAttributeFormEditorWidget : QWidget void valueChanged( const QVariant &value ); %Docstring -\param value new widget value + Emitted when the widget's value changes + \param value new widget value %End protected: diff --git a/python/gui/qgsidentifymenu.sip b/python/gui/qgsidentifymenu.sip index a62567d5e2e6..c7cf3b55b32d 100644 --- a/python/gui/qgsidentifymenu.sip +++ b/python/gui/qgsidentifymenu.sip @@ -97,6 +97,7 @@ define if the menu will be shown with a single idetify result void setMaxLayerDisplay( int maxLayerDisplay ); %Docstring + Defines the maximum number of layers displayed in the menu (default is 10). .. note:: 0 is unlimited. @@ -108,6 +109,7 @@ define if the menu will be shown with a single idetify result void setMaxFeatureDisplay( int maxFeatureDisplay ); %Docstring + Defines the maximum number of features displayed in the menu for vector layers (default is 10). .. note:: 0 is unlimited. diff --git a/python/gui/qgsmapcanvas.sip b/python/gui/qgsmapcanvas.sip index 4bb2373be627..52db38b48213 100644 --- a/python/gui/qgsmapcanvas.sip +++ b/python/gui/qgsmapcanvas.sip @@ -45,6 +45,7 @@ Constructor double magnificationFactor() const; %Docstring + Returns the magnification factor .. versionadded:: 2.16 :rtype: float %End @@ -66,12 +67,14 @@ Constructor const QgsMapSettings &mapSettings() const /KeepReference/; %Docstring + Get access to properties used for map rendering .. versionadded:: 2.4 :rtype: QgsMapSettings %End void setDestinationCrs( const QgsCoordinateReferenceSystem &crs ); %Docstring + sets destination coordinate reference system .. versionadded:: 2.4 %End @@ -83,28 +86,33 @@ Constructor const QgsLabelingResults *labelingResults() const; %Docstring + Get access to the labeling results (may be null) .. versionadded:: 2.4 :rtype: QgsLabelingResults %End void setCachingEnabled( bool enabled ); %Docstring + Set whether to cache images of rendered layers .. versionadded:: 2.4 %End bool isCachingEnabled() const; %Docstring + Check whether images of rendered layers are curerently being cached .. versionadded:: 2.4 :rtype: bool %End void clearCache(); %Docstring + Make sure to remove any rendered images from cache (does nothing if cache is not enabled) .. versionadded:: 2.4 %End void refreshAllLayers(); %Docstring + Reload all layers, clear the cache and refresh the canvas .. versionadded:: 2.9 %End @@ -121,22 +129,26 @@ Constructor void setParallelRenderingEnabled( bool enabled ); %Docstring + Set whether the layers are rendered in parallel or sequentially .. versionadded:: 2.4 %End bool isParallelRenderingEnabled() const; %Docstring + Check whether the layers are rendered in parallel or sequentially .. versionadded:: 2.4 :rtype: bool %End void setMapUpdateInterval( int timeMilliseconds ); %Docstring + Set how often map preview should be updated while it is being rendered (in milliseconds) .. versionadded:: 2.4 %End int mapUpdateInterval() const; %Docstring + Find out how often map preview should be updated while it is being rendered (in milliseconds) .. versionadded:: 2.4 :rtype: int %End @@ -172,22 +184,26 @@ Set the extent of the map canvas double rotation() const; %Docstring + Get the current map canvas rotation in clockwise degrees .. versionadded:: 2.8 :rtype: float %End void setRotation( double degrees ); %Docstring + Set the rotation of the map canvas in clockwise degrees .. versionadded:: 2.8 %End void setCenter( const QgsPointXY ¢er ); %Docstring + Set the center of the map canvas, in geographical coordinates .. versionadded:: 2.8 %End QgsPointXY center() const; %Docstring + Get map center, in geographical coordinates .. versionadded:: 2.8 :rtype: QgsPointXY %End @@ -300,11 +316,13 @@ Read property of QColor bgColor. void setSelectionColor( const QColor &color ); %Docstring + Set color of selected vector features .. versionadded:: 2.4 %End QColor selectionColor() const; %Docstring + Returns color for selected features .. versionadded:: 3.0 :rtype: QColor %End @@ -452,7 +470,8 @@ set wheel zoom factor (should be greater than 1) void zoomByFactor( double scaleFactor, const QgsPointXY *center = 0 ); %Docstring -If point is given, re-center on it + Zoom with the factor supplied. Factor > 1 zooms out, interval (0,1) zooms in + If point is given, re-center on it %End void zoomWithCenter( int x, int y, bool zoomIn ); @@ -462,11 +481,14 @@ Zooms in/out with a given center void zoomToFeatureExtent( QgsRectangle &rect ); %Docstring -and does a pan if rect is empty (point extent) + Zooms to feature extent. Adds a small margin around the extent + and does a pan if rect is empty (point extent) %End bool scaleLocked() const; %Docstring + Returns whether the scale is locked, so zooming can be performed using magnication. +.. versionadded:: 2.16 .. seealso:: setScaleLocked() :rtype: bool %End @@ -692,6 +714,7 @@ This slot is connected to the layer's CRS change void stopRendering(); %Docstring + stop rendering (if there is any right now) .. versionadded:: 2.4 %End @@ -712,11 +735,16 @@ ask user about datum transformation void setMagnificationFactor( double factor ); %Docstring + Sets the factor of magnification to apply to the map canvas. Indeed, we + increase/decrease the DPI of the map settings according to this factor + in order to render marker point, labels, ... bigger. .. versionadded:: 2.16 %End void setScaleLocked( bool isLocked ); %Docstring + Lock the scale, so zooming can be performed using magnication +.. versionadded:: 2.16 .. seealso:: scaleLocked() %End @@ -752,22 +780,28 @@ Emitted when the extents of the map change void rotationChanged( double ); %Docstring + Emitted when the rotation of the map changes .. versionadded:: 2.8 %End void magnificationChanged( double ); %Docstring + Emitted when the scale of the map changes .. versionadded:: 2.16 %End void canvasColorChanged(); %Docstring + Emitted when canvas background color changes .. versionadded:: 3.0 %End + void renderComplete( QPainter * ); %Docstring -- additional drawing shall be done directly within the renderer job or independently as a map canvas item + TODO: deprecate when decorations are reimplemented as map canvas items + - anything related to rendering progress is not visible outside of map canvas + - additional drawing shall be done directly within the renderer job or independently as a map canvas item %End void mapCanvasRefreshed(); @@ -818,16 +852,19 @@ Emitted when zoom next status changed void destinationCrsChanged(); %Docstring + Emitted when map CRS has changed .. versionadded:: 2.4 %End void currentLayerChanged( QgsMapLayer *layer ); %Docstring + Emitted when the current layer is changed .. versionadded:: 2.8 %End void layerStyleOverridesChanged(); %Docstring + Emitted when the configuration of overridden layer styles changes .. versionadded:: 2.12 %End diff --git a/python/gui/qgsmapcanvastracer.sip b/python/gui/qgsmapcanvastracer.sip index d60b6ddd6aa8..e2de919ddc07 100644 --- a/python/gui/qgsmapcanvastracer.sip +++ b/python/gui/qgsmapcanvastracer.sip @@ -42,12 +42,15 @@ Access to action that user may use to toggle tracing on/off. May be null if no a void setActionEnableTracing( QAction *action ); %Docstring -The action is used to determine whether tracing is currently enabled by the user + Assign "enable tracing" checkable action to the tracer. + The action is used to determine whether tracing is currently enabled by the user %End static QgsMapCanvasTracer *tracerForCanvas( QgsMapCanvas *canvas ); %Docstring -instances for easier access to the common tracer by various map tools + Retrieve instance of this class associated with given canvas (if any). + The class keeps a simple registry of tracers associated with map canvas + instances for easier access to the common tracer by various map tools :rtype: QgsMapCanvasTracer %End diff --git a/python/gui/qgsmaplayeractionregistry.sip b/python/gui/qgsmaplayeractionregistry.sip index 3ce42589c3f4..1c09214f7b9a 100644 --- a/python/gui/qgsmaplayeractionregistry.sip +++ b/python/gui/qgsmaplayeractionregistry.sip @@ -32,6 +32,7 @@ class QgsMapLayerAction : QAction QgsMapLayerAction( const QString &name, QObject *parent /TransferThis/, Targets targets = AllActions, const QIcon &icon = QIcon() ); %Docstring + 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 compatibility reasons. diff --git a/python/gui/qgsmaptool.sip b/python/gui/qgsmaptool.sip index d914645479cf..52efe6e9d4b6 100644 --- a/python/gui/qgsmaptool.sip +++ b/python/gui/qgsmaptool.sip @@ -156,6 +156,7 @@ returns pointer to the tool's map canvas QString toolName(); %Docstring + Emit map tool changed with the old tool .. versionadded:: 2.3 :rtype: str %End @@ -239,6 +240,7 @@ transformation from layer's coordinates to map coordinates (which is different i QgsPoint toMapCoordinates( const QgsMapLayer *layer, const QgsPoint &point ) /PyName=toMapCoordinatesV2/; %Docstring + transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) .. note:: available in Python bindings as toMapCoordinatesV2 diff --git a/python/gui/qgsmaptoolidentify.sip b/python/gui/qgsmaptoolidentify.sip index bb699fcd4627..41332566e577 100644 --- a/python/gui/qgsmaptoolidentify.sip +++ b/python/gui/qgsmaptoolidentify.sip @@ -100,7 +100,8 @@ this has been made private and two publics methods are offered QgsIdentifyMenu *identifyMenu(); %Docstring -this menu can also be customized + return a pointer to the identify menu which will be used in layer selection mode + this menu can also be customized :rtype: QgsIdentifyMenu %End diff --git a/python/gui/qgssourceselectproviderregistry.sip b/python/gui/qgssourceselectproviderregistry.sip index 03e6158f2053..15f5f4deb7dd 100644 --- a/python/gui/qgssourceselectproviderregistry.sip +++ b/python/gui/qgssourceselectproviderregistry.sip @@ -52,7 +52,8 @@ Add a ``provider`` implementation. Takes ownership of the object. bool removeProvider( QgsSourceSelectProvider *provider /Transfer/ ); %Docstring -:return: true if the provider was actually removed and deleted + Remove ``provider`` implementation from the list (``provider`` object is deleted) + :return: true if the provider was actually removed and deleted :rtype: bool %End diff --git a/python/gui/qgssublayersdialog.sip b/python/gui/qgssublayersdialog.sip index b129c598a9b7..df053b9c5348 100644 --- a/python/gui/qgssublayersdialog.sip +++ b/python/gui/qgssublayersdialog.sip @@ -44,34 +44,40 @@ class QgsSublayersDialog : QDialog void populateLayerTable( const LayerDefinitionList &list ); %Docstring + Populate the table with layers .. versionadded:: 2.16 %End LayerDefinitionList selection(); %Docstring + Returns list of selected layers .. versionadded:: 2.16 :rtype: LayerDefinitionList %End void setShowAddToGroupCheckbox( bool showAddToGroupCheckbox ); %Docstring + Set if we should display the add to group checkbox .. versionadded:: 3.0 %End bool showAddToGroupCheckbox() const; %Docstring + If we should display the add to group checkbox .. versionadded:: 3.0 :rtype: bool %End bool addToGroupCheckbox() const; %Docstring + If we should add layers in a group .. versionadded:: 3.0 :rtype: bool %End int countColumn() const; %Docstring + Return column with count or -1 .. versionadded:: 3.0 :rtype: int %End diff --git a/python/gui/symbology/qgsdatadefinedsizelegendwidget.sip b/python/gui/symbology/qgsdatadefinedsizelegendwidget.sip index b83e237f8fad..cd3b717fe2ba 100644 --- a/python/gui/symbology/qgsdatadefinedsizelegendwidget.sip +++ b/python/gui/symbology/qgsdatadefinedsizelegendwidget.sip @@ -24,9 +24,13 @@ class QgsDataDefinedSizeLegendWidget : QgsPanelWidget #include "qgsdatadefinedsizelegendwidget.h" %End public: + explicit QgsDataDefinedSizeLegendWidget( const QgsDataDefinedSizeLegend *ddsLegend, const QgsProperty &ddSize, QgsMarkerSymbol *overrideSymbol /Transfer/, QgsMapCanvas *canvas = 0, QWidget *parent /TransferThis/ = 0 ); %Docstring -when the symbol is given from outside rather than being set inside QgsDataDefinedSizeLegend. + Creates the dialog and initializes the content to what is passed in the legend configuration (may be null). + The ddSize argument determines scaling of the marker symbol - it should have a size scale transformer assigned + to know the range of sizes. The overrideSymbol argument may override the source symbol: this is useful in case + when the symbol is given from outside rather than being set inside QgsDataDefinedSizeLegend. %End ~QgsDataDefinedSizeLegendWidget(); diff --git a/python/gui/symbology/qgsrendererwidget.sip b/python/gui/symbology/qgsrendererwidget.sip index a3bbc10c50a2..b1196ca4c6d4 100644 --- a/python/gui/symbology/qgsrendererwidget.sip +++ b/python/gui/symbology/qgsrendererwidget.sip @@ -88,6 +88,8 @@ and by connecting the slot contextMenuViewCategories(const QPoint&)* QgsDataDefinedSizeLegendWidget *createDataDefinedSizeLegendWidget( const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend ) /Factory/; %Docstring + Creates widget to setup data-defined size legend. + Returns newly created panel - may be null if it could not be opened. Ownership is transferred to the caller. .. versionadded:: 3.0 :rtype: QgsDataDefinedSizeLegendWidget %End diff --git a/python/gui/symbology/qgssymbolselectordialog.sip b/python/gui/symbology/qgssymbolselectordialog.sip index a35224f3b7c5..aa9e71c20502 100644 --- a/python/gui/symbology/qgssymbolselectordialog.sip +++ b/python/gui/symbology/qgssymbolselectordialog.sip @@ -140,6 +140,7 @@ return menu for "advanced" button - create it if doesn't exist and show the adva void duplicateLayer(); %Docstring + Duplicates the current symbol layer and places the duplicated layer above the current symbol layer .. versionadded:: 2.14 %End @@ -163,9 +164,11 @@ return menu for "advanced" button - create it if doesn't exist and show the adva %Docstring Slot to update tree when a new symbol from style %End + void changeLayer( QgsSymbolLayer *layer ); %Docstring -\note: The layer is received from the LayerPropertiesWidget + alters tree and sets proper widget when Layer Type is changed + \note: The layer is received from the LayerPropertiesWidget %End @@ -247,6 +250,7 @@ return menu for "advanced" button - create it if doesn't exist and show the adva void duplicateLayer(); %Docstring + Duplicates the current symbol layer and places the duplicated layer above the current symbol layer .. versionadded:: 2.14 %End @@ -259,9 +263,11 @@ return menu for "advanced" button - create it if doesn't exist and show the adva %Docstring Slot to update tree when a new symbol from style %End + void changeLayer( QgsSymbolLayer *layer ); %Docstring -\note: The layer is received from the LayerPropertiesWidget + alters tree and sets proper widget when Layer Type is changed + \note: The layer is received from the LayerPropertiesWidget %End }; diff --git a/python/server/qgsserver.sip b/python/server/qgsserver.sip index 6791d9a330d9..9cf2f4e1b0f6 100644 --- a/python/server/qgsserver.sip +++ b/python/server/qgsserver.sip @@ -53,9 +53,11 @@ Returns a pointer to the server interface :rtype: QgsServerInterfaceImpl %End + void initPython(); %Docstring -Note: not in Python bindings + Initialize Python + Note: not in Python bindings %End private: diff --git a/scripts/doxygen_space.pl b/scripts/doxygen_space.pl index be43bad42c3b..f111c27d485b 100755 --- a/scripts/doxygen_space.pl +++ b/scripts/doxygen_space.pl @@ -1,4 +1,4 @@ -#!/usr/bin/perl -0 -i.sortinc -n +#!/usr/bin/perl ########################################################################### # doxygen_space.pl # --------------------- @@ -23,7 +23,62 @@ use strict; use warnings; -# Space around doxygen start blocks (force blank line before /**) -s#(?); +close $handle; + + +my $LINE_IDX = 0; +my $LINE; +my @OUTPUT = (); +my $LINE_COUNT = @INPUT_LINES; + +open(my $out_handle, ">", $file) || die "Couldn't open '".$file."' for writing because: ".$!; + +my $PREVIOUS_WAS_BLANKLINE = 0; + +while ($LINE_IDX < $LINE_COUNT){ + my $new_line = $INPUT_LINES[$LINE_IDX]; + my $is_blank_line = ( $new_line =~ m/^\s*$/ ) ? 1 : 0; + + if ( $new_line =~ m/^(\s*)\/\/!\s*(.*?)$/ ){ + #found a //! comment + my $identation = $1; + my $comment = $2; + #check next line to see if it begins with //! + if ( $INPUT_LINES[$LINE_IDX+1] =~ m/\s*\/\/!\s*(.*?)$/){ + #we are in a multiline //! comment block, convert to /** block + if ( !$PREVIOUS_WAS_BLANKLINE ){ + print $out_handle "\n"; + } + print $out_handle $identation."/**\n"; + print $out_handle $identation." * ".$comment."\n"; + while ( $INPUT_LINES[$LINE_IDX+1] =~ m/\s*\/\/!\s*(.*?)$/ ){ + if ($1 ne ''){ + print $out_handle $identation." * ".$1."\n"; + } + else { + print $out_handle $identation." *\n"; + } + $LINE_IDX++; + } + print $out_handle $identation." */\n"; + } + else { + print $out_handle $new_line."\n"; + } + } + else { + if ( !$PREVIOUS_WAS_BLANKLINE && $new_line =~ m/^(\s*)\/\*\*\s/ ){ + # Space around doxygen start blocks (force blank line before /**) + print $out_handle "\n"; + } + print $out_handle $new_line."\n"; + } + $LINE_IDX++; + $PREVIOUS_WAS_BLANKLINE = $is_blank_line; +} +close $out_handle; \ No newline at end of file diff --git a/src/3d/chunks/qgschunklist_p.h b/src/3d/chunks/qgschunklist_p.h index c6bd6d2f9440..ca491b3c2997 100644 --- a/src/3d/chunks/qgschunklist_p.h +++ b/src/3d/chunks/qgschunklist_p.h @@ -76,8 +76,10 @@ class QgsChunkList //! Returns whether the list is empty or it contains some entries bool isEmpty() const; - //! Inserts a new entry before the entry "next". - //! If "next" is null, entry will be inserted at the end of the list + /** + * Inserts a new entry before the entry "next". + * If "next" is null, entry will be inserted at the end of the list + */ void insertEntry( QgsChunkListEntry *entry, QgsChunkListEntry *next ); //! Takes the entry out of the list (does not delete it) diff --git a/src/3d/chunks/qgschunkloader_p.h b/src/3d/chunks/qgschunkloader_p.h index 36353ec29715..ccc8df0280b4 100644 --- a/src/3d/chunks/qgschunkloader_p.h +++ b/src/3d/chunks/qgschunkloader_p.h @@ -45,8 +45,10 @@ class QgsChunkLoader : public QgsChunkQueueJob virtual ~QgsChunkLoader() = default; - //! Run in main thread to use loaded data. - //! Returns entity attached to the given parent entity in disabled state + /** + * Run in main thread to use loaded data. + * Returns entity attached to the given parent entity in disabled state + */ virtual Qt3DCore::QEntity *createEntity( Qt3DCore::QEntity *parent ) = 0; }; diff --git a/src/3d/chunks/qgschunkqueuejob_p.h b/src/3d/chunks/qgschunkqueuejob_p.h index 191b1973b4c7..824f7b7dc88c 100644 --- a/src/3d/chunks/qgschunkqueuejob_p.h +++ b/src/3d/chunks/qgschunkqueuejob_p.h @@ -61,9 +61,11 @@ class QgsChunkQueueJob : public QObject //! Returns chunk node of this job QgsChunkNode *chunk() { return mNode; } - //! Request that the job gets canceled. - //! Returns only after the async job has been stopped. - //! The signal finished() will not be emitted afterwards. + /** + * Request that the job gets canceled. + * Returns only after the async job has been stopped. + * The signal finished() will not be emitted afterwards. + */ virtual void cancel(); signals: diff --git a/src/3d/qgs3dmapsettings.h b/src/3d/qgs3dmapsettings.h index 614816b5b00f..1aef39601332 100644 --- a/src/3d/qgs3dmapsettings.h +++ b/src/3d/qgs3dmapsettings.h @@ -86,8 +86,10 @@ class _3D_EXPORT Qgs3DMapSettings : public QObject // terrain related config // - //! Sets vertical scale (exaggeration) of terrain - //! (1 = true scale, > 1 = hills get more pronounced) + /** + * Sets vertical scale (exaggeration) of terrain + * (1 = true scale, > 1 = hills get more pronounced) + */ void setTerrainVerticalScale( double zScale ); //! Returns vertical scale (exaggeration) of terrain double terrainVerticalScale() const; @@ -97,34 +99,51 @@ class _3D_EXPORT Qgs3DMapSettings : public QObject //! Returns the list of map layers to be rendered as a texture of the terrain QList layers() const; - //! Sets resolution (in pixels) of the texture of a terrain tile - //! \sa mapTileResolution() + /** + * Sets resolution (in pixels) of the texture of a terrain tile + * \sa mapTileResolution() + */ void setMapTileResolution( int res ); - //! Returns resolution (in pixels) of the texture of a terrain tile. This parameter influences - //! how many zoom levels for terrain tiles there will be (together with maxTerrainGroundError()) + + /** + * Returns resolution (in pixels) of the texture of a terrain tile. This parameter influences + * how many zoom levels for terrain tiles there will be (together with maxTerrainGroundError()) + */ int mapTileResolution() const; - //! Sets maximum allowed screen error of terrain tiles in pixels. - //! \sa maxTerrainScreenError() + /** + * Sets maximum allowed screen error of terrain tiles in pixels. + * \sa maxTerrainScreenError() + */ void setMaxTerrainScreenError( float error ); - //! Returns maximum allowed screen error of terrain tiles in pixels. This parameter decides - //! how aggressively less detailed terrain tiles are swapped to more detailed ones as camera gets closer. - //! Each tile has its error defined in world units - this error gets projected to screen pixels - //! according to camera view and if the tile's error is greater than the allowed error, it will - //! be swapped by more detailed tiles with lower error. + + /** + * Returns maximum allowed screen error of terrain tiles in pixels. This parameter decides + * how aggressively less detailed terrain tiles are swapped to more detailed ones as camera gets closer. + * Each tile has its error defined in world units - this error gets projected to screen pixels + * according to camera view and if the tile's error is greater than the allowed error, it will + * be swapped by more detailed tiles with lower error. + */ float maxTerrainScreenError() const; - //! Returns maximum ground error of terrain tiles in world units. - //! \sa maxTerrainGroundError() + /** + * Returns maximum ground error of terrain tiles in world units. + * \sa maxTerrainGroundError() + */ void setMaxTerrainGroundError( float error ); - //! Returns maximum ground error of terrain tiles in world units. This parameter influences - //! how many zoom levels there will be (together with mapTileResolution()). - //! This value tells that when the given ground error is reached (e.g. 10 meters), it makes no sense - //! to further split terrain tiles into finer ones because they will not add extra details anymore. + + /** + * Returns maximum ground error of terrain tiles in world units. This parameter influences + * how many zoom levels there will be (together with mapTileResolution()). + * This value tells that when the given ground error is reached (e.g. 10 meters), it makes no sense + * to further split terrain tiles into finer ones because they will not add extra details anymore. + */ float maxTerrainGroundError() const; - //! Sets terrain generator. It takes care of producing terrain tiles from the input data. - //! Takes ownership of the generator + /** + * Sets terrain generator. It takes care of producing terrain tiles from the input data. + * Takes ownership of the generator + */ void setTerrainGenerator( QgsTerrainGenerator *gen SIP_TRANSFER ); //! Returns terrain generator. It takes care of producing terrain tiles from the input data. QgsTerrainGenerator *terrainGenerator() const { return mTerrainGenerator.get(); } @@ -134,10 +153,12 @@ class _3D_EXPORT Qgs3DMapSettings : public QObject //! Returns list of extra 3D renderers QList renderers() const { return mRenderers; } - //! Sets skybox configuration. When enabled, map scene will try to load six texture files - //! using the following syntax of filenames: "[base]_[side][extension]" where [side] is one - //! of the following: posx/posy/posz/negx/negy/negz and [base] and [extension] are the arguments - //! passed this method. + /** + * Sets skybox configuration. When enabled, map scene will try to load six texture files + * using the following syntax of filenames: "[base]_[side][extension]" where [side] is one + * of the following: posx/posy/posz/negx/negy/negz and [base] and [extension] are the arguments + * passed this method. + */ void setSkybox( bool enabled, const QString &fileBase = QString(), const QString &fileExtension = QString() ); //! Returns whether skybox is enabled bool hasSkyboxEnabled() const { return mSkyboxEnabled; } diff --git a/src/3d/qgs3dutils.cpp b/src/3d/qgs3dutils.cpp index 25ac52bcec3d..a654505e58f2 100644 --- a/src/3d/qgs3dutils.cpp +++ b/src/3d/qgs3dutils.cpp @@ -186,9 +186,11 @@ QList Qgs3DUtils::positions( const Qgs3DMapSettings &map, QgsVectorLa return positions; } -//! copied from https://searchcode.com/codesearch/view/35195518/ -//! qt3d /src/threed/painting/qglpainter.cpp -//! no changes in the code +/** + * copied from https://searchcode.com/codesearch/view/35195518/ + * qt3d /src/threed/painting/qglpainter.cpp + * no changes in the code + */ static inline uint outcode( const QVector4D &v ) { // For a discussion of outcodes see pg 388 Dunn & Parberry. @@ -209,14 +211,16 @@ static inline uint outcode( const QVector4D &v ) } -//! coarse box vs frustum test for culling. -//! corners of oriented box are transformed to clip space -//! and there is a test that all points are on the wrong side of the same plane -//! see http://www.lighthouse3d.com/tutorials/view-frustum-culling/geometric-approach-testing-boxes/ -//! -//! should be equivalent to https://searchcode.com/codesearch/view/35195518/ -//! qt3d /src/threed/painting/qglpainter.cpp -//! bool QGLPainter::isCullable(const QBox3D& box) const +/** + * coarse box vs frustum test for culling. + * corners of oriented box are transformed to clip space + * and there is a test that all points are on the wrong side of the same plane + * see http://www.lighthouse3d.com/tutorials/view-frustum-culling/geometric-approach-testing-boxes/ + * + * should be equivalent to https://searchcode.com/codesearch/view/35195518/ + * qt3d /src/threed/painting/qglpainter.cpp + * bool QGLPainter::isCullable(const QBox3D& box) const + */ bool Qgs3DUtils::isCullable( const QgsAABB &bbox, const QMatrix4x4 &viewProjectionMatrix ) { uint out = 0xff; diff --git a/src/3d/qgscameracontroller.h b/src/3d/qgscameracontroller.h index 7ca2d50b1e27..407bb1b021ee 100644 --- a/src/3d/qgscameracontroller.h +++ b/src/3d/qgscameracontroller.h @@ -41,8 +41,10 @@ class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity //! Returns viewport rectangle QRect viewport() const { return mViewport; } - //! Connects to object picker attached to terrain entity. Called internally from 3D scene. - //! This allows camera controller understand how far from the camera is the terrain under mouse cursor + /** + * Connects to object picker attached to terrain entity. Called internally from 3D scene. + * This allows camera controller understand how far from the camera is the terrain under mouse cursor + */ void addTerrainPicker( Qt3DRender::QObjectPicker *picker ); //! Assigns camera that should be controlled by this class. Called internally from 3D scene. void setCamera( Qt3DRender::QCamera *camera ); @@ -120,8 +122,10 @@ class _3D_EXPORT QgsCameraController : public Qt3DCore::QEntity Qt3DInput::QMouseHandler *mMouseHandler = nullptr; - //! Allows us to define a set of actions that we wish to use - //! (it is a component that can be attached to 3D scene) + /** + * Allows us to define a set of actions that we wish to use + * (it is a component that can be attached to 3D scene) + */ Qt3DInput::QLogicalDevice *mLogicalDevice = nullptr; Qt3DInput::QAction *mLeftMouseButtonAction = nullptr; diff --git a/src/3d/terrain/qgsdemterraintilegeometry_p.h b/src/3d/terrain/qgsdemterraintilegeometry_p.h index 335d9a5a46cb..15ffc99c33ef 100644 --- a/src/3d/terrain/qgsdemterraintilegeometry_p.h +++ b/src/3d/terrain/qgsdemterraintilegeometry_p.h @@ -49,8 +49,11 @@ namespace Qt3DRender class DemTerrainTileGeometry : public Qt3DRender::QGeometry { public: - //! Constructs a terrain tile geometry. Resolution is the number of vertices on one side of the tile, - //! heightMap is array of float values with one height value for each vertex + + /** + * Constructs a terrain tile geometry. Resolution is the number of vertices on one side of the tile, + * heightMap is array of float values with one height value for each vertex + */ explicit DemTerrainTileGeometry( int resolution, const QByteArray &heightMap, QNode *parent = nullptr ); ~DemTerrainTileGeometry() = default; diff --git a/src/3d/terrain/qgsdemterraintileloader_p.h b/src/3d/terrain/qgsdemterraintileloader_p.h index bcc82606a38d..68b1a2744965 100644 --- a/src/3d/terrain/qgsdemterraintileloader_p.h +++ b/src/3d/terrain/qgsdemterraintileloader_p.h @@ -72,8 +72,11 @@ class QgsDemHeightMapGenerator : public QObject { Q_OBJECT public: - //! Constructs height map generator based on a raster layer with elevation model, - //! terrain's tiling scheme and height map resolution (number of height values on each side of tile) + + /** + * Constructs height map generator based on a raster layer with elevation model, + * terrain's tiling scheme and height map resolution (number of height values on each side of tile) + */ QgsDemHeightMapGenerator( QgsRasterLayer *dtm, const QgsTilingScheme &tilingScheme, int resolution ); ~QgsDemHeightMapGenerator(); diff --git a/src/3d/terrain/qgsterraintexturegenerator_p.h b/src/3d/terrain/qgsterraintexturegenerator_p.h index e94e06a56d77..91f63a747c91 100644 --- a/src/3d/terrain/qgsterraintexturegenerator_p.h +++ b/src/3d/terrain/qgsterraintexturegenerator_p.h @@ -55,8 +55,10 @@ class QgsTerrainTextureGenerator : public QObject //! Initializes the object QgsTerrainTextureGenerator( const Qgs3DMapSettings &map ); - //! Starts async rendering of a map for the given extent (must be a square!). - //! Returns job ID. The class will emit tileReady() signal with the job ID when rendering is done. + /** + * Starts async rendering of a map for the given extent (must be a square!). + * Returns job ID. The class will emit tileReady() signal with the job ID when rendering is done. + */ int render( const QgsRectangle &extent, const QString &debugText = QString() ); //! Cancels a rendering job diff --git a/src/3d/terrain/qgsterraintileentity_p.h b/src/3d/terrain/qgsterraintileentity_p.h index 5fe27c5a73cb..9691321084f4 100644 --- a/src/3d/terrain/qgsterraintileentity_p.h +++ b/src/3d/terrain/qgsterraintileentity_p.h @@ -47,8 +47,10 @@ class QgsTerrainTileEntity : public Qt3DCore::QEntity { } - //! Assigns texture image. Should be called when the class is being initialized. - //! Texture image is owned by the texture used by the entity. + /** + * Assigns texture image. Should be called when the class is being initialized. + * Texture image is owned by the texture used by the entity. + */ void setTextureImage( QgsTerrainTextureImage *textureImage ) { mTextureImage = textureImage; } //! Returns assigned texture image QgsTerrainTextureImage *textureImage() { return mTextureImage; } diff --git a/src/analysis/openstreetmap/qgsosmdatabase.h b/src/analysis/openstreetmap/qgsosmdatabase.h index 60c9bbd9dba3..ca0f2c845219 100644 --- a/src/analysis/openstreetmap/qgsosmdatabase.h +++ b/src/analysis/openstreetmap/qgsosmdatabase.h @@ -83,8 +83,10 @@ class ANALYSIS_EXPORT QgsOSMDatabase QgsOSMTags tags( bool way, QgsOSMId id ) const; - //! \note not available in Python bindings - //! SIP does not seem to handle this return type - strange + /** + * \note not available in Python bindings + * SIP does not seem to handle this return type - strange + */ QList usedTags( bool ways ) const SIP_SKIP; QgsPolyline wayPoints( QgsOSMId id ) const; diff --git a/src/analysis/raster/qgsalignraster.h b/src/analysis/raster/qgsalignraster.h index 392c901844d0..c1a8da57c760 100644 --- a/src/analysis/raster/qgsalignraster.h +++ b/src/analysis/raster/qgsalignraster.h @@ -103,8 +103,10 @@ class ANALYSIS_EXPORT QgsAlignRaster }; - //! Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg) - //! \note RA_Max, RA_Min, RA_Median, RA_Q1 and RA_Q3 are available on GDAL >= 2.0 builds only + /** + * Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg) + * \note RA_Max, RA_Min, RA_Median, RA_Q1 and RA_Q3 are available on GDAL >= 2.0 builds only + */ enum ResampleAlg { RA_NearestNeighbour = 0, //!< Nearest neighbour (select on one input pixel) @@ -151,9 +153,12 @@ class ANALYSIS_EXPORT QgsAlignRaster //! Helper struct to be sub-classed for progress reporting struct ProgressHandler { - //! Method to be overridden for progress reporting. - //! \param complete Overall progress of the alignment operation - //! \returns false if the execution should be canceled, true otherwise + + /** + * Method to be overridden for progress reporting. + * \param complete Overall progress of the alignment operation + * \returns false if the execution should be canceled, true otherwise + */ virtual bool progress( double complete ) = 0; virtual ~ProgressHandler() = default; @@ -184,47 +189,71 @@ class ANALYSIS_EXPORT QgsAlignRaster //! Get the output CRS in WKT format QString destinationCrs() const { return mCrsWkt; } - //! Configure clipping extent (region of interest). - //! No extra clipping is done if the rectangle is null + /** + * Configure clipping extent (region of interest). + * No extra clipping is done if the rectangle is null + */ void setClipExtent( double xmin, double ymin, double xmax, double ymax ); - //! Configure clipping extent (region of interest). - //! No extra clipping is done if the rectangle is null + + /** + * Configure clipping extent (region of interest). + * No extra clipping is done if the rectangle is null + */ void setClipExtent( const QgsRectangle &extent ); - //! Get clipping extent (region of interest). - //! No extra clipping is done if the rectangle is null + + /** + * Get clipping extent (region of interest). + * No extra clipping is done if the rectangle is null + */ QgsRectangle clipExtent() const; - //! Set destination CRS, cell size and grid offset from a raster file. - //! The user may provide custom values for some of the parameters - in such case - //! only the remaining parameters are calculated. - //! - //! If default CRS is used, the parameters are set according to the raster file's geo-transform. - //! If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order - //! to determine suitable defaults for cell size and grid offset. - //! - //! \returns true on success (may fail if it is not possible to reproject raster to given CRS) + /** + * Set destination CRS, cell size and grid offset from a raster file. + * The user may provide custom values for some of the parameters - in such case + * only the remaining parameters are calculated. + * + * If default CRS is used, the parameters are set according to the raster file's geo-transform. + * If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order + * to determine suitable defaults for cell size and grid offset. + * + * \returns true on success (may fail if it is not possible to reproject raster to given CRS) + */ bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) ); - //! Overridden variant for convenience, taking filename instead RasterInfo object. - //! See the other variant for details. + + /** + * Overridden variant for convenience, taking filename instead RasterInfo object. + * See the other variant for details. + */ bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) ); - //! Determine destination extent from the input rasters and calculate derived values - //! \returns true on success, sets error on error (see errorMessage()) + /** + * Determine destination extent from the input rasters and calculate derived values + * \returns true on success, sets error on error (see errorMessage()) + */ bool checkInputParameters(); - //! Return expected size of the resulting aligned raster - //! \note first need to run checkInputParameters() which returns with success + /** + * Return expected size of the resulting aligned raster + * \note first need to run checkInputParameters() which returns with success + */ QSize alignedRasterSize() const; - //! Return expected extent of the resulting aligned raster - //! \note first need to run checkInputParameters() which returns with success + + /** + * Return expected extent of the resulting aligned raster + * \note first need to run checkInputParameters() which returns with success + */ QgsRectangle alignedRasterExtent() const; - //! Run the alignment process - //! \returns true on success, sets error on error (see errorMessage()) + /** + * Run the alignment process + * \returns true on success, sets error on error (see errorMessage()) + */ bool run(); - //! Return error from a previous run() call. - //! Error message is empty if run() succeeded (returned true) + /** + * Return error from a previous run() call. + * Error message is empty if run() succeeded (returned true) + */ QString errorMessage() const { return mErrorMessage; } //! write contents of the object to standard error stream - for debugging @@ -261,8 +290,10 @@ class ANALYSIS_EXPORT QgsAlignRaster //! Destination grid offset - expected to be in interval <0,cellsize) double mGridOffsetX, mGridOffsetY; - //! Optional clip extent: sets "requested area" which be extended to fit the raster grid. - //! Clipping not done if all coords are zeroes. + /** + * Optional clip extent: sets "requested area" which be extended to fit the raster grid. + * Clipping not done if all coords are zeroes. + */ double mClipExtent[4]; // derived data from other members diff --git a/src/analysis/raster/qgsrastermatrix.h b/src/analysis/raster/qgsrastermatrix.h index ec372e729fd2..8d71ebce68db 100644 --- a/src/analysis/raster/qgsrastermatrix.h +++ b/src/analysis/raster/qgsrastermatrix.h @@ -71,11 +71,16 @@ class ANALYSIS_EXPORT QgsRasterMatrix bool isNumber() const { return ( mColumns == 1 && mRows == 1 ); } double number() const { return mData[0]; } - //! Returns data array (but not ownership) - //! \note not available in Python bindings + /** + * Returns data array (but not ownership) + * \note not available in Python bindings + */ double *data() { return mData; } SIP_SKIP - //! Returns data and ownership. Sets data and nrows, ncols of this matrix to 0 - //! \note not available in Python bindings + + /** + * Returns data and ownership. Sets data and nrows, ncols of this matrix to 0 + * \note not available in Python bindings + */ double *takeData() SIP_SKIP; void setData( int cols, int rows, double *data, double nodataValue ); diff --git a/src/app/composer/qgscomposer.h b/src/app/composer/qgscomposer.h index 8422e9be44c2..a51768a8559c 100644 --- a/src/app/composer/qgscomposer.h +++ b/src/app/composer/qgscomposer.h @@ -129,8 +129,10 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase */ bool loadFromTemplate( const QDomDocument &templateDoc, bool clearExisting ); - //! Sets the specified feature as the current atlas feature - //! \since QGIS 2.1 + /** + * Sets the specified feature as the current atlas feature + * \since QGIS 2.1 + */ void setAtlasFeature( QgsMapLayer *layer, const QgsFeature &feat ); protected: @@ -598,8 +600,10 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase //! Create a duplicate of a menu (for Mac) QMenu *mirrorOtherMenu( QMenu *otherMenu ); - //! Toggles the state of the atlas preview and navigation controls - //! \since QGIS 2.1 + /** + * Toggles the state of the atlas preview and navigation controls + * \since QGIS 2.1 + */ void toggleAtlasControls( bool atlasEnabled ); //! Sets the printer page orientation when the page orientation changes diff --git a/src/app/nodetool/qgsnodetool.cpp b/src/app/nodetool/qgsnodetool.cpp index c0f6555a8d13..df5de4ac505e 100644 --- a/src/app/nodetool/qgsnodetool.cpp +++ b/src/app/nodetool/qgsnodetool.cpp @@ -109,8 +109,10 @@ int adjacentVertexIndexToEndpoint( const QgsGeometry &geom, int vertexIndex ) } -//! Determine whether a vertex is in the middle of a circular edge or not -//! (wrapper for slightly awkward API) +/** + * Determine whether a vertex is in the middle of a circular edge or not + * (wrapper for slightly awkward API) + */ static bool isCircularVertex( const QgsGeometry &geom, int vertexIndex ) { QgsVertexId vid; diff --git a/src/app/nodetool/qgsnodetool.h b/src/app/nodetool/qgsnodetool.h index f49f0fb75ce2..f34c5009e87f 100644 --- a/src/app/nodetool/qgsnodetool.h +++ b/src/app/nodetool/qgsnodetool.h @@ -168,18 +168,24 @@ class APP_EXPORT QgsNodeTool : public QgsMapToolAdvancedDigitizing //! Allow moving back and forth selected vertex within a feature void highlightAdjacentVertex( double offset ); - //! Initialize rectangle that is being dragged to select nodes. - //! Argument point0 is in screen coordinates. + /** + * Initialize rectangle that is being dragged to select nodes. + * Argument point0 is in screen coordinates. + */ void startSelectionRect( const QPoint &point0 ); - //! Update bottom-right corner of the existing selection rectangle. - //! Argument point1 is in screen coordinates. + /** + * Update bottom-right corner of the existing selection rectangle. + * Argument point1 is in screen coordinates. + */ void updateSelectionRect( const QPoint &point1 ); void stopSelectionRect(); - //! Using a given edge match and original map point, find out - //! center of the edge and whether we are close enough to the center + /** + * Using a given edge match and original map point, find out + * center of the edge and whether we are close enough to the center + */ bool matchEdgeCenterTest( const QgsPointLocator::Match &m, const QgsPointXY &mapPoint, QgsPointXY *edgeCenterPtr = nullptr ); void cleanupNodeEditor(); @@ -196,8 +202,11 @@ class APP_EXPORT QgsNodeTool : public QgsMapToolAdvancedDigitizing //! marker of a snap match (if any) when dragging a vertex QgsVertexMarker *mSnapMarker = nullptr; - //! marker in the middle of an edge while pointer is close to a vertex and not dragging anything - //! (highlighting point that can be clicked to add a new vertex) + + /** + * marker in the middle of an edge while pointer is close to a vertex and not dragging anything + * (highlighting point that can be clicked to add a new vertex) + */ QgsVertexMarker *mEdgeCenterMarker = nullptr; //! rubber band for highlight of a whole feature on mouse over and not dragging anything QgsRubberBand *mFeatureBand = nullptr; @@ -222,11 +231,16 @@ class APP_EXPORT QgsNodeTool : public QgsMapToolAdvancedDigitizing AddingEndpoint, }; - //! markers for points used only for moving standalone point geoetry - //! (there are no adjacent vertices so it is not used in mDragBands) + /** + * markers for points used only for moving standalone point geoetry + * (there are no adjacent vertices so it is not used in mDragBands) + */ QList mDragPointMarkers; - //! companion array to mDragPointMarkers: for each marker it keeps offset - //! (in map units) from the position of the main vertex + + /** + * companion array to mDragPointMarkers: for each marker it keeps offset + * (in map units) from the position of the main vertex + */ QList mDragPointMarkersOffset; //! structure to keep information about a rubber band user for dragging of a straight line segment @@ -260,13 +274,19 @@ class APP_EXPORT QgsNodeTool : public QgsMapToolAdvancedDigitizing DraggingVertexType mDraggingVertexType = NotDragging; //! whether we are currently dragging an edge bool mDraggingEdge = false; - //! list of Vertex instances of further vertices that are dragged together with - //! the main vertex (mDraggingVertex) - either topologically connected points - //! (if topo editing is allowed) or the ones coming from the highlight + + /** + * list of Vertex instances of further vertices that are dragged together with + * the main vertex (mDraggingVertex) - either topologically connected points + * (if topo editing is allowed) or the ones coming from the highlight + */ QList mDraggingExtraVertices; - //! companion array to mDraggingExtraVertices: for each vertex in mDraggingExtraVertices - //! this is offset (in units of the layer) of the vertex from the position of the main - //! vertex (mDraggingVertex) + + /** + * companion array to mDraggingExtraVertices: for each vertex in mDraggingExtraVertices + * this is offset (in units of the layer) of the vertex from the position of the main + * vertex (mDraggingVertex) + */ QList mDraggingExtraVerticesOffset; // members for selection handling @@ -291,16 +311,23 @@ class APP_EXPORT QgsNodeTool : public QgsMapToolAdvancedDigitizing std::unique_ptr mMouseAtEndpoint; //! QgsPointXY or None (can't get center from QgsVertexMarker) std::unique_ptr mEndpointMarkerCenter; - //! marker shown near the end of a curve to suggest that the user - //! may add a new vertex at the end of the curve + + /** + * marker shown near the end of a curve to suggest that the user + * may add a new vertex at the end of the curve + */ QgsVertexMarker *mEndpointMarker = nullptr; - //! keeps information about previously used snap match - //! to stick with the same highlighted feature next time if there are more options + /** + * keeps information about previously used snap match + * to stick with the same highlighted feature next time if there are more options + */ std::unique_ptr mLastSnap; - //! When double-clicking to add a new vertex, this member keeps the snap - //! match from "press" event used to be used in following "release" event + /** + * When double-clicking to add a new vertex, this member keeps the snap + * match from "press" event used to be used in following "release" event + */ std::unique_ptr mNewVertexFromDoubleClick; //! Geometry cache for fast access to geometries diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp index 467947d89489..d2eb74953c48 100644 --- a/src/app/qgisapp.cpp +++ b/src/app/qgisapp.cpp @@ -559,7 +559,7 @@ void QgisApp::validateCrs( QgsCoordinateReferenceSystem &srs ) QString myDefaultProjectionOption = mySettings.value( QStringLiteral( "Projections/defaultBehavior" ), "prompt" ).toString(); if ( myDefaultProjectionOption == QLatin1String( "prompt" ) ) { - // @note this class is not a descendent of QWidget so we can't pass + // \note this class is not a descendent of QWidget so we can't pass // it in the ctor of the layer projection selector QgsProjectionSelectionDialog *mySelector = new QgsProjectionSelectionDialog(); diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h index 88d5882961df..a25da3f17bdc 100644 --- a/src/app/qgisapp.h +++ b/src/app/qgisapp.h @@ -935,8 +935,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void saveLastMousePosition( const QgsPointXY & ); //! Slot to show current map scale; void showScale( double scale ); - //! Slot to handle user rotation input; - //! \since QGIS 2.8 + + /** + * Slot to handle user rotation input; + * \since QGIS 2.8 + */ void userRotation(); //! Remove a layer from the map and legend void removeLayer(); @@ -1126,8 +1129,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void dxfExport(); //! Import layers in dwg format void dwgImport(); - //! Open the project file corresponding to the - //! text)= of the given action. + + /** + * Open the project file corresponding to the + * text)= of the given action. + */ void openProject( QAction *action ); //! Save the map view as an image - user is prompted for image name using a dialog void saveMapAsImage(); diff --git a/src/app/qgisappinterface.h b/src/app/qgisappinterface.h index d7abb5cf5065..5b5851b7c354 100644 --- a/src/app/qgisappinterface.h +++ b/src/app/qgisappinterface.h @@ -169,8 +169,10 @@ class APP_EXPORT QgisAppInterface : public QgisInterface //! Add toolbar with specified name QToolBar *addToolBar( const QString &name ) override; - //! Add a toolbar - //! \since QGIS 2.3 + /** + * Add a toolbar + * \since QGIS 2.3 + */ void addToolBar( QToolBar *toolbar, Qt::ToolBarArea area = Qt::TopToolBarArea ) override; /** Open a url in the users browser. By default the QGIS doc directory is used diff --git a/src/app/qgsdiscoverrelationsdlg.cpp b/src/app/qgsdiscoverrelationsdlg.cpp index 2f8dd7aaeb29..407435c8ac17 100644 --- a/src/app/qgsdiscoverrelationsdlg.cpp +++ b/src/app/qgsdiscoverrelationsdlg.cpp @@ -58,4 +58,4 @@ QList QgsDiscoverRelationsDlg::relations() const void QgsDiscoverRelationsDlg::onSelectionChanged() { mButtonBox->button( QDialogButtonBox::Ok )->setEnabled( mRelationsTable->selectionModel()->hasSelection() ); -} \ No newline at end of file +} diff --git a/src/app/qgsmapthemes.h b/src/app/qgsmapthemes.h index 3c93b0e3f5ba..f3cdf022855f 100644 --- a/src/app/qgsmapthemes.h +++ b/src/app/qgsmapthemes.h @@ -47,8 +47,10 @@ class APP_EXPORT QgsMapThemes : public QObject //! Update existing preset using the current state of project's layer tree void updatePreset( const QString &name ); - //! Return list of layer IDs that should be visible for particular preset. - //! The order will match the layer order from the map canvas + /** + * Return list of layer IDs that should be visible for particular preset. + * The order will match the layer order from the map canvas + */ QList orderedPresetVisibleLayers( const QString &name ) const; //! Convenience menu that lists available presets and actions for management diff --git a/src/app/qgsmaptooloffsetpointsymbol.h b/src/app/qgsmaptooloffsetpointsymbol.h index 8d1b9de15ac0..26136f459214 100644 --- a/src/app/qgsmaptooloffsetpointsymbol.h +++ b/src/app/qgsmaptooloffsetpointsymbol.h @@ -74,8 +74,10 @@ class APP_EXPORT QgsMapToolOffsetPointSymbol: public QgsMapToolPointSymbol //! Create item with the point symbol for a specific feature. This will be used to show the offset to the user. void createPreviewItem( QgsMarkerSymbol *markerSymbol ); - //! Calculates the new values for offset attributes, respecting the symbol's offset units - //! \note start and end point are in map units + /** + * Calculates the new values for offset attributes, respecting the symbol's offset units + * \note start and end point are in map units + */ QMap< int, QVariant > calculateNewOffsetAttributes( const QgsPointXY &startPoint, const QgsPointXY &endPoint ) const; /** Updates the preview item to reflect a new offset. @@ -83,8 +85,10 @@ class APP_EXPORT QgsMapToolOffsetPointSymbol: public QgsMapToolPointSymbol */ void updateOffsetPreviewItem( const QgsPointXY &startPoint, const QgsPointXY &endPoint ); - //! Calculates the required offset from the start to end points, in the specified unit - //! \note start and end points are in map units + /** + * Calculates the required offset from the start to end points, in the specified unit + * \note start and end points are in map units + */ QPointF calculateOffset( const QgsPointXY &startPoint, const QgsPointXY &endPoint, QgsUnitTypes::RenderUnit unit ) const; //! Adjusts the calculated offset to account for the symbol's rotation diff --git a/src/app/qgspluginregistry.h b/src/app/qgspluginregistry.h index e1c2f541d1f8..7a20e920ba94 100644 --- a/src/app/qgspluginregistry.h +++ b/src/app/qgspluginregistry.h @@ -103,8 +103,10 @@ class APP_EXPORT QgsPluginRegistry //! Try to load and get metadata from Python plugin, return true on success bool checkPythonPlugin( const QString &packageName ); - //! Check current QGIS version against requested minimal and optionally maximal QGIS version - //! if maxVersion not specified, the default value is assumed: std::floor(minVersion) + 0.99.99 + /** + * Check current QGIS version against requested minimal and optionally maximal QGIS version + * if maxVersion not specified, the default value is assumed: std::floor(minVersion) + 0.99.99 + */ bool checkQgisVersion( const QString &minVersion, const QString &maxVersion = QString() ) const; private: diff --git a/src/app/qgsrasterlayerproperties.cpp b/src/app/qgsrasterlayerproperties.cpp index a2ae329e3b1e..23749b4b3159 100644 --- a/src/app/qgsrasterlayerproperties.cpp +++ b/src/app/qgsrasterlayerproperties.cpp @@ -593,7 +593,7 @@ void QgsRasterLayerProperties::setRendererWidget( const QString &rendererName ) } /** - @note moved from ctor + \note moved from ctor Previously this dialog was created anew with each right-click pop-up menu invocation. Changed so that the dialog always exists after first diff --git a/src/app/qgsrasterlayerproperties.h b/src/app/qgsrasterlayerproperties.h index 3f18191913dc..b53046657fbe 100644 --- a/src/app/qgsrasterlayerproperties.h +++ b/src/app/qgsrasterlayerproperties.h @@ -1,3 +1,4 @@ + /** \brief The qgsrasterlayerproperties class is used to set up how raster layers are displayed. */ /* ************************************************************************** @@ -80,8 +81,11 @@ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private void on_pbnImportTransparentPixelValues_clicked(); //! \brief slot executed when user presses "Remove Selected Row" button on the transparency page void on_pbnRemoveSelectedRow_clicked(); - //! \brief slot executed when the single band radio button is pressed. - //! \brief slot executed when the reset null value to file default icon is selected + + /** + * \brief slot executed when the single band radio button is pressed. + * \brief slot executed when the reset null value to file default icon is selected + */ //void on_btnResetNull_clicked(); void pixelSelected( const QgsPointXY & ); diff --git a/src/core/auth/qgsauthmanager.h b/src/core/auth/qgsauthmanager.h index 755546c478dc..d86d99f40fe1 100644 --- a/src/core/auth/qgsauthmanager.h +++ b/src/core/auth/qgsauthmanager.h @@ -512,32 +512,46 @@ class CORE_EXPORT QgsAuthManager : public QObject //! Return pointer to mutex QMutex *mutex() { return mMutex; } - //! Error message getter - //! @note not available in Python bindings + /** + * Error message getter + * \note not available in Python bindings + */ const QString passwordHelperErrorMessage() { return mPasswordHelperErrorMessage; } SIP_SKIP - //! Delete master password from wallet - //! @note not available in Python bindings + /** + * Delete master password from wallet + * \note not available in Python bindings + */ bool passwordHelperDelete() SIP_SKIP; - //! Password helper enabled getter - //! @note not available in Python bindings + /** + * Password helper enabled getter + * \note not available in Python bindings + */ bool passwordHelperEnabled() const SIP_SKIP; - //! Password helper enabled setter - //! @note not available in Python bindings + /** + * Password helper enabled setter + * \note not available in Python bindings + */ void setPasswordHelperEnabled( const bool enabled ) SIP_SKIP; - //! Password helper logging enabled getter - //! @note not available in Python bindings + /** + * Password helper logging enabled getter + * \note not available in Python bindings + */ bool passwordHelperLoggingEnabled() const SIP_SKIP; - //! Password helper logging enabled setter - //! @note not available in Python bindings + /** + * Password helper logging enabled setter + * \note not available in Python bindings + */ void setPasswordHelperLoggingEnabled( const bool enabled ) SIP_SKIP; - //! Store the password manager into the wallet - //! @note not available in Python bindings + /** + * Store the password manager into the wallet + * \note not available in Python bindings + */ bool passwordHelperSync() SIP_SKIP; //! The display name of the password helper (platform dependent) @@ -637,8 +651,10 @@ class CORE_EXPORT QgsAuthManager : public QObject //! Clear error code and message void passwordHelperClearErrors(); - //! Process the error: show it and/or disable the password helper system in case of - //! access denied or no backend, reset error flags at the end + /** + * Process the error: show it and/or disable the password helper system in case of + * access denied or no backend, reset error flags at the end + */ void passwordHelperProcessError(); bool createConfigTables(); diff --git a/src/core/composer/qgscomposeritemcommand.h b/src/core/composer/qgscomposeritemcommand.h index 464b1e02f0b5..8eb32a683758 100644 --- a/src/core/composer/qgscomposeritemcommand.h +++ b/src/core/composer/qgscomposeritemcommand.h @@ -64,8 +64,10 @@ class CORE_EXPORT QgsComposerItemCommand: public QUndoCommand //! XML containing the state after executing the command QDomDocument mAfterState; - //! Parameters for frame items - //! Parent multiframe + /** + * Parameters for frame items + * Parent multiframe + */ QgsComposerMultiFrame *mMultiFrame = nullptr; int mFrameNumber; diff --git a/src/core/composer/qgscomposerlegend.h b/src/core/composer/qgscomposerlegend.h index cdb7be11eecf..d394275a317e 100644 --- a/src/core/composer/qgscomposerlegend.h +++ b/src/core/composer/qgscomposerlegend.h @@ -98,25 +98,36 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem //! \since QGIS 2.6 bool autoUpdateModel() const; - //! Set whether legend items should be filtered to show just the ones visible in the associated map - //! \since QGIS 2.6 + /** + * Set whether legend items should be filtered to show just the ones visible in the associated map + * \since QGIS 2.6 + */ void setLegendFilterByMapEnabled( bool enabled ); - //! Find out whether legend items are filtered to show just the ones visible in the associated map - //! \since QGIS 2.6 + + /** + * Find out whether legend items are filtered to show just the ones visible in the associated map + * \since QGIS 2.6 + */ bool legendFilterByMapEnabled() const { return mLegendFilterByMap; } - //! Update() overloading. Use it rather than update() - //! \since QGIS 2.12 + /** + * Update() overloading. Use it rather than update() + * \since QGIS 2.12 + */ virtual void updateItem() override; - //! When set to true, during an atlas rendering, it will filter out legend elements - //! where features are outside the current atlas feature. - //! \since QGIS 2.14 + /** + * When set to true, during an atlas rendering, it will filter out legend elements + * where features are outside the current atlas feature. + * \since QGIS 2.14 + */ void setLegendFilterOutAtlas( bool doFilter ); - //! Whether to filter out legend elements outside of the current atlas feature - //! \see setLegendFilterOutAtlas() - //! \since QGIS 2.14 + /** + * Whether to filter out legend elements outside of the current atlas feature + * \see setLegendFilterOutAtlas() + * \since QGIS 2.14 + */ bool legendFilterOutAtlas() const; //setters and getters diff --git a/src/core/dxf/qgsdxfexport.h b/src/core/dxf/qgsdxfexport.h index 25437790efd1..2001b5c271e1 100644 --- a/src/core/dxf/qgsdxfexport.h +++ b/src/core/dxf/qgsdxfexport.h @@ -295,33 +295,45 @@ class CORE_EXPORT QgsDxfExport */ void writePolygon( const QgsRingSequence &polygon, const QString &layer, const QString &hatchPattern, const QColor &color ) SIP_SKIP; - //! Write line (as a polyline) - //! \since QGIS 2.15 + /** + * Write line (as a polyline) + * \since QGIS 2.15 + */ void writeLine( const QgsPoint &pt1, const QgsPoint &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 ); - //! Write point - //! \note available in Python bindings as writePointV2 - //! \since QGIS 2.15 + /** + * Write point + * \note available in Python bindings as writePointV2 + * \since QGIS 2.15 + */ void writePoint( const QString &layer, const QColor &color, const QgsPoint &pt ) SIP_PYNAME( writePointV2 ); - //! Write filled circle (as hatch) - //! \note available in Python bindings as writePointV2 - //! \since QGIS 2.15 + /** + * Write filled circle (as hatch) + * \note available in Python bindings as writePointV2 + * \since QGIS 2.15 + */ void writeFilledCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius ) SIP_PYNAME( writeFillCircleV2 ); - //! Write circle (as polyline) - //! \note available in Python bindings as writeCircleV2 - //! \since QGIS 2.15 + /** + * Write circle (as polyline) + * \note available in Python bindings as writeCircleV2 + * \since QGIS 2.15 + */ void writeCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius, const QString &lineStyleName, double width ) SIP_PYNAME( writeCircleV2 ); - //! Write text (TEXT) - //! \note available in Python bindings as writeTextV2 - //! \since QGIS 2.15 + /** + * Write text (TEXT) + * \note available in Python bindings as writeTextV2 + * \since QGIS 2.15 + */ void writeText( const QString &layer, const QString &text, const QgsPoint &pt, double size, double angle, const QColor &color ) SIP_PYNAME( writeTextV2 ); - //! Write mtext (MTEXT) - //! \note available in Python bindings as writeMTextV2 - //! \since QGIS 2.15 + /** + * Write mtext (MTEXT) + * \note available in Python bindings as writeMTextV2 + * \since QGIS 2.15 + */ void writeMText( const QString &layer, const QString &text, const QgsPoint &pt, double width, double angle, const QColor &color ); /** diff --git a/src/core/expression/qgsexpression.h b/src/core/expression/qgsexpression.h index b3f173291297..edc3a312d468 100644 --- a/src/core/expression/qgsexpression.h +++ b/src/core/expression/qgsexpression.h @@ -248,15 +248,19 @@ class CORE_EXPORT QgsExpression */ void setExpression( const QString &expression ); - //! Return the original, unmodified expression string. - //! If there was none supplied because it was constructed by sole - //! API calls, dump() will be used to create one instead. + /** + * Return the original, unmodified expression string. + * If there was none supplied because it was constructed by sole + * API calls, dump() will be used to create one instead. + */ QString expression() const; - //! Return an expression string, constructed from the internal - //! abstract syntax tree. This does not contain any nice whitespace - //! formatting or comments. In general it is preferable to use - //! expression() instead. + /** + * Return an expression string, constructed from the internal + * abstract syntax tree. This does not contain any nice whitespace + * formatting or comments. In general it is preferable to use + * expression() instead. + */ QString dump() const; /** Return calculator used for distance and area calculations @@ -368,8 +372,10 @@ class CORE_EXPORT QgsExpression */ static bool unregisterFunction( const QString &name ); - //! List of functions owned by the expression engine - //! \note not available in Python bindings + /** + * List of functions owned by the expression engine + * \note not available in Python bindings + */ static QList sOwnedFunctions SIP_SKIP; /** Deletes all registered functions whose ownership have been transferred to the expression engine. diff --git a/src/core/expression/qgsexpressionnode.h b/src/core/expression/qgsexpressionnode.h index 323c5702c6f0..e8e26275c4c3 100644 --- a/src/core/expression/qgsexpressionnode.h +++ b/src/core/expression/qgsexpressionnode.h @@ -81,9 +81,11 @@ class CORE_EXPORT QgsExpressionNode SIP_ABSTRACT }; - //! Named node - //! \since QGIS 2.16 - //! \ingroup core + /** + * Named node + * \since QGIS 2.16 + * \ingroup core + */ struct NamedNode { public: @@ -122,8 +124,10 @@ class CORE_EXPORT QgsExpressionNode SIP_ABSTRACT */ int count() const { return mList.count(); } - //! Returns true if list contains any named nodes - //! \since QGIS 2.16 + /** + * Returns true if list contains any named nodes + * \since QGIS 2.16 + */ bool hasNamedNodes() const { return mHasNamedNodes; } /** @@ -138,8 +142,10 @@ class CORE_EXPORT QgsExpressionNode SIP_ABSTRACT */ QgsExpressionNode *at( int i ) { return mList.at( i ); } - //! Returns a list of names for nodes. Unnamed nodes will be indicated by an empty string in the list. - //! \since QGIS 2.16 + /** + * Returns a list of names for nodes. Unnamed nodes will be indicated by an empty string in the list. + * \since QGIS 2.16 + */ QStringList names() const { return mNameList; } //! Creates a deep copy of this list. Ownership is transferred to the caller diff --git a/src/core/geometry/qgsgeos.cpp b/src/core/geometry/qgsgeos.cpp index 432198c81e64..c9d68625b048 100644 --- a/src/core/geometry/qgsgeos.cpp +++ b/src/core/geometry/qgsgeos.cpp @@ -105,8 +105,8 @@ static GEOSInit geosinit; /** \ingroup core - * @brief Scoped GEOS pointer - * @note not available in Python bindings + * \brief Scoped GEOS pointer + * \note not available in Python bindings */ class GEOSGeomScopedPtr { diff --git a/src/core/layertree/qgslayertreemodel.h b/src/core/layertree/qgslayertreemodel.h index e5a3323b0137..814e240bf2a5 100644 --- a/src/core/layertree/qgslayertreemodel.h +++ b/src/core/layertree/qgslayertreemodel.h @@ -65,8 +65,11 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel Q_OBJECT public: - //! Construct a new tree model with given layer tree (root node must not be null pointer). - //! The root node is not transferred by the model. + + /** + * Construct a new tree model with given layer tree (root node must not be null pointer). + * The root node is not transferred by the model. + */ explicit QgsLayerTreeModel( QgsLayerTree *rootNode, QObject *parent SIP_TRANSFERTHIS = nullptr ); ~QgsLayerTreeModel(); @@ -115,38 +118,54 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel //! Check whether a flag is enabled bool testFlag( Flag f ) const; - //! Return layer tree node for given index. Returns root node for invalid index. - //! Returns null pointer if index does not refer to a layer tree node (e.g. it is a legend node) + /** + * Return layer tree node for given index. Returns root node for invalid index. + * Returns null pointer if index does not refer to a layer tree node (e.g. it is a legend node) + */ QgsLayerTreeNode *index2node( const QModelIndex &index ) const; //! Return index for a given node. If the node does not belong to the layer tree, the result is undefined QModelIndex node2index( QgsLayerTreeNode *node ) const; - //! Convert a list of indexes to a list of layer tree nodes. - //! Indices that do not represent layer tree nodes are skipped. - //! @arg skipInternal If true, a node is included in the output list only if no parent node is in the list + + /** + * Convert a list of indexes to a list of layer tree nodes. + * Indices that do not represent layer tree nodes are skipped. + * \param skipInternal If true, a node is included in the output list only if no parent node is in the list + */ QList indexes2nodes( const QModelIndexList &list, bool skipInternal = false ) const; - //! Return legend node for given index. Returns null for invalid index - //! \since QGIS 2.6 + /** + * Return legend node for given index. Returns null for invalid index + * \since QGIS 2.6 + */ static QgsLayerTreeModelLegendNode *index2legendNode( const QModelIndex &index ); - //! Return index for a given legend node. If the legend node does not belong to the layer tree, the result is undefined. - //! If the legend node is belongs to the tree but it is filtered out, invalid model index is returned. - //! \since QGIS 2.6 + + /** + * Return index for a given legend node. If the legend node does not belong to the layer tree, the result is undefined. + * If the legend node is belongs to the tree but it is filtered out, invalid model index is returned. + * \since QGIS 2.6 + */ QModelIndex legendNode2index( QgsLayerTreeModelLegendNode *legendNode ); - //! Return filtered list of active legend nodes attached to a particular layer node - //! (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true) - //! \since QGIS 2.6 - //! \note Parameter skipNodeEmbeddedInParent added in QGIS 2.18 - //! \see layerOriginalLegendNodes() + /** + * Return filtered list of active legend nodes attached to a particular layer node + * (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true) + * \since QGIS 2.6 + * \note Parameter skipNodeEmbeddedInParent added in QGIS 2.18 + * \see layerOriginalLegendNodes() + */ QList layerLegendNodes( QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent = false ); - //! Return original (unfiltered) list of legend nodes attached to a particular layer node - //! \since QGIS 2.14 - //! \see layerLegendNodes() + /** + * Return original (unfiltered) list of legend nodes attached to a particular layer node + * \since QGIS 2.14 + * \see layerLegendNodes() + */ QList layerOriginalLegendNodes( QgsLayerTreeLayer *nodeLayer ); - //! Return legend node that may be embedded in parent (i.e. its icon will be used for layer's icon). - //! \since QGIS 2.18 + /** + * Return legend node that may be embedded in parent (i.e. its icon will be used for layer's icon). + * \since QGIS 2.18 + */ QgsLayerTreeModelLegendNode *legendNodeEmbeddedInParent( QgsLayerTreeLayer *nodeLayer ) const; /** Searches through the layer tree to find a legend node with a matching layer ID @@ -160,12 +179,17 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel //! Return pointer to the root node of the layer tree. Always a non-null pointer. QgsLayerTree *rootGroup() const; - //! Reset the model and use a new root group node - //! \since QGIS 2.6 + + /** + * Reset the model and use a new root group node + * \since QGIS 2.6 + */ void setRootGroup( QgsLayerTree *newRootGroup ); - //! Force a refresh of legend nodes of a layer node. - //! Not necessary to call when layer's renderer is changed as the model listens to these events. + /** + * Force a refresh of legend nodes of a layer node. + * Not necessary to call when layer's renderer is changed as the model listens to these events. + */ void refreshLayerLegend( QgsLayerTreeLayer *nodeLayer ); //! Get index of the item marked as current. Item marked as current is underlined. @@ -201,38 +225,54 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel */ double legendFilterByScale() const { return mLegendFilterByScale; } - //! Force only display of legend nodes which are valid for given map settings. - //! Setting null pointer or invalid map settings will disable the functionality. - //! Ownership of map settings pointer does not change, a copy is made. - //! \since QGIS 2.6 + /** + * Force only display of legend nodes which are valid for given map settings. + * Setting null pointer or invalid map settings will disable the functionality. + * Ownership of map settings pointer does not change, a copy is made. + * \since QGIS 2.6 + */ void setLegendFilterByMap( const QgsMapSettings *settings ); - //! Filter display of legend nodes for given map settings - //! \param settings Map settings. Setting a null pointer or invalid settings will disable any filter. Ownership is not changed, a copy is made - //! \param useExtent Whether to use the extent of the map settings as a first spatial filter on legend nodes - //! \param polygon If not empty, this polygon will be used instead of the map extent to filter legend nodes - //! \param useExpressions Whether to use legend node filter expressions - //! \since QGIS 2.14 + /** + * Filter display of legend nodes for given map settings + * \param settings Map settings. Setting a null pointer or invalid settings will disable any filter. Ownership is not changed, a copy is made + * \param useExtent Whether to use the extent of the map settings as a first spatial filter on legend nodes + * \param polygon If not empty, this polygon will be used instead of the map extent to filter legend nodes + * \param useExpressions Whether to use legend node filter expressions + * \since QGIS 2.14 + */ void setLegendFilter( const QgsMapSettings *settings, bool useExtent = true, const QgsGeometry &polygon = QgsGeometry(), bool useExpressions = true ); - //! Returns the current map settings used for the current legend filter (or null if none is enabled) - //! \since QGIS 2.14 + /** + * Returns the current map settings used for the current legend filter (or null if none is enabled) + * \since QGIS 2.14 + */ const QgsMapSettings *legendFilterMapSettings() const { return mLegendFilterMapSettings.get(); } - //! Give the layer tree model hints about the currently associated map view - //! so that legend nodes that use map units can be scaled currectly - //! \since QGIS 2.6 + /** + * Give the layer tree model hints about the currently associated map view + * so that legend nodes that use map units can be scaled currectly + * \since QGIS 2.6 + */ void setLegendMapViewData( double mapUnitsPerPixel, int dpi, double scale ); - //! Get hints about map view - to be used in legend nodes. Arguments that are not null will receive values. - //! If there are no valid map view data (from previous call to setLegendMapViewData()), returned values are zeros. - //! \since QGIS 2.6 + + /** + * Get hints about map view - to be used in legend nodes. Arguments that are not null will receive values. + * If there are no valid map view data (from previous call to setLegendMapViewData()), returned values are zeros. + * \since QGIS 2.6 + */ void legendMapViewData( double *mapUnitsPerPixel SIP_OUT, int *dpi SIP_OUT, double *scale SIP_OUT ) const; - //! Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one - //! \since QGIS 2.10 + /** + * Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one + * \since QGIS 2.10 + */ QMap layerStyleOverrides() const; - //! Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one - //! \since QGIS 2.10 + + /** + * Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one + * \since QGIS 2.10 + */ void setLayerStyleOverrides( const QMap &overrides ); protected slots: @@ -242,8 +282,11 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel void nodeRemovedChildren(); void nodeVisibilityChanged( QgsLayerTreeNode *node ); - //! Updates model when node's name has changed - //! \since QGIS 3.0 + + /** + * Updates model when node's name has changed + * \since QGIS 3.0 + */ void nodeNameChanged( QgsLayerTreeNode *node, const QString &name ); void nodeCustomPropertyChanged( QgsLayerTreeNode *node, const QString &key ); @@ -308,12 +351,14 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel //! Minimal number of nodes when legend should be automatically collapsed. -1 = disabled int mAutoCollapseLegendNodesCount; - //! Structure that stores tree representation of map layer's legend. - //! This structure is used only when the following requirements are met: - //! 1. tree legend representation is enabled in model (ShowLegendAsTree flag) - //! 2. some legend nodes have non-null parent rule key (accessible via data(ParentRuleKeyRole) method) - //! The tree structure (parents and children of each node) is extracted by analyzing nodes' parent rules. - //! \note not available in Python bindings + /** + * Structure that stores tree representation of map layer's legend. + * This structure is used only when the following requirements are met: + * 1. tree legend representation is enabled in model (ShowLegendAsTree flag) + * 2. some legend nodes have non-null parent rule key (accessible via data(ParentRuleKeyRole) method) + * The tree structure (parents and children of each node) is extracted by analyzing nodes' parent rules. + * \note not available in Python bindings + */ #ifndef SIP_RUN struct LayerLegendTree { @@ -324,22 +369,32 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel }; #endif - //! Structure that stores all data associated with one map layer - //! \note not available in Python bindings + /** + * Structure that stores all data associated with one map layer + * \note not available in Python bindings + */ #ifndef SIP_RUN struct LayerLegendData { LayerLegendData() = default; - //! Active legend nodes. May have been filtered. - //! Owner of legend nodes is still originalNodes ! + /** + * Active legend nodes. May have been filtered. + * Owner of legend nodes is still originalNodes ! + */ QList activeNodes; - //! A legend node that is not displayed separately, its icon is instead - //! shown within the layer node's item. - //! May be null. if non-null, node is owned by originalNodes ! + + /** + * A legend node that is not displayed separately, its icon is instead + * shown within the layer node's item. + * May be null. if non-null, node is owned by originalNodes ! + */ QgsLayerTreeModelLegendNode *embeddedNodeInParent = nullptr; - //! Data structure for storage of legend nodes. - //! These are nodes as received from QgsMapLayerLegend + + /** + * Data structure for storage of legend nodes. + * These are nodes as received from QgsMapLayerLegend + */ QList originalNodes; //! Optional pointer to a tree structure - see LayerLegendTree for details LayerLegendTree *tree = nullptr; @@ -349,8 +404,10 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel //! \note not available in Python bindings LayerLegendTree *tryBuildLegendTree( const QList &nodes ) SIP_SKIP; - //! Overrides of map layers' styles: key = layer ID, value = style XML. - //! This allows showing a legend that is different from the current style of layers + /** + * Overrides of map layers' styles: key = layer ID, value = style XML. + * This allows showing a legend that is different from the current style of layers + */ QMap mLayerStyleOverrides; //! Per layer data about layer's legend nodes diff --git a/src/core/layertree/qgslayertreemodellegendnode.h b/src/core/layertree/qgslayertreemodellegendnode.h index 8008b12f30b0..4fc8a7863444 100644 --- a/src/core/layertree/qgslayertreemodellegendnode.h +++ b/src/core/layertree/qgslayertreemodellegendnode.h @@ -176,8 +176,10 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode virtual void invalidateMapBasedData() override; - //! Set the icon size - //! \since QGIS 2.10 + /** + * Set the icon size + * \since QGIS 2.10 + */ void setIconSize( QSize sz ) { mIconSize = sz; } //! \since QGIS 2.10 QSize iconSize() const { return mIconSize; } diff --git a/src/core/layertree/qgslayertreenode.h b/src/core/layertree/qgslayertreenode.h index 48cd69b653a1..13f8c23605e8 100644 --- a/src/core/layertree/qgslayertreenode.h +++ b/src/core/layertree/qgslayertreenode.h @@ -109,19 +109,29 @@ class CORE_EXPORT QgsLayerTreeNode : public QObject //! Get list of children of the node. Children are owned by the parent QList children() const { return mChildren; } SIP_SKIP - //! Return name of the node - //! \since QGIS 3.0 + /** + * Return name of the node + * \since QGIS 3.0 + */ virtual QString name() const = 0; - //! Set name of the node. Emits nameChanged signal. - //! \since QGIS 3.0 + + /** + * Set name of the node. Emits nameChanged signal. + * \since QGIS 3.0 + */ virtual void setName( const QString &name ) = 0; - //! Read layer tree from XML. Returns new instance. - //! Does not resolve textual references to layers. Call resolveReferences() afterwards to do it. + /** + * Read layer tree from XML. Returns new instance. + * Does not resolve textual references to layers. Call resolveReferences() afterwards to do it. + */ static QgsLayerTreeNode *readXml( QDomElement &element ) SIP_FACTORY; - //! Read layer tree from XML. Returns new instance. - //! Also resolves textual references to layers from the project (calls resolveReferences() internally). - //! \since QGIS 3.0 + + /** + * Read layer tree from XML. Returns new instance. + * Also resolves textual references to layers from the project (calls resolveReferences() internally). + * \since QGIS 3.0 + */ static QgsLayerTreeNode *readXml( QDomElement &element, const QgsProject *project ) SIP_FACTORY; //! Write layer tree to XML @@ -144,32 +154,46 @@ class CORE_EXPORT QgsLayerTreeNode : public QObject */ virtual void resolveReferences( const QgsProject *project, bool looseMatching = false ) = 0; - //! Returns whether a node is really visible (ie checked and all its ancestors checked as well) - //! \since QGIS 3.0 + /** + * Returns whether a node is really visible (ie checked and all its ancestors checked as well) + * \since QGIS 3.0 + */ bool isVisible() const; - //! Returns whether a node is checked (independently of its ancestors or children) - //! \since QGIS 3.0 + /** + * Returns whether a node is checked (independently of its ancestors or children) + * \since QGIS 3.0 + */ bool itemVisibilityChecked() const { return mChecked; } - //! Check or uncheck a node (independently of its ancestors or children) - //! \since QGIS 3.0 + /** + * Check or uncheck a node (independently of its ancestors or children) + * \since QGIS 3.0 + */ void setItemVisibilityChecked( bool checked ); - //! Check or uncheck a node and all its children (taking into account exclusion rules) - //! \since QGIS 3.0 + /** + * Check or uncheck a node and all its children (taking into account exclusion rules) + * \since QGIS 3.0 + */ virtual void setItemVisibilityCheckedRecursive( bool checked ); - //! Check or uncheck a node and all its parents - //! \since QGIS 3.0 + /** + * Check or uncheck a node and all its parents + * \since QGIS 3.0 + */ void setItemVisibilityCheckedParentRecursive( bool checked ); - //! Return whether this node is checked and all its children. - //! \since QGIS 3.0 + /** + * Return whether this node is checked and all its children. + * \since QGIS 3.0 + */ bool isItemVisibilityCheckedRecursive() const; - //! Return whether this node is unchecked and all its children. - //! \since QGIS 3.0 + /** + * Return whether this node is unchecked and all its children. + * \since QGIS 3.0 + */ bool isItemVisibilityUncheckedRecursive() const; /** @@ -211,8 +235,11 @@ class CORE_EXPORT QgsLayerTreeNode : public QObject void customPropertyChanged( QgsLayerTreeNode *node, const QString &key ); //! Emitted when the collapsed/expanded state of a node within the tree has been changed void expandedChanged( QgsLayerTreeNode *node, bool expanded ); - //! Emitted when the name of the node is changed - //! \since QGIS 3.0 + + /** + * Emitted when the name of the node is changed + * \since QGIS 3.0 + */ void nameChanged( QgsLayerTreeNode *node, QString name ); protected: diff --git a/src/core/layertree/qgslayertreeregistrybridge.h b/src/core/layertree/qgslayertreeregistrybridge.h index 41e0ce3d5efc..5be34db600ec 100644 --- a/src/core/layertree/qgslayertreeregistrybridge.h +++ b/src/core/layertree/qgslayertreeregistrybridge.h @@ -53,13 +53,18 @@ class CORE_EXPORT QgsLayerTreeRegistryBridge : public QObject void setNewLayersVisible( bool enabled ) { mNewLayersVisible = enabled; } bool newLayersVisible() const { return mNewLayersVisible; } - //! Set where the new layers should be inserted - can be used to follow current selection. - //! By default it is root group with zero index. + /** + * Set where the new layers should be inserted - can be used to follow current selection. + * By default it is root group with zero index. + */ void setLayerInsertionPoint( QgsLayerTreeGroup *parentGroup, int index ); signals: - //! Tell others we have just added layers to the tree (used in QGIS to auto-select first newly added layer) - //! \since QGIS 2.6 + + /** + * Tell others we have just added layers to the tree (used in QGIS to auto-select first newly added layer) + * \since QGIS 2.6 + */ void addedLayersToLayerTree( const QList &layers ); protected slots: diff --git a/src/core/layertree/qgslayertreeutils.h b/src/core/layertree/qgslayertreeutils.h index 5cb858ea78da..70db8603b028 100644 --- a/src/core/layertree/qgslayertreeutils.h +++ b/src/core/layertree/qgslayertreeutils.h @@ -76,11 +76,13 @@ class CORE_EXPORT QgsLayerTreeUtils //! Test if one of the layers in a group has an expression filter static bool hasLegendFilterExpression( const QgsLayerTreeGroup &group ); - //! Insert a QgsMapLayer just below another one - //! \param group the tree group where layers are (can be the root group) - //! \param refLayer the reference layer - //! \param layerToInsert the new layer to insert just below the reference layer - //! \returns the new tree layer + /** + * Insert a QgsMapLayer just below another one + * \param group the tree group where layers are (can be the root group) + * \param refLayer the reference layer + * \param layerToInsert the new layer to insert just below the reference layer + * \returns the new tree layer + */ static QgsLayerTreeLayer *insertLayerBelow( QgsLayerTreeGroup *group, const QgsMapLayer *refLayer, QgsMapLayer *layerToInsert ); }; diff --git a/src/core/pal/feature.h b/src/core/pal/feature.h index 36ef6a0dc0ed..52faea6ee718 100644 --- a/src/core/pal/feature.h +++ b/src/core/pal/feature.h @@ -239,15 +239,19 @@ namespace pal //! Returns true if the feature's label has a fixed position bool hasFixedPosition() const { return mLF->hasFixedPosition(); } - //! Returns true if the feature's label should always been shown, - //! even when it collides with other labels + /** + * Returns true if the feature's label should always been shown, + * even when it collides with other labels + */ bool alwaysShow() const { return mLF->alwaysShow(); } //! Returns true if the feature should act as an obstacle to labels bool isObstacle() const { return mLF->isObstacle(); } - //! Returns the feature's obstacle factor, which represents the penalty - //! incurred for a label to overlap the feature + /** + * Returns the feature's obstacle factor, which represents the penalty + * incurred for a label to overlap the feature + */ double obstacleFactor() const { return mLF->obstacleFactor(); } //! Returns the distance between repeating labels for this feature diff --git a/src/core/qgis.h b/src/core/qgis.h index 94ccc635912e..6be2a4c73e95 100644 --- a/src/core/qgis.h +++ b/src/core/qgis.h @@ -192,9 +192,11 @@ template inline QgsSignalBlocker whileBlocking( Object *ob //! Hash for QVariant CORE_EXPORT uint qHash( const QVariant &variant ); -//! Returns a string representation of a double -//! \param a double value -//! \param precision number of decimal places to retain +/** + * Returns a string representation of a double + * \param a double value + * \param precision number of decimal places to retain + */ inline QString qgsDoubleToString( double a, int precision = 17 ) { if ( precision ) @@ -203,20 +205,24 @@ inline QString qgsDoubleToString( double a, int precision = 17 ) return QString::number( a, 'f', precision ); } -//! Compare two doubles (but allow some difference) -//! \param a first double -//! \param b second double -//! \param epsilon maximum difference allowable between doubles +/** + * Compare two doubles (but allow some difference) + * \param a first double + * \param b second double + * \param epsilon maximum difference allowable between doubles + */ inline bool qgsDoubleNear( double a, double b, double epsilon = 4 * DBL_EPSILON ) { const double diff = a - b; return diff > -epsilon && diff <= epsilon; } -//! Compare two floats (but allow some difference) -//! \param a first float -//! \param b second float -//! \param epsilon maximum difference allowable between floats +/** + * Compare two floats (but allow some difference) + * \param a first float + * \param b second float + * \param epsilon maximum difference allowable between floats + */ inline bool qgsFloatNear( float a, float b, float epsilon = 4 * FLT_EPSILON ) { const float diff = a - b; @@ -295,16 +301,20 @@ CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok ); */ CORE_EXPORT int qgsPermissiveToInt( QString string, bool &ok ); -//! Compares two QVariant values and returns whether the first is less than the second. -//! Useful for sorting lists of variants, correctly handling sorting of the various -//! QVariant data types (such as strings, numeric values, dates and times) -//! \see qgsVariantGreaterThan() +/** + * Compares two QVariant values and returns whether the first is less than the second. + * Useful for sorting lists of variants, correctly handling sorting of the various + * QVariant data types (such as strings, numeric values, dates and times) + * \see qgsVariantGreaterThan() + */ CORE_EXPORT bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs ); -//! Compares two QVariant values and returns whether the first is greater than the second. -//! Useful for sorting lists of variants, correctly handling sorting of the various -//! QVariant data types (such as strings, numeric values, dates and times) -//! \see qgsVariantLessThan() +/** + * Compares two QVariant values and returns whether the first is greater than the second. + * Useful for sorting lists of variants, correctly handling sorting of the various + * QVariant data types (such as strings, numeric values, dates and times) + * \see qgsVariantLessThan() + */ CORE_EXPORT bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs ); CORE_EXPORT QString qgsVsiPrefix( const QString &path ); diff --git a/src/core/qgsaggregatecalculator.h b/src/core/qgsaggregatecalculator.h index 52a96ac238f7..73eebbbd722d 100644 --- a/src/core/qgsaggregatecalculator.h +++ b/src/core/qgsaggregatecalculator.h @@ -42,8 +42,10 @@ class CORE_EXPORT QgsAggregateCalculator { public: - //! Available aggregates to calculate. Not all aggregates are available for all field - //! types. + /** + * Available aggregates to calculate. Not all aggregates are available for all field + * types. + */ enum Aggregate { Count, //!< Count diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h index 5f76c996fdb5..1ffa4b558f15 100644 --- a/src/core/qgsapplication.h +++ b/src/core/qgsapplication.h @@ -288,16 +288,22 @@ class CORE_EXPORT QgsApplication : public QApplication //! Returns the path to the default theme directory. static QString defaultThemePath(); - //! Returns path to the desired icon file. - //! First it tries to use the active theme path, then default theme path + /** + * Returns path to the desired icon file. + * First it tries to use the active theme path, then default theme path + */ static QString iconPath( const QString &iconFile ); - //! Helper to get a theme icon. It will fall back to the - //! default theme if the active theme does not have the required icon. + /** + * Helper to get a theme icon. It will fall back to the + * default theme if the active theme does not have the required icon. + */ static QIcon getThemeIcon( const QString &name ); - //! Helper to get a theme icon as a pixmap. It will fall back to the - //! default theme if the active theme does not have the required icon. + /** + * Helper to get a theme icon as a pixmap. It will fall back to the + * default theme if the active theme does not have the required icon. + */ static QPixmap getThemePixmap( const QString &name ); //! Returns the path to user's style. diff --git a/src/core/qgsbrowsermodel.h b/src/core/qgsbrowsermodel.h index 405bca044ed1..2b19b4eed4db 100644 --- a/src/core/qgsbrowsermodel.h +++ b/src/core/qgsbrowsermodel.h @@ -134,8 +134,11 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel signals: //! Emitted when item children fetch was finished void stateChanged( const QModelIndex &index, QgsDataItem::State oldState ); - //! Connections changed in the browser, forwarded to the widget and used to - //! notify the provider dialogs of a changed connection + + /** + * Connections changed in the browser, forwarded to the widget and used to + * notify the provider dialogs of a changed connection + */ void connectionsChanged(); public slots: diff --git a/src/core/qgsconnectionpool.h b/src/core/qgsconnectionpool.h index 20c42e93d595..1290b3f58243 100644 --- a/src/core/qgsconnectionpool.h +++ b/src/core/qgsconnectionpool.h @@ -256,8 +256,10 @@ class QgsConnectionPool mMutex.unlock(); } - //! Try to acquire a connection: if no connections are available, the thread will get blocked. - //! \returns initialized connection or null on error + /** + * Try to acquire a connection: if no connections are available, the thread will get blocked. + * \returns initialized connection or null on error + */ T acquireConnection( const QString &connInfo ) { mMutex.lock(); @@ -284,11 +286,13 @@ class QgsConnectionPool group->release( conn ); } - //! Invalidates all connections to the specified resource. - //! The internal state of certain handles (for instance OGR) are altered - //! when a dataset is modified. Consquently, all open handles need to be - //! invalidated when such datasets are changed to ensure the handles are - //! refreshed. See the OGR provider for an example where this is needed. + /** + * Invalidates all connections to the specified resource. + * The internal state of certain handles (for instance OGR) are altered + * when a dataset is modified. Consquently, all open handles need to be + * invalidated when such datasets are changed to ensure the handles are + * refreshed. See the OGR provider for an example where this is needed. + */ void invalidateConnections( const QString &connInfo ) { mMutex.lock(); diff --git a/src/core/qgscoordinatereferencesystem.h b/src/core/qgscoordinatereferencesystem.h index a08db20504bd..4b4a6217c43b 100644 --- a/src/core/qgscoordinatereferencesystem.h +++ b/src/core/qgscoordinatereferencesystem.h @@ -664,8 +664,10 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ RecordMap getRecord( const QString &sql ); - //! Open SQLite db and show message if cannot be opened - //! \returns the same code as sqlite3_open + /** + * Open SQLite db and show message if cannot be opened + * \returns the same code as sqlite3_open + */ static int openDatabase( const QString &path, sqlite3 **db, bool readonly = true ); //! Work out the projection units and set the appropriate local variable @@ -677,8 +679,10 @@ class CORE_EXPORT QgsCoordinateReferenceSystem //! Helper for sql-safe value quoting static QString quotedValue( QString value ); - //! Initialize the CRS object by looking up CRS database in path given in db argument, - //! using first CRS entry where expression = 'value' + /** + * Initialize the CRS object by looking up CRS database in path given in db argument, + * using first CRS entry where expression = 'value' + */ bool loadFromDatabase( const QString &db, const QString &expression, const QString &value ); static bool loadIds( QHash &wkts ); diff --git a/src/core/qgscoordinatetransform_p.h b/src/core/qgscoordinatetransform_p.h index 1797c1be4633..fd078cb7df82 100644 --- a/src/core/qgscoordinatetransform_p.h +++ b/src/core/qgscoordinatetransform_p.h @@ -72,8 +72,10 @@ class QgsCoordinateTransformPrivate : public QSharedData QPair< projPJ, projPJ > threadLocalProjData(); - //! Flag to indicate whether the transform is valid (ie has a valid - //! source and destination crs) + /** + * Flag to indicate whether the transform is valid (ie has a valid + * source and destination crs) + */ bool mIsValid = false; /** diff --git a/src/core/qgsdatadefinedsizelegend.h b/src/core/qgsdatadefinedsizelegend.h index 3c29c9f40417..72296c926843 100644 --- a/src/core/qgsdatadefinedsizelegend.h +++ b/src/core/qgsdatadefinedsizelegend.h @@ -125,9 +125,11 @@ class CORE_EXPORT QgsDataDefinedSizeLegend //! Generates legend symbol items according to the configuration QgsLegendSymbolList legendSymbolList() const; - //! Draw the legend if using LegendOneNodeForAll and optionally output size of the legend and x offset of labels (in painter units). - //! If the painter in context is null, it only does size calculation without actual rendering. - //! Does nothing if legend is not configured as collapsed. + /** + * Draw the legend if using LegendOneNodeForAll and optionally output size of the legend and x offset of labels (in painter units). + * If the painter in context is null, it only does size calculation without actual rendering. + * Does nothing if legend is not configured as collapsed. + */ void drawCollapsedLegend( QgsRenderContext &context, QSize *outputSize SIP_OUT = nullptr, int *labelXOffset SIP_OUT = nullptr ) const; //! Returns output image that would be shown in the legend. Returns invalid image if legend is not configured as collapsed. diff --git a/src/core/qgsdataitem.h b/src/core/qgsdataitem.h index 6f672f9538b9..4195b99b9b14 100644 --- a/src/core/qgsdataitem.h +++ b/src/core/qgsdataitem.h @@ -320,10 +320,13 @@ class CORE_EXPORT QgsDataItem : public QObject void endRemoveItems(); void dataChanged( QgsDataItem *item ); void stateChanged( QgsDataItem *item, QgsDataItem::State oldState ); - //! Emitted when the provider's connections of the child items have changed - //! This signal is normally forwarded to the app in order to refresh the connection - //! item in the provider dialogs and to refresh the connection items in the other - //! open browsers + + /** + * Emitted when the provider's connections of the child items have changed + * This signal is normally forwarded to the app in order to refresh the connection + * item in the provider dialogs and to refresh the connection items in the other + * open browsers + */ void connectionsChanged(); protected slots: diff --git a/src/core/qgsdataitemprovider.h b/src/core/qgsdataitemprovider.h index 51bedbbc3a7e..dbdaed331094 100644 --- a/src/core/qgsdataitemprovider.h +++ b/src/core/qgsdataitemprovider.h @@ -51,12 +51,16 @@ class CORE_EXPORT QgsDataItemProvider //! Return combination of flags from QgsDataProvider::DataCapabilities virtual int capabilities() = 0; - //! Create a new instance of QgsDataItem (or null) for given path and parent item. - //! Caller takes responsibility of deleting created items. + /** + * Create a new instance of QgsDataItem (or null) for given path and parent item. + * Caller takes responsibility of deleting created items. + */ virtual QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem ) = 0 SIP_FACTORY; - //! Create a vector of instances of QgsDataItem (or null) for given path and parent item. - //! Caller takes responsibility of deleting created items. + /** + * Create a vector of instances of QgsDataItem (or null) for given path and parent item. + * Caller takes responsibility of deleting created items. + */ virtual QVector createDataItems( const QString &path, QgsDataItem *parentItem ) { Q_UNUSED( path ); Q_UNUSED( parentItem ); return QVector(); } /** diff --git a/src/core/qgsdatasourceuri.h b/src/core/qgsdatasourceuri.h index bc0e680dc770..2497ebdb804f 100644 --- a/src/core/qgsdatasourceuri.h +++ b/src/core/qgsdatasourceuri.h @@ -79,14 +79,18 @@ class CORE_EXPORT QgsDataSourceUri //! quoted table name QString quotedTablename() const; - //! Set generic param (generic mode) - //! \note if key exists, another is inserted + /** + * Set generic param (generic mode) + * \note if key exists, another is inserted + */ void setParam( const QString &key, const QString &value ); //! \note available in Python as setParamList void setParam( const QString &key, const QStringList &value ) SIP_PYNAME( setParamList ); - //! Remove generic param (generic mode) - //! \note remove all occurrences of key, returns number of params removed + /** + * Remove generic param (generic mode) + * \note remove all occurrences of key, returns number of params removed + */ int removeParam( const QString &key ); //! Get generic param (generic mode) diff --git a/src/core/qgsdiagramrenderer.h b/src/core/qgsdiagramrenderer.h index a8115820e0b3..cef6cf22cca0 100644 --- a/src/core/qgsdiagramrenderer.h +++ b/src/core/qgsdiagramrenderer.h @@ -308,9 +308,11 @@ class CORE_EXPORT QgsDiagramLayerSettings //! Diagram placement flags LinePlacementFlags mPlacementFlags = OnLine; - //! Placement priority, where 0 = low and 10 = high - //! \note placement priority is shared with labeling, so diagrams with a high priority may displace labels - //! and vice-versa + /** + * Placement priority, where 0 = low and 10 = high + * \note placement priority is shared with labeling, so diagrams with a high priority may displace labels + * and vice-versa + */ int mPriority = 5; //! Z-index of diagrams, where diagrams with a higher z-index are drawn on top of diagrams with a lower z-index diff --git a/src/core/qgsfeatureiterator.h b/src/core/qgsfeatureiterator.h index f4bbd6aa82b2..383b16b1ac91 100644 --- a/src/core/qgsfeatureiterator.h +++ b/src/core/qgsfeatureiterator.h @@ -151,8 +151,10 @@ class CORE_EXPORT QgsAbstractFeatureIterator */ bool mZombie; - //! reference counting (to allow seamless copying of QgsFeatureIterator instances) - //! TODO QGIS3: make this private + /** + * reference counting (to allow seamless copying of QgsFeatureIterator instances) + * TODO QGIS3: make this private + */ int refs; //! Add reference void ref(); diff --git a/src/core/qgsfeaturerequest.h b/src/core/qgsfeaturerequest.h index b04d1534bf02..25a4c039bd5a 100644 --- a/src/core/qgsfeaturerequest.h +++ b/src/core/qgsfeaturerequest.h @@ -477,8 +477,10 @@ class CORE_EXPORT QgsFeatureRequest QgsFeatureRequest &setFlags( QgsFeatureRequest::Flags flags ); const Flags &flags() const { return mFlags; } - //! Set a subset of attributes that will be fetched. Empty list means that all attributes are used. - //! To disable fetching attributes, reset the FetchAttributes flag (which is set by default) + /** + * Set a subset of attributes that will be fetched. Empty list means that all attributes are used. + * To disable fetching attributes, reset the FetchAttributes flag (which is set by default) + */ QgsFeatureRequest &setSubsetOfAttributes( const QgsAttributeList &attrs ); /** @@ -493,11 +495,16 @@ class CORE_EXPORT QgsFeatureRequest //! Set a subset of attributes by names that will be fetched QgsFeatureRequest &setSubsetOfAttributes( const QSet &attrNames, const QgsFields &fields ); - //! Set a simplification method for geometries that will be fetched - //! \since QGIS 2.2 + /** + * Set a simplification method for geometries that will be fetched + * \since QGIS 2.2 + */ QgsFeatureRequest &setSimplifyMethod( const QgsSimplifyMethod &simplifyMethod ); - //! Get simplification method for geometries that will be fetched - //! \since QGIS 2.2 + + /** + * Get simplification method for geometries that will be fetched + * \since QGIS 2.2 + */ const QgsSimplifyMethod &simplifyMethod() const { return mSimplifyMethod; } /** diff --git a/src/core/qgsfields.h b/src/core/qgsfields.h index 831879eb71c7..e90a41043ad3 100644 --- a/src/core/qgsfields.h +++ b/src/core/qgsfields.h @@ -134,9 +134,11 @@ class CORE_EXPORT QgsFields //! Return number of items int size() const; - //! Return if a field index is valid - //! \param i Index of the field which needs to be checked - //! \returns True if the field exists + /** + * Return if a field index is valid + * \param i Index of the field which needs to be checked + * \returns True if the field exists + */ bool exists( int i ) const; #ifndef SIP_RUN @@ -279,8 +281,10 @@ class CORE_EXPORT QgsFields */ int lookupField( const QString &fieldName ) const; - //! Utility function to get list of attribute indexes - //! \since QGIS 2.4 + /** + * Utility function to get list of attribute indexes + * \since QGIS 2.4 + */ QgsAttributeList allAttributesList() const; //! Utility function to return a list of QgsField instances diff --git a/src/core/qgsjsonutils.h b/src/core/qgsjsonutils.h index a5d888f895b3..a3afb2aa4419 100644 --- a/src/core/qgsjsonutils.h +++ b/src/core/qgsjsonutils.h @@ -177,8 +177,10 @@ class CORE_EXPORT QgsJsonExporter //! Maximum number of decimal places for geometry coordinates int mPrecision; - //! List of attribute indexes to include in export, or empty list to include all attributes - //! \see mExcludedAttributeIndexes + /** + * List of attribute indexes to include in export, or empty list to include all attributes + * \see mExcludedAttributeIndexes + */ QgsAttributeList mAttributeIndexes; //! List of attribute indexes to exclude from export diff --git a/src/core/qgslabelfeature.h b/src/core/qgslabelfeature.h index cfd551308d6f..abd377a2c78a 100644 --- a/src/core/qgslabelfeature.h +++ b/src/core/qgslabelfeature.h @@ -186,19 +186,31 @@ class CORE_EXPORT QgsLabelFeature * \see quadOffset */ void setHasFixedQuadrant( bool enabled ) { mHasFixedQuadrant = enabled; } - //! Applies to "offset from point" placement strategy and "around point" (in case hasFixedQuadrant() returns true). - //! Determines which side of the point to use. - //! For X coordinate, values -1, 0, 1 mean left, center, right. - //! For Y coordinate, values -1, 0, 1 mean above, center, below. + + /** + * Applies to "offset from point" placement strategy and "around point" (in case hasFixedQuadrant() returns true). + * Determines which side of the point to use. + * For X coordinate, values -1, 0, 1 mean left, center, right. + * For Y coordinate, values -1, 0, 1 mean above, center, below. + */ QPointF quadOffset() const { return mQuadOffset; } - //! Set which side of the point to use - //! \see quadOffset + + /** + * Set which side of the point to use + * \see quadOffset + */ void setQuadOffset( QPointF quadOffset ) { mQuadOffset = quadOffset; } - //! Applies only to "offset from point" placement strategy. - //! What offset (in map units) to use from the point + + /** + * Applies only to "offset from point" placement strategy. + * What offset (in map units) to use from the point + */ QgsPointXY positionOffset() const { return mPositionOffset; } - //! Applies only to "offset from point" placement strategy. - //! Set what offset (in map units) to use from the point + + /** + * Applies only to "offset from point" placement strategy. + * Set what offset (in map units) to use from the point + */ void setPositionOffset( const QgsPointXY &offset ) { mPositionOffset = offset; } /** Returns the offset type, which determines how offsets and distance to label @@ -215,11 +227,16 @@ class CORE_EXPORT QgsLabelFeature */ void setOffsetType( QgsPalLayerSettings::OffsetType type ) { mOffsetType = type; } - //! Applies to "around point" placement strategy or linestring features. - //! Distance of the label from the feature (in map units) + /** + * Applies to "around point" placement strategy or linestring features. + * Distance of the label from the feature (in map units) + */ double distLabel() const { return mDistLabel; } - //! Applies to "around point" placement strategy or linestring features. - //! Set distance of the label from the feature (in map units) + + /** + * Applies to "around point" placement strategy or linestring features. + * Set distance of the label from the feature (in map units) + */ void setDistLabel( double dist ) { mDistLabel = dist; } /** Returns the priority ordered list of predefined positions for label candidates. This property @@ -234,11 +251,16 @@ class CORE_EXPORT QgsLabelFeature */ void setPredefinedPositionOrder( const QVector< QgsPalLayerSettings::PredefinedPointPosition > &order ) { mPredefinedPositionOrder = order; } - //! Applies only to linestring features - after what distance (in map units) - //! the labels should be repeated (0 = no repetitions) + /** + * Applies only to linestring features - after what distance (in map units) + * the labels should be repeated (0 = no repetitions) + */ double repeatDistance() const { return mRepeatDistance; } - //! Applies only to linestring features - set after what distance (in map units) - //! the labels should be repeated (0 = no repetitions) + + /** + * Applies only to linestring features - set after what distance (in map units) + * the labels should be repeated (0 = no repetitions) + */ void setRepeatDistance( double dist ) { mRepeatDistance = dist; } //! Whether label should be always shown (sets very high label priority) diff --git a/src/core/qgslabelingengine.h b/src/core/qgslabelingengine.h index 545b9a0c5ee1..df96bbdcc051 100644 --- a/src/core/qgslabelingengine.h +++ b/src/core/qgslabelingengine.h @@ -79,9 +79,11 @@ class CORE_EXPORT QgsAbstractLabelProvider //! Returns the associated layer, or nullptr if no layer is associated with the provider. QgsMapLayer *layer() const { return mLayer.data(); } - //! Returns provider ID - useful in case there is more than one label provider within a layer - //! (e.g. in case of rule-based labeling - provider ID = rule's key). May be empty string if - //! layer ID is sufficient for identification of provider's configuration. + /** + * Returns provider ID - useful in case there is more than one label provider within a layer + * (e.g. in case of rule-based labeling - provider ID = rule's key). May be empty string if + * layer ID is sufficient for identification of provider's configuration. + */ QString providerId() const { return mProviderId; } //! Flags associated with the provider diff --git a/src/core/qgslabelingenginesettings.h b/src/core/qgslabelingenginesettings.h index a5acc1ba9e0d..7658c553c0ba 100644 --- a/src/core/qgslabelingenginesettings.h +++ b/src/core/qgslabelingenginesettings.h @@ -25,8 +25,10 @@ class CORE_EXPORT QgsLabelingEngineSettings }; Q_DECLARE_FLAGS( Flags, Flag ) - //! Search methods in the PAL library to remove colliding labels - //! (methods have different processing speed and number of labels placed) + /** + * Search methods in the PAL library to remove colliding labels + * (methods have different processing speed and number of labels placed) + */ enum Search { Chain, diff --git a/src/core/qgslogger.h b/src/core/qgslogger.h index e8e5ca20c134..cf2c22802e94 100644 --- a/src/core/qgslogger.h +++ b/src/core/qgslogger.h @@ -69,12 +69,16 @@ class CORE_EXPORT QgsLogger //! Similar to the previous method, but prints a variable int-value pair static void debug( const QString &var, int val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 ); - //! Similar to the previous method, but prints a variable double-value pair - //! \note not available in Python bindings + /** + * Similar to the previous method, but prints a variable double-value pair + * \note not available in Python bindings + */ static void debug( const QString &var, double val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 ) SIP_SKIP SIP_SKIP; - //! Prints out a variable/value pair for types with overloaded operator<< - //! \note not available in Python bindings + /** + * Prints out a variable/value pair for types with overloaded operator<< + * \note not available in Python bindings + */ template static void debug( const QString &var, T val, const char *file = nullptr, const char *function = nullptr, int line = -1, int debuglevel = 1 ) SIP_SKIP SIP_SKIP { diff --git a/src/core/qgsmaphittest.h b/src/core/qgsmaphittest.h index c5ecc55cfa6e..a39ed26939f0 100644 --- a/src/core/qgsmaphittest.h +++ b/src/core/qgsmaphittest.h @@ -39,9 +39,11 @@ class CORE_EXPORT QgsMapHitTest //! Maps an expression string to a layer id typedef QMap LayerFilterExpression; - //! \param settings Map settings used to evaluate symbols - //! \param polygon Polygon geometry to refine the hit test - //! \param layerFilterExpression Expression string for each layer id to evaluate in order to refine the symbol selection + /** + * \param settings Map settings used to evaluate symbols + * \param polygon Polygon geometry to refine the hit test + * \param layerFilterExpression Expression string for each layer id to evaluate in order to refine the symbol selection + */ QgsMapHitTest( const QgsMapSettings &settings, const QgsGeometry &polygon = QgsGeometry(), const QgsMapHitTest::LayerFilterExpression &layerFilterExpression = QgsMapHitTest::LayerFilterExpression() ); //! Constructor version used with only expressions to filter symbols (no extent or polygon intersection) diff --git a/src/core/qgsmaplayerrenderer.h b/src/core/qgsmaplayerrenderer.h index 5be1b75e923d..bf59452ab0c6 100644 --- a/src/core/qgsmaplayerrenderer.h +++ b/src/core/qgsmaplayerrenderer.h @@ -53,8 +53,10 @@ class CORE_EXPORT QgsMapLayerRenderer //! Do the rendering (based on data stored in the class) virtual bool render() = 0; - //! Access to feedback object of the layer renderer (may be null) - //! \since QGIS 3.0 + /** + * Access to feedback object of the layer renderer (may be null) + * \since QGIS 3.0 + */ virtual QgsFeedback *feedback() const { return nullptr; } //! Return list of errors (problems) that happened during the rendering diff --git a/src/core/qgsmaplayerstylemanager.h b/src/core/qgsmaplayerstylemanager.h index 17673c53f1f1..4095718dbf1c 100644 --- a/src/core/qgsmaplayerstylemanager.h +++ b/src/core/qgsmaplayerstylemanager.h @@ -120,28 +120,44 @@ class CORE_EXPORT QgsMapLayerStyleManager : public QObject //! Return data of a stored style - accessed by its unique name QgsMapLayerStyle style( const QString &name ) const; - //! Add a style with given name and data - //! \returns true on success (name is unique and style is valid) + /** + * Add a style with given name and data + * \returns true on success (name is unique and style is valid) + */ bool addStyle( const QString &name, const QgsMapLayerStyle &style ); - //! Add style by cloning the current one - //! \returns true on success + + /** + * Add style by cloning the current one + * \returns true on success + */ bool addStyleFromLayer( const QString &name ); - //! Remove a stored style - //! \returns true on success (style exists and it is not the last one) + + /** + * Remove a stored style + * \returns true on success (style exists and it is not the last one) + */ bool removeStyle( const QString &name ); - //! Rename a stored style to a different name - //! \returns true on success (style exists and new name is unique) + + /** + * Rename a stored style to a different name + * \returns true on success (style exists and new name is unique) + */ bool renameStyle( const QString &name, const QString &newName ); //! Return name of the current style QString currentStyle() const; - //! Set a different style as the current style - will apply it to the layer - //! \returns true on success + + /** + * Set a different style as the current style - will apply it to the layer + * \returns true on success + */ bool setCurrentStyle( const QString &name ); - //! Temporarily apply a different style to the layer. The argument - //! can be either a style name or a full QML style definition. - //! Each call must be paired with restoreOverrideStyle() + /** + * Temporarily apply a different style to the layer. The argument + * can be either a style name or a full QML style definition. + * Each call must be paired with restoreOverrideStyle() + */ bool setOverrideStyle( const QString &styleDef ); //! Restore the original store after a call to setOverrideStyle() bool restoreOverrideStyle(); diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h index 66b8b3b71ed2..9e7e7a5c02b0 100644 --- a/src/core/qgsmaprendererjob.h +++ b/src/core/qgsmaprendererjob.h @@ -116,12 +116,16 @@ class CORE_EXPORT QgsMapRendererJob : public QObject QgsMapRendererJob( const QgsMapSettings &settings ); - //! Start the rendering job and immediately return. - //! Does nothing if the rendering is already in progress. + /** + * Start the rendering job and immediately return. + * Does nothing if the rendering is already in progress. + */ virtual void start() = 0; - //! Stop the rendering job - does not return until the job has terminated. - //! Does nothing if the rendering is not active. + /** + * Stop the rendering job - does not return until the job has terminated. + * Does nothing if the rendering is not active. + */ virtual void cancel() = 0; /** @@ -153,16 +157,20 @@ class CORE_EXPORT QgsMapRendererJob : public QObject */ virtual QgsLabelingResults *takeLabelingResults() = 0 SIP_TRANSFER; - //! \since QGIS 3.0 - //! Set the feature filter provider used by the QgsRenderContext of - //! each LayerRenderJob. - //! Ownership is not transferred and the provider must not be deleted - //! before the render job. + /** + * \since QGIS 3.0 + * Set the feature filter provider used by the QgsRenderContext of + * each LayerRenderJob. + * Ownership is not transferred and the provider must not be deleted + * before the render job. + */ void setFeatureFilterProvider( const QgsFeatureFilterProvider *f ) { mFeatureFilterProvider = f; } - //! \since QGIS 3.0 - //! Returns the feature filter provider used by the QgsRenderContext of - //! each LayerRenderJob. + /** + * \since QGIS 3.0 + * Returns the feature filter provider used by the QgsRenderContext of + * each LayerRenderJob. + */ const QgsFeatureFilterProvider *featureFilterProvider() const { return mFeatureFilterProvider; } struct Error @@ -182,8 +190,10 @@ class CORE_EXPORT QgsMapRendererJob : public QObject Errors errors() const; - //! Assign a cache to be used for reading and storing rendered images of individual layers. - //! Does not take ownership of the object. + /** + * Assign a cache to be used for reading and storing rendered images of individual layers. + * Does not take ownership of the object. + */ void setCache( QgsMapRendererCache *cache ); //! Find out how long it took to finish the job (in milliseconds) diff --git a/src/core/qgsmapsettings.h b/src/core/qgsmapsettings.h index 8ef7c130e886..233524f8deeb 100644 --- a/src/core/qgsmapsettings.h +++ b/src/core/qgsmapsettings.h @@ -60,15 +60,20 @@ class CORE_EXPORT QgsMapSettings public: QgsMapSettings(); - //! Return geographical coordinates of the rectangle that should be rendered. - //! The actual visible extent used for rendering could be slightly different - //! since the given extent may be expanded in order to fit the aspect ratio - //! of output size. Use visibleExtent() to get the resulting extent. + /** + * Return geographical coordinates of the rectangle that should be rendered. + * The actual visible extent used for rendering could be slightly different + * since the given extent may be expanded in order to fit the aspect ratio + * of output size. Use visibleExtent() to get the resulting extent. + */ QgsRectangle extent() const; - //! Set coordinates of the rectangle which should be rendered. - //! The actual visible extent used for rendering could be slightly different - //! since the given extent may be expanded in order to fit the aspect ratio - //! of output size. Use visibleExtent() to get the resulting extent. + + /** + * Set coordinates of the rectangle which should be rendered. + * The actual visible extent used for rendering could be slightly different + * since the given extent may be expanded in order to fit the aspect ratio + * of output size. Use visibleExtent() to get the resulting extent. + */ void setExtent( const QgsRectangle &rect, bool magnified = true ); //! Return the size of the resulting map image @@ -90,8 +95,10 @@ class CORE_EXPORT QgsMapSettings */ void setRotation( double rotation ); - //! Return DPI used for conversion between real world units (e.g. mm) and pixels - //! Default value is 96 + /** + * Return DPI used for conversion between real world units (e.g. mm) and pixels + * Default value is 96 + */ double outputDpi() const; //! Set DPI used for conversion between real world units (e.g. mm) and pixels void setOutputDpi( double dpi ); @@ -104,26 +111,41 @@ class CORE_EXPORT QgsMapSettings */ void setMagnificationFactor( double factor ); - //! Return the magnification factor. - //! \since QGIS 2.16 - //! \see setMagnificationFactor() + /** + * Return the magnification factor. + * \since QGIS 2.16 + * \see setMagnificationFactor() + */ double magnificationFactor() const; - //! Get list of layer IDs for map rendering - //! The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + /** + * Get list of layer IDs for map rendering + * The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + */ QStringList layerIds() const; - //! Get list of layers for map rendering - //! The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + + /** + * Get list of layers for map rendering + * The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + */ QList layers() const; - //! Set list of layers for map rendering. The layers must be registered in QgsProject. - //! The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + + /** + * Set list of layers for map rendering. The layers must be registered in QgsProject. + * The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) + */ void setLayers( const QList &layers ); - //! Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one - //! \since QGIS 2.8 + /** + * Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one + * \since QGIS 2.8 + */ QMap layerStyleOverrides() const; - //! Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one - //! \since QGIS 2.8 + + /** + * Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one + * \since QGIS 2.8 + */ void setLayerStyleOverrides( const QMap &overrides ); /** Get custom rendering flags. Layers might honour these to alter their rendering. @@ -210,8 +232,11 @@ class CORE_EXPORT QgsMapSettings bool hasValidSettings() const; //! Return the actual extent derived from requested extent that takes takes output image size into account QgsRectangle visibleExtent() const; - //! Return the visible area as a polygon (may be rotated) - //! \since QGIS 2.8 + + /** + * Return the visible area as a polygon (may be rotated) + * \since QGIS 2.8 + */ QPolygonF visiblePolygon() const; //! Return the distance in geographical coordinates that equals to one pixel in the map double mapUnitsPerPixel() const; diff --git a/src/core/qgsmapthemecollection.h b/src/core/qgsmapthemecollection.h index fe7e68501fbe..351b125da472 100644 --- a/src/core/qgsmapthemecollection.h +++ b/src/core/qgsmapthemecollection.h @@ -122,8 +122,10 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject //! Add a new record for a layer. void addLayerRecord( const QgsMapThemeCollection::MapThemeLayerRecord &record ); - //! Return set with only records for valid layers - //! \note not available in Python bindings + /** + * Return set with only records for valid layers + * \note not available in Python bindings + */ QHash validLayerRecords() const SIP_SKIP; private: diff --git a/src/core/qgsmessageoutput.h b/src/core/qgsmessageoutput.h index ae95707d4437..7a557259a949 100644 --- a/src/core/qgsmessageoutput.h +++ b/src/core/qgsmessageoutput.h @@ -64,13 +64,17 @@ class CORE_EXPORT QgsMessageOutput */ static void showMessage( const QString &title, const QString &message, MessageType msgType ); - //! sets function that will be used to create message output - //! \note not available in Python bindings + /** + * sets function that will be used to create message output + * \note not available in Python bindings + */ // TODO: implementation where Python class could be passed static void setMessageOutputCreator( MESSAGE_OUTPUT_CREATOR f ) SIP_SKIP; - //! function that returns new class derived from QgsMessageOutput - //! (don't forget to delete it then if showMessage(bool) is not used showMessage(bool) deletes the instance) + /** + * function that returns new class derived from QgsMessageOutput + * (don't forget to delete it then if showMessage(bool) is not used showMessage(bool) deletes the instance) + */ static QgsMessageOutput *createMessageOutput(); private: diff --git a/src/core/qgsmimedatautils.h b/src/core/qgsmimedatautils.h index af85d6afcc25..06f031dac82d 100644 --- a/src/core/qgsmimedatautils.h +++ b/src/core/qgsmimedatautils.h @@ -39,8 +39,10 @@ class CORE_EXPORT QgsMimeDataUtils //! Constructs URI from encoded data explicit Uri( QString &encData ); - //! Returns whether the object contains valid data - //! \since QGIS 3.0 + /** + * Returns whether the object contains valid data + * \since QGIS 3.0 + */ bool isValid() const { return !layerType.isEmpty(); } //! Returns encoded representation of the object @@ -60,9 +62,12 @@ class CORE_EXPORT QgsMimeDataUtils //! Type of URI. Recognized types: "vector" / "raster" / "plugin" / "custom" QString layerType; - //! For "vector" / "raster" type: provider id. - //! For "plugin" type: plugin layer type name. - //! For "custom" type: key of its QgsCustomDropHandler + + /** + * For "vector" / "raster" type: provider id. + * For "plugin" type: plugin layer type name. + * For "custom" type: key of its QgsCustomDropHandler + */ QString providerKey; //! Human readable name to be used e.g. in layer tree QString name; diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h index 1ec9c146415f..ce3ae2904112 100644 --- a/src/core/qgspallabeling.h +++ b/src/core/qgspallabeling.h @@ -160,8 +160,10 @@ class CORE_EXPORT QgsPalLayerSettings BottomRight, //!< Label on bottom right of point }; - //! Behavior modifier for label offset and distance, only applies in some - //! label placement modes. + /** + * Behavior modifier for label offset and distance, only applies in some + * label placement modes. + */ //TODO QGIS 3.0 - move to QgsLabelingEngine enum OffsetType { @@ -930,8 +932,10 @@ class CORE_EXPORT QgsPalLabeling { public: - //! called to find out whether the layer is used for labeling - //! \since QGIS 2.4 + /** + * called to find out whether the layer is used for labeling + * \since QGIS 2.4 + */ static bool staticWillUseLayer( QgsVectorLayer *layer ); //! \note not available in Python bindings diff --git a/src/core/qgspointlocator.cpp b/src/core/qgspointlocator.cpp index 07a5fbd8e36d..9e3863a07a8f 100644 --- a/src/core/qgspointlocator.cpp +++ b/src/core/qgspointlocator.cpp @@ -56,7 +56,7 @@ static const double POINT_LOC_EPSILON = 1e-12; /** \ingroup core * Helper class for bulk loading of R-trees. - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsPointLocator_Stream : public IDataStream { @@ -83,7 +83,7 @@ class QgsPointLocator_Stream : public IDataStream /** \ingroup core * Helper class used when traversing the index looking for vertices - builds a list of matches. - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsPointLocator_VisitorNearestVertex : public IVisitor { @@ -131,7 +131,7 @@ class QgsPointLocator_VisitorNearestVertex : public IVisitor /** \ingroup core * Helper class used when traversing the index looking for edges - builds a list of matches. - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsPointLocator_VisitorNearestEdge : public IVisitor { @@ -181,7 +181,7 @@ class QgsPointLocator_VisitorNearestEdge : public IVisitor /** \ingroup core * Helper class used when traversing the index with areas - builds a list of matches. - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsPointLocator_VisitorArea : public IVisitor { @@ -522,7 +522,7 @@ static QgsPointLocator::MatchList _geometrySegmentsInRect( QgsGeometry *geom, co /** \ingroup core * Helper class used when traversing the index looking for edges - builds a list of matches. - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsPointLocator_VisitorEdgesInRect : public IVisitor { @@ -566,7 +566,7 @@ class QgsPointLocator_VisitorEdgesInRect : public IVisitor /** \ingroup core * Helper class to dump the R-index nodes and their content - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsPointLocator_DumpTree : public SpatialIndex::IQueryStrategy { diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h index 37931eb35cdd..a92184f45a26 100644 --- a/src/core/qgspointlocator.h +++ b/src/core/qgspointlocator.h @@ -52,26 +52,37 @@ class CORE_EXPORT QgsPointLocator : public QObject public: /** Construct point locator for a layer. - * @arg destinationCrs if a valid QgsCoordinateReferenceSystem is passed then the locator will + * \param destinationCrs if a valid QgsCoordinateReferenceSystem is passed then the locator will * do the searches on data reprojected to the given CRS - * @arg extent if not null, will index only a subset of the layer + * \param extent if not null, will index only a subset of the layer */ explicit QgsPointLocator( QgsVectorLayer *layer, const QgsCoordinateReferenceSystem &destinationCrs = QgsCoordinateReferenceSystem(), const QgsRectangle *extent = nullptr ); ~QgsPointLocator(); - //! Get associated layer - //! \since QGIS 2.14 + /** + * Get associated layer + * \since QGIS 2.14 + */ QgsVectorLayer *layer() const { return mLayer; } - //! Get destination CRS - may be an invalid QgsCoordinateReferenceSystem if not doing OTF reprojection - //! \since QGIS 2.14 + + /** + * Get destination CRS - may be an invalid QgsCoordinateReferenceSystem if not doing OTF reprojection + * \since QGIS 2.14 + */ QgsCoordinateReferenceSystem destinationCrs() const; - //! Get extent of the area point locator covers - if null then it caches the whole layer - //! \since QGIS 2.14 + + /** + * Get extent of the area point locator covers - if null then it caches the whole layer + * \since QGIS 2.14 + */ const QgsRectangle *extent() const { return mExtent; } - //! Configure extent - if not null, it will index only that area - //! \since QGIS 2.14 + + /** + * Configure extent - if not null, it will index only that area + * \since QGIS 2.14 + */ void setExtent( const QgsRectangle *extent ); /** @@ -125,12 +136,16 @@ class CORE_EXPORT QgsPointLocator : public QObject bool hasEdge() const { return mType == Edge; } bool hasArea() const { return mType == Area; } - //! for vertex / edge match - //! units depending on what class returns it (geom.cache: layer units, map canvas snapper: dest crs units) + /** + * for vertex / edge match + * units depending on what class returns it (geom.cache: layer units, map canvas snapper: dest crs units) + */ double distance() const { return mDist; } - //! for vertex / edge match - //! coords depending on what class returns it (geom.cache: layer coords, map canvas snapper: dest coords) + /** + * for vertex / edge match + * coords depending on what class returns it (geom.cache: layer coords, map canvas snapper: dest coords) + */ QgsPointXY point() const { return mPoint; } //! for vertex / edge match (first vertex of the edge) @@ -181,9 +196,11 @@ class CORE_EXPORT QgsPointLocator : public QObject typedef QList MatchList; #endif - //! Interface that allows rejection of some matches in intersection queries - //! (e.g. a match can only belong to a particular feature / match must not be a particular point). - //! Implement the interface and pass its instance to QgsPointLocator or QgsSnappingUtils methods. + /** + * Interface that allows rejection of some matches in intersection queries + * (e.g. a match can only belong to a particular feature / match must not be a particular point). + * Implement the interface and pass its instance to QgsPointLocator or QgsSnappingUtils methods. + */ struct MatchFilter { virtual ~MatchFilter() = default; @@ -192,14 +209,22 @@ class CORE_EXPORT QgsPointLocator : public QObject // intersection queries - //! Find nearest vertex to the specified point - up to distance specified by tolerance - //! Optional filter may discard unwanted matches. + /** + * Find nearest vertex to the specified point - up to distance specified by tolerance + * Optional filter may discard unwanted matches. + */ Match nearestVertex( const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter = nullptr ); - //! Find nearest edge to the specified point - up to distance specified by tolerance - //! Optional filter may discard unwanted matches. + + /** + * Find nearest edge to the specified point - up to distance specified by tolerance + * Optional filter may discard unwanted matches. + */ Match nearestEdge( const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter = nullptr ); - //! Find edges within a specified recangle - //! Optional filter may discard unwanted matches. + + /** + * Find edges within a specified recangle + * Optional filter may discard unwanted matches. + */ MatchList edgesInRect( const QgsRectangle &rect, QgsPointLocator::MatchFilter *filter = nullptr ); //! Override of edgesInRect that construct rectangle from a center point and tolerance MatchList edgesInRect( const QgsPointXY &point, double tolerance, QgsPointLocator::MatchFilter *filter = nullptr ); @@ -212,8 +237,10 @@ class CORE_EXPORT QgsPointLocator : public QObject // - //! Return how many geometries are cached in the index - //! \since QGIS 2.14 + /** + * Return how many geometries are cached in the index + * \since QGIS 2.14 + */ int cachedGeometryCount() const { return mGeoms.count(); } protected: diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h index c5e4419fff43..a644353fbcd0 100644 --- a/src/core/qgsproject.h +++ b/src/core/qgsproject.h @@ -1044,8 +1044,10 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ void clearError() SIP_SKIP; - //! Creates layer and adds it to maplayer registry - //! \note not available in Python bindings + /** + * Creates layer and adds it to maplayer registry + * \note not available in Python bindings + */ bool addLayer( const QDomElement &layerElem, QList &brokenNodes, const QgsReadWriteContext &context ) SIP_SKIP; //! \note not available in Python bindings diff --git a/src/core/qgsproviderregistry.h b/src/core/qgsproviderregistry.h index 4470f94d26a9..6b396fc9f14d 100644 --- a/src/core/qgsproviderregistry.h +++ b/src/core/qgsproviderregistry.h @@ -53,8 +53,10 @@ class CORE_EXPORT QgsProviderRegistry public: - //! Different ways a source select dialog can be used - //! (embedded is for the data source manager dialog) + /** + * Different ways a source select dialog can be used + * (embedded is for the data source manager dialog) + */ enum WidgetMode { None, diff --git a/src/core/qgsrendercontext.h b/src/core/qgsrendercontext.h index 717bb67b2df2..ee98d27463ac 100644 --- a/src/core/qgsrendercontext.h +++ b/src/core/qgsrendercontext.h @@ -90,8 +90,10 @@ class CORE_EXPORT QgsRenderContext */ bool testFlag( Flag flag ) const; - //! create initialized QgsRenderContext instance from given QgsMapSettings - //! \since QGIS 2.4 + /** + * create initialized QgsRenderContext instance from given QgsMapSettings + * \since QGIS 2.4 + */ static QgsRenderContext fromMapSettings( const QgsMapSettings &mapSettings ); /** @@ -154,8 +156,10 @@ class CORE_EXPORT QgsRenderContext */ double rendererScale() const {return mRendererScale;} - //! Get access to new labeling engine (may be nullptr) - //! \note not available in Python bindings + /** + * Get access to new labeling engine (may be nullptr) + * \note not available in Python bindings + */ QgsLabelingEngine *labelingEngine() const { return mLabelingEngine; } SIP_SKIP QColor selectionColor() const { return mSelectionColor; } @@ -211,8 +215,10 @@ class CORE_EXPORT QgsRenderContext void setForceVectorOutput( bool force ); - //! Assign new labeling engine - //! \note not available in Python bindings + /** + * Assign new labeling engine + * \note not available in Python bindings + */ void setLabelingEngine( QgsLabelingEngine *engine2 ) { mLabelingEngine = engine2; } SIP_SKIP void setSelectionColor( const QColor &color ) { mSelectionColor = color; } diff --git a/src/core/qgsrulebasedlabeling.h b/src/core/qgsrulebasedlabeling.h index 7d7c9a281f4c..acee4f76302f 100644 --- a/src/core/qgsrulebasedlabeling.h +++ b/src/core/qgsrulebasedlabeling.h @@ -248,20 +248,28 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling // evaluation - //! add providers - //! \note not available in Python bindings + /** + * add providers + * \note not available in Python bindings + */ void createSubProviders( QgsVectorLayer *layer, RuleToProviderMap &subProviders, QgsRuleBasedLabelProvider *provider ) SIP_SKIP; - //! append rule keys of descendants that contain valid settings (i.e. they will be sub-providers) - //! \note not available in Python bindings + /** + * append rule keys of descendants that contain valid settings (i.e. they will be sub-providers) + * \note not available in Python bindings + */ void subProviderIds( QStringList &list ) const SIP_SKIP; - //! call prepare() on sub-providers and populate attributeNames - //! \note not available in Python bindings + /** + * call prepare() on sub-providers and populate attributeNames + * \note not available in Python bindings + */ void prepare( const QgsRenderContext &context, QSet &attributeNames, RuleToProviderMap &subProviders ) SIP_SKIP; - //! register individual features - //! \note not available in Python bindings + /** + * register individual features + * \note not available in Python bindings + */ RegisterResult registerFeature( QgsFeature &feature, QgsRenderContext &context, RuleToProviderMap &subProviders, const QgsGeometry &obstacleGeometry = QgsGeometry() ) SIP_SKIP; /** diff --git a/src/core/qgssettings.h b/src/core/qgssettings.h index 2761b530310f..443d3bc0eaf1 100644 --- a/src/core/qgssettings.h +++ b/src/core/qgssettings.h @@ -161,7 +161,7 @@ class CORE_EXPORT QgsSettings : public QObject /** Adds prefix to the current group and starts writing an array of size size. * If size is -1 (the default), it is automatically determined based on the indexes of the entries written. - * @note This will completely shadow any existing array with the same name in the global settings + * \note This will completely shadow any existing array with the same name in the global settings */ void beginWriteArray( const QString &prefix, int size = -1 ); //! Closes the array that was started using beginReadArray() or beginWriteArray(). diff --git a/src/core/qgssnappingutils.h b/src/core/qgssnappingutils.h index e8e3684220b3..f0364986a5a5 100644 --- a/src/core/qgssnappingutils.h +++ b/src/core/qgssnappingutils.h @@ -219,14 +219,17 @@ class CORE_EXPORT QgsSnappingUtils : public QObject LocatorsMap mTemporaryLocators; //! list of layer IDs that are too large to be indexed (hybrid strategy will use temporary locators for those) QSet mHybridNonindexableLayers; - //! a record for each layer seen: - //! - value -1 == it is small layer -> fully indexed - //! - value > 0 == maximum area (in map units) for which it may make sense to build index. - //! This means that index is built in area around the point with this total area, because - //! for a larger area the number of features will likely exceed the limit. When the limit - //! is exceeded, the maximum area is lowered to prevent that from happening. - //! When requesting snap in area that is not currently indexed, layer's index is destroyed - //! and a new one is built in the different area. + + /** + * a record for each layer seen: + * - value -1 == it is small layer -> fully indexed + * - value > 0 == maximum area (in map units) for which it may make sense to build index. + * This means that index is built in area around the point with this total area, because + * for a larger area the number of features will likely exceed the limit. When the limit + * is exceeded, the maximum area is lowered to prevent that from happening. + * When requesting snap in area that is not currently indexed, layer's index is destroyed + * and a new one is built in the different area. + */ QHash mHybridMaxAreaPerLayer; //! if using hybrid strategy, how many features of one layer may be indexed (to limit amount of consumed memory) int mHybridPerLayerFeatureLimit = 50000; diff --git a/src/core/qgssqlstatement.cpp b/src/core/qgssqlstatement.cpp index 3782258a2f49..bbbe2eb4c45a 100644 --- a/src/core/qgssqlstatement.cpp +++ b/src/core/qgssqlstatement.cpp @@ -191,7 +191,7 @@ void QgsSQLStatement::RecursiveVisitor::visit( const QgsSQLStatement::NodeJoin & /** \ingroup core * Internal use. - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsSQLStatementCollectTableNames: public QgsSQLStatement::RecursiveVisitor { diff --git a/src/core/qgssqlstatement.h b/src/core/qgssqlstatement.h index 57ae87a88017..c2d8f0a49430 100644 --- a/src/core/qgssqlstatement.h +++ b/src/core/qgssqlstatement.h @@ -69,15 +69,19 @@ class CORE_EXPORT QgsSQLStatement //! Returns root node of the statement. Root node is null is parsing has failed const QgsSQLStatement::Node *rootNode() const; - //! Return the original, unmodified statement string. - //! If there was none supplied because it was constructed by sole - //! API calls, dump() will be used to create one instead. + /** + * Return the original, unmodified statement string. + * If there was none supplied because it was constructed by sole + * API calls, dump() will be used to create one instead. + */ QString statement() const; - //! Return statement string, constructed from the internal - //! abstract syntax tree. This does not contain any nice whitespace - //! formatting or comments. In general it is preferable to use - //! statement() instead. + /** + * Return statement string, constructed from the internal + * abstract syntax tree. This does not contain any nice whitespace + * formatting or comments. In general it is preferable to use + * statement() instead. + */ QString dump() const; /** Returns a quoted column reference (in double quotes) diff --git a/src/core/qgstaskmanager.h b/src/core/qgstaskmanager.h index 8dfacdfd3c0c..2490dd4d2d64 100644 --- a/src/core/qgstaskmanager.h +++ b/src/core/qgstaskmanager.h @@ -290,8 +290,10 @@ class CORE_EXPORT QgsTask : public QObject //! Status of this task and all subtasks TaskStatus mOverallStatus = Queued; - //! This mutex remains locked from initialization until the task finishes, - //! it's used as a trigger for waitForFinished. + /** + * This mutex remains locked from initialization until the task finishes, + * it's used as a trigger for waitForFinished. + */ QMutex mNotFinishedMutex; //! Progress of this (parent) task alone @@ -443,8 +445,10 @@ class CORE_EXPORT QgsTaskManager : public QObject //! Returns true if all dependencies for the specified task are satisfied bool dependenciesSatisfied( long taskId ) const; - //! Returns the set of task IDs on which a task is dependent - //! \note not available in Python bindings + /** + * Returns the set of task IDs on which a task is dependent + * \note not available in Python bindings + */ QSet< long > dependencies( long taskId ) const SIP_SKIP; /** Returns a list of layers on which as task is dependent. The task will automatically @@ -474,35 +478,49 @@ class CORE_EXPORT QgsTaskManager : public QObject signals: - //! Will be emitted when a task reports a progress change - //! \param taskId ID of task - //! \param progress percent of progress, from 0.0 - 100.0 + /** + * Will be emitted when a task reports a progress change + * \param taskId ID of task + * \param progress percent of progress, from 0.0 - 100.0 + */ void progressChanged( long taskId, double progress ); - //! Will be emitted when only a single task remains to complete - //! and that task has reported a progress change - //! \param progress percent of progress, from 0.0 - 100.0 + /** + * Will be emitted when only a single task remains to complete + * and that task has reported a progress change + * \param progress percent of progress, from 0.0 - 100.0 + */ void finalTaskProgressChanged( double progress ); - //! Will be emitted when a task reports a status change - //! \param taskId ID of task - //! \param status new task status + /** + * Will be emitted when a task reports a status change + * \param taskId ID of task + * \param status new task status + */ void statusChanged( long taskId, int status ); - //! Emitted when a new task has been added to the manager - //! \param taskId ID of task + /** + * Emitted when a new task has been added to the manager + * \param taskId ID of task + */ void taskAdded( long taskId ); - //! Emitted when a task is about to be deleted - //! \param taskId ID of task + /** + * Emitted when a task is about to be deleted + * \param taskId ID of task + */ void taskAboutToBeDeleted( long taskId ); - //! Emitted when all tasks are complete - //! \see countActiveTasksChanged() + /** + * Emitted when all tasks are complete + * \see countActiveTasksChanged() + */ void allTasksFinished(); - //! Emitted when the number of active tasks changes - //! \see countActiveTasks() + /** + * Emitted when the number of active tasks changes + * \see countActiveTasks() + */ void countActiveTasksChanged( int count ); private slots: @@ -547,13 +565,17 @@ class CORE_EXPORT QgsTaskManager : public QObject bool cleanupAndDeleteTask( QgsTask *task ); - //! Process the queue of outstanding jobs and starts up any - //! which are ready to go. + /** + * Process the queue of outstanding jobs and starts up any + * which are ready to go. + */ void processQueue(); - //! Recursively cancel dependent tasks - //! \param taskId id of terminated task to cancel any other tasks - //! which are dependent on + /** + * Recursively cancel dependent tasks + * \param taskId id of terminated task to cancel any other tasks + * which are dependent on + */ void cancelDependentTasks( long taskId ); bool resolveDependencies( long firstTaskId, long currentTaskId, QSet< long > &results ) const; diff --git a/src/core/qgstextrenderer.h b/src/core/qgstextrenderer.h index acd0bb31cdcd..f0e9ce00478d 100644 --- a/src/core/qgstextrenderer.h +++ b/src/core/qgstextrenderer.h @@ -1248,8 +1248,11 @@ class CORE_EXPORT QgsTextRenderer QPointF offset; //! A stored QPicture of painting for the component QPicture picture; - //! Buffer for component to accommodate graphic items ignored by QPicture, - //! e.g. half-width of an applied QPen, which would extend beyond boundingRect() of QPicture + + /** + * Buffer for component to accommodate graphic items ignored by QPicture, + * e.g. half-width of an applied QPen, which would extend beyond boundingRect() of QPicture + */ double pictureBuffer = 0.0; //! A ratio of native painter dpi and that of rendering context's painter double dpiRatio = 1.0; diff --git a/src/core/qgstracer.h b/src/core/qgstracer.h index cf396d989fc8..e19e8e49af2d 100644 --- a/src/core/qgstracer.h +++ b/src/core/qgstracer.h @@ -67,18 +67,22 @@ class CORE_EXPORT QgsTracer : public QObject //! Get maximum possible number of features in graph. If the number is exceeded, graph is not created. void setMaxFeatureCount( int count ) { mMaxFeatureCount = count; } - //! Build the internal data structures. This may take some time - //! depending on how big the input layers are. It is not necessary - //! to call this method explicitly - it will be called by findShortestPath() - //! if necessary. + /** + * Build the internal data structures. This may take some time + * depending on how big the input layers are. It is not necessary + * to call this method explicitly - it will be called by findShortestPath() + * if necessary. + */ bool init(); //! Whether the internal data structures have been initialized bool isInitialized() const { return static_cast< bool >( mGraph ); } - //! Whether there was an error during graph creation due to noding exception, - //! indicating some input data topology problems - //! \since QGIS 2.16 + /** + * Whether there was an error during graph creation due to noding exception, + * indicating some input data topology problems + * \since QGIS 2.16 + */ bool hasTopologyProblem() const { return mHasTopologyProblem; } //! Possible errors that may happen when calling findShortestPath() @@ -91,18 +95,23 @@ class CORE_EXPORT QgsTracer : public QObject ErrNoPath, //!< Points are not connected in the graph }; - //! Given two points, find the shortest path and return points on the way. - //! The optional "error" argument may receive error code (PathError enum) if it is not null - //! \returns array of points - trace of linestrings of other features (empty array one error) + /** + * Given two points, find the shortest path and return points on the way. + * The optional "error" argument may receive error code (PathError enum) if it is not null + * \returns array of points - trace of linestrings of other features (empty array one error) + */ QVector findShortestPath( const QgsPointXY &p1, const QgsPointXY &p2, PathError *error SIP_OUT = nullptr ); //! Find out whether the point is snapped to a vertex or edge (i.e. it can be used for tracing start/stop) bool isPointSnapped( const QgsPointXY &pt ); protected: - //! Allows derived classes to setup the settings just before the tracer is initialized. - //! This allows the configuration to be set in a lazy way only when it is really necessary. - //! Default implementation does nothing. + + /** + * Allows derived classes to setup the settings just before the tracer is initialized. + * This allows the configuration to be set in a lazy way only when it is really necessary. + * Default implementation does nothing. + */ virtual void configure() {} protected slots: @@ -127,11 +136,17 @@ class CORE_EXPORT QgsTracer : public QObject QgsCoordinateReferenceSystem mCRS; //! Extent for graph building (empty extent means no limit) QgsRectangle mExtent; - //! Limit of how many features can be in the graph (0 means no limit). - //! This is to avoid possibly long graph preparation for complicated layers + + /** + * Limit of how many features can be in the graph (0 means no limit). + * This is to avoid possibly long graph preparation for complicated layers + */ int mMaxFeatureCount = 0; - //! A flag indicating that there was an error during graph creation - //! due to noding exception, indicating some input data topology problems + + /** + * A flag indicating that there was an error during graph creation + * due to noding exception, indicating some input data topology problems + */ bool mHasTopologyProblem = false; }; diff --git a/src/core/qgsvectorlayer.cpp b/src/core/qgsvectorlayer.cpp index a92ecb4674af..34faa487b5c4 100644 --- a/src/core/qgsvectorlayer.cpp +++ b/src/core/qgsvectorlayer.cpp @@ -681,7 +681,7 @@ long QgsVectorLayer::featureCount( const QString &legendKey ) const /** \ingroup core * Used by QgsVectorLayer::countSymbolFeatures() to provide an interruption checker - * @note not available in Python bindings + * \note not available in Python bindings */ class QgsVectorLayerInterruptionCheckerDuringCountSymbolFeatures: public QgsInterruptionChecker { diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h index 7e7127c68e96..8730cda2bff4 100644 --- a/src/core/qgsvectorlayer.h +++ b/src/core/qgsvectorlayer.h @@ -1288,8 +1288,10 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! Buffer with uncommitted editing operations. Only valid after editing has been turned on. QgsVectorLayerEditBuffer *editBuffer() { return mEditBuffer; } - //! Buffer with uncommitted editing operations. Only valid after editing has been turned on. - //! \note not available in Python bindings + /** + * Buffer with uncommitted editing operations. Only valid after editing has been turned on. + * \note not available in Python bindings + */ const QgsVectorLayerEditBuffer *editBuffer() const SIP_SKIP { return mEditBuffer; } /** diff --git a/src/core/qgsvectorlayerfeatureiterator.h b/src/core/qgsvectorlayerfeatureiterator.h index 8c3392ca111e..6ee23ebd9fed 100644 --- a/src/core/qgsvectorlayerfeatureiterator.h +++ b/src/core/qgsvectorlayerfeatureiterator.h @@ -139,8 +139,10 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera //! fetch next feature, return true on success virtual bool fetchFeature( QgsFeature &feature ) override; - //! Overrides default method as we only need to filter features in the edit buffer - //! while for others filtering is left to the provider implementation. + /** + * Overrides default method as we only need to filter features in the edit buffer + * while for others filtering is left to the provider implementation. + */ virtual bool nextFeatureFilterExpression( QgsFeature &f ) override { return fetchFeature( f ); } //! Setup the simplification of geometries to fetch using the specified simplify method diff --git a/src/core/qgsvectorlayerjoinbuffer.h b/src/core/qgsvectorlayerjoinbuffer.h index ac67767a55ec..1470cd887a58 100644 --- a/src/core/qgsvectorlayerjoinbuffer.h +++ b/src/core/qgsvectorlayerjoinbuffer.h @@ -57,12 +57,16 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi //! Saves mVectorJoins to xml under the layer node void writeXml( QDomNode &layer_node, QDomDocument &document ) const; - //! Reads joins from project file. - //! Does not resolve layer IDs to layers - call resolveReferences() afterwards + /** + * Reads joins from project file. + * Does not resolve layer IDs to layers - call resolveReferences() afterwards + */ void readXml( const QDomNode &layer_node ); - //! Resolves layer IDs of joined layers using given project's available layers - //! \since QGIS 3.0 + /** + * Resolves layer IDs of joined layers using given project's available layers + * \since QGIS 3.0 + */ void resolveReferences( QgsProject *project ); //! Quick way to test if there is any join at all @@ -76,12 +80,16 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi \param sourceFieldIndex Output: field's index in source layer */ const QgsVectorLayerJoinInfo *joinForFieldIndex( int index, const QgsFields &fields, int &sourceFieldIndex SIP_OUT ) const; - //! Find out what is the first index of the join within fields. Returns -1 if join is not present - //! \since QGIS 2.6 + /** + * Find out what is the first index of the join within fields. Returns -1 if join is not present + * \since QGIS 2.6 + */ int joinedFieldsOffset( const QgsVectorLayerJoinInfo *info, const QgsFields &fields ); - //! Return a vector of indices for use in join based on field names from the layer - //! \since QGIS 2.6 + /** + * Return a vector of indices for use in join based on field names from the layer + * \since QGIS 2.6 + */ static QVector joinSubsetIndices( QgsVectorLayer *joinLayer, const QStringList &joinFieldsSubset ); /** Returns joins where the field of a target layer is considered as an id. @@ -105,8 +113,10 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi */ QgsFeature targetedFeatureOf( const QgsVectorLayerJoinInfo *info, const QgsFeature &feature ) const; - //! Create a copy of the join buffer - //! \since QGIS 2.6 + /** + * Create a copy of the join buffer + * \since QGIS 2.6 + */ QgsVectorLayerJoinBuffer *clone() const SIP_FACTORY; /** @@ -167,8 +177,11 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi bool deleteFeatures( const QgsFeatureIds &fids ) const; signals: - //! Emitted whenever the list of joined fields changes (e.g. added join or joined layer's fields change) - //! \since QGIS 2.6 + + /** + * Emitted whenever the list of joined fields changes (e.g. added join or joined layer's fields change) + * \since QGIS 2.6 + */ void joinedFieldsChanged(); private slots: diff --git a/src/core/qgsvectorlayerlabeling.h b/src/core/qgsvectorlayerlabeling.h index 1ae0dd7a99c0..aa0711b13ec7 100644 --- a/src/core/qgsvectorlayerlabeling.h +++ b/src/core/qgsvectorlayerlabeling.h @@ -49,8 +49,10 @@ class CORE_EXPORT QgsAbstractVectorLayerLabeling //! Return a new copy of the object virtual QgsAbstractVectorLayerLabeling *clone() const = 0 SIP_FACTORY; - //! Factory for label provider implementation - //! \note not available in Python bindings + /** + * Factory for label provider implementation + * \note not available in Python bindings + */ virtual QgsVectorLayerLabelProvider *provider( QgsVectorLayer *layer ) const SIP_SKIP { Q_UNUSED( layer ); return nullptr; } //! Return labeling configuration as XML element @@ -59,8 +61,10 @@ class CORE_EXPORT QgsAbstractVectorLayerLabeling //! Get list of sub-providers within the layer's labeling. virtual QStringList subProviders() const { return QStringList( QString() ); } - //! Get associated label settings. In case of multiple sub-providers with different settings, - //! they are identified by their ID (e.g. in case of rule-based labeling, provider ID == rule key) + /** + * Get associated label settings. In case of multiple sub-providers with different settings, + * they are identified by their ID (e.g. in case of rule-based labeling, provider ID == rule key) + */ virtual QgsPalLayerSettings settings( const QString &providerId = QString() ) const = 0; /** diff --git a/src/core/qgsvectorlayerrenderer.h b/src/core/qgsvectorlayerrenderer.h index 4ab2d120f38c..2cbc4d208768 100644 --- a/src/core/qgsvectorlayerrenderer.h +++ b/src/core/qgsvectorlayerrenderer.h @@ -124,11 +124,16 @@ class QgsVectorLayerRenderer : public QgsMapLayerRenderer //! used with new labeling engine (QgsPalLabeling): whether diagrams are enabled bool mDiagrams; - //! used with new labeling engine (QgsLabelingEngine): provider for labels. - //! may be null. no need to delete: if exists it is owned by labeling engine + /** + * used with new labeling engine (QgsLabelingEngine): provider for labels. + * may be null. no need to delete: if exists it is owned by labeling engine + */ QgsVectorLayerLabelProvider *mLabelProvider = nullptr; - //! used with new labeling engine (QgsLabelingEngine): provider for diagrams. - //! may be null. no need to delete: if exists it is owned by labeling engine + + /** + * used with new labeling engine (QgsLabelingEngine): provider for diagrams. + * may be null. no need to delete: if exists it is owned by labeling engine + */ QgsVectorLayerDiagramProvider *mDiagramProvider = nullptr; QPainter::CompositionMode mFeatureBlendMode; diff --git a/src/core/qgsvirtuallayerdefinition.h b/src/core/qgsvirtuallayerdefinition.h index 340ea4718c10..13a977291182 100644 --- a/src/core/qgsvirtuallayerdefinition.h +++ b/src/core/qgsvirtuallayerdefinition.h @@ -80,18 +80,20 @@ class CORE_EXPORT QgsVirtualLayerDefinition //! Constructor with an optional file path QgsVirtualLayerDefinition( const QString &filePath = "" ); - //! Constructor to build a definition from a QUrl - //! The path part of the URL is extracted as well as the following optional keys: - //! layer_ref=layer_id[:name] represents a live layer referenced by its ID. An optional name can be given - //! layer=provider:source[:name[:encoding]] represents a layer given by its provider key, its source url (URL-encoded). - //! An optional name and encoding can be given - //! geometry=column_name[:type:srid] gives the definition of the geometry column. - //! Type can be either a WKB type code or a string (point, linestring, etc.) - //! srid is an integer - //! uid=column_name is the name of a column with unique integer values. - //! nogeometry is a flag to force the layer to be a non-geometry layer - //! query=sql represents the SQL query. Must be URL-encoded - //! field=column_name:[int|real|text] represents a field with its name and its type + /** + * Constructor to build a definition from a QUrl + * The path part of the URL is extracted as well as the following optional keys: + * layer_ref=layer_id[:name] represents a live layer referenced by its ID. An optional name can be given + * layer=provider:source[:name[:encoding]] represents a layer given by its provider key, its source url (URL-encoded). + * An optional name and encoding can be given + * geometry=column_name[:type:srid] gives the definition of the geometry column. + * Type can be either a WKB type code or a string (point, linestring, etc.) + * srid is an integer + * uid=column_name is the name of a column with unique integer values. + * nogeometry is a flag to force the layer to be a non-geometry layer + * query=sql represents the SQL query. Must be URL-encoded + * field=column_name:[int|real|text] represents a field with its name and its type + */ static QgsVirtualLayerDefinition fromUrl( const QUrl &url ); //! Convert the definition into a QUrl @@ -132,9 +134,11 @@ class CORE_EXPORT QgsVirtualLayerDefinition //! Set the name of the geometry field void setGeometryField( const QString &geometryField ) { mGeometryField = geometryField; } - //! Get the type of the geometry - //! QgsWkbTypes::NoGeometry to hide any geometry - //! QgsWkbTypes::Unknown for unknown types + /** + * Get the type of the geometry + * QgsWkbTypes::NoGeometry to hide any geometry + * QgsWkbTypes::Unknown for unknown types + */ QgsWkbTypes::Type geometryWkbType() const { return mGeometryWkbType; } //! Set the type of the geometry void setGeometryWkbType( QgsWkbTypes::Type t ) { mGeometryWkbType = t; } diff --git a/src/core/raster/qgsrasterinterface.h b/src/core/raster/qgsrasterinterface.h index 711180dc673a..632deb2d3a5e 100644 --- a/src/core/raster/qgsrasterinterface.h +++ b/src/core/raster/qgsrasterinterface.h @@ -45,28 +45,43 @@ class CORE_EXPORT QgsRasterBlockFeedback : public QgsFeedback //! Construct a new raster block feedback object QgsRasterBlockFeedback( QObject *parent = nullptr ) : QgsFeedback( parent ) {} - //! May be emitted by raster data provider to indicate that some partial data are available - //! and a new preview image may be produced + /** + * May be emitted by raster data provider to indicate that some partial data are available + * and a new preview image may be produced + */ virtual void onNewData() {} - //! Whether the raster provider should return only data that are already available - //! without waiting for full result. By default this flag is not enabled. - //! \see setPreviewOnly() + /** + * Whether the raster provider should return only data that are already available + * without waiting for full result. By default this flag is not enabled. + * \see setPreviewOnly() + */ bool isPreviewOnly() const { return mPreviewOnly; } - //! set flag whether the block request is for preview purposes only - //! \see isPreviewOnly() + + /** + * set flag whether the block request is for preview purposes only + * \see isPreviewOnly() + */ void setPreviewOnly( bool preview ) { mPreviewOnly = preview; } - //! Whether our painter is drawing to a temporary image used just by this layer - //! \see setRenderPartialOutput() + /** + * Whether our painter is drawing to a temporary image used just by this layer + * \see setRenderPartialOutput() + */ bool renderPartialOutput() const { return mRenderPartialOutput; } - //! Set whether our painter is drawing to a temporary image used just by this layer - //! \see renderPartialOutput() + + /** + * Set whether our painter is drawing to a temporary image used just by this layer + * \see renderPartialOutput() + */ void setRenderPartialOutput( bool enable ) { mRenderPartialOutput = enable; } private: - //! Whether the raster provider should return only data that are already available - //! without waiting for full result + + /** + * Whether the raster provider should return only data that are already available + * without waiting for full result + */ bool mPreviewOnly = false; //! Whether our painter is drawing to a temporary image used just by this layer diff --git a/src/core/raster/qgsrasterlayer.cpp b/src/core/raster/qgsrasterlayer.cpp index d244bf7ebb4f..1df0073f228c 100644 --- a/src/core/raster/qgsrasterlayer.cpp +++ b/src/core/raster/qgsrasterlayer.cpp @@ -1390,7 +1390,7 @@ bool QgsRasterLayer::readStyle( const QDomNode &node, QString &errorMessage, con Raster layer project file XML of form: - @note Called by QgsMapLayer::readXml(). + \note Called by QgsMapLayer::readXml(). */ bool QgsRasterLayer::readXml( const QDomNode &layer_node, const QgsReadWriteContext &context ) { @@ -1568,7 +1568,7 @@ bool QgsRasterLayer::writeStyle( QDomNode &node, QDomDocument &doc, QString &err /* * virtual - * @note Called by QgsMapLayer::writeXml(). + * \note Called by QgsMapLayer::writeXml(). */ bool QgsRasterLayer::writeXml( QDomNode &layer_node, QDomDocument &document, diff --git a/src/core/symbology/qgscategorizedsymbolrenderer.h b/src/core/symbology/qgscategorizedsymbolrenderer.h index d75793e16a1b..364bb7010c64 100644 --- a/src/core/symbology/qgscategorizedsymbolrenderer.h +++ b/src/core/symbology/qgscategorizedsymbolrenderer.h @@ -108,8 +108,10 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer //! return index of category with specified value (-1 if not found) int categoryIndexForValue( const QVariant &val ); - //! return index of category with specified label (-1 if not found or not unique) - //! \since QGIS 2.5 + /** + * return index of category with specified label (-1 if not found or not unique) + * \since QGIS 2.5 + */ int categoryIndexForLabel( const QString &val ); bool updateCategoryValue( int catIndex, const QVariant &value ); @@ -179,9 +181,11 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer virtual void checkLegendSymbolItem( const QString &key, bool state = true ) override; virtual QString legendClassificationAttribute() const override { return classAttribute(); } - //! creates a QgsCategorizedSymbolRenderer from an existing renderer. - //! \since QGIS 2.5 - //! \returns a new renderer if the conversion was possible, otherwise 0. + /** + * creates a QgsCategorizedSymbolRenderer from an existing renderer. + * \since QGIS 2.5 + * \returns a new renderer if the conversion was possible, otherwise 0. + */ static QgsCategorizedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY; /** diff --git a/src/core/symbology/qgsgeometrygeneratorsymbollayer.h b/src/core/symbology/qgsgeometrygeneratorsymbollayer.h index 42e36182dfd8..5b99c7625ade 100644 --- a/src/core/symbology/qgsgeometrygeneratorsymbollayer.h +++ b/src/core/symbology/qgsgeometrygeneratorsymbollayer.h @@ -73,9 +73,11 @@ class CORE_EXPORT QgsGeometryGeneratorSymbolLayer : public QgsSymbolLayer virtual QSet usedAttributes( const QgsRenderContext &context ) const override; - //! Will always return true. - //! This is a hybrid layer, it constructs its own geometry so it does not - //! care about the geometry of its parents. + /** + * Will always return true. + * This is a hybrid layer, it constructs its own geometry so it does not + * care about the geometry of its parents. + */ bool isCompatibleWithSymbol( QgsSymbol *symbol ) const override; /** diff --git a/src/core/symbology/qgsgraduatedsymbolrenderer.h b/src/core/symbology/qgsgraduatedsymbolrenderer.h index 4e40e11e4f6c..235c84da08eb 100644 --- a/src/core/symbology/qgsgraduatedsymbolrenderer.h +++ b/src/core/symbology/qgsgraduatedsymbolrenderer.h @@ -214,25 +214,35 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer Mode mode() const { return mMode; } void setMode( Mode mode ) { mMode = mode; } - //! Recalculate classes for a layer - //! \param vlayer The layer being rendered (from which data values are calculated) - //! \param mode The calculation mode - //! \param nclasses The number of classes to calculate (approximate for some modes) - //! \since QGIS 2.6 + + /** + * Recalculate classes for a layer + * \param vlayer The layer being rendered (from which data values are calculated) + * \param mode The calculation mode + * \param nclasses The number of classes to calculate (approximate for some modes) + * \since QGIS 2.6 + */ void updateClasses( QgsVectorLayer *vlayer, Mode mode, int nclasses ); - //! Return the label format used to generate default classification labels - //! \since QGIS 2.6 + /** + * Return the label format used to generate default classification labels + * \since QGIS 2.6 + */ const QgsRendererRangeLabelFormat &labelFormat() const { return mLabelFormat; } - //! Set the label format used to generate default classification labels - //! \param labelFormat The string appended to classification labels - //! \param updateRanges If true then ranges ending with the old unit string are updated to the new. - //! \since QGIS 2.6 + + /** + * Set the label format used to generate default classification labels + * \param labelFormat The string appended to classification labels + * \param updateRanges If true then ranges ending with the old unit string are updated to the new. + * \since QGIS 2.6 + */ void setLabelFormat( const QgsRendererRangeLabelFormat &labelFormat, bool updateRanges = false ); - //! Reset the label decimal places to a numberbased on the minimum class interval - //! \param updateRanges if true then ranges currently using the default label will be updated - //! \since QGIS 2.6 + /** + * Reset the label decimal places to a numberbased on the minimum class interval + * \param updateRanges if true then ranges currently using the default label will be updated + * \since QGIS 2.6 + */ void calculateLabelPrecision( bool updateRanges = true ); /** Creates a new graduated renderer. @@ -299,17 +309,23 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer */ void updateSymbols( QgsSymbol *sym ); - //! set varying symbol size for classes - //! \note the classes must already be set so that symbols exist - //! \since QGIS 2.10 + /** + * set varying symbol size for classes + * \note the classes must already be set so that symbols exist + * \since QGIS 2.10 + */ void setSymbolSizes( double minSize, double maxSize ); - //! return the min symbol size when graduated by size - //! \since QGIS 2.10 + /** + * return the min symbol size when graduated by size + * \since QGIS 2.10 + */ double minSymbolSize() const; - //! return the max symbol size when graduated by size - //! \since QGIS 2.10 + /** + * return the max symbol size when graduated by size + * \since QGIS 2.10 + */ double maxSymbolSize() const; enum GraduatedMethod @@ -318,12 +334,16 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer GraduatedSize = 1 }; - //! return the method used for graduation (either size or color) - //! \since QGIS 2.10 + /** + * return the method used for graduation (either size or color) + * \since QGIS 2.10 + */ GraduatedMethod graduatedMethod() const { return mGraduatedMethod; } - //! set the method used for graduation (either size or color) - //! \since QGIS 2.10 + /** + * set the method used for graduation (either size or color) + * \since QGIS 2.10 + */ void setGraduatedMethod( GraduatedMethod method ) { mGraduatedMethod = method; } virtual bool legendSymbolItemsCheckable() const override; @@ -332,9 +352,11 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer virtual void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override; virtual QString legendClassificationAttribute() const override { return classAttribute(); } - //! creates a QgsGraduatedSymbolRenderer from an existing renderer. - //! \since QGIS 2.6 - //! \returns a new renderer if the conversion was possible, otherwise 0. + /** + * creates a QgsGraduatedSymbolRenderer from an existing renderer. + * \since QGIS 2.6 + * \returns a new renderer if the conversion was possible, otherwise 0. + */ static QgsGraduatedSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY; /** diff --git a/src/core/symbology/qgslegendsymbolitem.h b/src/core/symbology/qgslegendsymbolitem.h index 39e9a6617edb..f02165f2d5ff 100644 --- a/src/core/symbology/qgslegendsymbolitem.h +++ b/src/core/symbology/qgslegendsymbolitem.h @@ -41,8 +41,10 @@ class CORE_EXPORT QgsLegendSymbolItem */ QgsLegendSymbolItem() = default; - //! Construct item. Does not take ownership of symbol (makes internal clone) - //! \since QGIS 2.8 + /** + * Construct item. Does not take ownership of symbol (makes internal clone) + * \since QGIS 2.8 + */ QgsLegendSymbolItem( QgsSymbol *symbol, const QString &label, const QString &ruleKey, bool checkable = false, int scaleMinDenom = -1, int scaleMaxDenom = -1, int level = 0, const QString &parentRuleKey = QString() ); ~QgsLegendSymbolItem(); @@ -63,18 +65,26 @@ class CORE_EXPORT QgsLegendSymbolItem //! Determine whether given scale is within the scale range. Returns true if scale or scale range is invalid (value <= 0) bool isScaleOK( double scale ) const; - //! Min scale denominator of the scale range. For range 1:1000 to 1:2000 this will return 1000. - //! Value <= 0 means the range is unbounded on this side + + /** + * Min scale denominator of the scale range. For range 1:1000 to 1:2000 this will return 1000. + * Value <= 0 means the range is unbounded on this side + */ int scaleMinDenom() const { return mScaleMinDenom; } - //! Max scale denominator of the scale range. For range 1:1000 to 1:2000 this will return 2000. - //! Value <= 0 means the range is unbounded on this side + + /** + * Max scale denominator of the scale range. For range 1:1000 to 1:2000 this will return 2000. + * Value <= 0 means the range is unbounded on this side + */ int scaleMaxDenom() const { return mScaleMaxDenom; } //! Identation level that tells how deep the item is in a hierarchy of items. For flat lists level is 0 int level() const { return mLevel; } - //! Key of the parent legend node. For legends with tree hierarchy - //! \note Parameter parentRuleKey added in QGIS 2.8 + /** + * Key of the parent legend node. For legends with tree hierarchy + * \note Parameter parentRuleKey added in QGIS 2.8 + */ QString parentRuleKey() const { return mParentKey; } //! Set symbol of the item. Takes ownership of symbol. @@ -107,8 +117,10 @@ class CORE_EXPORT QgsLegendSymbolItem QgsSymbol *mOriginalSymbolPointer = nullptr; - //! optional pointer to data-defined legend size settings - if set, the output legend - //! node should be QgsDataDefinedSizeLegendNode rather than ordinary QgsSymbolLegendNode + /** + * optional pointer to data-defined legend size settings - if set, the output legend + * node should be QgsDataDefinedSizeLegendNode rather than ordinary QgsSymbolLegendNode + */ QgsDataDefinedSizeLegend *mDataDefinedSizeLegendSettings = nullptr; // additional data that may be used for filtering diff --git a/src/core/symbology/qgsmarkersymbollayer.h b/src/core/symbology/qgsmarkersymbollayer.h index 6940511fc9c3..2bb56085ef2e 100644 --- a/src/core/symbology/qgsmarkersymbollayer.h +++ b/src/core/symbology/qgsmarkersymbollayer.h @@ -126,12 +126,16 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer protected: - //! Prepares the layer for drawing the specified shape (QPolygonF version) - //! \note not available in Python bindings + /** + * Prepares the layer for drawing the specified shape (QPolygonF version) + * \note not available in Python bindings + */ bool prepareMarkerShape( Shape shape ); - //! Prepares the layer for drawing the specified shape (QPainterPath version) - //! \note not available in Python bindings + /** + * Prepares the layer for drawing the specified shape (QPainterPath version) + * \note not available in Python bindings + */ bool prepareMarkerPath( Shape symbol ); /** Creates a polygon representing the specified shape. @@ -375,8 +379,11 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer QBrush mSelBrush; //! Cached image of selected marker, if using cached version QImage mSelCache; - //! True if using cached images of markers for drawing. This is faster, but cannot - //! be used when data defined properties are present + + /** + * True if using cached images of markers for drawing. This is faster, but cannot + * be used when data defined properties are present + */ bool mUsingCache = false; //! Maximum width/height of cache image static const int MAXIMUM_CACHE_WIDTH = 3000; diff --git a/src/core/symbology/qgsrenderer.h b/src/core/symbology/qgsrenderer.h index 811433f6b0a0..a028904243ae 100644 --- a/src/core/symbology/qgsrenderer.h +++ b/src/core/symbology/qgsrenderer.h @@ -255,8 +255,10 @@ class CORE_EXPORT QgsFeatureRenderer //! store renderer info to XML element virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ); - //! create the SLD UserStyle element following the SLD v1.1 specs with the given name - //! \since QGIS 2.8 + /** + * create the SLD UserStyle element following the SLD v1.1 specs with the given name + * \since QGIS 2.8 + */ virtual QDomElement writeSld( QDomDocument &doc, const QString &styleName, const QgsStringMap &props = QgsStringMap() ) const; /** Create a new renderer according to the information contained in @@ -278,16 +280,22 @@ class CORE_EXPORT QgsFeatureRenderer ( void ) props; // warning avoidance } - //! items of symbology items in legend should be checkable - //! \since QGIS 2.5 + /** + * items of symbology items in legend should be checkable + * \since QGIS 2.5 + */ virtual bool legendSymbolItemsCheckable() const; - //! items of symbology items in legend is checked - //! \since QGIS 2.5 + /** + * items of symbology items in legend is checked + * \since QGIS 2.5 + */ virtual bool legendSymbolItemChecked( const QString &key ); - //! item in symbology was checked - //! \since QGIS 2.5 + /** + * item in symbology was checked + * \since QGIS 2.5 + */ virtual void checkLegendSymbolItem( const QString &key, bool state = true ); /** Sets the symbol to be used for a legend symbol item. @@ -297,12 +305,16 @@ class CORE_EXPORT QgsFeatureRenderer */ virtual void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ); - //! Returns a list of symbology items for the legend - //! \since QGIS 2.6 + /** + * Returns a list of symbology items for the legend + * \since QGIS 2.6 + */ virtual QgsLegendSymbolList legendSymbolItems() const; - //! If supported by the renderer, return classification attribute for the use in legend - //! \since QGIS 2.6 + /** + * If supported by the renderer, return classification attribute for the use in legend + * \since QGIS 2.6 + */ virtual QString legendClassificationAttribute() const { return QString(); } //! set type and size of editing vertex markers for subsequent rendering diff --git a/src/core/symbology/qgsrendererregistry.h b/src/core/symbology/qgsrendererregistry.h index d3aaf7241c7d..816a27a45a94 100644 --- a/src/core/symbology/qgsrendererregistry.h +++ b/src/core/symbology/qgsrendererregistry.h @@ -40,8 +40,10 @@ class CORE_EXPORT QgsRendererAbstractMetadata { public: - //! Layer types the renderer is compatible with - //! \since QGIS 2.16 + /** + * Layer types the renderer is compatible with + * \since QGIS 2.16 + */ enum LayerType { PointLayer = 1, //!< Compatible with point layers @@ -110,8 +112,10 @@ class CORE_EXPORT QgsRendererMetadata : public QgsRendererAbstractMetadata { public: - //! Construct metadata - //! \note not available in Python bindings + /** + * Construct metadata + * \note not available in Python bindings + */ QgsRendererMetadata( const QString &name, const QString &visibleName, QgsRendererCreateFunc pfCreate, @@ -199,29 +203,39 @@ class CORE_EXPORT QgsRendererRegistry //! QgsRendererRegistry cannot be copied. QgsRendererRegistry &operator=( const QgsRendererRegistry &rh ) = delete; - //! Adds a renderer to the registry. Takes ownership of the metadata object. - //! \param metadata renderer metadata - //! \returns true if renderer was added successfully, or false if renderer could not - //! be added (e.g., a renderer with a duplicate name already exists) + /** + * Adds a renderer to the registry. Takes ownership of the metadata object. + * \param metadata renderer metadata + * \returns true if renderer was added successfully, or false if renderer could not + * be added (e.g., a renderer with a duplicate name already exists) + */ bool addRenderer( QgsRendererAbstractMetadata *metadata SIP_TRANSFER ); - //! Removes a renderer from registry. - //! \param rendererName name of renderer to remove from registry - //! \returns true if renderer was successfully removed, or false if matching - //! renderer could not be found + /** + * Removes a renderer from registry. + * \param rendererName name of renderer to remove from registry + * \returns true if renderer was successfully removed, or false if matching + * renderer could not be found + */ bool removeRenderer( const QString &rendererName ); - //! Returns the metadata for a specified renderer. Returns NULL if a matching - //! renderer was not found in the registry. + /** + * Returns the metadata for a specified renderer. Returns NULL if a matching + * renderer was not found in the registry. + */ QgsRendererAbstractMetadata *rendererMetadata( const QString &rendererName ); - //! Returns a list of available renderers. - //! \param layerTypes flags to filter the renderers by compatible layer types + /** + * Returns a list of available renderers. + * \param layerTypes flags to filter the renderers by compatible layer types + */ QStringList renderersList( QgsRendererAbstractMetadata::LayerTypes layerTypes = QgsRendererAbstractMetadata::All ) const; - //! Returns a list of available renderers which are compatible with a specified layer. - //! \param layer vector layer - //! \since QGIS 2.16 + /** + * Returns a list of available renderers which are compatible with a specified layer. + * \param layer vector layer + * \since QGIS 2.16 + */ QStringList renderersList( const QgsVectorLayer *layer ) const; private: diff --git a/src/core/symbology/qgsrulebasedrenderer.h b/src/core/symbology/qgsrulebasedrenderer.h index c4f8d87e28cd..867a3ff8b2fc 100644 --- a/src/core/symbology/qgsrulebasedrenderer.h +++ b/src/core/symbology/qgsrulebasedrenderer.h @@ -226,11 +226,16 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer */ bool active() const { return mIsActive; } - //! Unique rule identifier (for identification of rule within renderer) - //! \since QGIS 2.6 + /** + * Unique rule identifier (for identification of rule within renderer) + * \since QGIS 2.6 + */ QString ruleKey() const { return mRuleKey; } - //! Override the assigned rule key (should be used just internally by rule-based renderer) - //! \since QGIS 2.6 + + /** + * Override the assigned rule key (should be used just internally by rule-based renderer) + * \since QGIS 2.6 + */ void setRuleKey( const QString &key ) { mRuleKey = key; } //! set a new symbol (or NULL). Deletes old symbol. @@ -293,8 +298,10 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer //! get all used z-levels from this rule and children QSet collectZLevels(); - //! assign normalized z-levels [0..N-1] for this rule's symbol for quick access during rendering - //! \note not available in Python bindings + /** + * assign normalized z-levels [0..N-1] for this rule's symbol for quick access during rendering + * \note not available in Python bindings + */ void setNormZLevels( const QMap &zLevelsToNormLevels ) SIP_SKIP; /** @@ -378,8 +385,10 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer //! take child rule out, set parent as null QgsRuleBasedRenderer::Rule *takeChildAt( int i ) SIP_TRANSFERBACK; - //! Try to find a rule given its unique key - //! \since QGIS 2.6 + /** + * Try to find a rule given its unique key + * \since QGIS 2.6 + */ QgsRuleBasedRenderer::Rule *findRuleByKey( const QString &key ); /** @@ -491,9 +500,11 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer //! take a rule and create a list of new rules with intervals of scales given by the passed scale denominators static void refineRuleScales( QgsRuleBasedRenderer::Rule *initialRule, QList scales ); - //! creates a QgsRuleBasedRenderer from an existing renderer. - //! \since QGIS 2.5 - //! \returns a new renderer if the conversion was possible, otherwise 0. + /** + * creates a QgsRuleBasedRenderer from an existing renderer. + * \since QGIS 2.5 + * \returns a new renderer if the conversion was possible, otherwise 0. + */ static QgsRuleBasedRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY; //! helper function to convert the size scale and rotation fields present in some other renderers to data defined symbology diff --git a/src/core/symbology/qgssinglesymbolrenderer.h b/src/core/symbology/qgssinglesymbolrenderer.h index 2ba72a038ffe..aec6b1410e85 100644 --- a/src/core/symbology/qgssinglesymbolrenderer.h +++ b/src/core/symbology/qgssinglesymbolrenderer.h @@ -57,9 +57,11 @@ class CORE_EXPORT QgsSingleSymbolRenderer : public QgsFeatureRenderer virtual QSet< QString > legendKeysForFeature( QgsFeature &feature, QgsRenderContext &context ) override; virtual void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override; - //! creates a QgsSingleSymbolRenderer from an existing renderer. - //! \since QGIS 2.5 - //! \returns a new renderer if the conversion was possible, otherwise 0. + /** + * creates a QgsSingleSymbolRenderer from an existing renderer. + * \since QGIS 2.5 + * \returns a new renderer if the conversion was possible, otherwise 0. + */ static QgsSingleSymbolRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY; /** diff --git a/src/core/symbology/qgssymbol.h b/src/core/symbology/qgssymbol.h index 71c3fb658953..72b64ea40758 100644 --- a/src/core/symbology/qgssymbol.h +++ b/src/core/symbology/qgssymbol.h @@ -189,9 +189,11 @@ class CORE_EXPORT QgsSymbol void setColor( const QColor &color ); QColor color() const; - //! Draw icon of the symbol that occupyies area given by size using the painter. - //! Optionally custom context may be given in order to get rendering of symbols that use map units right. - //! \since QGIS 2.6 + /** + * Draw icon of the symbol that occupyies area given by size using the painter. + * Optionally custom context may be given in order to get rendering of symbols that use map units right. + * \since QGIS 2.6 + */ void drawPreviewIcon( QPainter *painter, QSize size, QgsRenderContext *customContext = nullptr ); //! export symbol as image format. PNG and SVG supported @@ -368,8 +370,10 @@ class CORE_EXPORT QgsSymbol */ void renderUsingLayer( QgsSymbolLayer *layer, QgsSymbolRenderContext &context ); - //! Render editing vertex marker at specified point - //! \since QGIS 2.16 + /** + * Render editing vertex marker at specified point + * \since QGIS 2.16 + */ void renderVertexMarker( QPointF pt, QgsRenderContext &context, int currentVertexMarkerType, int currentVertexMarkerSize ); SymbolType mType; @@ -388,8 +392,10 @@ class CORE_EXPORT QgsSymbol QgsSymbol( const QgsSymbol & ); #endif - //! True if render has already been started - guards against multiple calls to - //! startRender() (usually a result of not cloning a shared symbol instance before rendering). + /** + * True if render has already been started - guards against multiple calls to + * startRender() (usually a result of not cloning a shared symbol instance before rendering). + */ bool mStarted = false; //! Initialized in startRender, destroyed in stopRender @@ -489,10 +495,12 @@ class CORE_EXPORT QgsSymbolRenderContext */ QgsWkbTypes::GeometryType originalGeometryType() const { return mOriginalGeometryType; } - //! Fields of the layer. Currently only available in startRender() calls - //! to allow symbols with data-defined properties prepare the expressions - //! (other times fields() returns null) - //! \since QGIS 2.4 + /** + * Fields of the layer. Currently only available in startRender() calls + * to allow symbols with data-defined properties prepare the expressions + * (other times fields() returns null) + * \since QGIS 2.4 + */ QgsFields fields() const { return mFields; } /** Part count of current geometry diff --git a/src/gui/attributetable/qgsfeatureselectionmodel.h b/src/gui/attributetable/qgsfeatureselectionmodel.h index b0f792a145a9..801181d7f847 100644 --- a/src/gui/attributetable/qgsfeatureselectionmodel.h +++ b/src/gui/attributetable/qgsfeatureselectionmodel.h @@ -117,16 +117,22 @@ class GUI_EXPORT QgsFeatureSelectionModel : public QItemSelectionModel QgsIFeatureSelectionManager *mFeatureSelectionManager = nullptr; bool mSyncEnabled; - //! If sync is disabled - //! Holds a list of newly selected features which will be synced when re-enabled + /** + * If sync is disabled + * Holds a list of newly selected features which will be synced when re-enabled + */ QgsFeatureIds mSelectedBuffer; - //! If sync is disabled - //! Holds a list of newly deselected features which will be synced when re-enabled + /** + * If sync is disabled + * Holds a list of newly deselected features which will be synced when re-enabled + */ QgsFeatureIds mDeselectedBuffer; - //! If sync is disabled - //! Is set to true, if a clear and select operation should be performed before syncing + /** + * If sync is disabled + * Is set to true, if a clear and select operation should be performed before syncing + */ bool mClearAndSelectBuffer; }; diff --git a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp index e7f43b1ff942..29bcced7c2a4 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp +++ b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp @@ -20,7 +20,7 @@ /** \ingroup gui * Widget auto conf plugin that guesses what widget type to use in function of what the widgets support. * - * @note not available in Python bindings + * \note not available in Python bindings * \since QGIS 3.0 */ class FromFactoriesPlugin: public QgsEditorWidgetAutoConfPlugin @@ -57,7 +57,7 @@ class FromFactoriesPlugin: public QgsEditorWidgetAutoConfPlugin /** \ingroup gui * Widget auto conf plugin that reads the widget setup to use from what the data provider says. * - * @note not available in Python bindings + * \note not available in Python bindings * \since QGIS 3.0 */ class FromDbTablePlugin: public QgsEditorWidgetAutoConfPlugin diff --git a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h index ce304c71cdcb..342539945fb6 100644 --- a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h @@ -92,8 +92,10 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper Q_OBJECT public: - //! Flags which indicate what types of filtering and searching is possible using the widget - //! \since QGIS 2.16 + /** + * Flags which indicate what types of filtering and searching is possible using the widget + * \since QGIS 2.16 + */ enum FilterFlag { EqualTo = 1 << 1, //!< Supports equal to diff --git a/src/gui/editorwidgets/qgscolorwidgetfactory.cpp b/src/gui/editorwidgets/qgscolorwidgetfactory.cpp index 2dd2c0da7f28..ea67b798fba4 100644 --- a/src/gui/editorwidgets/qgscolorwidgetfactory.cpp +++ b/src/gui/editorwidgets/qgscolorwidgetfactory.cpp @@ -46,4 +46,4 @@ unsigned int QgsColorWidgetFactory::fieldScore( const QgsVectorLayer *vl, int fi { return 5; } -} \ No newline at end of file +} diff --git a/src/gui/editorwidgets/qgsrelationreferencewidget.h b/src/gui/editorwidgets/qgsrelationreferencewidget.h index 6a818a3d3ede..13b944800f31 100644 --- a/src/gui/editorwidgets/qgsrelationreferencewidget.h +++ b/src/gui/editorwidgets/qgsrelationreferencewidget.h @@ -130,8 +130,10 @@ class GUI_EXPORT QgsRelationReferenceWidget : public QWidget */ void setChainFilters( bool chainFilters ); - //! return the related feature (from the referenced layer) - //! if no feature is related, it returns an invalid feature + /** + * return the related feature (from the referenced layer) + * if no feature is related, it returns an invalid feature + */ QgsFeature referencedFeature() const; /** Sets the widget to display in an indeterminate "mixed value" state. diff --git a/src/gui/editorwidgets/qgsuuidwidgetfactory.cpp b/src/gui/editorwidgets/qgsuuidwidgetfactory.cpp index 6bf52e3dfbdb..49bbfa60ff38 100644 --- a/src/gui/editorwidgets/qgsuuidwidgetfactory.cpp +++ b/src/gui/editorwidgets/qgsuuidwidgetfactory.cpp @@ -38,4 +38,4 @@ unsigned int QgsUuidWidgetFactory::fieldScore( const QgsVectorLayer *vl, int fie { const QVariant::Type type = vl->fields().field( fieldIdx ).type(); return type == QVariant::String ? 5 : 0; -} \ No newline at end of file +} diff --git a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h index c9a3edca6c77..7be3540998e9 100644 --- a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h +++ b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h @@ -42,9 +42,11 @@ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetProvider //! Human readable name - may be translatable with tr() virtual QString name() const = 0; - //! Factory to create widgets. The returned widget is owned by the caller. - //! The widgetIndex argument may be used to identify which widget is being - //! created (useful when using multiple widgets from the same provider for one layer). + /** + * Factory to create widgets. The returned widget is owned by the caller. + * The widgetIndex argument may be used to identify which widget is being + * created (useful when using multiple widgets from the same provider for one layer). + */ virtual QWidget *createWidget( QgsMapLayer *layer, int widgetIndex ) = 0 SIP_FACTORY; //! Whether it makes sense to use this widget for a particular layer diff --git a/src/gui/layertree/qgslayertreemapcanvasbridge.h b/src/gui/layertree/qgslayertreemapcanvasbridge.h index 5e819eb93319..eda159daac7f 100644 --- a/src/gui/layertree/qgslayertreemapcanvasbridge.h +++ b/src/gui/layertree/qgslayertreemapcanvasbridge.h @@ -56,15 +56,22 @@ class GUI_EXPORT QgsLayerTreeMapCanvasBridge : public QObject QgsLayerTree *rootGroup() const { return mRoot; } QgsMapCanvas *mapCanvas() const { return mCanvas; } - //! Associates overview canvas with the bridge, so the overview will be updated whenever main canvas is updated - //! \since QGIS 3.0 + /** + * Associates overview canvas with the bridge, so the overview will be updated whenever main canvas is updated + * \since QGIS 3.0 + */ void setOvervewCanvas( QgsMapOverviewCanvas *overviewCanvas ) { mOverviewCanvas = overviewCanvas; } - //! Returns associated overview canvas (may be null) - //! \since QGIS 3.0 + + /** + * Returns associated overview canvas (may be null) + * \since QGIS 3.0 + */ QgsMapOverviewCanvas *overviewCanvas() const { return mOverviewCanvas; } - //! if enabled, will automatically set full canvas extent and destination CRS + map units - //! when first layer(s) are added + /** + * if enabled, will automatically set full canvas extent and destination CRS + map units + * when first layer(s) are added + */ void setAutoSetupOnFirstLayer( bool enabled ) { mAutoSetupOnFirstLayer = enabled; } bool autoSetupOnFirstLayer() const { return mAutoSetupOnFirstLayer; } diff --git a/src/gui/layertree/qgslayertreeview.h b/src/gui/layertree/qgslayertreeview.h index f86d48190d48..0aaf9df22cea 100644 --- a/src/gui/layertree/qgslayertreeview.h +++ b/src/gui/layertree/qgslayertreeview.h @@ -92,8 +92,10 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView */ QgsLayerTreeModelLegendNode *currentLegendNode() const; - //! Return list of selected nodes - //! @arg skipInternal If true, will ignore nodes which have an ancestor in the selection + /** + * Return list of selected nodes + * \param skipInternal If true, will ignore nodes which have an ancestor in the selection + */ QList selectedNodes( bool skipInternal = false ) const; //! Return list of selected nodes filtered to just layer nodes QList selectedLayerNodes() const; @@ -105,12 +107,16 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView //! Force refresh of layer symbology. Normally not needed as the changes of layer's renderer are monitored by the model void refreshLayerSymbology( const QString &layerId ); - //! Enhancement of QTreeView::expandAll() that also records expanded state in layer tree nodes - //! \since QGIS 2.18 + /** + * Enhancement of QTreeView::expandAll() that also records expanded state in layer tree nodes + * \since QGIS 2.18 + */ void expandAllNodes(); - //! Enhancement of QTreeView::collapseAll() that also records expanded state in layer tree nodes - //! \since QGIS 2.18 + /** + * Enhancement of QTreeView::collapseAll() that also records expanded state in layer tree nodes + * \since QGIS 2.18 + */ void collapseAllNodes(); signals: diff --git a/src/gui/layertree/qgslayertreeviewdefaultactions.h b/src/gui/layertree/qgslayertreeviewdefaultactions.h index b736ba44c0c1..516b8200cdd8 100644 --- a/src/gui/layertree/qgslayertreeviewdefaultactions.h +++ b/src/gui/layertree/qgslayertreeviewdefaultactions.h @@ -63,8 +63,11 @@ class GUI_EXPORT QgsLayerTreeViewDefaultActions : public QObject QAction *actionMakeTopLevel( QObject *parent = nullptr ) SIP_FACTORY; QAction *actionGroupSelected( QObject *parent = nullptr ) SIP_FACTORY; - //! Action to enable/disable mutually exclusive flag of a group (only one child node may be checked) - //! \since QGIS 2.12 + + /** + * Action to enable/disable mutually exclusive flag of a group (only one child node may be checked) + * \since QGIS 2.12 + */ QAction *actionMutuallyExclusiveGroup( QObject *parent = nullptr ) SIP_FACTORY; void zoomToLayer( QgsMapCanvas *canvas ); @@ -82,8 +85,11 @@ class GUI_EXPORT QgsLayerTreeViewDefaultActions : public QObject void zoomToGroup(); void makeTopLevel(); void groupSelected(); - //! Slot to enable/disable mutually exclusive group flag - //! \since QGIS 2.12 + + /** + * Slot to enable/disable mutually exclusive group flag + * \since QGIS 2.12 + */ void mutuallyExclusiveGroup(); private slots: diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h index 040aadc832d7..514f54330fe8 100644 --- a/src/gui/qgisinterface.h +++ b/src/gui/qgisinterface.h @@ -177,8 +177,10 @@ class GUI_EXPORT QgisInterface : public QObject //! Get pointer to the active layer (layer selected in the legend) virtual QgsMapLayer *activeLayer() = 0; - //! Set the active layer (layer gets selected in the legend) - //! returns true if the layer exists, false otherwise + /** + * Set the active layer (layer gets selected in the legend) + * returns true if the layer exists, false otherwise + */ virtual bool setActiveLayer( QgsMapLayer * ) = 0; //! Add an icon to the plugins toolbar @@ -264,8 +266,10 @@ class GUI_EXPORT QgisInterface : public QObject //! Add toolbar with specified name virtual QToolBar *addToolBar( const QString &name ) = 0 SIP_FACTORY; - //! Add a toolbar - //! \since QGIS 2.3 + /** + * Add a toolbar + * \since QGIS 2.3 + */ virtual void addToolBar( QToolBar *toolbar SIP_TRANSFER, Qt::ToolBarArea area = Qt::TopToolBarArea ) = 0; //! Return a pointer to the map canvas diff --git a/src/gui/qgsadvanceddigitizingdockwidget.h b/src/gui/qgsadvanceddigitizingdockwidget.h index b60db85fbcfc..1dd435bf535d 100644 --- a/src/gui/qgsadvanceddigitizingdockwidget.h +++ b/src/gui/qgsadvanceddigitizingdockwidget.h @@ -203,18 +203,24 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private */ bool canvasKeyPressEventFilter( QKeyEvent *e ); - //! apply the CAD constraints. The will modify the position of the map event in map coordinates by applying the CAD constraints. - //! \returns false if no solution was found (invalid constraints) + /** + * apply the CAD constraints. The will modify the position of the map event in map coordinates by applying the CAD constraints. + * \returns false if no solution was found (invalid constraints) + */ bool applyConstraints( QgsMapMouseEvent *e ); - //! align to segment for additional constraint. - //! If additional constraints are used, this will determine the angle to be locked depending on the snapped segment. - //! \since QGIS 3.0 + /** + * align to segment for additional constraint. + * If additional constraints are used, this will determine the angle to be locked depending on the snapped segment. + * \since QGIS 3.0 + */ bool alignToSegment( QgsMapMouseEvent *e, QgsAdvancedDigitizingDockWidget::CadConstraint::LockMode lockMode = QgsAdvancedDigitizingDockWidget::CadConstraint::HardLock ); - //! unlock all constraints - //! \param releaseRepeatingLocks set to false to preserve the lock for any constraints set to repeating lock mode - //! \since QGIS 3.0 + /** + * unlock all constraints + * \param releaseRepeatingLocks set to false to preserve the lock for any constraints set to repeating lock mode + * \since QGIS 3.0 + */ void releaseLocks( bool releaseRepeatingLocks = true ); /** @@ -314,8 +320,10 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private */ void disable(); - //! Updates canvas item that displays constraints on the ma - //! \since QGIS 3.0 + /** + * Updates canvas item that displays constraints on the ma + * \since QGIS 3.0 + */ void updateCadPaintItem(); signals: @@ -347,12 +355,16 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private //! lock/unlock a constraint and set its value void lockConstraint( bool activate = true ); - //! Called when user has manually altered a constraint value. Any entered expressions will - //! be left intact + /** + * Called when user has manually altered a constraint value. Any entered expressions will + * be left intact + */ void constraintTextEdited( const QString &textValue ); - //! Called when a constraint input widget has lost focus. Any entered expressions - //! will be converted to their calculated value + /** + * Called when a constraint input widget has lost focus. Any entered expressions + * will be converted to their calculated value + */ void constraintFocusOut(); //! set the relative properties of constraints @@ -361,8 +373,10 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private //! Set the repeating lock property of constraints void setConstraintRepeatingLock( bool activate ); - //! activate/deactivate tools. It is called when tools are activated manually (from the GUI) - //! it will call setCadEnabled to properly update the UI. + /** + * activate/deactivate tools. It is called when tools are activated manually (from the GUI) + * it will call setCadEnabled to properly update the UI. + */ void activateCad( bool enabled ); //! enable/disable construction mode (events are not forwarded to the map tool) @@ -396,12 +410,16 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private //! remove previous point in the CAD point list void removePreviousPoint(); - //! filters key press - //! \note called by eventFilter (filter on line edits), canvasKeyPressEvent (filter on map tool) and keyPressEvent (filter on dock) + /** + * filters key press + * \note called by eventFilter (filter on line edits), canvasKeyPressEvent (filter on map tool) and keyPressEvent (filter on dock) + */ bool filterKeyPress( QKeyEvent *e ); - //! event filter for line edits in the dock UI (angle/distance/x/y line edits) - //! \note defined as private in Python bindings + /** + * event filter for line edits in the dock UI (angle/distance/x/y line edits) + * \note defined as private in Python bindings + */ bool eventFilter( QObject *obj, QEvent *event ) override SIP_SKIP; //! trigger fake mouse move event to update map tool rubber band and/or show new constraints diff --git a/src/gui/qgsattributeformeditorwidget.h b/src/gui/qgsattributeformeditorwidget.h index 2bbd4d29dc49..32f402c359ab 100644 --- a/src/gui/qgsattributeformeditorwidget.h +++ b/src/gui/qgsattributeformeditorwidget.h @@ -124,8 +124,10 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget signals: - //! Emitted when the widget's value changes - //! \param value new widget value + /** + * Emitted when the widget's value changes + * \param value new widget value + */ void valueChanged( const QVariant &value ); private slots: diff --git a/src/gui/qgscodeeditorsql.h b/src/gui/qgscodeeditorsql.h index 88de794aed09..be7ed6d48143 100644 --- a/src/gui/qgscodeeditorsql.h +++ b/src/gui/qgscodeeditorsql.h @@ -50,8 +50,8 @@ class GUI_EXPORT QgsCodeEditorSQL : public QgsCodeEditor setAutoCompletionCaseSensitivity( false ) is not sufficient when installing a lexer, since its caseSensitive() method is actually used, and defaults to true. - @note not available in Python bindings - @ingroup gui + \note not available in Python bindings + \ingroup gui */ class QgsCaseInsensitiveLexerSQL: public QsciLexerSQL { diff --git a/src/gui/qgsdatasourcemanagerdialog.h b/src/gui/qgsdatasourcemanagerdialog.h index 2b673b293115..364d14a7d204 100644 --- a/src/gui/qgsdatasourcemanagerdialog.h +++ b/src/gui/qgsdatasourcemanagerdialog.h @@ -40,7 +40,7 @@ class QgsBrowserModel; * The dialog does not handle layer addition directly but emits signals that * need to be forwarded to the QGIS application to be handled. * \since QGIS 3.0 - * @note not available in Python bindings + * \note not available in Python bindings */ class GUI_EXPORT QgsDataSourceManagerDialog : public QgsOptionsDialogBase, private Ui::QgsDataSourceManagerDialog { @@ -69,8 +69,10 @@ class GUI_EXPORT QgsDataSourceManagerDialog : public QgsOptionsDialogBase, priva //! Sync current page with the leftbar list void setCurrentPage( int index ); - //! A raster layer was added: for signal forwarding to QgisApp - //! TODO: use this with an internal source select dialog instead of forwarding the whole raster selection to app + /** + * A raster layer was added: for signal forwarding to QgisApp + * TODO: use this with an internal source select dialog instead of forwarding the whole raster selection to app + */ void rasterLayerAdded( QString const &uri, QString const &baseName, QString const &providerKey ); //! A vector layer was added: for signal forwarding to QgisApp void vectorLayerAdded( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ); @@ -107,12 +109,18 @@ class GUI_EXPORT QgsDataSourceManagerDialog : public QgsOptionsDialogBase, priva void handleDropUriList( const QgsMimeDataUtils::UriList & ); //! Update project home directory void updateProjectHome(); - //! Emitted when a connection has changed inside the provider dialogs - //! This signal is normally forwarded to the application to notify other - //! browsers that they need to refresh their connections list + + /** + * Emitted when a connection has changed inside the provider dialogs + * This signal is normally forwarded to the application to notify other + * browsers that they need to refresh their connections list + */ void connectionsChanged(); - //! One or more provider connections have changed and the - //! dialogs should be refreshed + + /** + * One or more provider connections have changed and the + * dialogs should be refreshed + */ void providerDialogsRefreshRequested(); private: diff --git a/src/gui/qgsidentifymenu.h b/src/gui/qgsidentifymenu.h index 3fe57471048f..48196558e335 100644 --- a/src/gui/qgsidentifymenu.h +++ b/src/gui/qgsidentifymenu.h @@ -118,13 +118,17 @@ class GUI_EXPORT QgsIdentifyMenu : public QMenu void setResultsIfExternalAction( bool resultsIfExternalAction ) {mResultsIfExternalAction = resultsIfExternalAction;} bool resultsIfExternalAction() {return mResultsIfExternalAction;} - //! Defines the maximum number of layers displayed in the menu (default is 10). - //! \note 0 is unlimited. + /** + * Defines the maximum number of layers displayed in the menu (default is 10). + * \note 0 is unlimited. + */ void setMaxLayerDisplay( int maxLayerDisplay ); int maxLayerDisplay() {return mMaxLayerDisplay;} - //! Defines the maximum number of features displayed in the menu for vector layers (default is 10). - //! \note 0 is unlimited. + /** + * Defines the maximum number of features displayed in the menu for vector layers (default is 10). + * \note 0 is unlimited. + */ void setMaxFeatureDisplay( int maxFeatureDisplay ); int maxFeatureDisplay() {return mMaxFeatureDisplay;} @@ -155,8 +159,10 @@ class GUI_EXPORT QgsIdentifyMenu : public QMenu //! adds a raster layer in the menu being built void addRasterLayer( QgsMapLayer *layer ); - //! adds a vector layer and its results in the menu being built - //! if singleLayer is true, results will be displayed on the top level item (not in QMenu with the layer name) + /** + * adds a vector layer and its results in the menu being built + * if singleLayer is true, results will be displayed on the top level item (not in QMenu with the layer name) + */ void addVectorLayer( QgsVectorLayer *layer, const QList &results, bool singleLayer = false ); //! get the lists of results corresponding to an action in the menu diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp index b0200be8e2d4..7f7326bc5ea4 100644 --- a/src/gui/qgsmapcanvas.cpp +++ b/src/gui/qgsmapcanvas.cpp @@ -70,7 +70,7 @@ email : sherman at mrcc.com /** \ingroup gui * Deprecated to be deleted, stuff from here should be moved elsewhere. - * @note not available in Python bindings + * \note not available in Python bindings */ //TODO QGIS 3.0 - remove class QgsMapCanvas::CanvasProperties diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h index d998da5eb8f9..608b8c91cdc2 100644 --- a/src/gui/qgsmapcanvas.h +++ b/src/gui/qgsmapcanvas.h @@ -93,8 +93,10 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView ~QgsMapCanvas(); - //! Returns the magnification factor - //! \since QGIS 2.16 + /** + * Returns the magnification factor + * \since QGIS 2.16 + */ double magnificationFactor() const; /** @@ -112,12 +114,16 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView void setCurrentLayer( QgsMapLayer *layer ); - //! Get access to properties used for map rendering - //! \since QGIS 2.4 + /** + * Get access to properties used for map rendering + * \since QGIS 2.4 + */ const QgsMapSettings &mapSettings() const SIP_KEEPREFERENCE; - //! sets destination coordinate reference system - //! \since QGIS 2.4 + /** + * sets destination coordinate reference system + * \since QGIS 2.4 + */ void setDestinationCrs( const QgsCoordinateReferenceSystem &crs ); /** @@ -126,24 +132,34 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void setMapSettingsFlags( QgsMapSettings::Flags flags ); - //! Get access to the labeling results (may be null) - //! \since QGIS 2.4 + /** + * Get access to the labeling results (may be null) + * \since QGIS 2.4 + */ const QgsLabelingResults *labelingResults() const; - //! Set whether to cache images of rendered layers - //! \since QGIS 2.4 + /** + * Set whether to cache images of rendered layers + * \since QGIS 2.4 + */ void setCachingEnabled( bool enabled ); - //! Check whether images of rendered layers are curerently being cached - //! \since QGIS 2.4 + /** + * Check whether images of rendered layers are curerently being cached + * \since QGIS 2.4 + */ bool isCachingEnabled() const; - //! Make sure to remove any rendered images from cache (does nothing if cache is not enabled) - //! \since QGIS 2.4 + /** + * Make sure to remove any rendered images from cache (does nothing if cache is not enabled) + * \since QGIS 2.4 + */ void clearCache(); - //! Reload all layers, clear the cache and refresh the canvas - //! \since QGIS 2.9 + /** + * Reload all layers, clear the cache and refresh the canvas + * \since QGIS 2.9 + */ void refreshAllLayers(); /** @@ -157,20 +173,28 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void waitWhileRendering(); - //! Set whether the layers are rendered in parallel or sequentially - //! \since QGIS 2.4 + /** + * Set whether the layers are rendered in parallel or sequentially + * \since QGIS 2.4 + */ void setParallelRenderingEnabled( bool enabled ); - //! Check whether the layers are rendered in parallel or sequentially - //! \since QGIS 2.4 + /** + * Check whether the layers are rendered in parallel or sequentially + * \since QGIS 2.4 + */ bool isParallelRenderingEnabled() const; - //! Set how often map preview should be updated while it is being rendered (in milliseconds) - //! \since QGIS 2.4 + /** + * Set how often map preview should be updated while it is being rendered (in milliseconds) + * \since QGIS 2.4 + */ void setMapUpdateInterval( int timeMilliseconds ); - //! Find out how often map preview should be updated while it is being rendered (in milliseconds) - //! \since QGIS 2.4 + /** + * Find out how often map preview should be updated while it is being rendered (in milliseconds) + * \since QGIS 2.4 + */ int mapUpdateInterval() const; /** @@ -190,20 +214,28 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! Set the extent of the map canvas void setExtent( const QgsRectangle &r, bool magnified = false ); - //! Get the current map canvas rotation in clockwise degrees - //! \since QGIS 2.8 + /** + * Get the current map canvas rotation in clockwise degrees + * \since QGIS 2.8 + */ double rotation() const; - //! Set the rotation of the map canvas in clockwise degrees - //! \since QGIS 2.8 + /** + * Set the rotation of the map canvas in clockwise degrees + * \since QGIS 2.8 + */ void setRotation( double degrees ); - //! Set the center of the map canvas, in geographical coordinates - //! \since QGIS 2.8 + /** + * Set the center of the map canvas, in geographical coordinates + * \since QGIS 2.8 + */ void setCenter( const QgsPointXY ¢er ); - //! Get map center, in geographical coordinates - //! \since QGIS 2.8 + /** + * Get map center, in geographical coordinates + * \since QGIS 2.8 + */ QgsPointXY center() const; //! Zoom to the full extent of all layers @@ -287,12 +319,16 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! Read property of QColor bgColor. QColor canvasColor() const; - //! Set color of selected vector features - //! \since QGIS 2.4 + /** + * Set color of selected vector features + * \since QGIS 2.4 + */ void setSelectionColor( const QColor &color ); - //! Returns color for selected features - //! \since QGIS 3.0 + /** + * Returns color for selected features + * \since QGIS 3.0 + */ QColor selectionColor() const; //! Emits signal scaleChanged to update scale in main window @@ -411,20 +447,26 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void zoomScale( double scale ); - //! Zoom with the factor supplied. Factor > 1 zooms out, interval (0,1) zooms in - //! If point is given, re-center on it + /** + * Zoom with the factor supplied. Factor > 1 zooms out, interval (0,1) zooms in + * If point is given, re-center on it + */ void zoomByFactor( double scaleFactor, const QgsPointXY *center = nullptr ); //! Zooms in/out with a given center void zoomWithCenter( int x, int y, bool zoomIn ); - //! Zooms to feature extent. Adds a small margin around the extent - //! and does a pan if rect is empty (point extent) + /** + * Zooms to feature extent. Adds a small margin around the extent + * and does a pan if rect is empty (point extent) + */ void zoomToFeatureExtent( QgsRectangle &rect ); - //! Returns whether the scale is locked, so zooming can be performed using magnication. - //! \since QGIS 2.16 - //! \see setScaleLocked() + /** + * Returns whether the scale is locked, so zooming can be performed using magnication. + * \since QGIS 2.16 + * \see setScaleLocked() + */ bool scaleLocked() const { return mScaleLocked;} //! used to determine if anti-aliasing is enabled or not @@ -606,8 +648,10 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void setRenderFlag( bool flag ); - //! stop rendering (if there is any right now) - //! \since QGIS 2.4 + /** + * stop rendering (if there is any right now) + * \since QGIS 2.4 + */ void stopRendering(); //! called to read map canvas settings from project @@ -619,15 +663,19 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! ask user about datum transformation void getDatumTransformInfo( const QgsMapLayer *ml, const QString &srcAuthId, const QString &destAuthId ); - //! Sets the factor of magnification to apply to the map canvas. Indeed, we - //! increase/decrease the DPI of the map settings according to this factor - //! in order to render marker point, labels, ... bigger. - //! \since QGIS 2.16 + /** + * Sets the factor of magnification to apply to the map canvas. Indeed, we + * increase/decrease the DPI of the map settings according to this factor + * in order to render marker point, labels, ... bigger. + * \since QGIS 2.16 + */ void setMagnificationFactor( double factor ); - //! Lock the scale, so zooming can be performed using magnication - //! \since QGIS 2.16 - //! \see scaleLocked() + /** + * Lock the scale, so zooming can be performed using magnication + * \since QGIS 2.16 + * \see scaleLocked() + */ void setScaleLocked( bool isLocked ); //! Zoom in with fixed factor @@ -664,16 +712,22 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! Emitted when the extents of the map change void extentsChanged(); - //! Emitted when the rotation of the map changes - //! \since QGIS 2.8 + /** + * Emitted when the rotation of the map changes + * \since QGIS 2.8 + */ void rotationChanged( double ); - //! Emitted when the scale of the map changes - //! \since QGIS 2.16 + /** + * Emitted when the scale of the map changes + * \since QGIS 2.16 + */ void magnificationChanged( double ); - //! Emitted when canvas background color changes - //! \since QGIS 3.0 + /** + * Emitted when canvas background color changes + * \since QGIS 3.0 + */ void canvasColorChanged(); /** Emitted when the canvas has rendered. @@ -683,9 +737,12 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * being rendered onto a pixmap other than the mapCanvas own pixmap member. * */ - //! TODO: deprecate when decorations are reimplemented as map canvas items - //! - anything related to rendering progress is not visible outside of map canvas - //! - additional drawing shall be done directly within the renderer job or independently as a map canvas item + + /** + * TODO: deprecate when decorations are reimplemented as map canvas items + * - anything related to rendering progress is not visible outside of map canvas + * - additional drawing shall be done directly within the renderer job or independently as a map canvas item + */ void renderComplete( QPainter * ); // ### QGIS 3: renamte to mapRefreshFinished() @@ -720,16 +777,22 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! Emitted when zoom next status changed void zoomNextStatusChanged( bool ); - //! Emitted when map CRS has changed - //! \since QGIS 2.4 + /** + * Emitted when map CRS has changed + * \since QGIS 2.4 + */ void destinationCrsChanged(); - //! Emitted when the current layer is changed - //! \since QGIS 2.8 + /** + * Emitted when the current layer is changed + * \since QGIS 2.8 + */ void currentLayerChanged( QgsMapLayer *layer ); - //! Emitted when the configuration of overridden layer styles changes - //! \since QGIS 2.12 + /** + * Emitted when the configuration of overridden layer styles changes + * \since QGIS 2.12 + */ void layerStyleOverridesChanged(); /** @@ -917,8 +980,10 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView bool mUsePreviewJobs = false; - //! Force a resize of the map canvas item - //! \since QGIS 2.16 + /** + * Force a resize of the map canvas item + * \since QGIS 2.16 + */ void updateMapSize(); /** Starts zooming via rectangle diff --git a/src/gui/qgsmapcanvasitem.h b/src/gui/qgsmapcanvasitem.h index 5e2a0a3179d5..ea65db3f82ba 100644 --- a/src/gui/qgsmapcanvasitem.h +++ b/src/gui/qgsmapcanvasitem.h @@ -78,14 +78,16 @@ class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem //! pointer to map canvas QgsMapCanvas *mMapCanvas = nullptr; - //! cached canvas item rectangle in map coordinates - //! encodes position (xmin,ymax) and size (width/height) - //! used to re-position and re-size the item on zoom/pan - //! while waiting for the renderer to complete. - //! - //! NOTE: does not include rotation information, so cannot - //! be used to correctly present pre-rendered map - //! on rotation change + /** + * cached canvas item rectangle in map coordinates + * encodes position (xmin,ymax) and size (width/height) + * used to re-position and re-size the item on zoom/pan + * while waiting for the renderer to complete. + * + * NOTE: does not include rotation information, so cannot + * be used to correctly present pre-rendered map + * on rotation change + */ QgsRectangle mRect; double mRectRotation; diff --git a/src/gui/qgsmapcanvastracer.h b/src/gui/qgsmapcanvastracer.h index c39f919642fc..4d619d5d80a2 100644 --- a/src/gui/qgsmapcanvastracer.h +++ b/src/gui/qgsmapcanvastracer.h @@ -48,13 +48,17 @@ class GUI_EXPORT QgsMapCanvasTracer : public QgsTracer //! Access to action that user may use to toggle tracing on/off. May be null if no action was associated QAction *actionEnableTracing() const { return mActionEnableTracing; } - //! Assign "enable tracing" checkable action to the tracer. - //! The action is used to determine whether tracing is currently enabled by the user + /** + * Assign "enable tracing" checkable action to the tracer. + * The action is used to determine whether tracing is currently enabled by the user + */ void setActionEnableTracing( QAction *action ) { mActionEnableTracing = action; } - //! Retrieve instance of this class associated with given canvas (if any). - //! The class keeps a simple registry of tracers associated with map canvas - //! instances for easier access to the common tracer by various map tools + /** + * Retrieve instance of this class associated with given canvas (if any). + * The class keeps a simple registry of tracers associated with map canvas + * instances for easier access to the common tracer by various map tools + */ static QgsMapCanvasTracer *tracerForCanvas( QgsMapCanvas *canvas ); //! Report a path finding error to the user diff --git a/src/gui/qgsmaplayeractionregistry.h b/src/gui/qgsmaplayeractionregistry.h index e323f8586c00..681c91ab5b0a 100644 --- a/src/gui/qgsmaplayeractionregistry.h +++ b/src/gui/qgsmaplayeractionregistry.h @@ -45,8 +45,10 @@ class GUI_EXPORT QgsMapLayerAction : public QAction }; Q_DECLARE_FLAGS( Targets, Target ) - //! 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 compatibility reasons. + /** + * 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 compatibility reasons. + */ QgsMapLayerAction( const QString &name, QObject *parent SIP_TRANSFERTHIS, Targets targets = AllActions, const QIcon &icon = QIcon() ); //! Creates a map layer action which can run only on a specific layer diff --git a/src/gui/qgsmapmouseevent.h b/src/gui/qgsmapmouseevent.h index 22ed77b1f9ae..f6da02888cdf 100644 --- a/src/gui/qgsmapmouseevent.h +++ b/src/gui/qgsmapmouseevent.h @@ -136,8 +136,10 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent //! Location in map coordinates. May be snapped. QgsPointXY mMapPoint; - //! Location in pixel coordinates. May be snapped. - //! Original pixel point available through the parent QMouseEvent. + /** + * Location in pixel coordinates. May be snapped. + * Original pixel point available through the parent QMouseEvent. + */ QPoint mPixelPoint; //! The map canvas on which the event was triggered. diff --git a/src/gui/qgsmaptool.h b/src/gui/qgsmaptool.h index 677e27eaa561..d3c1c67e2ae3 100644 --- a/src/gui/qgsmaptool.h +++ b/src/gui/qgsmaptool.h @@ -81,8 +81,10 @@ class GUI_EXPORT QgsMapTool : public QObject public: - //! Enumeration of flags that adjust the way the map tool operates - //! \since QGIS 2.16 + /** + * Enumeration of flags that adjust the way the map tool operates + * \since QGIS 2.16 + */ enum Flag { Transient = 1 << 1, /*!< Indicates that this map tool performs a transient (one-off) operation. @@ -152,8 +154,10 @@ class GUI_EXPORT QgsMapTool : public QObject //! returns pointer to the tool's map canvas QgsMapCanvas *canvas(); - //! Emit map tool changed with the old tool - //! \since QGIS 2.3 + /** + * Emit map tool changed with the old tool + * \since QGIS 2.3 + */ QString toolName() { return mToolName; } /** Get search radius in mm. Used by identify, tip etc. @@ -206,8 +210,10 @@ class GUI_EXPORT QgsMapTool : public QObject //!transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) QgsPointXY toMapCoordinates( const QgsMapLayer *layer, const QgsPointXY &point ); - //!transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) - //! \note available in Python bindings as toMapCoordinatesV2 + /** + * transformation from layer's coordinates to map coordinates (which is different in case reprojection is used) + * \note available in Python bindings as toMapCoordinatesV2 + */ QgsPoint toMapCoordinates( const QgsMapLayer *layer, const QgsPoint &point ) SIP_PYNAME( toMapCoordinatesV2 ); //! trnasformation of the rect from map coordinates to layer's coordinates @@ -222,12 +228,16 @@ class GUI_EXPORT QgsMapTool : public QObject //! cursor used in map tool QCursor mCursor; - //! optionally map tool can have pointer to action - //! which will be used to set that action as active + /** + * optionally map tool can have pointer to action + * which will be used to set that action as active + */ QAction *mAction = nullptr; - //! optionally map tool can have pointer to a button - //! which will be used to set that action as active + /** + * optionally map tool can have pointer to a button + * which will be used to set that action as active + */ QAbstractButton *mButton = nullptr; //! translated name of the map tool diff --git a/src/gui/qgsmaptoolidentify.h b/src/gui/qgsmaptoolidentify.h index 10a578eb0bc4..43684582505e 100644 --- a/src/gui/qgsmaptoolidentify.h +++ b/src/gui/qgsmaptoolidentify.h @@ -118,8 +118,10 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool \returns a list of IdentifyResult*/ QList 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 + /** + * return a pointer to the identify menu which will be used in layer selection mode + * this menu can also be customized + */ QgsIdentifyMenu *identifyMenu() {return mIdentifyMenu;} public slots: diff --git a/src/gui/qgsowssourceselect.h b/src/gui/qgsowssourceselect.h index 2b31c226c5c0..aea0e0fdf1c9 100644 --- a/src/gui/qgsowssourceselect.h +++ b/src/gui/qgsowssourceselect.h @@ -168,8 +168,10 @@ class GUI_EXPORT QgsOWSSourceSelect : public QgsAbstractDataSourceWidget, protec */ virtual void populateLayerList(); - //! create an item including possible parents - //! \note not available in Python bindings + /** + * create an item including possible parents + * \note not available in Python bindings + */ QgsTreeWidgetItem *createItem( int id, const QStringList &names, QMap &items, diff --git a/src/gui/qgsprojectionselectiontreewidget.h b/src/gui/qgsprojectionselectiontreewidget.h index d759c95eac58..7d65d7c2fda9 100644 --- a/src/gui/qgsprojectionselectiontreewidget.h +++ b/src/gui/qgsprojectionselectiontreewidget.h @@ -160,7 +160,7 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui:: * and optionally, percentage symbols. Percentage symbols are used * as wildcards sometimes and so when using the string as part of the * LIKE phrase of a select statement, should be escaped. - * \arg const QString in The input string to make safe. + * \param const QString in The input string to make safe. * \returns The string made safe for SQL statements. */ const QString sqlSafeString( const QString &theSQL ); diff --git a/src/gui/qgssearchquerybuilder.cpp b/src/gui/qgssearchquerybuilder.cpp index 75c2fe23a787..4606c636821f 100644 --- a/src/gui/qgssearchquerybuilder.cpp +++ b/src/gui/qgssearchquerybuilder.cpp @@ -493,4 +493,4 @@ void QgsSearchQueryBuilder::loadQuery() void QgsSearchQueryBuilder::showHelp() { QgsHelp::openHelp( QStringLiteral( "working_with_vector/vector_properties.html#query-builder" ) ); -} \ No newline at end of file +} diff --git a/src/gui/qgssourceselectproviderregistry.h b/src/gui/qgssourceselectproviderregistry.h index c1830d4ff023..cc22538c62c2 100644 --- a/src/gui/qgssourceselectproviderregistry.h +++ b/src/gui/qgssourceselectproviderregistry.h @@ -56,8 +56,10 @@ class GUI_EXPORT QgsSourceSelectProviderRegistry //! Add a \a provider implementation. Takes ownership of the object. void addProvider( QgsSourceSelectProvider *provider SIP_TRANSFER ); - //! Remove \a provider implementation from the list (\a provider object is deleted) - //! \returns true if the provider was actually removed and deleted + /** + * Remove \a provider implementation from the list (\a provider object is deleted) + * \returns true if the provider was actually removed and deleted + */ bool removeProvider( QgsSourceSelectProvider *provider SIP_TRANSFER ); //! Return a provider by \a name or nullptr if not found @@ -68,8 +70,11 @@ class GUI_EXPORT QgsSourceSelectProviderRegistry private: - //! Populate the providers list, this needs to happen after the data provider - //! registry has been initialized. + + /** + * Populate the providers list, this needs to happen after the data provider + * registry has been initialized. + */ void init(); bool mInitialized = false; #ifdef SIP_RUN diff --git a/src/gui/qgssublayersdialog.h b/src/gui/qgssublayersdialog.h index aa634a08dcb0..20a430a64528 100644 --- a/src/gui/qgssublayersdialog.h +++ b/src/gui/qgssublayersdialog.h @@ -37,8 +37,10 @@ class GUI_EXPORT QgsSublayersDialog : public QDialog, private Ui::QgsSublayersDi Vsifile }; - //! A structure that defines layers for the purpose of this dialog - //! \since QGIS 2.16 + /** + * A structure that defines layers for the purpose of this dialog + * \since QGIS 2.16 + */ struct LayerDefinition { LayerDefinition() {} @@ -49,8 +51,10 @@ class GUI_EXPORT QgsSublayersDialog : public QDialog, private Ui::QgsSublayersDi QString type; //!< Extra type depending on the use (e.g. geometry type for vector sublayers) }; - //! List of layer definitions for the purpose of this dialog - //! \since QGIS 2.16 + /** + * List of layer definitions for the purpose of this dialog + * \since QGIS 2.16 + */ typedef QList LayerDefinitionList; QgsSublayersDialog( ProviderType providerType, @@ -60,28 +64,40 @@ class GUI_EXPORT QgsSublayersDialog : public QDialog, private Ui::QgsSublayersDi ~QgsSublayersDialog(); - //! Populate the table with layers - //! \since QGIS 2.16 + /** + * Populate the table with layers + * \since QGIS 2.16 + */ void populateLayerTable( const LayerDefinitionList &list ); - //! Returns list of selected layers - //! \since QGIS 2.16 + /** + * Returns list of selected layers + * \since QGIS 2.16 + */ LayerDefinitionList selection(); - //! Set if we should display the add to group checkbox - //! \since QGIS 3.0 + /** + * Set if we should display the add to group checkbox + * \since QGIS 3.0 + */ void setShowAddToGroupCheckbox( bool showAddToGroupCheckbox ) { mShowAddToGroupCheckbox = showAddToGroupCheckbox; } - //! If we should display the add to group checkbox - //! \since QGIS 3.0 + /** + * If we should display the add to group checkbox + * \since QGIS 3.0 + */ bool showAddToGroupCheckbox() const { return mShowAddToGroupCheckbox; } - //! If we should add layers in a group - //! \since QGIS 3.0 + /** + * If we should add layers in a group + * \since QGIS 3.0 + */ bool addToGroupCheckbox() const { return mCheckboxAddToGroup->isChecked(); } - //! Return column with count or -1 - //! \since QGIS 3.0 + /** + * Return column with count or -1 + * \since QGIS 3.0 + */ int countColumn() const { return mShowCount ? 2 : -1; } public slots: diff --git a/src/gui/symbology/qgsdatadefinedsizelegendwidget.h b/src/gui/symbology/qgsdatadefinedsizelegendwidget.h index 42e036a98c0e..ff1de939a6f9 100644 --- a/src/gui/symbology/qgsdatadefinedsizelegendwidget.h +++ b/src/gui/symbology/qgsdatadefinedsizelegendwidget.h @@ -46,10 +46,13 @@ class GUI_EXPORT QgsDataDefinedSizeLegendWidget : public QgsPanelWidget, private { Q_OBJECT public: - //! Creates the dialog and initializes the content to what is passed in the legend configuration (may be null). - //! The ddSize argument determines scaling of the marker symbol - it should have a size scale transformer assigned - //! to know the range of sizes. The overrideSymbol argument may override the source symbol: this is useful in case - //! when the symbol is given from outside rather than being set inside QgsDataDefinedSizeLegend. + + /** + * Creates the dialog and initializes the content to what is passed in the legend configuration (may be null). + * The ddSize argument determines scaling of the marker symbol - it should have a size scale transformer assigned + * to know the range of sizes. The overrideSymbol argument may override the source symbol: this is useful in case + * when the symbol is given from outside rather than being set inside QgsDataDefinedSizeLegend. + */ explicit QgsDataDefinedSizeLegendWidget( const QgsDataDefinedSizeLegend *ddsLegend, const QgsProperty &ddSize, QgsMarkerSymbol *overrideSymbol SIP_TRANSFER, QgsMapCanvas *canvas = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr ); ~QgsDataDefinedSizeLegendWidget(); diff --git a/src/gui/symbology/qgsrendererwidget.h b/src/gui/symbology/qgsrendererwidget.h index bb82da9c3f35..33ceb5a0f8c6 100644 --- a/src/gui/symbology/qgsrendererwidget.h +++ b/src/gui/symbology/qgsrendererwidget.h @@ -99,9 +99,11 @@ class GUI_EXPORT QgsRendererWidget : public QgsPanelWidget virtual QList selectedSymbols() { return QList(); } virtual void refreshSymbolView() {} - //! Creates widget to setup data-defined size legend. - //! Returns newly created panel - may be null if it could not be opened. Ownership is transferred to the caller. - //! \since QGIS 3.0 + /** + * Creates widget to setup data-defined size legend. + * Returns newly created panel - may be null if it could not be opened. Ownership is transferred to the caller. + * \since QGIS 3.0 + */ QgsDataDefinedSizeLegendWidget *createDataDefinedSizeLegendWidget( const QgsMarkerSymbol *symbol, const QgsDataDefinedSizeLegend *ddsLegend ) SIP_FACTORY; protected slots: diff --git a/src/gui/symbology/qgssmartgroupeditordialog.h b/src/gui/symbology/qgssmartgroupeditordialog.h index 0787044c4eba..71b447165375 100644 --- a/src/gui/symbology/qgssmartgroupeditordialog.h +++ b/src/gui/symbology/qgssmartgroupeditordialog.h @@ -76,15 +76,19 @@ class GUI_EXPORT QgsSmartGroupEditorDialog : public QDialog, private Ui::QgsSmar //! returns the value from mNameLineEdit QString smartgroupName(); - //! returns the condition map - //! \note not available in Python bindings + /** + * returns the condition map + * \note not available in Python bindings + */ QgsSmartConditionMap conditionMap() SIP_SKIP; //! returns the AND/OR condition QString conditionOperator(); - //! sets up the GUI for the given conditionmap - //! \note not available in Python bindings + /** + * sets up the GUI for the given conditionmap + * \note not available in Python bindings + */ void setConditionMap( const QgsSmartConditionMap & ) SIP_SKIP; //! sets the operator AND/OR diff --git a/src/gui/symbology/qgssymbolselectordialog.h b/src/gui/symbology/qgssymbolselectordialog.h index a06b8f82bdd4..8e51c7d39a1f 100644 --- a/src/gui/symbology/qgssymbolselectordialog.h +++ b/src/gui/symbology/qgssymbolselectordialog.h @@ -203,8 +203,10 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs */ void lockLayer(); - //! Duplicates the current symbol layer and places the duplicated layer above the current symbol layer - //! \since QGIS 2.14 + /** + * Duplicates the current symbol layer and places the duplicated layer above the current symbol layer + * \since QGIS 2.14 + */ void duplicateLayer(); /** @@ -225,8 +227,11 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs //! Slot to update tree when a new symbol from style void symbolChanged(); - //! alters tree and sets proper widget when Layer Type is changed - //! \note: The layer is received from the LayerPropertiesWidget + + /** + * alters tree and sets proper widget when Layer Type is changed + * \note: The layer is received from the LayerPropertiesWidget + */ void changeLayer( QgsSymbolLayer *layer ); @@ -310,8 +315,10 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog void lockLayer(); - //! Duplicates the current symbol layer and places the duplicated layer above the current symbol layer - //! \since QGIS 2.14 + /** + * Duplicates the current symbol layer and places the duplicated layer above the current symbol layer + * \since QGIS 2.14 + */ void duplicateLayer(); void layerChanged(); @@ -321,8 +328,11 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog //! Slot to update tree when a new symbol from style void symbolChanged(); - //! alters tree and sets proper widget when Layer Type is changed - //! \note: The layer is received from the LayerPropertiesWidget + + /** + * alters tree and sets proper widget when Layer Type is changed + * \note: The layer is received from the LayerPropertiesWidget + */ void changeLayer( QgsSymbolLayer *layer ); private: diff --git a/src/providers/gdal/qgsgdalprovider.cpp b/src/providers/gdal/qgsgdalprovider.cpp index d815f5381a40..0565fb142a84 100644 --- a/src/providers/gdal/qgsgdalprovider.cpp +++ b/src/providers/gdal/qgsgdalprovider.cpp @@ -1894,11 +1894,11 @@ QGISEXTERN bool isProvider() call. The regular express, glob, will have both all lower and upper case versions added. - @note + \note Copied from qgisapp.cpp. - @todo XXX This should probably be generalized and moved to a standard + \todo XXX This should probably be generalized and moved to a standard utility type thingy. */ diff --git a/src/providers/ogr/qgsogrdbconnection.h b/src/providers/ogr/qgsogrdbconnection.h index 88a5be742f81..b12dace581a5 100644 --- a/src/providers/ogr/qgsogrdbconnection.h +++ b/src/providers/ogr/qgsogrdbconnection.h @@ -39,8 +39,11 @@ class QgsOgrDbConnection : public QObject static void setSelectedConnection( const QString &connName, const QString &settingsKey ); public: - //! Return the uri - //! \see QgsDataSourceUri + + /** + * Return the uri + * \see QgsDataSourceUri + */ QgsDataSourceUri uri(); //! Return the path QString path( ) const { return mPath; } diff --git a/src/providers/ogr/qgsogrprovider.cpp b/src/providers/ogr/qgsogrprovider.cpp index ede605924f56..5e91f46e4e62 100644 --- a/src/providers/ogr/qgsogrprovider.cpp +++ b/src/providers/ogr/qgsogrprovider.cpp @@ -2152,11 +2152,11 @@ QString QgsOgrProvider::description() const call. The regular express, glob, will have both all lower and upper case versions added. - @note + \note Copied from qgisapp.cpp. - @todo XXX This should probably be generalized and moved to a standard + \todo XXX This should probably be generalized and moved to a standard utility type thingy. */ diff --git a/src/providers/oracle/qgsoraclesourceselect.cpp b/src/providers/oracle/qgsoraclesourceselect.cpp index 633b18f30f8b..90a3b123d751 100644 --- a/src/providers/oracle/qgsoraclesourceselect.cpp +++ b/src/providers/oracle/qgsoraclesourceselect.cpp @@ -674,4 +674,4 @@ void QgsOracleSourceSelect::treeWidgetSelectionChanged( const QItemSelection &se void QgsOracleSourceSelect::showHelp() { QgsHelp::openHelp( QStringLiteral( "managing_data_source/opening_data.html#loading-a-database-layer" ) ); -} \ No newline at end of file +} diff --git a/src/providers/virtual/qgsvirtuallayerblob.h b/src/providers/virtual/qgsvirtuallayerblob.h index 509cb6efcd35..1f47e73f7dfc 100644 --- a/src/providers/virtual/qgsvirtuallayerblob.h +++ b/src/providers/virtual/qgsvirtuallayerblob.h @@ -51,21 +51,25 @@ struct SpatialiteBlobHeader void writeTo( char *p ) const; }; -//! -//! Convert a QgsGeometry into a SpatiaLite geometry BLOB -//! The blob will be allocated and must be handled by the caller +/** + * Convert a QgsGeometry into a SpatiaLite geometry BLOB + * The blob will be allocated and must be handled by the caller + */ void qgsGeometryToSpatialiteBlob( const QgsGeometry &geom, int32_t srid, char *&blob, int &size ); -//! -//! Return the bounding box of a SpatiaLite geometry blob +/** + * Return the bounding box of a SpatiaLite geometry blob + */ QgsRectangle spatialiteBlobBbox( const char *blob, size_t size ); -//! -//! Convert a SpatiaLite geometry BLOB to a QgsGeometry +/** + * Convert a SpatiaLite geometry BLOB to a QgsGeometry + */ QgsGeometry spatialiteBlobToQgsGeometry( const char *blob, size_t size ); -//! -//! Get geometry type and srid from a SpatiaLite geometry blob +/** + * Get geometry type and srid from a SpatiaLite geometry blob + */ QPair spatialiteBlobGeometryType( const char *blob, size_t size ); #endif diff --git a/src/providers/virtual/qgsvirtuallayerqueryparser.h b/src/providers/virtual/qgsvirtuallayerqueryparser.h index a1ab4778c291..b4cbe6ad40a8 100644 --- a/src/providers/virtual/qgsvirtuallayerqueryparser.h +++ b/src/providers/virtual/qgsvirtuallayerqueryparser.h @@ -24,8 +24,9 @@ email : hugo dot mercier at oslandia dot com namespace QgsVirtualLayerQueryParser { - //! - //! Return the list of tables referenced in the SQL query + /** + * Return the list of tables referenced in the SQL query + */ QStringList referencedTables( const QString &q ); /** @@ -70,16 +71,19 @@ namespace QgsVirtualLayerQueryParser long mSrid = -1; }; - //! - //! Type used by the parser to type a query. It is slightly different from a QgsVirtualLayerDefinition since more than one geometry column can be represented + /** + * Type used by the parser to type a query. It is slightly different from a QgsVirtualLayerDefinition since more than one geometry column can be represented + */ typedef QList TableDef; - //! Get the column names and types that can be deduced from the query, using SQLite introspection - //! Special comments can also be used in the query to type columns - //! Comments should be set after the name of the column and are introduced by "/*:" - //! For instance 'SELECT t+1 /*:int*/ FROM table' will type the column 't' as integer - //! A geometry column can also be set by specifying a type and an SRID - //! For instance 'SELECT t, GeomFromText('POINT(0 0)',4326) as geom /*:point:4326*/ + /** + * Get the column names and types that can be deduced from the query, using SQLite introspection + * Special comments can also be used in the query to type columns + * Comments should be set after the name of the column and are introduced by "/*:" + * For instance 'SELECT t+1 /*:int* / FROM table' will type the column 't' as integer + * A geometry column can also be set by specifying a type and an SRID + * For instance 'SELECT t, GeomFromText('POINT(0 0)',4326) as geom /*:point:4326* / + */ TableDef columnDefinitionsFromQuery( sqlite3 *db, const QString &query ); //! Get the column types of a virtual table diff --git a/src/providers/wms/qgstilecache.h b/src/providers/wms/qgstilecache.h index f440a65bed41..9a08ba60d15b 100644 --- a/src/providers/wms/qgstilecache.h +++ b/src/providers/wms/qgstilecache.h @@ -37,8 +37,10 @@ class QgsTileCache //! Add a tile image with given URL to the cache static void insertTile( const QUrl &url, const QImage &image ); - //! Try to access a tile and load it into "image" argument - //! \returns true if the tile exists in the cache + /** + * Try to access a tile and load it into "image" argument + * \returns true if the tile exists in the cache + */ static bool tile( const QUrl &url, QImage &image ); //! how many tiles are stored in the in-memory cache diff --git a/src/providers/wms/qgswmscapabilities.h b/src/providers/wms/qgswmscapabilities.h index 886c8039b307..afc68553be82 100644 --- a/src/providers/wms/qgswmscapabilities.h +++ b/src/providers/wms/qgswmscapabilities.h @@ -324,16 +324,22 @@ struct QgsWmtsTileMatrix int matrixHeight; //!< Number of tiles vertically double tres; //!< Pixel span in map units - //! Returns extent of a tile in map coordinates. - //! (same function as tileBBox() but returns QRectF instead of QgsRectangle) + /** + * Returns extent of a tile in map coordinates. + * (same function as tileBBox() but returns QRectF instead of QgsRectangle) + */ QRectF tileRect( int col, int row ) const; - //! Returns extent of a tile in map coordinates - //! (same function as tileRect() but returns QgsRectangle instead of QRectF) + /** + * Returns extent of a tile in map coordinates + * (same function as tileRect() but returns QgsRectangle instead of QRectF) + */ QgsRectangle tileBBox( int col, int row ) const; - //! Returns range of tiles that intersects with the view extent - //! (tml may be null) + /** + * Returns range of tiles that intersects with the view extent + * (tml may be null) + */ void viewExtentIntersection( const QgsRectangle &viewExtent, const QgsWmtsTileMatrixLimits *tml, int &col0, int &row0, int &col1, int &row1 ) const; }; diff --git a/src/python/qgspythonutils.h b/src/python/qgspythonutils.h index 473f297da006..b98c28e61726 100644 --- a/src/python/qgspythonutils.h +++ b/src/python/qgspythonutils.h @@ -66,18 +66,24 @@ class PYTHON_EXPORT QgsPythonUtils /* console */ - //! run a statement, show an error message on error - //! \returns true if no error occurred + /** + * run a statement, show an error message on error + * \returns true if no error occurred + */ virtual bool runString( const QString &command, QString msgOnError = QString(), bool single = true ) = 0; - //! run a statement, error reporting is not done - //! \returns true if no error occurred + /** + * run a statement, error reporting is not done + * \returns true if no error occurred + */ virtual bool runStringUnsafe( const QString &command, bool single = true ) = 0; virtual bool evalString( const QString &command, QString &result ) = 0; - //! get information about error to the supplied arguments - //! \returns false if there was no Python error + /** + * get information about error to the supplied arguments + * \returns false if there was no Python error + */ virtual bool getError( QString &errorClassName, QString &errorText ) = 0; /* plugins */ @@ -97,8 +103,10 @@ class PYTHON_EXPORT QgsPythonUtils //! start plugin: add to active plugins and call initGui() virtual bool startPlugin( const QString &packageName ) = 0; - //! helper function to get some information about plugin - //! \param function one of these strings: name, tpye, version, description + /** + * helper function to get some information about plugin + * \param function one of these strings: name, tpye, version, description + */ virtual QString getPluginMetadata( const QString &pluginName, const QString &function ) = 0; //! confirm that the plugin can be uninstalled diff --git a/src/python/qgspythonutilsimpl.h b/src/python/qgspythonutilsimpl.h index 1d552d8783e5..77b9caac2724 100644 --- a/src/python/qgspythonutilsimpl.h +++ b/src/python/qgspythonutilsimpl.h @@ -54,14 +54,18 @@ class QgsPythonUtilsImpl : public QgsPythonUtils //! returns path where QGIS Python stuff is located QString pythonPath(); - //! run a statement (wrapper for PyRun_String) - //! this command is more advanced as enables error checking etc. - //! when an exception is raised, it shows dialog with exception details - //! \returns true if no error occurred + /** + * run a statement (wrapper for PyRun_String) + * this command is more advanced as enables error checking etc. + * when an exception is raised, it shows dialog with exception details + * \returns true if no error occurred + */ bool runString( const QString &command, QString msgOnError = QString(), bool single = true ) override; - //! run a statement, error reporting is not done - //! \returns true if no error occurred + /** + * run a statement, error reporting is not done + * \returns true if no error occurred + */ bool runStringUnsafe( const QString &command, bool single = true ) override; bool evalString( const QString &command, QString &result ) override; @@ -69,8 +73,10 @@ class QgsPythonUtilsImpl : public QgsPythonUtils //! \returns object's type name as a string QString getTypeAsString( PyObject *obj ); - //! get information about error to the supplied arguments - //! \returns false if there was no Python error + /** + * get information about error to the supplied arguments + * \returns false if there was no Python error + */ bool getError( QString &errorClassName, QString &errorText ) override; /* plugins related functions */ @@ -102,8 +108,10 @@ class QgsPythonUtilsImpl : public QgsPythonUtils //! start plugin: add to active plugins and call initGui() bool startPlugin( const QString &packageName ) override; - //! helper function to get some information about plugin - //! \param function one of these strings: name, tpye, version, description + /** + * helper function to get some information about plugin + * \param function one of these strings: name, tpye, version, description + */ QString getPluginMetadata( const QString &pluginName, const QString &function ) override; //! confirm it is safe to uninstall the plugin diff --git a/src/server/qgshttptransaction.h b/src/server/qgshttptransaction.h index 27b6b8b5e618..85cfb5805b4b 100644 --- a/src/server/qgshttptransaction.h +++ b/src/server/qgshttptransaction.h @@ -61,8 +61,10 @@ class QgsHttpTransaction : public QObject void getAsynchronously(); - //! Gets the response synchronously. Note that signals will still be emitted - //! while in this function. + /** + * Gets the response synchronously. Note that signals will still be emitted + * while in this function. + */ /*! The function returns false if there is an error while getting the response. diff --git a/src/server/qgsserver.h b/src/server/qgsserver.h index 73bf869c6856..5e6a3061afe3 100644 --- a/src/server/qgsserver.h +++ b/src/server/qgsserver.h @@ -79,8 +79,11 @@ class SERVER_EXPORT QgsServer QgsServerInterfaceImpl SIP_PYALTERNATIVETYPE( QgsServerInterface ) *serverInterface() { return sServerInterface; } #ifdef HAVE_SERVER_PYTHON_PLUGINS - //! Initialize Python - //! Note: not in Python bindings + + /** + * Initialize Python + * Note: not in Python bindings + */ void initPython(); #endif From 78c0c284687ee89c991d829ae7fc9d13a91ddbe4 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Thu, 5 Oct 2017 13:40:11 +1000 Subject: [PATCH 3/4] Fix doxygen warnings --- python/core/layertree/qgslayertreemodel.sip | 4 ++-- python/core/qgspointlocator.sip | 10 ++++++---- src/core/layertree/qgslayertreemodel.h | 4 ++-- src/core/qgspointlocator.h | 10 ++++++---- src/gui/qgsprojectionselectiontreewidget.cpp | 2 +- src/gui/qgsprojectionselectiontreewidget.h | 5 ++--- 6 files changed, 19 insertions(+), 16 deletions(-) diff --git a/python/core/layertree/qgslayertreemodel.sip b/python/core/layertree/qgslayertreemodel.sip index f5d3353d4e5a..5e976ac0c303 100644 --- a/python/core/layertree/qgslayertreemodel.sip +++ b/python/core/layertree/qgslayertreemodel.sip @@ -126,9 +126,9 @@ Return index for a given node. If the node does not belong to the layer tree, th QList indexes2nodes( const QModelIndexList &list, bool skipInternal = false ) const; %Docstring - Convert a list of indexes to a list of layer tree nodes. + Convert a ``list`` of indexes to a list of layer tree nodes. Indices that do not represent layer tree nodes are skipped. - \param skipInternal If true, a node is included in the output list only if no parent node is in the list + If ``skipInternal`` is true, a node is included in the output list only if no parent node is in the list. :rtype: list of QgsLayerTreeNode %End diff --git a/python/core/qgspointlocator.sip b/python/core/qgspointlocator.sip index 1dee88f40b74..292b61099c3f 100644 --- a/python/core/qgspointlocator.sip +++ b/python/core/qgspointlocator.sip @@ -32,10 +32,12 @@ class QgsPointLocator : QObject explicit QgsPointLocator( QgsVectorLayer *layer, const QgsCoordinateReferenceSystem &destinationCrs = QgsCoordinateReferenceSystem(), const QgsRectangle *extent = 0 ); %Docstring - Construct point locator for a layer. - \param destinationCrs if a valid QgsCoordinateReferenceSystem is passed then the locator will - do the searches on data reprojected to the given CRS - \param extent if not null, will index only a subset of the layer + Construct point locator for a ``layer``. + + If a valid QgsCoordinateReferenceSystem is passed for ``destinationCrs`` then the locator will + do the searches on data reprojected to the given CRS. + + If ``extent`` is not null, the locator will index only a subset of the layer which falls within that extent. %End ~QgsPointLocator(); diff --git a/src/core/layertree/qgslayertreemodel.h b/src/core/layertree/qgslayertreemodel.h index 814e240bf2a5..2a3ccfcaeee9 100644 --- a/src/core/layertree/qgslayertreemodel.h +++ b/src/core/layertree/qgslayertreemodel.h @@ -127,9 +127,9 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel QModelIndex node2index( QgsLayerTreeNode *node ) const; /** - * Convert a list of indexes to a list of layer tree nodes. + * Convert a \a list of indexes to a list of layer tree nodes. * Indices that do not represent layer tree nodes are skipped. - * \param skipInternal If true, a node is included in the output list only if no parent node is in the list + * If \a skipInternal is true, a node is included in the output list only if no parent node is in the list. */ QList indexes2nodes( const QModelIndexList &list, bool skipInternal = false ) const; diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h index a92184f45a26..909489890576 100644 --- a/src/core/qgspointlocator.h +++ b/src/core/qgspointlocator.h @@ -51,10 +51,12 @@ class CORE_EXPORT QgsPointLocator : public QObject Q_OBJECT public: - /** Construct point locator for a layer. - * \param destinationCrs if a valid QgsCoordinateReferenceSystem is passed then the locator will - * do the searches on data reprojected to the given CRS - * \param extent if not null, will index only a subset of the layer + /** Construct point locator for a \a layer. + * + * If a valid QgsCoordinateReferenceSystem is passed for \a destinationCrs then the locator will + * do the searches on data reprojected to the given CRS. + * + * If \a extent is not null, the locator will index only a subset of the layer which falls within that extent. */ explicit QgsPointLocator( QgsVectorLayer *layer, const QgsCoordinateReferenceSystem &destinationCrs = QgsCoordinateReferenceSystem(), const QgsRectangle *extent = nullptr ); diff --git a/src/gui/qgsprojectionselectiontreewidget.cpp b/src/gui/qgsprojectionselectiontreewidget.cpp index d11662989e56..7574be330e28 100644 --- a/src/gui/qgsprojectionselectiontreewidget.cpp +++ b/src/gui/qgsprojectionselectiontreewidget.cpp @@ -985,7 +985,7 @@ QStringList QgsProjectionSelectionTreeWidget::authorities() return authorities; } -const QString QgsProjectionSelectionTreeWidget::sqlSafeString( const QString &theSQL ) +QString QgsProjectionSelectionTreeWidget::sqlSafeString( const QString &theSQL ) const { QString retval = theSQL; retval.replace( '\\', QLatin1String( "\\\\" ) ); diff --git a/src/gui/qgsprojectionselectiontreewidget.h b/src/gui/qgsprojectionselectiontreewidget.h index 7d65d7c2fda9..9f6e0528fb8a 100644 --- a/src/gui/qgsprojectionselectiontreewidget.h +++ b/src/gui/qgsprojectionselectiontreewidget.h @@ -155,15 +155,14 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui:: void loadCrsList( QSet *crsFilter = nullptr ); /** - * \brief Make the string safe for use in SQL statements. + * \brief Makes a \a string safe for use in SQL statements. * This involves escaping single quotes, double quotes, backslashes, * and optionally, percentage symbols. Percentage symbols are used * as wildcards sometimes and so when using the string as part of the * LIKE phrase of a select statement, should be escaped. - * \param const QString in The input string to make safe. * \returns The string made safe for SQL statements. */ - const QString sqlSafeString( const QString &theSQL ); + QString sqlSafeString( const QString &string ) const; /** * \brief converts the CRS group to a SQL expression fragment From 04a9cd921192865cb2b2359ebeaf532cef521eaa Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Fri, 6 Oct 2017 08:19:00 +1000 Subject: [PATCH 4/4] Add more consistency to doxygen formatting --- scripts/doxygen_space.pl | 19 +- src/3d/chunks/qgschunkboundsentity_p.h | 3 +- src/3d/chunks/qgschunkedentity_p.h | 3 +- src/3d/chunks/qgschunklist_p.h | 6 +- src/3d/chunks/qgschunkloader_p.h | 6 +- src/3d/chunks/qgschunknode_p.h | 3 +- src/3d/chunks/qgschunkqueuejob_p.h | 6 +- src/3d/qgs3dmapscene.h | 3 +- src/3d/qgs3dmapsettings.h | 3 +- src/3d/qgs3dutils.h | 3 +- src/3d/qgsaabb.h | 3 +- src/3d/qgscameracontroller.h | 3 +- src/3d/qgsphongmaterialsettings.h | 3 +- src/3d/qgstessellatedpolygongeometry.h | 3 +- src/3d/qgstessellator.h | 3 +- src/3d/qgstilingscheme.h | 3 +- src/3d/qgsvectorlayer3drenderer.h | 6 +- src/3d/symbols/qgsline3dsymbol.h | 3 +- src/3d/symbols/qgspoint3dsymbol.h | 3 +- src/3d/symbols/qgspolygon3dsymbol.h | 3 +- src/3d/terrain/qgsdemterraingenerator.h | 3 +- src/3d/terrain/qgsdemterraintilegeometry_p.h | 3 +- src/3d/terrain/qgsdemterraintileloader_p.h | 6 +- src/3d/terrain/qgsflatterraingenerator.h | 3 +- src/3d/terrain/qgsterrainentity_p.h | 3 +- src/3d/terrain/qgsterraingenerator.h | 3 +- src/3d/terrain/qgsterraintexturegenerator_p.h | 3 +- src/3d/terrain/qgsterraintextureimage_p.h | 3 +- src/3d/terrain/qgsterraintileentity_p.h | 3 +- src/3d/terrain/qgsterraintileloader_p.h | 3 +- src/3d/terrain/quantizedmeshgeometry.h | 3 +- .../terrain/quantizedmeshterraingenerator.h | 3 +- src/analysis/interpolation/Bezier3D.h | 3 +- .../interpolation/CloughTocherInterpolator.h | 3 +- .../interpolation/DualEdgeTriangulation.h | 3 +- src/analysis/interpolation/HalfEdge.h | 3 +- .../interpolation/LinTriangleInterpolator.h | 3 +- src/analysis/interpolation/Line3D.h | 3 +- src/analysis/interpolation/Node.h | 3 +- src/analysis/interpolation/NormVecDecorator.h | 3 +- src/analysis/interpolation/ParametricLine.h | 6 +- src/analysis/interpolation/TriDecorator.h | 3 +- .../interpolation/TriangleInterpolator.h | 3 +- src/analysis/interpolation/Triangulation.h | 9 +- src/analysis/interpolation/Vector3D.h | 3 +- .../interpolation/qgsgridfilewriter.h | 6 +- .../interpolation/qgsidwinterpolator.h | 9 +- src/analysis/interpolation/qgsinterpolator.h | 12 +- .../interpolation/qgstininterpolator.h | 9 +- src/analysis/network/qgsgraphanalyzer.h | 3 +- .../network/qgsnetworkdistancestrategy.h | 3 +- .../network/qgsnetworkspeedstrategy.h | 3 +- .../network/qgsvectorlayerdirector.cpp | 3 +- src/analysis/network/qgsvectorlayerdirector.h | 3 +- src/analysis/openstreetmap/qgsosmbase.h | 15 +- src/analysis/openstreetmap/qgsosmdatabase.h | 15 +- src/analysis/openstreetmap/qgsosmdownload.h | 6 +- src/analysis/openstreetmap/qgsosmimport.h | 3 +- src/analysis/raster/qgsalignraster.h | 3 +- src/analysis/raster/qgsaspectfilter.h | 6 +- src/analysis/raster/qgsderivativefilter.h | 3 +- src/analysis/raster/qgshillshadefilter.h | 6 +- src/analysis/raster/qgsninecellfilter.h | 15 +- src/analysis/raster/qgsrastercalcnode.h | 6 +- src/analysis/raster/qgsrastercalculator.h | 21 +- src/analysis/raster/qgsrastermatrix.h | 3 +- src/analysis/raster/qgsrelief.h | 21 +- src/analysis/raster/qgsruggednessfilter.h | 6 +- src/analysis/raster/qgsslopefilter.h | 6 +- src/analysis/raster/qgstotalcurvaturefilter.h | 6 +- src/analysis/vector/qgszonalstatistics.h | 9 +- src/app/composer/qgsatlascompositionwidget.h | 3 +- src/app/composer/qgscomposer.h | 9 +- .../qgscomposerimageexportoptionsdialog.h | 33 +- src/app/composer/qgscomposeritemwidget.h | 18 +- src/app/composer/qgscomposerlabelwidget.h | 3 +- .../composer/qgscomposerlegendlayersdialog.h | 3 +- src/app/composer/qgscomposerlegendwidget.h | 3 +- src/app/composer/qgscomposermanager.h | 9 +- src/app/composer/qgscomposermapgridwidget.h | 3 +- src/app/composer/qgscomposermapwidget.h | 3 +- src/app/composer/qgscomposerpicturewidget.h | 6 +- src/app/composer/qgscomposerscalebarwidget.h | 3 +- .../qgscomposertablebackgroundcolorsdialog.h | 6 +- src/app/composer/qgscompositionwidget.h | 6 +- src/app/gps/qgsgpsinformationwidget.h | 3 +- src/app/gps/qgsgpsmarker.h | 3 +- src/app/main.cpp | 3 +- src/app/nodetool/qgsnodetool.h | 3 +- .../qgsapppluginmanagerinterface.h | 3 +- src/app/qgisapp.cpp | 6 +- src/app/qgisapp.h | 171 ++++--- src/app/qgisappinterface.h | 39 +- src/app/qgisappstylesheet.h | 9 +- src/app/qgsannotationwidget.h | 3 +- src/app/qgsclipboard.h | 12 +- src/app/qgsdecorationgrid.h | 15 +- src/app/qgsdecorationitem.h | 6 +- src/app/qgsdisplayangle.h | 3 +- src/app/qgsfieldsproperties.h | 6 +- src/app/qgslabelpropertydialog.h | 3 +- src/app/qgslayerstylingwidget.h | 9 +- src/app/qgsmapsavedialog.h | 6 +- src/app/qgsmapthemes.h | 3 +- src/app/qgsmaptooladdcircularstring.h | 3 +- src/app/qgsmaptooladdfeature.h | 3 +- src/app/qgsmaptoolchangelabelproperties.h | 3 +- src/app/qgsmaptooldeletering.h | 3 +- src/app/qgsmaptoolfillring.h | 6 +- src/app/qgsmaptoollabel.h | 45 +- src/app/qgsmaptooloffsetpointsymbol.h | 9 +- src/app/qgsmaptoolpointsymbol.h | 3 +- src/app/qgsmaptoolrotatepointsymbols.h | 6 +- src/app/qgsmaptoolselectutils.h | 3 +- src/app/qgsmeasuredialog.h | 3 +- src/app/qgsmergeattributesdialog.h | 12 +- src/app/qgsoptions.h | 15 +- src/app/qgspointmarkeritem.h | 27 +- src/app/qgspointrotationitem.h | 3 +- src/app/qgsprojectproperties.h | 9 +- src/app/qgsrasterlayerproperties.h | 15 +- src/app/qgsselectbyformdialog.h | 9 +- src/app/qgsstatisticalsummarydockwidget.h | 9 +- src/app/qgsstatusbarmagnifierwidget.h | 6 +- src/app/qgsstatusbarscalewidget.h | 3 +- src/app/qgsvectorlayerproperties.h | 6 +- src/auth/basic/qgsauthbasicmethod.cpp | 3 +- src/auth/identcert/qgsauthidentcertmethod.cpp | 3 +- src/auth/pkipaths/qgsauthpkipathsmethod.cpp | 3 +- src/auth/pkipkcs12/qgsauthpkcs12method.cpp | 3 +- src/core/3d/qgsabstract3drenderer.h | 3 +- src/core/annotations/qgsannotation.h | 3 +- src/core/annotations/qgsannotationmanager.h | 3 +- src/core/auth/qgsauthcertutils.h | 57 ++- src/core/auth/qgsauthconfig.h | 18 +- src/core/auth/qgsauthcrypto.h | 3 +- src/core/auth/qgsauthmanager.h | 51 +- src/core/auth/qgsauthmethod.h | 30 +- src/core/auth/qgsauthmethodmetadata.h | 12 +- src/core/auth/qgsauthmethodregistry.cpp | 3 +- src/core/auth/qgsauthmethodregistry.h | 15 +- src/core/composer/qgsaddremoveitemcommand.h | 3 +- .../composer/qgsaddremovemultiframecommand.h | 3 +- src/core/composer/qgsatlascomposition.h | 96 ++-- src/core/composer/qgscomposerarrow.h | 81 ++- .../qgscomposerattributetablemodelv2.h | 54 +- .../composer/qgscomposerattributetablev2.h | 111 ++-- src/core/composer/qgscomposereffect.h | 3 +- src/core/composer/qgscomposerframe.h | 27 +- src/core/composer/qgscomposerhtml.h | 57 ++- src/core/composer/qgscomposeritem.h | 201 +++++--- src/core/composer/qgscomposeritemcommand.h | 9 +- src/core/composer/qgscomposeritemgroup.h | 15 +- src/core/composer/qgscomposerlabel.h | 45 +- src/core/composer/qgscomposerlegend.h | 48 +- src/core/composer/qgscomposermap.h | 114 +++-- src/core/composer/qgscomposermapgrid.h | 312 ++++++++---- src/core/composer/qgscomposermapitem.h | 90 ++-- src/core/composer/qgscomposermapoverview.h | 90 ++-- src/core/composer/qgscomposermodel.h | 93 ++-- src/core/composer/qgscomposermousehandles.h | 6 +- src/core/composer/qgscomposermultiframe.h | 93 ++-- .../composer/qgscomposermultiframecommand.h | 6 +- src/core/composer/qgscomposernodesitem.h | 48 +- src/core/composer/qgscomposerobject.h | 51 +- src/core/composer/qgscomposerpicture.h | 81 ++- src/core/composer/qgscomposerpolygon.h | 12 +- src/core/composer/qgscomposerpolyline.h | 12 +- src/core/composer/qgscomposerscalebar.h | 81 ++- src/core/composer/qgscomposershape.h | 30 +- src/core/composer/qgscomposertablecolumn.h | 57 ++- src/core/composer/qgscomposertablev2.h | 198 +++++--- src/core/composer/qgscomposertexttable.h | 9 +- src/core/composer/qgscomposerutils.h | 72 ++- src/core/composer/qgscomposition.h | 234 ++++++--- .../composer/qgsgroupungroupitemscommand.h | 6 +- src/core/composer/qgslayoutmanager.h | 3 +- src/core/composer/qgspaperitem.h | 12 +- src/core/diagram/qgsdiagram.h | 27 +- src/core/diagram/qgshistogramdiagram.h | 3 +- src/core/diagram/qgspiediagram.h | 3 +- src/core/diagram/qgstextdiagram.h | 6 +- src/core/dxf/qgsdxfexport.h | 9 +- src/core/dxf/qgsdxfpaintdevice.h | 3 +- src/core/dxf/qgsdxfpaintengine.h | 3 +- src/core/dxf/qgsdxfpallabeling.h | 21 +- src/core/effects/qgsblureffect.h | 30 +- src/core/effects/qgscoloreffect.h | 60 ++- src/core/effects/qgseffectstack.h | 36 +- src/core/effects/qgsgloweffect.h | 72 ++- src/core/effects/qgsimageoperation.h | 54 +- src/core/effects/qgspainteffect.h | 87 ++-- src/core/effects/qgspainteffectregistry.h | 63 ++- src/core/effects/qgsshadoweffect.h | 66 ++- src/core/effects/qgstransformeffect.h | 66 ++- src/core/expression/qgsexpression.h | 81 ++- src/core/expression/qgsexpressionfunction.h | 54 +- src/core/expression/qgsexpressionnode.h | 12 +- src/core/expression/qgsexpressionnodeimpl.h | 24 +- src/core/geometry/qgsabstractgeometry.h | 147 ++++-- src/core/geometry/qgsbox3d.h | 3 +- src/core/geometry/qgscircle.h | 18 +- src/core/geometry/qgscircularstring.h | 15 +- src/core/geometry/qgscompoundcurve.h | 27 +- src/core/geometry/qgscurve.h | 51 +- src/core/geometry/qgscurvepolygon.h | 15 +- src/core/geometry/qgsellipse.h | 60 ++- src/core/geometry/qgsgeometry.h | 66 ++- src/core/geometry/qgsgeometrycollection.h | 30 +- src/core/geometry/qgsgeometryeditutils.h | 9 +- src/core/geometry/qgsgeometryengine.h | 12 +- src/core/geometry/qgsgeometryfactory.h | 9 +- src/core/geometry/qgsgeometryutils.h | 66 ++- src/core/geometry/qgsgeos.cpp | 3 +- src/core/geometry/qgsgeos.h | 27 +- src/core/geometry/qgslinestring.h | 42 +- src/core/geometry/qgsmulticurve.h | 6 +- src/core/geometry/qgsmultilinestring.h | 6 +- src/core/geometry/qgsmultipoint.h | 3 +- src/core/geometry/qgsmultipolygon.h | 6 +- src/core/geometry/qgsmultisurface.h | 3 +- src/core/geometry/qgspoint.h | 54 +- src/core/geometry/qgspolygon.h | 6 +- src/core/geometry/qgsrectangle.h | 3 +- src/core/geometry/qgsregularpolygon.h | 84 ++-- src/core/geometry/qgssurface.h | 6 +- src/core/geometry/qgstriangle.h | 15 +- src/core/geometry/qgswkbptr.h | 9 +- src/core/geometry/qgswkbtypes.h | 54 +- src/core/gps/qgsgpsconnection.h | 6 +- src/core/gps/qgsgpsconnectionregistry.h | 3 +- src/core/gps/qgsgpsdconnection.h | 3 +- src/core/gps/qgsgpsdetector.h | 3 +- src/core/gps/qgsnmeaconnection.h | 3 +- src/core/gps/qgsqtlocationconnection.h | 9 +- src/core/layertree/qgslayertree.h | 3 +- src/core/layertree/qgslayertreegroup.h | 3 +- src/core/layertree/qgslayertreelayer.h | 3 +- src/core/layertree/qgslayertreemodel.h | 12 +- .../layertree/qgslayertreemodellegendnode.h | 39 +- src/core/layertree/qgslayertreenode.h | 3 +- .../layertree/qgslayertreeregistrybridge.h | 3 +- src/core/layertree/qgslayertreeutils.h | 3 +- src/core/layout/qgslayoutitem.h | 3 +- src/core/layout/qgslayoutobject.h | 3 +- src/core/pal/costcalculator.h | 9 +- src/core/pal/feature.h | 57 ++- src/core/pal/geomfunction.h | 3 +- src/core/pal/internalexception.h | 18 +- src/core/pal/labelposition.h | 33 +- src/core/pal/layer.h | 72 ++- src/core/pal/pal.h | 3 +- src/core/pal/palexception.h | 21 +- src/core/pal/palstat.h | 3 +- src/core/pal/pointset.h | 21 +- src/core/pal/priorityqueue.h | 3 +- src/core/pal/problem.h | 3 +- src/core/pal/rtree.hpp | 9 +- src/core/qgis.h | 57 ++- src/core/qgsaction.h | 3 +- src/core/qgsactionmanager.h | 15 +- src/core/qgsactionscope.h | 3 +- src/core/qgsactionscoperegistry.h | 3 +- src/core/qgsaggregatecalculator.h | 36 +- src/core/qgsanimatedicon.h | 3 +- src/core/qgsapplication.h | 69 ++- src/core/qgsattributeeditorelement.h | 12 +- src/core/qgsattributes.h | 3 +- src/core/qgsattributetableconfig.h | 21 +- src/core/qgsbrowsermodel.h | 24 +- src/core/qgscachedfeatureiterator.h | 6 +- src/core/qgscacheindex.h | 3 +- src/core/qgscacheindexfeatureid.h | 3 +- src/core/qgsclipper.h | 9 +- src/core/qgscolorramp.h | 186 ++++--- src/core/qgscolorscheme.h | 63 ++- src/core/qgscolorschemeregistry.h | 30 +- src/core/qgsconditionalstyle.h | 18 +- src/core/qgsconnectionpool.h | 6 +- src/core/qgscoordinatereferencesystem.h | 153 ++++-- src/core/qgscoordinatetransform.h | 60 ++- src/core/qgscoordinateutils.h | 6 +- src/core/qgscredentials.h | 9 +- src/core/qgscrscache.h | 6 +- src/core/qgsdartmeasurement.h | 3 +- src/core/qgsdatadefinedsizelegend.h | 3 +- src/core/qgsdataitem.h | 90 ++-- src/core/qgsdataitemprovider.h | 3 +- src/core/qgsdataitemproviderregistry.h | 3 +- src/core/qgsdataprovider.h | 36 +- src/core/qgsdatasourceuri.h | 6 +- src/core/qgsdatetimestatisticalsummary.h | 51 +- src/core/qgsdatumtransformstore.h | 3 +- src/core/qgsdiagramrenderer.h | 120 +++-- src/core/qgsdistancearea.h | 3 +- src/core/qgseditformconfig.h | 6 +- src/core/qgseditorwidgetsetup.h | 3 +- src/core/qgserror.h | 27 +- src/core/qgsexception.h | 6 +- src/core/qgsexpressioncontext.h | 228 ++++++--- src/core/qgsexpressionfieldbuffer.h | 3 +- src/core/qgsfeature.h | 75 ++- src/core/qgsfeaturefilterprovider.h | 9 +- src/core/qgsfeatureiterator.h | 21 +- src/core/qgsfeaturerequest.h | 33 +- src/core/qgsfeaturesource.h | 6 +- src/core/qgsfeaturestore.h | 3 +- src/core/qgsfeedback.h | 3 +- src/core/qgsfield.h | 30 +- src/core/qgsfieldproxymodel.h | 6 +- src/core/qgsfields.h | 15 +- src/core/qgsfontutils.h | 45 +- src/core/qgsgeometrysimplifier.h | 6 +- src/core/qgsgeometryvalidator.h | 3 +- src/core/qgsgml.h | 48 +- src/core/qgsgmlschema.h | 15 +- src/core/qgshistogram.h | 21 +- src/core/qgsindexedfeature.h | 3 +- src/core/qgsinterval.h | 72 ++- src/core/qgsjsonutils.h | 78 ++- src/core/qgslabelfeature.h | 75 ++- src/core/qgslabelingengine.cpp | 3 +- src/core/qgslabelingengine.h | 15 +- src/core/qgslabelingenginesettings.h | 3 +- src/core/qgslabelsearchtree.h | 12 +- src/core/qgslayerdefinition.h | 12 +- src/core/qgslegendrenderer.h | 21 +- src/core/qgslegendsettings.h | 36 +- src/core/qgslegendstyle.h | 3 +- src/core/qgslocalec.h | 3 +- src/core/qgslogger.h | 15 +- src/core/qgsmaphittest.h | 12 +- src/core/qgsmaplayer.h | 219 +++++--- src/core/qgsmaplayerdependency.h | 3 +- src/core/qgsmaplayerlegend.h | 12 +- src/core/qgsmaplayermodel.h | 3 +- src/core/qgsmaplayerproxymodel.h | 3 +- src/core/qgsmaplayerref.h | 3 +- src/core/qgsmaplayerrenderer.h | 3 +- src/core/qgsmaplayerstylemanager.h | 9 +- src/core/qgsmaprenderercache.h | 3 +- src/core/qgsmaprenderercustompainterjob.h | 3 +- src/core/qgsmaprendererjob.h | 15 +- src/core/qgsmaprendererparalleljob.h | 3 +- src/core/qgsmaprenderersequentialjob.h | 3 +- src/core/qgsmapsettings.h | 27 +- src/core/qgsmapsettingsutils.h | 9 +- src/core/qgsmapthemecollection.h | 3 +- src/core/qgsmaptopixel.h | 12 +- src/core/qgsmaptopixelgeometrysimplifier.h | 3 +- src/core/qgsmapunitscale.h | 6 +- src/core/qgsmessagelog.h | 6 +- src/core/qgsmessageoutput.h | 9 +- src/core/qgsmimedatautils.h | 9 +- src/core/qgsmultirenderchecker.h | 9 +- src/core/qgsnetworkcontentfetcher.h | 18 +- src/core/qgsnetworkdiskcache.h | 3 +- src/core/qgsnetworkreplyparser.h | 21 +- src/core/qgsobjectcustomproperties.h | 6 +- src/core/qgsofflineediting.h | 9 +- src/core/qgsogcutils.h | 69 ++- src/core/qgsogrutils.h | 27 +- src/core/qgsowsconnection.h | 3 +- src/core/qgspaintenginehack.h | 3 +- src/core/qgspainting.h | 3 +- src/core/qgspalgeometry.h | 3 +- src/core/qgspallabeling.h | 75 ++- src/core/qgspathresolver.h | 3 +- src/core/qgspluginlayer.h | 9 +- src/core/qgspluginlayerregistry.h | 15 +- src/core/qgspointlocator.cpp | 18 +- src/core/qgspointlocator.h | 9 +- src/core/qgspointxy.h | 54 +- src/core/qgsproject.cpp | 3 +- src/core/qgsproject.h | 105 ++-- src/core/qgsprojectbadlayerhandler.h | 3 +- src/core/qgsprojectfiletransform.h | 12 +- src/core/qgsprojectproperty.h | 3 +- src/core/qgsprojectversion.h | 15 +- src/core/qgsprovidermetadata.h | 12 +- src/core/qgsproviderregistry.cpp | 3 +- src/core/qgsproviderregistry.h | 30 +- src/core/qgspythonrunner.h | 9 +- src/core/qgsrelation.h | 9 +- src/core/qgsrelationmanager.h | 9 +- src/core/qgsrenderchecker.h | 24 +- src/core/qgsrendercontext.h | 57 ++- src/core/qgsrulebasedlabeling.h | 6 +- src/core/qgsrunprocess.h | 3 +- src/core/qgsruntimeprofiler.h | 3 +- src/core/qgsscalecalculator.h | 3 +- src/core/qgsscaleutils.h | 9 +- src/core/qgssettings.h | 39 +- src/core/qgssimplifymethod.h | 3 +- src/core/qgsslconnect.h | 3 +- src/core/qgssnappingconfig.h | 6 +- src/core/qgssnappingutils.h | 6 +- src/core/qgsspatialindex.cpp | 12 +- src/core/qgsspatialindex.h | 12 +- src/core/qgssqlexpressioncompiler.h | 30 +- src/core/qgssqliteexpressioncompiler.h | 6 +- src/core/qgssqlstatement.cpp | 3 +- src/core/qgssqlstatement.h | 72 ++- src/core/qgsstatisticalsummary.h | 81 ++- src/core/qgsstringstatisticalsummary.h | 60 ++- src/core/qgsstringutils.h | 57 ++- src/core/qgstaskmanager.h | 27 +- src/core/qgstextlabelfeature.h | 6 +- src/core/qgstextrenderer.h | 474 ++++++++++++------ src/core/qgstolerance.h | 6 +- src/core/qgstracer.h | 3 +- src/core/qgstrackedvectorlayertools.h | 3 +- src/core/qgstransaction.h | 3 +- src/core/qgstransactiongroup.h | 3 +- src/core/qgsunittypes.h | 81 ++- src/core/qgsuserprofile.h | 3 +- src/core/qgsuserprofilemanager.h | 3 +- src/core/qgsvector.h | 42 +- src/core/qgsvectordataprovider.h | 12 +- src/core/qgsvectorfilewriter.h | 72 ++- src/core/qgsvectorlayer.cpp | 3 +- src/core/qgsvectorlayer.h | 159 ++++-- src/core/qgsvectorlayercache.h | 12 +- src/core/qgsvectorlayerdiagramprovider.h | 6 +- src/core/qgsvectorlayereditbuffer.h | 57 ++- src/core/qgsvectorlayereditpassthrough.h | 3 +- src/core/qgsvectorlayereditutils.h | 3 +- src/core/qgsvectorlayerfeaturecounter.h | 3 +- src/core/qgsvectorlayerfeatureiterator.h | 24 +- src/core/qgsvectorlayerjoinbuffer.h | 24 +- src/core/qgsvectorlayerjoininfo.h | 39 +- src/core/qgsvectorlayerlabeling.h | 6 +- src/core/qgsvectorlayerlabelprovider.h | 6 +- src/core/qgsvectorlayerrenderer.h | 15 +- src/core/qgsvectorlayertools.h | 3 +- src/core/qgsvectorlayerundocommand.h | 48 +- .../qgsvectorlayerundopassthroughcommand.h | 63 ++- src/core/qgsvectorlayerutils.h | 3 +- src/core/qgsvectorsimplifymethod.h | 3 +- src/core/qgsvirtuallayerdefinition.h | 6 +- src/core/qgsvirtuallayerdefinitionutils.h | 3 +- src/core/qgswebframe.h | 3 +- src/core/qgswebpage.h | 15 +- src/core/qgswebview.h | 6 +- src/core/qgsxmlutils.h | 9 +- src/core/qgsziputils.h | 9 +- src/core/raster/qgsbilinearrasterresampler.h | 3 +- src/core/raster/qgsbrightnesscontrastfilter.h | 3 +- src/core/raster/qgscliptominmaxenhancement.h | 3 +- src/core/raster/qgscolorrampshader.h | 36 +- src/core/raster/qgscontrastenhancement.h | 3 +- .../raster/qgscontrastenhancementfunction.h | 3 +- src/core/raster/qgscubicrasterresampler.h | 3 +- src/core/raster/qgshillshaderenderer.h | 18 +- src/core/raster/qgshuesaturationfilter.h | 3 +- src/core/raster/qgslinearminmaxenhancement.h | 3 +- .../qgslinearminmaxenhancementwithclip.h | 3 +- src/core/raster/qgsmultibandcolorrenderer.h | 3 +- src/core/raster/qgspalettedrasterrenderer.h | 12 +- src/core/raster/qgsraster.h | 9 +- src/core/raster/qgsrasterbandstats.h | 9 +- src/core/raster/qgsrasterblock.h | 132 +++-- src/core/raster/qgsrasterchecker.h | 3 +- src/core/raster/qgsrasterdataprovider.h | 72 ++- src/core/raster/qgsrasterdrawer.h | 9 +- src/core/raster/qgsrasterfilewriter.h | 18 +- src/core/raster/qgsrasterhistogram.h | 6 +- src/core/raster/qgsrasteridentifyresult.h | 12 +- src/core/raster/qgsrasterinterface.h | 39 +- src/core/raster/qgsrasteriterator.h | 9 +- src/core/raster/qgsrasterlayer.h | 33 +- src/core/raster/qgsrasterlayerrenderer.h | 6 +- src/core/raster/qgsrasterminmaxorigin.h | 3 +- src/core/raster/qgsrasternuller.h | 3 +- src/core/raster/qgsrasterpipe.h | 18 +- src/core/raster/qgsrasterprojector.h | 18 +- src/core/raster/qgsrasterpyramid.h | 3 +- src/core/raster/qgsrasterrange.h | 12 +- src/core/raster/qgsrasterrenderer.h | 9 +- src/core/raster/qgsrasterrendererregistry.h | 9 +- src/core/raster/qgsrasterresamplefilter.h | 3 +- src/core/raster/qgsrasterresampler.h | 3 +- src/core/raster/qgsrastershader.h | 6 +- src/core/raster/qgsrastershaderfunction.h | 3 +- src/core/raster/qgsrastertransparency.h | 3 +- src/core/raster/qgsrasterviewport.h | 12 +- .../raster/qgssinglebandcolordatarenderer.h | 3 +- src/core/raster/qgssinglebandgrayrenderer.h | 3 +- .../raster/qgssinglebandpseudocolorrenderer.h | 12 +- src/core/symbology/qgs25drenderer.h | 3 +- src/core/symbology/qgsarrowsymbollayer.h | 3 +- .../symbology/qgscategorizedsymbolrenderer.h | 24 +- src/core/symbology/qgscolorbrewerpalette.h | 3 +- src/core/symbology/qgscptcityarchive.h | 21 +- src/core/symbology/qgsellipsesymbollayer.h | 30 +- src/core/symbology/qgsfillsymbollayer.h | 225 ++++++--- .../qgsgeometrygeneratorsymbollayer.h | 3 +- .../symbology/qgsgraduatedsymbolrenderer.h | 48 +- src/core/symbology/qgsheatmaprenderer.h | 45 +- .../symbology/qgsinvertedpolygonrenderer.h | 36 +- src/core/symbology/qgslegendsymbolitem.h | 3 +- src/core/symbology/qgslinesymbollayer.h | 39 +- src/core/symbology/qgsmarkersymbollayer.h | 159 ++++-- src/core/symbology/qgsnullsymbolrenderer.h | 9 +- src/core/symbology/qgspointclusterrenderer.h | 12 +- .../symbology/qgspointdisplacementrenderer.h | 42 +- src/core/symbology/qgspointdistancerenderer.h | 57 ++- src/core/symbology/qgsrenderer.h | 54 +- src/core/symbology/qgsrendererregistry.h | 18 +- src/core/symbology/qgsrulebasedrenderer.h | 9 +- src/core/symbology/qgssinglesymbolrenderer.h | 3 +- src/core/symbology/qgsstyle.h | 96 ++-- src/core/symbology/qgssvgcache.h | 30 +- src/core/symbology/qgssymbol.h | 135 +++-- src/core/symbology/qgssymbollayer.h | 162 ++++-- src/core/symbology/qgssymbollayerregistry.h | 15 +- src/core/symbology/qgssymbollayerutils.h | 84 ++-- .../symbology/qgsvectorfieldsymbollayer.h | 9 +- .../qgsattributetabledelegate.h | 3 +- .../qgsattributetablefiltermodel.h | 3 +- .../attributetable/qgsattributetablemodel.h | 6 +- .../attributetable/qgsattributetableview.h | 6 +- src/gui/attributetable/qgsdualview.h | 21 +- src/gui/attributetable/qgsfeaturelistmodel.h | 3 +- src/gui/attributetable/qgsfeaturelistview.h | 3 +- .../qgsfeaturelistviewdelegate.h | 3 +- src/gui/attributetable/qgsfeaturemodel.h | 3 +- .../attributetable/qgsfeatureselectionmodel.h | 3 +- .../qgsfieldconditionalformatwidget.h | 21 +- .../qgsgenericfeatureselectionmanager.h | 3 +- .../qgsifeatureselectionmanager.h | 3 +- .../qgsorganizetablecolumnsdialog.h | 3 +- .../qgsvectorlayerselectionmanager.h | 3 +- src/gui/auth/qgsauthauthoritieseditor.h | 3 +- src/gui/auth/qgsauthcertificateinfo.h | 9 +- src/gui/auth/qgsauthcertificatemanager.h | 6 +- src/gui/auth/qgsauthcerttrustpolicycombobox.h | 3 +- src/gui/auth/qgsauthconfigedit.h | 3 +- src/gui/auth/qgsauthconfigeditor.h | 3 +- src/gui/auth/qgsauthconfigidedit.h | 3 +- src/gui/auth/qgsauthconfigselect.h | 6 +- src/gui/auth/qgsautheditorwidgets.h | 6 +- src/gui/auth/qgsauthguiutils.h | 3 +- src/gui/auth/qgsauthidentitieseditor.h | 3 +- src/gui/auth/qgsauthimportcertdialog.h | 3 +- src/gui/auth/qgsauthimportidentitydialog.h | 6 +- src/gui/auth/qgsauthmasterpassresetdialog.h | 3 +- src/gui/auth/qgsauthmethodedit.h | 3 +- src/gui/auth/qgsauthserverseditor.h | 3 +- src/gui/auth/qgsauthsettingswidget.h | 3 +- src/gui/auth/qgsauthsslconfigwidget.h | 9 +- src/gui/auth/qgsauthsslerrorsdialog.h | 3 +- src/gui/auth/qgsauthsslimportdialog.h | 3 +- src/gui/auth/qgsauthtrustedcasdialog.h | 3 +- .../core/qgseditorconfigwidget.h | 6 +- .../core/qgseditorwidgetautoconf.cpp | 6 +- .../core/qgseditorwidgetautoconf.h | 6 +- .../core/qgseditorwidgetfactory.h | 3 +- .../core/qgseditorwidgetregistry.h | 3 +- .../core/qgseditorwidgetwrapper.h | 6 +- .../core/qgssearchwidgetwrapper.h | 33 +- src/gui/editorwidgets/core/qgswidgetwrapper.h | 12 +- src/gui/editorwidgets/qgscheckboxconfigdlg.h | 3 +- .../qgscheckboxsearchwidgetwrapper.h | 9 +- .../editorwidgets/qgscheckboxwidgetfactory.h | 3 +- .../editorwidgets/qgscheckboxwidgetwrapper.h | 3 +- .../qgsclassificationwidgetwrapper.h | 3 +- .../qgsclassificationwidgetwrapperfactory.h | 3 +- src/gui/editorwidgets/qgscolorwidgetfactory.h | 3 +- src/gui/editorwidgets/qgscolorwidgetwrapper.h | 3 +- src/gui/editorwidgets/qgsdatetimeedit.h | 9 +- src/gui/editorwidgets/qgsdatetimeeditconfig.h | 3 +- .../editorwidgets/qgsdatetimeeditfactory.h | 3 +- .../editorwidgets/qgsdatetimeeditwrapper.h | 3 +- .../qgsdatetimesearchwidgetwrapper.h | 9 +- .../qgsdefaultsearchwidgetwrapper.h | 9 +- src/gui/editorwidgets/qgsdoublespinbox.h | 21 +- src/gui/editorwidgets/qgsdummyconfigdlg.h | 3 +- .../qgsenumerationwidgetfactory.h | 3 +- .../qgsenumerationwidgetwrapper.h | 3 +- .../qgsexternalresourceconfigdlg.h | 3 +- .../qgsexternalresourcewidgetfactory.h | 3 +- .../qgsexternalresourcewidgetwrapper.h | 3 +- .../editorwidgets/qgshiddenwidgetfactory.h | 3 +- .../editorwidgets/qgshiddenwidgetwrapper.h | 3 +- .../editorwidgets/qgskeyvaluewidgetfactory.h | 3 +- .../editorwidgets/qgskeyvaluewidgetwrapper.h | 3 +- src/gui/editorwidgets/qgslistwidgetfactory.h | 3 +- src/gui/editorwidgets/qgslistwidgetwrapper.h | 3 +- .../editorwidgets/qgsmultiedittoolbutton.h | 24 +- src/gui/editorwidgets/qgsrangeconfigdlg.h | 3 +- src/gui/editorwidgets/qgsrangewidgetfactory.h | 3 +- src/gui/editorwidgets/qgsrangewidgetwrapper.h | 3 +- .../qgsrelationreferenceconfigdlg.h | 3 +- .../qgsrelationreferencefactory.h | 3 +- .../qgsrelationreferencesearchwidgetwrapper.h | 9 +- .../qgsrelationreferencewidget.h | 6 +- .../qgsrelationreferencewidgetwrapper.h | 3 +- .../editorwidgets/qgsrelationwidgetwrapper.h | 6 +- .../editorwidgets/qgssearchwidgettoolbutton.h | 36 +- src/gui/editorwidgets/qgsspinbox.h | 21 +- src/gui/editorwidgets/qgstexteditconfigdlg.h | 3 +- .../qgstexteditsearchwidgetwrapper.h | 6 +- .../editorwidgets/qgstexteditwidgetfactory.h | 3 +- src/gui/editorwidgets/qgstexteditwrapper.h | 3 +- .../editorwidgets/qgsuniquevaluesconfigdlg.h | 3 +- .../qgsuniquevaluewidgetwrapper.h | 3 +- src/gui/editorwidgets/qgsuuidwidgetfactory.h | 3 +- src/gui/editorwidgets/qgsuuidwidgetwrapper.h | 3 +- src/gui/editorwidgets/qgsvaluemapconfigdlg.h | 3 +- .../qgsvaluemapsearchwidgetwrapper.h | 3 +- .../editorwidgets/qgsvaluemapwidgetfactory.h | 3 +- .../editorwidgets/qgsvaluemapwidgetwrapper.h | 3 +- .../editorwidgets/qgsvaluerelationconfigdlg.h | 3 +- .../qgsvaluerelationsearchwidgetwrapper.h | 3 +- .../qgsvaluerelationwidgetfactory.h | 3 +- .../qgsvaluerelationwidgetwrapper.h | 3 +- src/gui/effects/qgseffectdrawmodecombobox.h | 9 +- .../effects/qgseffectstackpropertieswidget.h | 81 ++- .../effects/qgspainteffectpropertieswidget.h | 18 +- src/gui/effects/qgspainteffectwidget.h | 21 +- .../qgslayertreeembeddedconfigwidget.h | 3 +- .../qgslayertreeembeddedwidgetregistry.h | 12 +- src/gui/layertree/qgslayertreeview.h | 6 +- src/gui/layout/qgslayoutdesignerinterface.h | 3 +- src/gui/ogr/qgsnewogrconnection.h | 3 +- src/gui/ogr/qgsogrhelperfunctions.h | 6 +- src/gui/ogr/qgsvectorlayersaveasdialog.h | 21 +- src/gui/qgisinterface.h | 69 ++- src/gui/qgsabstractdatasourcewidget.h | 24 +- src/gui/qgsactionmenu.h | 3 +- src/gui/qgsadvanceddigitizingcanvasitem.h | 3 +- src/gui/qgsadvanceddigitizingdockwidget.h | 24 +- src/gui/qgsattributedialog.h | 9 +- src/gui/qgsattributeeditorcontext.h | 15 +- src/gui/qgsattributeform.h | 27 +- src/gui/qgsattributeformeditorwidget.h | 48 +- src/gui/qgsattributeforminterface.h | 3 +- src/gui/qgsattributeformlegacyinterface.h | 3 +- src/gui/qgsattributetypeloaddialog.h | 3 +- src/gui/qgsblendmodecombobox.h | 9 +- src/gui/qgsbrowserdockwidget_p.h | 6 +- src/gui/qgsbrowsertreeview.h | 3 +- src/gui/qgsbusyindicatordialog.h | 6 +- src/gui/qgscharacterselectordialog.h | 3 +- src/gui/qgscheckablecombobox.h | 81 ++- src/gui/qgscodeeditor.h | 15 +- src/gui/qgscodeeditorcss.h | 3 +- src/gui/qgscodeeditorhtml.h | 3 +- src/gui/qgscodeeditorpython.h | 9 +- src/gui/qgscodeeditorsql.h | 6 +- src/gui/qgscollapsiblegroupbox.h | 12 +- src/gui/qgscolorbrewercolorrampdialog.h | 24 +- src/gui/qgscolorbutton.h | 129 +++-- src/gui/qgscolordialog.h | 30 +- src/gui/qgscolorrampbutton.h | 111 ++-- src/gui/qgscolorschemelist.h | 75 ++- src/gui/qgscolorswatchgrid.h | 81 ++- src/gui/qgscolorwidgets.h | 210 +++++--- src/gui/qgscomposerinterface.h | 3 +- src/gui/qgscomposeritemcombobox.h | 24 +- src/gui/qgscomposerruler.h | 3 +- src/gui/qgscomposerview.h | 21 +- src/gui/qgscompoundcolorwidget.h | 42 +- src/gui/qgsconfigureshortcutsdialog.h | 6 +- src/gui/qgscredentialdialog.h | 3 +- src/gui/qgscursors.h | 3 +- src/gui/qgscurveeditorwidget.h | 6 +- src/gui/qgscustomdrophandler.h | 3 +- src/gui/qgsdatasourcemanagerdialog.h | 6 +- src/gui/qgsdatumtransformdialog.h | 3 +- src/gui/qgsdetaileditemdata.h | 6 +- src/gui/qgsdetaileditemdelegate.h | 3 +- src/gui/qgsdetaileditemwidget.h | 3 +- src/gui/qgsdial.h | 3 +- src/gui/qgsdialog.h | 3 +- src/gui/qgsdockwidget.h | 27 +- src/gui/qgsencodingfiledialog.h | 3 +- src/gui/qgserrordialog.h | 6 +- src/gui/qgsexpressionbuilderdialog.h | 9 +- src/gui/qgsexpressionbuilderwidget.h | 60 ++- src/gui/qgsexpressionhighlighter.h | 3 +- src/gui/qgsexpressionlineedit.h | 6 +- src/gui/qgsexpressionselectiondialog.h | 6 +- src/gui/qgsextentgroupbox.h | 9 +- src/gui/qgsexternalresourcewidget.h | 3 +- src/gui/qgsfeatureselectiondlg.h | 3 +- src/gui/qgsfieldcombobox.h | 3 +- src/gui/qgsfieldexpressionwidget.h | 3 +- src/gui/qgsfieldvalidator.h | 3 +- src/gui/qgsfieldvalueslineedit.h | 45 +- src/gui/qgsfiledownloader.h | 3 +- src/gui/qgsfilewidget.h | 6 +- src/gui/qgsfilterlineedit.h | 45 +- src/gui/qgsfloatingwidget.h | 24 +- src/gui/qgsfocuswatcher.h | 9 +- src/gui/qgsfontbutton.h | 9 +- src/gui/qgsgeometryrubberband.h | 3 +- src/gui/qgsgradientcolorrampdialog.h | 18 +- src/gui/qgsgradientstopeditor.h | 45 +- src/gui/qgsgroupwmsdatadialog.h | 3 +- src/gui/qgsguiutils.h | 6 +- src/gui/qgshelp.h | 12 +- src/gui/qgshighlight.h | 24 +- src/gui/qgshistogramwidget.h | 57 ++- src/gui/qgsidentifymenu.h | 3 +- src/gui/qgskeyvaluewidget.h | 6 +- src/gui/qgslegendfilterbutton.h | 3 +- src/gui/qgslimitedrandomcolorrampdialog.h | 24 +- src/gui/qgslistwidget.h | 6 +- src/gui/qgslonglongvalidator.h | 3 +- src/gui/qgsludialog.h | 3 +- src/gui/qgsmanageconnectionsdialog.h | 3 +- src/gui/qgsmapcanvas.cpp | 3 +- src/gui/qgsmapcanvas.h | 69 ++- src/gui/qgsmapcanvasitem.h | 6 +- src/gui/qgsmapcanvasmap.h | 3 +- src/gui/qgsmapcanvassnappingutils.h | 3 +- src/gui/qgsmapcanvastracer.h | 3 +- src/gui/qgsmaplayeractionregistry.h | 6 +- src/gui/qgsmaplayercombobox.h | 9 +- src/gui/qgsmaplayerconfigwidget.h | 3 +- src/gui/qgsmaplayerconfigwidgetfactory.h | 3 +- src/gui/qgsmaplayerstylemanagerwidget.h | 3 +- src/gui/qgsmapmouseevent.h | 3 +- src/gui/qgsmapoverviewcanvas.h | 3 +- src/gui/qgsmaptip.h | 12 +- src/gui/qgsmaptool.h | 21 +- src/gui/qgsmaptooladvanceddigitizing.h | 3 +- src/gui/qgsmaptoolcapture.h | 18 +- src/gui/qgsmaptooledit.h | 9 +- src/gui/qgsmaptoolemitpoint.h | 3 +- src/gui/qgsmaptoolextent.h | 12 +- src/gui/qgsmaptoolidentify.h | 30 +- src/gui/qgsmaptoolidentifyfeature.h | 3 +- src/gui/qgsmaptoolpan.h | 3 +- src/gui/qgsmaptoolzoom.h | 3 +- src/gui/qgsmenuheader.h | 6 +- src/gui/qgsmessagebar.h | 15 +- src/gui/qgsmessagebaritem.h | 3 +- src/gui/qgsmessagelogviewer.h | 3 +- src/gui/qgsmessageviewer.h | 3 +- src/gui/qgsnewgeopackagelayerdialog.h | 3 +- src/gui/qgsnewhttpconnection.h | 3 +- src/gui/qgsnewmemorylayerdialog.h | 6 +- src/gui/qgsnewnamedialog.h | 30 +- src/gui/qgsnewvectorlayerdialog.h | 3 +- src/gui/qgsoptionsdialogbase.h | 21 +- src/gui/qgsoptionswidgetfactory.h | 6 +- src/gui/qgsorderbydialog.h | 3 +- src/gui/qgsowssourceselect.h | 6 +- src/gui/qgspanelwidget.h | 9 +- src/gui/qgspanelwidgetstack.h | 3 +- src/gui/qgspasswordlineedit.h | 15 +- src/gui/qgspixmaplabel.h | 3 +- src/gui/qgspluginmanagerinterface.h | 3 +- src/gui/qgspresetcolorrampdialog.h | 24 +- src/gui/qgsprevieweffect.h | 9 +- src/gui/qgsprojectionselectionwidget.h | 24 +- src/gui/qgspropertyoverridebutton.h | 3 +- src/gui/qgsquerybuilder.h | 9 +- src/gui/qgsrasterformatsaveoptionswidget.h | 3 +- src/gui/qgsrasterlayersaveasdialog.h | 3 +- src/gui/qgsrasterpyramidsoptionswidget.h | 3 +- src/gui/qgsratiolockbutton.h | 15 +- src/gui/qgsrelationeditorwidget.h | 3 +- src/gui/qgsrubberband.h | 6 +- src/gui/qgsscalecombobox.h | 3 +- src/gui/qgsscalevisibilitydialog.h | 3 +- src/gui/qgsscalewidget.h | 3 +- src/gui/qgssearchquerybuilder.h | 9 +- src/gui/qgsshortcutsmanager.h | 72 ++- src/gui/qgsslider.h | 3 +- src/gui/qgssourceselectprovider.h | 15 +- src/gui/qgssourceselectproviderregistry.h | 3 +- src/gui/qgssqlcomposerdialog.h | 15 +- src/gui/qgssublayersdialog.h | 3 +- src/gui/qgssubstitutionlistwidget.h | 24 +- src/gui/qgssymbolbutton.h | 9 +- src/gui/qgstablewidgetbase.h | 3 +- src/gui/qgstablewidgetitem.h | 3 +- src/gui/qgstabwidget.h | 3 +- src/gui/qgstaskmanagerwidget.h | 15 +- src/gui/qgstextformatwidget.h | 42 +- src/gui/qgstextpreview.h | 18 +- src/gui/qgstreewidgetitem.h | 45 +- src/gui/qgsunitselectionwidget.h | 57 ++- src/gui/qgsuserinputdockwidget.h | 6 +- src/gui/qgsvariableeditorwidget.h | 33 +- src/gui/qgsvertexmarker.h | 3 +- src/gui/raster/qgshillshaderendererwidget.h | 9 +- .../raster/qgsmultibandcolorrendererwidget.h | 3 +- src/gui/raster/qgspalettedrendererwidget.h | 9 +- src/gui/raster/qgsrasterhistogramwidget.h | 6 +- src/gui/raster/qgsrasterminmaxwidget.h | 15 +- src/gui/raster/qgsrasterrendererwidget.h | 9 +- src/gui/raster/qgsrastertransparencywidget.h | 3 +- .../qgsrendererrasterpropertieswidget.h | 6 +- .../raster/qgssinglebandgrayrendererwidget.h | 3 +- .../qgssinglebandpseudocolorrendererwidget.h | 9 +- src/gui/symbology/qgs25drendererwidget.h | 9 +- src/gui/symbology/qgsarrowsymbollayerwidget.h | 9 +- src/gui/symbology/qgsbrushstylecombobox.h | 3 +- .../qgscategorizedsymbolrendererwidget.h | 18 +- src/gui/symbology/qgscptcitycolorrampdialog.h | 21 +- src/gui/symbology/qgsdashspacedialog.h | 3 +- .../qgsdatadefinedsizelegendwidget.h | 3 +- .../symbology/qgsellipsesymbollayerwidget.h | 3 +- .../symbology/qgsgraduatedhistogramwidget.h | 12 +- .../qgsgraduatedsymbolrendererwidget.h | 3 +- src/gui/symbology/qgsheatmaprendererwidget.h | 9 +- .../qgsinvertedpolygonrendererwidget.h | 9 +- src/gui/symbology/qgslayerpropertieswidget.h | 9 +- .../symbology/qgsnullsymbolrendererwidget.h | 3 +- src/gui/symbology/qgspenstylecombobox.h | 9 +- .../symbology/qgspointclusterrendererwidget.h | 9 +- .../qgspointdisplacementrendererwidget.h | 3 +- .../symbology/qgsrendererpropertiesdialog.h | 9 +- src/gui/symbology/qgsrendererwidget.h | 39 +- .../symbology/qgsrulebasedrendererwidget.h | 15 +- .../symbology/qgssinglesymbolrendererwidget.h | 3 +- src/gui/symbology/qgssmartgroupeditordialog.h | 6 +- .../symbology/qgsstyleexportimportdialog.h | 3 +- .../symbology/qgsstylegroupselectiondialog.h | 3 +- src/gui/symbology/qgsstylemanagerdialog.h | 3 +- src/gui/symbology/qgsstylesavedialog.h | 6 +- src/gui/symbology/qgssvgselectorwidget.h | 57 ++- src/gui/symbology/qgssymbollayerwidget.h | 72 ++- src/gui/symbology/qgssymbollevelsdialog.h | 9 +- src/gui/symbology/qgssymbolselectordialog.h | 18 +- src/gui/symbology/qgssymbolslistwidget.h | 12 +- src/gui/symbology/qgssymbolwidgetcontext.h | 27 +- .../qgsvectorfieldsymbollayerwidget.h | 3 +- .../coordinate_capture/coordinatecapture.h | 3 +- .../georeferencer/qgsresidualplotitem.h | 3 +- src/plugins/gps_importer/qgsgpsplugin.h | 6 +- src/plugins/grass/qgsgrassmodule.h | 9 +- src/plugins/grass/qgsgrassmoduleinput.h | 6 +- src/plugins/grass/qgsgrassmoduleoptions.h | 12 +- src/plugins/grass/qgsgrassmoduleparam.h | 69 ++- src/plugins/grass/qgsgrassnewmapset.h | 3 +- src/plugins/grass/qgsgrassregion.h | 3 +- src/plugins/grass/qgsgrassselect.h | 3 +- src/plugins/grass/qgsgrasstools.h | 3 +- src/plugins/grass/qgsgrassutils.h | 6 +- src/plugins/qgisplugin.h | 6 +- src/plugins/qgsapplydialog.h | 3 +- .../arcgisrest/qgsarcgisservicesourceselect.h | 6 +- src/providers/db2/qgsdb2newconnection.h | 3 +- src/providers/db2/qgsdb2sourceselect.h | 6 +- src/providers/db2/qgsdb2tablemodel.h | 6 +- .../delimitedtext/qgsdelimitedtextfile.h | 123 +++-- .../qgsdelimitedtextprovider.cpp | 3 +- .../delimitedtext/qgsdelimitedtextprovider.h | 12 +- src/providers/gdal/qgsgdalprovider.cpp | 3 +- src/providers/gdal/qgsgdalprovider.h | 6 +- src/providers/gdal/qgsgdalsourceselect.h | 3 +- src/providers/geonode/qgsgeonodeprovider.cpp | 3 +- .../geonode/qgsgeonodesourceselect.h | 3 +- src/providers/gpx/gpsdata.h | 66 ++- src/providers/gpx/qgsgpxprovider.cpp | 3 +- src/providers/grass/qgsgrass.h | 81 ++- src/providers/grass/qgsgrassfeatureiterator.h | 9 +- src/providers/grass/qgsgrassgislib.h | 3 +- src/providers/grass/qgsgrassprovider.h | 102 ++-- .../grass/qgsgrassprovidermodule.cpp | 3 +- src/providers/grass/qgsgrassrasterprovider.h | 12 +- src/providers/grass/qgsgrassvector.h | 6 +- src/providers/grass/qgsgrassvectormap.h | 30 +- src/providers/grass/qgsgrassvectormaplayer.h | 39 +- src/providers/mssql/qgsmssqlnewconnection.h | 3 +- src/providers/mssql/qgsmssqlprovider.cpp | 3 +- src/providers/mssql/qgsmssqlsourceselect.h | 6 +- src/providers/mssql/qgsmssqltablemodel.h | 6 +- src/providers/ogr/qgsgeopackagedataitems.h | 3 +- src/providers/ogr/qgsogrdataitems.h | 6 +- src/providers/ogr/qgsogrdbsourceselect.h | 6 +- src/providers/ogr/qgsogrprovider.cpp | 6 +- src/providers/ogr/qgsogrprovider.h | 9 +- src/providers/oracle/qgsoracleconn.h | 6 +- src/providers/oracle/qgsoraclenewconnection.h | 3 +- src/providers/oracle/qgsoracleprovider.cpp | 3 +- src/providers/oracle/qgsoracleprovider.h | 15 +- src/providers/oracle/qgsoraclesourceselect.h | 6 +- src/providers/oracle/qgsoracletablemodel.h | 3 +- src/providers/postgres/qgspgnewconnection.h | 3 +- src/providers/postgres/qgspgsourceselect.h | 6 +- src/providers/postgres/qgspgtablemodel.h | 3 +- src/providers/postgres/qgspostgresconn.h | 15 +- .../postgres/qgspostgresprovider.cpp | 3 +- src/providers/postgres/qgspostgresprovider.h | 33 +- .../spatialite/qgsspatialiteconnection.h | 3 +- .../spatialite/qgsspatialiteprovider.cpp | 3 +- .../spatialite/qgsspatialiteprovider.h | 6 +- .../spatialite/qgsspatialitesourceselect.h | 6 +- .../spatialite/qgsspatialitetablemodel.h | 6 +- .../virtual/qgsvirtuallayerprovider.cpp | 3 +- src/providers/wcs/qgswcscapabilities.h | 15 +- src/providers/wcs/qgswcsprovider.h | 6 +- src/providers/wfs/qgswfsdataitems.h | 6 +- src/providers/wfs/qgswfsdatasourceuri.h | 3 +- src/providers/wfs/qgswfsfeatureiterator.h | 12 +- src/providers/wfs/qgswfsprovider.h | 12 +- src/providers/wfs/qgswfsrequest.h | 3 +- src/providers/wfs/qgswfsshareddata.h | 30 +- src/providers/wfs/qgswfssourceselect.h | 6 +- src/providers/wfs/qgswfsutils.h | 3 +- src/providers/wms/qgstilecache.h | 3 +- src/providers/wms/qgswmscapabilities.h | 3 +- src/providers/wms/qgswmsprovider.cpp | 3 +- src/providers/wms/qgswmsprovider.h | 9 +- src/providers/wms/qgswmssourceselect.h | 3 +- src/server/qgsaccesscontrol.h | 36 +- src/server/qgsaccesscontrolfilter.h | 21 +- src/server/qgsbufferserverresponse.h | 6 +- src/server/qgscapabilitiescache.h | 12 +- src/server/qgsconfigcache.h | 3 +- src/server/qgsfilterrestorer.h | 9 +- src/server/qgsftptransaction.h | 6 +- src/server/qgshttptransaction.h | 6 +- src/server/qgsinterpolationlayerbuilder.h | 3 +- src/server/qgsmapserviceexception.h | 3 +- src/server/qgsmslayerbuilder.h | 12 +- src/server/qgsmslayercache.h | 15 +- src/server/qgsremotedatasourcebuilder.h | 3 +- src/server/qgsrequesthandler.h | 12 +- src/server/qgssentdatasourcebuilder.h | 3 +- src/server/qgsserver.h | 12 +- src/server/qgsserverexception.h | 9 +- src/server/qgsserverfilter.h | 12 +- src/server/qgsserverinterface.h | 3 +- src/server/qgsserverinterfaceimpl.h | 3 +- src/server/qgsserverprojectutils.h | 135 +++-- src/server/qgsserverresponse.h | 6 +- src/server/qgsserversettings.h | 39 +- .../services/wcs/qgswcsdescribecoverage.h | 3 +- .../services/wcs/qgswcsgetcapabilities.h | 3 +- src/server/services/wcs/qgswcsgetcoverage.h | 3 +- .../services/wcs/qgswcsserviceexception.h | 9 +- .../services/wfs/qgswfsdescribefeaturetype.h | 3 +- src/server/services/wfs/qgswfsgetfeature.h | 12 +- .../services/wfs/qgswfsserviceexception.h | 9 +- src/server/services/wfs/qgswfstransaction.h | 18 +- src/server/services/wfs/qgswfsutils.h | 6 +- src/server/services/wms/qgsdxfwriter.h | 3 +- src/server/services/wms/qgslayerrestorer.h | 3 +- .../services/wms/qgsmaprendererjobproxy.h | 12 +- src/server/services/wms/qgswmsdescribelayer.h | 3 +- .../services/wms/qgswmsgetcapabilities.h | 3 +- src/server/services/wms/qgswmsgetcontext.h | 3 +- .../services/wms/qgswmsgetfeatureinfo.h | 3 +- .../services/wms/qgswmsgetlegendgraphics.h | 3 +- src/server/services/wms/qgswmsgetmap.h | 3 +- src/server/services/wms/qgswmsgetprint.h | 3 +- .../services/wms/qgswmsgetschemaextension.h | 6 +- src/server/services/wms/qgswmsgetstyles.h | 9 +- src/server/services/wms/qgswmsparameters.h | 327 ++++++++---- src/server/services/wms/qgswmsrenderer.h | 39 +- .../services/wms/qgswmsserviceexception.h | 9 +- src/server/services/wms/qgswmsutils.h | 15 +- tests/bench/main.cpp | 3 +- tests/code_layout/sipifyheader.h | 6 +- tests/src/analysis/testqgszonalstatistics.cpp | 3 +- tests/src/app/testqgisappclipboard.cpp | 3 +- tests/src/app/testqgisapppython.cpp | 3 +- tests/src/app/testqgsattributetable.cpp | 3 +- tests/src/app/testqgsfieldcalculator.cpp | 3 +- tests/src/app/testqgsmeasuretool.cpp | 3 +- tests/src/app/testqgsnodetool.cpp | 3 +- .../app/testqgsvectorlayersaveasdialog.cpp | 3 +- tests/src/core/testcontrastenhancements.cpp | 3 +- tests/src/core/testqgis.cpp | 3 +- tests/src/core/testqgs25drenderer.cpp | 3 +- tests/src/core/testqgsauthconfig.cpp | 3 +- tests/src/core/testqgsauthcrypto.cpp | 3 +- tests/src/core/testqgsauthmanager.cpp | 3 +- tests/src/core/testqgsblendmodes.cpp | 3 +- tests/src/core/testqgscadutils.cpp | 3 +- tests/src/core/testqgscentroidfillsymbol.cpp | 3 +- tests/src/core/testqgscurve.cpp | 3 +- .../src/core/testqgsdatadefinedsizelegend.cpp | 3 +- tests/src/core/testqgsdataitem.cpp | 3 +- tests/src/core/testqgsdiagram.cpp | 3 +- tests/src/core/testqgsellipsemarker.cpp | 3 +- tests/src/core/testqgsfilledmarker.cpp | 3 +- tests/src/core/testqgsfontmarker.cpp | 3 +- tests/src/core/testqgsgeometry.cpp | 3 +- tests/src/core/testqgsgeonodeconnection.cpp | 3 +- tests/src/core/testqgsgml.cpp | 3 +- tests/src/core/testqgsgradients.cpp | 3 +- tests/src/core/testqgshistogram.cpp | 3 +- .../core/testqgsinvertedpolygonrenderer.cpp | 3 +- tests/src/core/testqgslinefillsymbol.cpp | 3 +- tests/src/core/testqgsmaplayer.cpp | 3 +- tests/src/core/testqgsmaprendererjob.cpp | 6 +- tests/src/core/testqgsmaprotation.cpp | 3 +- .../testqgsmaptopixelgeometrysimplifier.cpp | 3 +- tests/src/core/testqgsmarkerlinesymbol.cpp | 3 +- tests/src/core/testqgsogcutils.cpp | 3 +- tests/src/core/testqgspainteffect.cpp | 3 +- .../core/testqgspointpatternfillsymbol.cpp | 3 +- tests/src/core/testqgsrasterblock.cpp | 3 +- tests/src/core/testqgsrasterfilewriter.cpp | 3 +- tests/src/core/testqgsrasterfill.cpp | 3 +- tests/src/core/testqgsrasterlayer.cpp | 3 +- tests/src/core/testqgsrastersublayer.cpp | 3 +- tests/src/core/testqgsrenderers.cpp | 3 +- tests/src/core/testqgsshapeburst.cpp | 3 +- tests/src/core/testqgssimplemarker.cpp | 3 +- tests/src/core/testqgsstyle.cpp | 3 +- tests/src/core/testqgssvgmarker.cpp | 3 +- tests/src/core/testqgssymbol.cpp | 3 +- tests/src/core/testqgsvectorfilewriter.cpp | 3 +- tests/src/core/testqgsvectorlayer.cpp | 3 +- tests/src/core/testqgsvectorlayercache.cpp | 3 +- .../src/core/testqgsvectorlayerjoinbuffer.cpp | 3 +- tests/src/core/testziplayer.cpp | 3 +- .../src/gui/testqgsfieldexpressionwidget.cpp | 3 +- tests/src/gui/testqgsmaptoolzoom.cpp | 3 +- tests/src/gui/testqgsquickprint.cpp | 3 +- tests/src/gui/testqgsrasterhistogram.cpp | 3 +- tests/src/gui/testqgsscalerangewidget.cpp | 3 +- .../providers/grass/testqgsgrassprovider.cpp | 3 +- tests/src/providers/testqgsgdalprovider.cpp | 3 +- tests/src/providers/testqgswcsprovider.cpp | 3 +- .../src/providers/testqgswmscapabilities.cpp | 3 +- tests/src/providers/testqgswmsprovider.cpp | 3 +- 1027 files changed, 12159 insertions(+), 6076 deletions(-) diff --git a/scripts/doxygen_space.pl b/scripts/doxygen_space.pl index f111c27d485b..83ff963d8ef9 100755 --- a/scripts/doxygen_space.pl +++ b/scripts/doxygen_space.pl @@ -72,13 +72,24 @@ } } else { - if ( !$PREVIOUS_WAS_BLANKLINE && $new_line =~ m/^(\s*)\/\*\*\s/ ){ + if ( $new_line =~ m/^(\s*)\/\*\*(?!\*)\s*(.*)$/ ){ # Space around doxygen start blocks (force blank line before /**) - print $out_handle "\n"; + if ( !$PREVIOUS_WAS_BLANKLINE ){ + print $out_handle "\n"; + } + if ( $2 ne '' ){ + # new line after /** begin block + print $out_handle "$1\/**\n$1 * $2\n"; + } + else { + print $out_handle $new_line."\n"; + } + } + else { + print $out_handle $new_line."\n"; } - print $out_handle $new_line."\n"; } $LINE_IDX++; $PREVIOUS_WAS_BLANKLINE = $is_blank_line; } -close $out_handle; \ No newline at end of file +close $out_handle; diff --git a/src/3d/chunks/qgschunkboundsentity_p.h b/src/3d/chunks/qgschunkboundsentity_p.h index 850443685155..3a7b519456b2 100644 --- a/src/3d/chunks/qgschunkboundsentity_p.h +++ b/src/3d/chunks/qgschunkboundsentity_p.h @@ -33,7 +33,8 @@ class QgsAABB; class AABBMesh; -/** \ingroup 3d +/** + * \ingroup 3d * Draws bounds of axis aligned bounding boxes * \since QGIS 3.0 */ diff --git a/src/3d/chunks/qgschunkedentity_p.h b/src/3d/chunks/qgschunkedentity_p.h index 6068de5304b5..620a99f85d19 100644 --- a/src/3d/chunks/qgschunkedentity_p.h +++ b/src/3d/chunks/qgschunkedentity_p.h @@ -42,7 +42,8 @@ class QgsChunkQueueJobFactory; #include -/** \ingroup 3d +/** + * \ingroup 3d * Implementation of entity that handles chunks of data organized in quadtree with loading data when necessary * based on data error and unloading of data when data are not necessary anymore * \since QGIS 3.0 diff --git a/src/3d/chunks/qgschunklist_p.h b/src/3d/chunks/qgschunklist_p.h index ca491b3c2997..70f9454542f3 100644 --- a/src/3d/chunks/qgschunklist_p.h +++ b/src/3d/chunks/qgschunklist_p.h @@ -29,7 +29,8 @@ class QgsChunkNode; -/** \ingroup 3d +/** + * \ingroup 3d * Element of a double-linked list * \since QGIS 3.0 */ @@ -47,7 +48,8 @@ struct QgsChunkListEntry }; -/** \ingroup 3d +/** + * \ingroup 3d * Double linked list of chunks. * The list does not own entries. * diff --git a/src/3d/chunks/qgschunkloader_p.h b/src/3d/chunks/qgschunkloader_p.h index ccc8df0280b4..c52a4837f585 100644 --- a/src/3d/chunks/qgschunkloader_p.h +++ b/src/3d/chunks/qgschunkloader_p.h @@ -29,7 +29,8 @@ #include "qgschunkqueuejob_p.h" -/** \ingroup 3d +/** + * \ingroup 3d * Base class for jobs that load chunks * \since QGIS 3.0 */ @@ -54,7 +55,8 @@ class QgsChunkLoader : public QgsChunkQueueJob }; -/** \ingroup 3d +/** + * \ingroup 3d * Factory for chunk loaders for a particular type of entity * \since QGIS 3.0 */ diff --git a/src/3d/chunks/qgschunknode_p.h b/src/3d/chunks/qgschunknode_p.h index 10c8378489d4..d34bff7bd6ae 100644 --- a/src/3d/chunks/qgschunknode_p.h +++ b/src/3d/chunks/qgschunknode_p.h @@ -42,7 +42,8 @@ class QgsChunkQueueJob; class QgsChunkQueueJobFactory; -/** \ingroup 3d +/** + * \ingroup 3d * Data structure for keeping track of chunks of data for 3D entities that use "out of core" rendering, * i.e. not all of the data are available in the memory all the time. This is useful for large datasets * where it may be impossible to load all data into memory or the rendering would get very slow. diff --git a/src/3d/chunks/qgschunkqueuejob_p.h b/src/3d/chunks/qgschunkqueuejob_p.h index 824f7b7dc88c..0b375e984c5f 100644 --- a/src/3d/chunks/qgschunkqueuejob_p.h +++ b/src/3d/chunks/qgschunkqueuejob_p.h @@ -36,7 +36,8 @@ namespace Qt3DCore #include -/** \ingroup 3d +/** + * \ingroup 3d * Base class for chunk queue jobs. Job implementations start their work when they are created * and all work is done asynchronously, i.e. constructor should exit as soon as possible and * all work should be done in a worker thread. Once the job is done, finished() signal is emitted @@ -76,7 +77,8 @@ class QgsChunkQueueJob : public QObject QgsChunkNode *mNode = nullptr; }; -/** \ingroup 3d +/** + * \ingroup 3d * Base class for factories of chunk queue jobs. Derived classes need to implement createJob() * method that will create a specific job for given chunk node. * \since QGIS 3.0 diff --git a/src/3d/qgs3dmapscene.h b/src/3d/qgs3dmapscene.h index c58694d7fca5..04278afd962f 100644 --- a/src/3d/qgs3dmapscene.h +++ b/src/3d/qgs3dmapscene.h @@ -42,7 +42,8 @@ class Qgs3DMapSettings; class QgsTerrainEntity; class QgsChunkedEntity; -/** \ingroup 3d +/** + * \ingroup 3d * Entity that encapsulates our 3D scene - contains all other entities (such as terrain) as children. * \since QGIS 3.0 */ diff --git a/src/3d/qgs3dmapsettings.h b/src/3d/qgs3dmapsettings.h index 1aef39601332..c91888c98d7d 100644 --- a/src/3d/qgs3dmapsettings.h +++ b/src/3d/qgs3dmapsettings.h @@ -37,7 +37,8 @@ class QgsProject; class QDomElement; -/** \ingroup 3d +/** + * \ingroup 3d * Definition of the world * * \since QGIS 3.0 diff --git a/src/3d/qgs3dutils.h b/src/3d/qgs3dutils.h index 76ee3ea08bd1..328ea4de150f 100644 --- a/src/3d/qgs3dutils.h +++ b/src/3d/qgs3dutils.h @@ -39,7 +39,8 @@ enum AltitudeBinding }; -/** \ingroup 3d +/** + * \ingroup 3d * Miscellaneous utility functions used from 3D code. * \since QGIS 3.0 */ diff --git a/src/3d/qgsaabb.h b/src/3d/qgsaabb.h index 069dbb734134..84319bebb89e 100644 --- a/src/3d/qgsaabb.h +++ b/src/3d/qgsaabb.h @@ -22,7 +22,8 @@ #include #include -/** \ingroup 3d +/** + * \ingroup 3d * Axis-aligned bounding box - in world coords. * \since QGIS 3.0 */ diff --git a/src/3d/qgscameracontroller.h b/src/3d/qgscameracontroller.h index 407bb1b021ee..1b2c974094d5 100644 --- a/src/3d/qgscameracontroller.h +++ b/src/3d/qgscameracontroller.h @@ -23,7 +23,8 @@ #include -/** \ingroup 3d +/** + * \ingroup 3d * Object that controls camera movement based on user input * \since QGIS 3.0 */ diff --git a/src/3d/qgsphongmaterialsettings.h b/src/3d/qgsphongmaterialsettings.h index 47f37b5eca3e..800d632fcf59 100644 --- a/src/3d/qgsphongmaterialsettings.h +++ b/src/3d/qgsphongmaterialsettings.h @@ -22,7 +22,8 @@ class QDomElement; -/** \ingroup 3d +/** + * \ingroup 3d * Basic shading material used for rendering based on the Phong shading model * with three color components: ambient, diffuse and specular. * \since QGIS 3.0 diff --git a/src/3d/qgstessellatedpolygongeometry.h b/src/3d/qgstessellatedpolygongeometry.h index f810ad016d93..01665667119b 100644 --- a/src/3d/qgstessellatedpolygongeometry.h +++ b/src/3d/qgstessellatedpolygongeometry.h @@ -25,7 +25,8 @@ namespace Qt3DRender class QBuffer; } -/** \ingroup 3d +/** + * \ingroup 3d * Class derived from Qt3DRender::QGeometry that represents polygons tessellated into 3D geometry. * * Takes a list of polygons as input, internally it does tessellation and writes output to the internal diff --git a/src/3d/qgstessellator.h b/src/3d/qgstessellator.h index 846b94d429ad..6db18d922eab 100644 --- a/src/3d/qgstessellator.h +++ b/src/3d/qgstessellator.h @@ -21,7 +21,8 @@ class QgsPolygonV2; #include -/** \ingroup 3d +/** + * \ingroup 3d * Class that takes care of tessellation of polygons into triangles. * * It is expected that client code will create the tessellator object, then repeatedly call diff --git a/src/3d/qgstilingscheme.h b/src/3d/qgstilingscheme.h index 24c6441979fe..6d79caf3da34 100644 --- a/src/3d/qgstilingscheme.h +++ b/src/3d/qgstilingscheme.h @@ -23,7 +23,8 @@ class QgsRectangle; -/** \ingroup 3d +/** + * \ingroup 3d * The class encapsulates tiling scheme (just like with WMTS / TMS / XYZ layers). * The origin (tile [0,0]) is in bottom-left corner. * \since QGIS 3.0 diff --git a/src/3d/qgsvectorlayer3drenderer.h b/src/3d/qgsvectorlayer3drenderer.h index a2153361cf47..c7c910a3785b 100644 --- a/src/3d/qgsvectorlayer3drenderer.h +++ b/src/3d/qgsvectorlayer3drenderer.h @@ -33,7 +33,8 @@ class QgsVectorLayer; class QgsAbstract3DSymbol; -/** \ingroup core +/** + * \ingroup core * Metadata for vector layer 3D renderer to allow creation of its instances from XML * \since QGIS 3.0 */ @@ -47,7 +48,8 @@ class _3D_EXPORT QgsVectorLayer3DRendererMetadata : public Qgs3DRendererAbstract }; -/** \ingroup core +/** + * \ingroup core * 3D renderer that renders all features of a vector layer with the same 3D symbol. * The appearance is completely defined by the symbol. * \since QGIS 3.0 diff --git a/src/3d/symbols/qgsline3dsymbol.h b/src/3d/symbols/qgsline3dsymbol.h index a71a36243244..dad8fb3a8652 100644 --- a/src/3d/symbols/qgsline3dsymbol.h +++ b/src/3d/symbols/qgsline3dsymbol.h @@ -23,7 +23,8 @@ #include "qgs3dutils.h" -/** \ingroup 3d +/** + * \ingroup 3d * 3D symbol that draws linestring geometries as planar polygons (created from lines using a buffer with given thickness). * \since QGIS 3.0 */ diff --git a/src/3d/symbols/qgspoint3dsymbol.h b/src/3d/symbols/qgspoint3dsymbol.h index 254c99fd9315..ad0d41c64e0c 100644 --- a/src/3d/symbols/qgspoint3dsymbol.h +++ b/src/3d/symbols/qgspoint3dsymbol.h @@ -23,7 +23,8 @@ #include "qgs3dutils.h" -/** \ingroup 3d +/** + * \ingroup 3d * 3D symbol that draws point geometries as 3D objects using one of the predefined shapes. * * \since QGIS 3.0 diff --git a/src/3d/symbols/qgspolygon3dsymbol.h b/src/3d/symbols/qgspolygon3dsymbol.h index 49528b79023d..554ca9f39cc4 100644 --- a/src/3d/symbols/qgspolygon3dsymbol.h +++ b/src/3d/symbols/qgspolygon3dsymbol.h @@ -23,7 +23,8 @@ #include "qgs3dutils.h" -/** \ingroup 3d +/** + * \ingroup 3d * 3D symbol that draws polygon geometries as planar polygons, optionally extruded (with added walls). * \since QGIS 3.0 */ diff --git a/src/3d/terrain/qgsdemterraingenerator.h b/src/3d/terrain/qgsdemterraingenerator.h index 2ec7023a27c5..9d7b7840067b 100644 --- a/src/3d/terrain/qgsdemterraingenerator.h +++ b/src/3d/terrain/qgsdemterraingenerator.h @@ -28,7 +28,8 @@ class QgsRasterLayer; #include "qgsmaplayerref.h" -/** \ingroup 3d +/** + * \ingroup 3d * Implementation of terrain generator that uses a raster layer with DEM to build terrain. * \since QGIS 3.0 */ diff --git a/src/3d/terrain/qgsdemterraintilegeometry_p.h b/src/3d/terrain/qgsdemterraintilegeometry_p.h index 15ffc99c33ef..f3c17981856e 100644 --- a/src/3d/terrain/qgsdemterraintilegeometry_p.h +++ b/src/3d/terrain/qgsdemterraintilegeometry_p.h @@ -42,7 +42,8 @@ namespace Qt3DRender } // Qt3DRender -/** \ingroup 3d +/** + * \ingroup 3d * Stores attributes and vertex/index buffers for one terrain tile based on DEM. * \since QGIS 3.0 */ diff --git a/src/3d/terrain/qgsdemterraintileloader_p.h b/src/3d/terrain/qgsdemterraintileloader_p.h index 68b1a2744965..42ddc32ddc2b 100644 --- a/src/3d/terrain/qgsdemterraintileloader_p.h +++ b/src/3d/terrain/qgsdemterraintileloader_p.h @@ -38,7 +38,8 @@ class QgsRasterDataProvider; class QgsRasterLayer; -/** \ingroup 3d +/** + * \ingroup 3d * Chunk loader for DEM terrain tiles. * \since QGIS 3.0 */ @@ -64,7 +65,8 @@ class QgsDemTerrainTileLoader : public QgsTerrainTileLoader -/** \ingroup 3d +/** + * \ingroup 3d * Utility class to asynchronously create heightmaps from DEM raster for given tiles of terrain. * \since QGIS 3.0 */ diff --git a/src/3d/terrain/qgsflatterraingenerator.h b/src/3d/terrain/qgsflatterraingenerator.h index a6041f714924..7e7e485895db 100644 --- a/src/3d/terrain/qgsflatterraingenerator.h +++ b/src/3d/terrain/qgsflatterraingenerator.h @@ -23,7 +23,8 @@ #include "qgsrectangle.h" -/** \ingroup 3d +/** + * \ingroup 3d * Terrain generator that creates a simple square flat area. * * \since QGIS 3.0 diff --git a/src/3d/terrain/qgsterrainentity_p.h b/src/3d/terrain/qgsterrainentity_p.h index dadec21d6574..ede8ee256d11 100644 --- a/src/3d/terrain/qgsterrainentity_p.h +++ b/src/3d/terrain/qgsterrainentity_p.h @@ -44,7 +44,8 @@ class QgsMapLayer; class QgsTerrainGenerator; class TerrainMapUpdateJobFactory; -/** \ingroup 3d +/** + * \ingroup 3d * Controller for terrain - decides on what terrain tiles to show based on camera position * and creates them using map's terrain tile generator. * \since QGIS 3.0 diff --git a/src/3d/terrain/qgsterraingenerator.h b/src/3d/terrain/qgsterraingenerator.h index 3eb396aaf36f..92c8f133d5f5 100644 --- a/src/3d/terrain/qgsterraingenerator.h +++ b/src/3d/terrain/qgsterraingenerator.h @@ -31,7 +31,8 @@ class QDomDocument; class QgsProject; -/** \ingroup 3d +/** + * \ingroup 3d * Base class for generators of terrain. All terrain generators are tile based * to support hierarchical level of detail. Tiling scheme of a generator is defined * by the generator itself. Terrain generators are asked to produce new terrain tiles diff --git a/src/3d/terrain/qgsterraintexturegenerator_p.h b/src/3d/terrain/qgsterraintexturegenerator_p.h index 91f63a747c91..5f8b6ead1b5a 100644 --- a/src/3d/terrain/qgsterraintexturegenerator_p.h +++ b/src/3d/terrain/qgsterraintexturegenerator_p.h @@ -38,7 +38,8 @@ class QgsRasterLayer; class Qgs3DMapSettings; -/** \ingroup 3d +/** + * \ingroup 3d * Class responsible for rendering map images in background for the purposes of their use * as textures for terrain's tiles. * diff --git a/src/3d/terrain/qgsterraintextureimage_p.h b/src/3d/terrain/qgsterraintextureimage_p.h index c819f6ef025c..f13babedd729 100644 --- a/src/3d/terrain/qgsterraintextureimage_p.h +++ b/src/3d/terrain/qgsterraintextureimage_p.h @@ -33,7 +33,8 @@ class QgsTerrainTextureGenerator; -/** \ingroup 3d +/** + * \ingroup 3d * Class that stores an image with a rendered map. The image is used as a texture for one map tile. * * The texture is provided to Qt 3D through the implementation of dataGenerator() method. diff --git a/src/3d/terrain/qgsterraintileentity_p.h b/src/3d/terrain/qgsterraintileentity_p.h index 9691321084f4..a84af9963cb8 100644 --- a/src/3d/terrain/qgsterraintileentity_p.h +++ b/src/3d/terrain/qgsterraintileentity_p.h @@ -31,7 +31,8 @@ class QgsTerrainTextureImage; #include -/** \ingroup 3d +/** + * \ingroup 3d * Base class for 3D entities representing one tile of terrain. * It contains pointer to tile's texture image. * diff --git a/src/3d/terrain/qgsterraintileloader_p.h b/src/3d/terrain/qgsterraintileloader_p.h index 68d6609f1ecc..ebfd30a3a6b8 100644 --- a/src/3d/terrain/qgsterraintileloader_p.h +++ b/src/3d/terrain/qgsterraintileloader_p.h @@ -36,7 +36,8 @@ class QgsTerrainEntity; class QgsTerrainTileEntity; -/** \ingroup 3d +/** + * \ingroup 3d * Base class for chunk loaders for terrain tiles. * Adds functionality for asynchronous rendering of terrain tile map texture and access to the terrain entity. * \since QGIS 3.0 diff --git a/src/3d/terrain/quantizedmeshgeometry.h b/src/3d/terrain/quantizedmeshgeometry.h index adbe3db29108..443d76f93020 100644 --- a/src/3d/terrain/quantizedmeshgeometry.h +++ b/src/3d/terrain/quantizedmeshgeometry.h @@ -54,7 +54,8 @@ class QgsMapToPixel; class Map3D; -/** \ingroup 3d +/** + * \ingroup 3d * Stores vertex and index buffer for one tile of quantized mesh terrain. * \since QGIS 3.0 */ diff --git a/src/3d/terrain/quantizedmeshterraingenerator.h b/src/3d/terrain/quantizedmeshterraingenerator.h index a8d9bf39943b..74984c23f287 100644 --- a/src/3d/terrain/quantizedmeshterraingenerator.h +++ b/src/3d/terrain/quantizedmeshterraingenerator.h @@ -4,7 +4,8 @@ #include "qgsterraingenerator.h" -/** \ingroup 3d +/** + * \ingroup 3d * Terrain generator using downloaded terrain tiles using quantized mesh specification * \since QGIS 3.0 */ diff --git a/src/analysis/interpolation/Bezier3D.h b/src/analysis/interpolation/Bezier3D.h index bfdd4266d6c2..252f13750d8c 100644 --- a/src/analysis/interpolation/Bezier3D.h +++ b/src/analysis/interpolation/Bezier3D.h @@ -23,7 +23,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * Class Bezier3D represents a bezier curve, represented by control points. Parameter t is running from 0 to 1. The class is capable to calculate the curve point and the first two derivatives belonging to it. * \note Not available in Python bindings */ diff --git a/src/analysis/interpolation/CloughTocherInterpolator.h b/src/analysis/interpolation/CloughTocherInterpolator.h index b882f0ca5a69..bcaa28ea9443 100644 --- a/src/analysis/interpolation/CloughTocherInterpolator.h +++ b/src/analysis/interpolation/CloughTocherInterpolator.h @@ -25,7 +25,8 @@ class NormVecDecorator; #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * This is an implementation of a Clough-Tocher interpolator based on a triangular tessellation. The derivatives orthogonal to the boundary curves are interpolated linearly along a triangle edge. * \note Not available in Python bindings */ diff --git a/src/analysis/interpolation/DualEdgeTriangulation.h b/src/analysis/interpolation/DualEdgeTriangulation.h index ea587dd59c03..e2f12f7441ca 100644 --- a/src/analysis/interpolation/DualEdgeTriangulation.h +++ b/src/analysis/interpolation/DualEdgeTriangulation.h @@ -35,7 +35,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * DualEdgeTriangulation is an implementation of a triangulation class based on the dual edge data structure. * \note Not available in Python bindings. */ diff --git a/src/analysis/interpolation/HalfEdge.h b/src/analysis/interpolation/HalfEdge.h index 521ff173c61e..3a4cf4a7111f 100644 --- a/src/analysis/interpolation/HalfEdge.h +++ b/src/analysis/interpolation/HalfEdge.h @@ -21,7 +21,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * \class HalfEdge * \note Not available in Python bindings. */ diff --git a/src/analysis/interpolation/LinTriangleInterpolator.h b/src/analysis/interpolation/LinTriangleInterpolator.h index d21fb281125a..fd96db02afb1 100644 --- a/src/analysis/interpolation/LinTriangleInterpolator.h +++ b/src/analysis/interpolation/LinTriangleInterpolator.h @@ -23,7 +23,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * LinTriangleInterpolator is a class which interpolates linearly on a triangulation. * \note Not available in Python bindings. */ diff --git a/src/analysis/interpolation/Line3D.h b/src/analysis/interpolation/Line3D.h index ed6e2f12eff6..383ab6ec172a 100644 --- a/src/analysis/interpolation/Line3D.h +++ b/src/analysis/interpolation/Line3D.h @@ -23,7 +23,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * This class represents a line. It is implemented as a single directed linked list of nodes (with related QgsPoint objects). Attention: the points inserted in a line are not deleted from Line3D * \note Not available in Python bindings */ diff --git a/src/analysis/interpolation/Node.h b/src/analysis/interpolation/Node.h index 81b5d9acb901..af6652b10999 100644 --- a/src/analysis/interpolation/Node.h +++ b/src/analysis/interpolation/Node.h @@ -22,7 +22,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * Node is a class used by Line3D. It represents a node in the single directed linked list. Associated QgsPoint objects are deleted when the node is deleted. * \note Not available in Python bindings */ diff --git a/src/analysis/interpolation/NormVecDecorator.h b/src/analysis/interpolation/NormVecDecorator.h index f59cc2bc775c..5d54d664ed92 100644 --- a/src/analysis/interpolation/NormVecDecorator.h +++ b/src/analysis/interpolation/NormVecDecorator.h @@ -29,7 +29,8 @@ class QgsFeedback; -/** \ingroup analysis +/** + * \ingroup analysis * Decorator class which adds the functionality of estimating normals at the data points. * \note Not available in Python bindings. */ diff --git a/src/analysis/interpolation/ParametricLine.h b/src/analysis/interpolation/ParametricLine.h index 185069fbec72..2f762e04298f 100644 --- a/src/analysis/interpolation/ParametricLine.h +++ b/src/analysis/interpolation/ParametricLine.h @@ -26,7 +26,8 @@ class Vector3D; #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * ParametricLine is an Interface for parametric lines. It is possible, that a parametric line is composed of several parametric * lines (see the composite pattern in Gamma et al. 'Design Patterns'). Do not build instances of it since it is an abstract class. * \note Not available in Python bindings @@ -44,7 +45,8 @@ class ANALYSIS_EXPORT ParametricLine //! Default constructor ParametricLine(); - /** Constructor, par is a pointer to the parent object, controlpoly the controlpolygon + /** + * Constructor, par is a pointer to the parent object, controlpoly the controlpolygon */ ParametricLine( ParametricLine *par SIP_TRANSFER, QVector *controlpoly ); virtual ~ParametricLine(); diff --git a/src/analysis/interpolation/TriDecorator.h b/src/analysis/interpolation/TriDecorator.h index 544c9358cfab..7d75b249889a 100644 --- a/src/analysis/interpolation/TriDecorator.h +++ b/src/analysis/interpolation/TriDecorator.h @@ -23,7 +23,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * Decorator class for Triangulations (s. Decorator pattern in Gamma et al.). * \note Not available in Python bindings. */ diff --git a/src/analysis/interpolation/TriangleInterpolator.h b/src/analysis/interpolation/TriangleInterpolator.h index beab1344bd7c..5813a1af4d0c 100644 --- a/src/analysis/interpolation/TriangleInterpolator.h +++ b/src/analysis/interpolation/TriangleInterpolator.h @@ -23,7 +23,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * This is an interface for interpolator classes for triangulations. * \note Not available in Python bindings. */ diff --git a/src/analysis/interpolation/Triangulation.h b/src/analysis/interpolation/Triangulation.h index 0299b09a3734..7bd9332b58af 100644 --- a/src/analysis/interpolation/Triangulation.h +++ b/src/analysis/interpolation/Triangulation.h @@ -30,7 +30,8 @@ class QgsFeedback; #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * Interface for Triangulation classes. * \note Not available in Python bindings. */ @@ -76,7 +77,8 @@ class ANALYSIS_EXPORT Triangulation //! Returns a pointer to the point with number i. Any virtual points must have the number -1 virtual QgsPoint *getPoint( unsigned int i ) const = 0; - /** Finds out in which triangle the point with coordinates x and y is and + /** + * Finds out in which triangle the point with coordinates x and y is and * assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3' */ virtual bool getTriangle( double x, double y, QgsPoint *p1 SIP_OUT, int *n1 SIP_OUT, QgsPoint *p2 SIP_OUT, int *n2 SIP_OUT, QgsPoint *p3 SIP_OUT, int *n3 SIP_OUT ) = 0 SIP_PYNAME( getTriangleVertices ); @@ -111,7 +113,8 @@ class ANALYSIS_EXPORT Triangulation */ virtual QList *getSurroundingTriangles( int pointno ) = 0; - /** Returns a value list with the numbers of the four points, which would be affected by an edge swap. + /** + * Returns a value list with the numbers of the four points, which would be affected by an edge swap. * This function is e.g. needed by NormVecDecorator to know the points, * for which the normals have to be recalculated. * The list has to be deleted by the code which calls this method diff --git a/src/analysis/interpolation/Vector3D.h b/src/analysis/interpolation/Vector3D.h index e9b42d2157ad..6bb1e7117fbb 100644 --- a/src/analysis/interpolation/Vector3D.h +++ b/src/analysis/interpolation/Vector3D.h @@ -22,7 +22,8 @@ #define SIP_NO_FILE -/** \ingroup analysis +/** + * \ingroup analysis * Class Vector3D represents a 3D-Vector, capable to store x-,y- and * z-coordinates in double values. In fact, the class is the same as QgsPoint. * The name 'vector' makes it easier to understand the programs. diff --git a/src/analysis/interpolation/qgsgridfilewriter.h b/src/analysis/interpolation/qgsgridfilewriter.h index 23228297815f..15adcb020c7b 100644 --- a/src/analysis/interpolation/qgsgridfilewriter.h +++ b/src/analysis/interpolation/qgsgridfilewriter.h @@ -26,7 +26,8 @@ class QgsInterpolator; class QgsFeedback; -/** \ingroup analysis +/** + * \ingroup analysis * A class that does interpolation to a grid and writes the results to an ascii grid*/ //todo: extend such that writing to other file types is possible class ANALYSIS_EXPORT QgsGridFileWriter @@ -34,7 +35,8 @@ class ANALYSIS_EXPORT QgsGridFileWriter public: QgsGridFileWriter( QgsInterpolator *i, const QString &outputPath, const QgsRectangle &extent, int nCols, int nRows, double cellSizeX, double cellSizeY ); - /** Writes the grid file. + /** + * Writes the grid file. \param feedback optional feedback object for progress reports and cancelation support \returns 0 in case of success*/ diff --git a/src/analysis/interpolation/qgsidwinterpolator.h b/src/analysis/interpolation/qgsidwinterpolator.h index 02aebab53f98..ae8ed9f2889e 100644 --- a/src/analysis/interpolation/qgsidwinterpolator.h +++ b/src/analysis/interpolation/qgsidwinterpolator.h @@ -21,7 +21,8 @@ #include "qgsinterpolator.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * \class QgsIDWInterpolator */ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator @@ -29,7 +30,8 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator public: QgsIDWInterpolator( const QList &layerData ); - /** Calculates interpolation value for map coordinates x, y + /** + * Calculates interpolation value for map coordinates x, y \param x x-coordinate (in map units) \param y y-coordinate (in map units) \param result out: interpolation result @@ -42,7 +44,8 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator QgsIDWInterpolator(); //forbidden - /** The parameter that sets how the values are weighted with distance. + /** + * The parameter that sets how the values are weighted with distance. Smaller values mean sharper peaks at the data points. The default is a value of 2*/ double mDistanceCoefficient = 2.0; diff --git a/src/analysis/interpolation/qgsinterpolator.h b/src/analysis/interpolation/qgsinterpolator.h index e67f84b8907d..5812717dcc2e 100644 --- a/src/analysis/interpolation/qgsinterpolator.h +++ b/src/analysis/interpolation/qgsinterpolator.h @@ -32,7 +32,8 @@ struct ANALYSIS_EXPORT vertexData double z; }; -/** \ingroup analysis +/** + * \ingroup analysis * Interface class for interpolations. Interpolators take the vertices of a vector layer as base data. The z-Value can be an attribute or the z-coordinates in case of 25D types*/ @@ -60,7 +61,8 @@ class ANALYSIS_EXPORT QgsInterpolator virtual ~QgsInterpolator() = default; - /** Calculates interpolation value for map coordinates x, y + /** + * Calculates interpolation value for map coordinates x, y \param x x-coordinate (in map units) \param y y-coordinate (in map units) \param result out: interpolation result @@ -72,7 +74,8 @@ class ANALYSIS_EXPORT QgsInterpolator protected: - /** Caches the vertex and value data from the provider. All the vertex data + /** + * Caches the vertex and value data from the provider. All the vertex data will be held in virtual memory \returns 0 in case of success*/ int cacheBaseData(); @@ -88,7 +91,8 @@ class ANALYSIS_EXPORT QgsInterpolator private: QgsInterpolator() = delete; - /** Helper method that adds the vertices of a geometry to the mCachedBaseData + /** + * Helper method that adds the vertices of a geometry to the mCachedBaseData \param geom the geometry \param zCoord true if the z-coordinate of the geometry is to be interpolated \param attributeValue the attribute value for interpolation (if not interpolated from z-coordinate) diff --git a/src/analysis/interpolation/qgstininterpolator.h b/src/analysis/interpolation/qgstininterpolator.h index bc3312d37d40..9aebd888a33c 100644 --- a/src/analysis/interpolation/qgstininterpolator.h +++ b/src/analysis/interpolation/qgstininterpolator.h @@ -29,7 +29,8 @@ class QgsFeature; class QgsFeedback; class QgsFields; -/** \ingroup analysis +/** + * \ingroup analysis * Interpolation in a triangular irregular network*/ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator { @@ -49,7 +50,8 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator QgsTINInterpolator( const QList &inputData, TINInterpolation interpolation = Linear, QgsFeedback *feedback = nullptr ); ~QgsTINInterpolator(); - /** Calculates interpolation value for map coordinates x, y + /** + * Calculates interpolation value for map coordinates x, y \param x x-coordinate (in map units) \param y y-coordinate (in map units) \param result out: interpolation result @@ -90,7 +92,8 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator //! Create dual edge triangulation void initialize(); - /** Inserts the vertices of a feature into the triangulation + /** + * Inserts the vertices of a feature into the triangulation \param f the feature \param zCoord true if the z coordinate is the interpolation attribute \param attr interpolation attribute index (if zCoord is false) diff --git a/src/analysis/network/qgsgraphanalyzer.h b/src/analysis/network/qgsgraphanalyzer.h index f6fc773fcaa9..273b5c2203d7 100644 --- a/src/analysis/network/qgsgraphanalyzer.h +++ b/src/analysis/network/qgsgraphanalyzer.h @@ -23,7 +23,8 @@ class QgsGraph; -/** \ingroup analysis +/** + * \ingroup analysis * This class performs graph analysis, e.g. calculates shortest path between two * points using different strategies with Dijkstra algorithm */ diff --git a/src/analysis/network/qgsnetworkdistancestrategy.h b/src/analysis/network/qgsnetworkdistancestrategy.h index b185beb0eeff..ed971df453f1 100644 --- a/src/analysis/network/qgsnetworkdistancestrategy.h +++ b/src/analysis/network/qgsnetworkdistancestrategy.h @@ -19,7 +19,8 @@ #include "qgsnetworkstrategy.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * \class QgsNetworkDistanceStrategy * \since QGIS 3.0 * \brief Strategy for caclulating edge cost based on its length. Should be diff --git a/src/analysis/network/qgsnetworkspeedstrategy.h b/src/analysis/network/qgsnetworkspeedstrategy.h index 070b4cf8ae75..a9006ba3645c 100644 --- a/src/analysis/network/qgsnetworkspeedstrategy.h +++ b/src/analysis/network/qgsnetworkspeedstrategy.h @@ -19,7 +19,8 @@ #include "qgsnetworkstrategy.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * \class QgsNetworkSpeedStrategy * \since QGIS 3.0 * \brief Strategy for calculating edge cost based on travel time. Should be diff --git a/src/analysis/network/qgsvectorlayerdirector.cpp b/src/analysis/network/qgsvectorlayerdirector.cpp index a10b10f90071..3e89f2454168 100644 --- a/src/analysis/network/qgsvectorlayerdirector.cpp +++ b/src/analysis/network/qgsvectorlayerdirector.cpp @@ -32,7 +32,8 @@ #include #include -/** \ingroup analysis +/** + * \ingroup analysis * \class QgsPointCompare */ class QgsPointCompare diff --git a/src/analysis/network/qgsvectorlayerdirector.h b/src/analysis/network/qgsvectorlayerdirector.h index fab5fae66c0a..f44f3f20627f 100644 --- a/src/analysis/network/qgsvectorlayerdirector.h +++ b/src/analysis/network/qgsvectorlayerdirector.h @@ -36,7 +36,8 @@ class ANALYSIS_EXPORT QgsVectorLayerDirector : public QgsGraphDirector public: - /** Edge direction + /** + * Edge direction * Edge can be one-way with direct flow (one can move only from the start * point to the end point), one-way with reversed flow (one can move only * from the end point to the start point) and bidirectional or two-way diff --git a/src/analysis/openstreetmap/qgsosmbase.h b/src/analysis/openstreetmap/qgsosmbase.h index 810aa5293716..dfae4c991b6c 100644 --- a/src/analysis/openstreetmap/qgsosmbase.h +++ b/src/analysis/openstreetmap/qgsosmbase.h @@ -35,7 +35,8 @@ struct ANALYSIS_EXPORT QgsOSMElementID }; -/** \ingroup analysis +/** + * \ingroup analysis Elements (also data primitives) are the basic components in OpenStreetMap from which everything else is defined. These consist of Nodes (which define a point in space), Ways (which define a linear features and areas), and Relations - with an optional role - which are sometimes used to define the relation @@ -62,7 +63,8 @@ class ANALYSIS_EXPORT QgsOSMElement -/** \ingroup analysis +/** + * \ingroup analysis A node is one of the core elements in the OpenStreetMap data model. It consists of a single geospatial point using a latitude and longitude. A third optional dimension, altitude, can be recorded; key:ele and a node can also be defined at a particular layer=* or level=*. Nodes can be used to define standalone @@ -89,7 +91,8 @@ class ANALYSIS_EXPORT QgsOSMNode : public QgsOSMElement }; -/** \ingroup analysis +/** + * \ingroup analysis A way is an ordered list of nodes which normally also has at least one tag or is included within a Relation. A way can have between 2 and 2,000 nodes, although it's possible that faulty ways with zero or a single node exist. A way can be open or closed. A closed way is one whose last node on the way @@ -122,7 +125,8 @@ class ANALYSIS_EXPORT QgsOSMWay : public QgsOSMElement #if 0 -/** \ingroup analysis +/** + * \ingroup analysis A relation is one of the core data elements that consists of one or more tags and also an ordered list of one or more nodes and/or ways as members which is used to define logical or geographic relationships between other elements. A member of a relation can optionally have a role which describe the part that @@ -137,7 +141,8 @@ class ANALYSIS_EXPORT QgsOSMRelation : public QgsOSMElement }; #endif -/** \ingroup analysis +/** + * \ingroup analysis * This class is a container of tags for a node, way or a relation. */ class ANALYSIS_EXPORT QgsOSMTags diff --git a/src/analysis/openstreetmap/qgsosmdatabase.h b/src/analysis/openstreetmap/qgsosmdatabase.h index ca0f2c845219..878058f72b2e 100644 --- a/src/analysis/openstreetmap/qgsosmdatabase.h +++ b/src/analysis/openstreetmap/qgsosmdatabase.h @@ -30,7 +30,8 @@ class QgsOSMWayIterator; typedef QPair QgsOSMTagCountPair; -/** \ingroup analysis +/** + * \ingroup analysis * Class that encapsulates access to OpenStreetMap data stored in a database * previously imported from XML file. * @@ -139,7 +140,8 @@ class ANALYSIS_EXPORT QgsOSMDatabase }; -/** \ingroup analysis +/** + * \ingroup analysis * Encapsulate iteration over table of nodes/ * \note not available in Python bindings */ @@ -154,7 +156,8 @@ class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three protected: - /** \note not available in Python bindings + /** + * \note not available in Python bindings */ QgsOSMNodeIterator( sqlite3 *handle ) SIP_SKIP; @@ -167,7 +170,8 @@ class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three -/** \ingroup analysis +/** + * \ingroup analysis * Encapsulate iteration over table of ways * \note not available in Python bindings */ @@ -182,7 +186,8 @@ class ANALYSIS_EXPORT QgsOSMWayIterator // clazy:exclude=rule-of-three protected: - /** \note not available in Python bindings + /** + * \note not available in Python bindings */ QgsOSMWayIterator( sqlite3 *handle ) SIP_SKIP; diff --git a/src/analysis/openstreetmap/qgsosmdownload.h b/src/analysis/openstreetmap/qgsosmdownload.h index c346a90ebfcc..ab7719994251 100644 --- a/src/analysis/openstreetmap/qgsosmdownload.h +++ b/src/analysis/openstreetmap/qgsosmdownload.h @@ -24,7 +24,8 @@ class QgsRectangle; -/** \ingroup analysis +/** + * \ingroup analysis * \brief OSMDownload is a utility class for downloading OpenStreetMap via Overpass API. * * To use this class, it is necessary to set query, output file name and start the request. @@ -50,7 +51,8 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject QgsOSMDownload(); - /** Constructor for QgsOSMDownload + /** + * Constructor for QgsOSMDownload * \param query The query to execute in the Overpass API. * * \since QGIS 3.0 diff --git a/src/analysis/openstreetmap/qgsosmimport.h b/src/analysis/openstreetmap/qgsosmimport.h index 3ba8304ddbd8..104fe1c7fecc 100644 --- a/src/analysis/openstreetmap/qgsosmimport.h +++ b/src/analysis/openstreetmap/qgsosmimport.h @@ -25,7 +25,8 @@ class QXmlStreamReader; -/** \ingroup analysis +/** + * \ingroup analysis * \brief The QgsOSMXmlImport class imports OpenStreetMap XML format to our topological representation * in a SQLite database (see QgsOSMDatabase for details). * diff --git a/src/analysis/raster/qgsalignraster.h b/src/analysis/raster/qgsalignraster.h index c1a8da57c760..d44b9667b2b4 100644 --- a/src/analysis/raster/qgsalignraster.h +++ b/src/analysis/raster/qgsalignraster.h @@ -29,7 +29,8 @@ class QgsRectangle; typedef void *GDALDatasetH SIP_SKIP; -/** \ingroup analysis +/** + * \ingroup analysis * \brief QgsAlignRaster takes one or more raster layers and warps (resamples) them * so they have the same: * - coordinate reference system diff --git a/src/analysis/raster/qgsaspectfilter.h b/src/analysis/raster/qgsaspectfilter.h index 39b166898c89..d04ecf442a73 100644 --- a/src/analysis/raster/qgsaspectfilter.h +++ b/src/analysis/raster/qgsaspectfilter.h @@ -21,14 +21,16 @@ #include "qgsderivativefilter.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * Calculates aspect values in a window of 3x3 cells based on first order derivatives in x- and y- directions. Direction is clockwise starting from north*/ class ANALYSIS_EXPORT QgsAspectFilter: public QgsDerivativeFilter { public: QgsAspectFilter( const QString &inputFile, const QString &outputFile, const QString &outputFormat ); - /** Calculates output value from nine input values. The input values and the output value can be equal to the + /** + * Calculates output value from nine input values. The input values and the output value can be equal to the nodata value if not present or outside of the border. Must be implemented by subclasses*/ float processNineCellWindow( float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, diff --git a/src/analysis/raster/qgsderivativefilter.h b/src/analysis/raster/qgsderivativefilter.h index f2c6a2399ec3..652a15fcd1ea 100644 --- a/src/analysis/raster/qgsderivativefilter.h +++ b/src/analysis/raster/qgsderivativefilter.h @@ -21,7 +21,8 @@ #include "qgsninecellfilter.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * Adds the ability to calculate derivatives in x- and y-directions. Needs to be subclassed (e.g. for slope and aspect)*/ class ANALYSIS_EXPORT QgsDerivativeFilter : public QgsNineCellFilter { diff --git a/src/analysis/raster/qgshillshadefilter.h b/src/analysis/raster/qgshillshadefilter.h index 25d76b7df4eb..8a5069d9fafb 100644 --- a/src/analysis/raster/qgshillshadefilter.h +++ b/src/analysis/raster/qgshillshadefilter.h @@ -21,7 +21,8 @@ #include "qgsderivativefilter.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * \class QgsHillshadeFilter */ class ANALYSIS_EXPORT QgsHillshadeFilter: public QgsDerivativeFilter @@ -30,7 +31,8 @@ class ANALYSIS_EXPORT QgsHillshadeFilter: public QgsDerivativeFilter QgsHillshadeFilter( const QString &inputFile, const QString &outputFile, const QString &outputFormat, double lightAzimuth = 300, double lightAngle = 40 ); - /** Calculates output value from nine input values. The input values and the output value can be equal to the + /** + * Calculates output value from nine input values. The input values and the output value can be equal to the nodata value if not present or outside of the border. Must be implemented by subclasses*/ float processNineCellWindow( float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, diff --git a/src/analysis/raster/qgsninecellfilter.h b/src/analysis/raster/qgsninecellfilter.h index 090a4517ac33..f070698c28ca 100644 --- a/src/analysis/raster/qgsninecellfilter.h +++ b/src/analysis/raster/qgsninecellfilter.h @@ -24,7 +24,8 @@ class QgsFeedback; -/** \ingroup analysis +/** + * \ingroup analysis * Base class for raster analysis methods that work with a 3x3 cell filter and calculate the value of each cell based on the cell value and the eight neighbour cells. Common examples are slope and aspect calculation in DEMs. Subclasses only implement the method that calculates the new value from the nine values. Everything else (reading file, writing file) is done by this subclass*/ @@ -36,7 +37,8 @@ class ANALYSIS_EXPORT QgsNineCellFilter QgsNineCellFilter( const QString &inputFile, const QString &outputFile, const QString &outputFormat ); virtual ~QgsNineCellFilter() = default; - /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile + /** + * Starts the calculation, reads from mInputFile and stores the result in mOutputFile \param feedback feedback object that receives update and that is checked for cancelation. \returns 0 in case of success*/ int processRaster( QgsFeedback *feedback = nullptr ); @@ -54,7 +56,8 @@ class ANALYSIS_EXPORT QgsNineCellFilter double outputNodataValue() const { return mOutputNodataValue; } void setOutputNodataValue( double value ) { mOutputNodataValue = value; } - /** Calculates output value from nine input values. The input values and the output value can be equal to the + /** + * Calculates output value from nine input values. The input values and the output value can be equal to the nodata value if not present or outside of the border. Must be implemented by subclasses*/ virtual float processNineCellWindow( float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, @@ -67,11 +70,13 @@ class ANALYSIS_EXPORT QgsNineCellFilter //! Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction GDALDatasetH openInputFile( int &nCellsX, int &nCellsY ); - /** Opens the output driver and tests if it supports the creation of a new dataset + /** + * Opens the output driver and tests if it supports the creation of a new dataset \returns nullptr on error and the driver handle on success*/ GDALDriverH openOutputDriver(); - /** Opens the output file and sets the same geotransform and CRS as the input data + /** + * Opens the output file and sets the same geotransform and CRS as the input data \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); diff --git a/src/analysis/raster/qgsrastercalcnode.h b/src/analysis/raster/qgsrastercalcnode.h index b3420c5e0d55..815d2882baea 100644 --- a/src/analysis/raster/qgsrastercalcnode.h +++ b/src/analysis/raster/qgsrastercalcnode.h @@ -28,7 +28,8 @@ class QgsRasterBlock; class QgsRasterMatrix; -/** \ingroup analysis +/** + * \ingroup analysis * \class QgsRasterCalcNode */ class ANALYSIS_EXPORT QgsRasterCalcNode @@ -94,7 +95,8 @@ class ANALYSIS_EXPORT QgsRasterCalcNode void setLeft( QgsRasterCalcNode *left ) { delete mLeft; mLeft = left; } void setRight( QgsRasterCalcNode *right ) { delete mRight; mRight = right; } - /** Calculates result of raster calculation (might be real matrix or single number). + /** + * Calculates result of raster calculation (might be real matrix or single number). * \param rasterData input raster data references, map of raster name to raster data block * \param result destination raster matrix for calculation results * \param row optional row number to calculate for calculating result by rows, or -1 to diff --git a/src/analysis/raster/qgsrastercalculator.h b/src/analysis/raster/qgsrastercalculator.h index 4af6fe369605..10a2d6e00a21 100644 --- a/src/analysis/raster/qgsrastercalculator.h +++ b/src/analysis/raster/qgsrastercalculator.h @@ -42,7 +42,8 @@ struct ANALYSIS_EXPORT QgsRasterCalculatorEntry int bandNumber; //raster band number }; -/** \ingroup analysis +/** + * \ingroup analysis * Raster calculator class*/ class ANALYSIS_EXPORT QgsRasterCalculator { @@ -59,7 +60,8 @@ class ANALYSIS_EXPORT QgsRasterCalculator MemoryError = 5, //!< Error allocating memory for result }; - /** QgsRasterCalculator constructor. + /** + * QgsRasterCalculator constructor. * \param formulaString formula for raster calculation * \param outputFile output file path * \param outputFormat output file format @@ -71,7 +73,8 @@ class ANALYSIS_EXPORT QgsRasterCalculator QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, int nOutputColumns, int nOutputRows, const QVector &rasterEntries ); - /** QgsRasterCalculator constructor. + /** + * QgsRasterCalculator constructor. * \param formulaString formula for raster calculation * \param outputFile output file path * \param outputFormat output file format @@ -85,7 +88,8 @@ class ANALYSIS_EXPORT QgsRasterCalculator QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat, const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector &rasterEntries ); - /** Starts the calculation and writes a new raster. + /** + * Starts the calculation and writes a new raster. * * The optional \a feedback argument can be used for progress reporting and cancelation support. * \returns 0 in case of success @@ -97,15 +101,18 @@ class ANALYSIS_EXPORT QgsRasterCalculator //default constructor forbidden. We need formula, output file, output format and output raster resolution obligatory QgsRasterCalculator() = delete; - /** Opens the output driver and tests if it supports the creation of a new dataset + /** + * Opens the output driver and tests if it supports the creation of a new dataset \returns nullptr on error and the driver handle on success*/ GDALDriverH openOutputDriver(); - /** Opens the output file and sets the same geotransform and CRS as the input data + /** + * Opens the output file and sets the same geotransform and CRS as the input data \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDriverH outputDriver ); - /** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows + /** + * Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows \param transform double[6] array that receives the GDAL parameters*/ void outputGeoTransform( double *transform ) const; diff --git a/src/analysis/raster/qgsrastermatrix.h b/src/analysis/raster/qgsrastermatrix.h index 8d71ebce68db..2e211e654fa4 100644 --- a/src/analysis/raster/qgsrastermatrix.h +++ b/src/analysis/raster/qgsrastermatrix.h @@ -21,7 +21,8 @@ #include "qgis_analysis.h" #include "qgis_sip.h" -/** \ingroup analysis +/** + * \ingroup analysis * \class QgsRasterMatrix */ class ANALYSIS_EXPORT QgsRasterMatrix diff --git a/src/analysis/raster/qgsrelief.h b/src/analysis/raster/qgsrelief.h index c02338adefe1..9fbaf3a3975b 100644 --- a/src/analysis/raster/qgsrelief.h +++ b/src/analysis/raster/qgsrelief.h @@ -30,7 +30,8 @@ class QgsSlopeFilter; class QgsHillshadeFilter; class QgsFeedback; -/** \ingroup analysis +/** + * \ingroup analysis * Produces colored relief rasters from DEM*/ class ANALYSIS_EXPORT QgsRelief { @@ -51,7 +52,8 @@ class ANALYSIS_EXPORT QgsRelief //! QgsRelief cannot be copied QgsRelief &operator=( const QgsRelief &rh ) = delete; - /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile + /** + * Starts the calculation, reads from mInputFile and stores the result in mOutputFile \param feedback feedback object that receives update and that is checked for cancelation. \returns 0 in case of success*/ int processRaster( QgsFeedback *feedback = nullptr ); @@ -64,7 +66,8 @@ class ANALYSIS_EXPORT QgsRelief QList< QgsRelief::ReliefColor > reliefColors() const { return mReliefColors; } void setReliefColors( const QList< QgsRelief::ReliefColor > &c ) { mReliefColors = c; } - /** Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression + /** + * Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression \returns true in case of success*/ QList< QgsRelief::ReliefColor > calculateOptimizedReliefClasses(); @@ -104,11 +107,13 @@ class ANALYSIS_EXPORT QgsRelief //! Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction GDALDatasetH openInputFile( int &nCellsX, int &nCellsY ); - /** Opens the output driver and tests if it supports the creation of a new dataset + /** + * Opens the output driver and tests if it supports the creation of a new dataset \returns nullptr on error and the driver handle on success*/ GDALDriverH openOutputDriver(); - /** Opens the output file and sets the same geotransform and CRS as the input data + /** + * Opens the output file and sets the same geotransform and CRS as the input data \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); @@ -118,13 +123,15 @@ class ANALYSIS_EXPORT QgsRelief //! Sets relief colors void setDefaultReliefColors(); - /** Returns class (0-255) for an elevation value + /** + * Returns class (0-255) for an elevation value \returns elevation class or -1 in case of error*/ int frequencyClassForElevation( double elevation, double minElevation, double elevationClassRange ); //! Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez) void optimiseClassBreaks( QList &breaks, double *frequencies ); - /** Calculates coefficients a and b + /** + * Calculates coefficients a and b \param input data points ( elevation class / frequency ) \param a slope \param b y value for x=0 diff --git a/src/analysis/raster/qgsruggednessfilter.h b/src/analysis/raster/qgsruggednessfilter.h index 0b1377657862..c0b2b6b11796 100644 --- a/src/analysis/raster/qgsruggednessfilter.h +++ b/src/analysis/raster/qgsruggednessfilter.h @@ -21,7 +21,8 @@ #include "qgsninecellfilter.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * Calculates the ruggedness index based on a 3x3 moving window. Algorithm from Riley et al. 1999: A terrain ruggedness index that quantifies topographic heterogeneity*/ class ANALYSIS_EXPORT QgsRuggednessFilter: public QgsNineCellFilter @@ -32,7 +33,8 @@ class ANALYSIS_EXPORT QgsRuggednessFilter: public QgsNineCellFilter protected: - /** Calculates output value from nine input values. The input values and the output value can be equal to the + /** + * Calculates output value from nine input values. The input values and the output value can be equal to the nodata value if not present or outside of the border. Must be implemented by subclasses*/ float processNineCellWindow( float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, diff --git a/src/analysis/raster/qgsslopefilter.h b/src/analysis/raster/qgsslopefilter.h index 030b5462a115..9a946e31a9f5 100644 --- a/src/analysis/raster/qgsslopefilter.h +++ b/src/analysis/raster/qgsslopefilter.h @@ -21,7 +21,8 @@ #include "qgsderivativefilter.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * Calculates slope values in a window of 3x3 cells based on first order derivatives in x- and y- directions*/ class ANALYSIS_EXPORT QgsSlopeFilter: public QgsDerivativeFilter { @@ -29,7 +30,8 @@ class ANALYSIS_EXPORT QgsSlopeFilter: public QgsDerivativeFilter QgsSlopeFilter( const QString &inputFile, const QString &outputFile, const QString &outputFormat ); ~QgsSlopeFilter() = default; - /** Calculates output value from nine input values. The input values and the output value can be equal to the + /** + * Calculates output value from nine input values. The input values and the output value can be equal to the nodata value if not present or outside of the border. Must be implemented by subclasses*/ float processNineCellWindow( float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, diff --git a/src/analysis/raster/qgstotalcurvaturefilter.h b/src/analysis/raster/qgstotalcurvaturefilter.h index c3b305f3dfe2..5684c9b2aee5 100644 --- a/src/analysis/raster/qgstotalcurvaturefilter.h +++ b/src/analysis/raster/qgstotalcurvaturefilter.h @@ -21,7 +21,8 @@ #include "qgsninecellfilter.h" #include "qgis_analysis.h" -/** \ingroup analysis +/** + * \ingroup analysis * Calculates total curvature as described by Wilson, Gallant (2000): terrain analysis*/ class ANALYSIS_EXPORT QgsTotalCurvatureFilter: public QgsNineCellFilter { @@ -31,7 +32,8 @@ class ANALYSIS_EXPORT QgsTotalCurvatureFilter: public QgsNineCellFilter protected: - /** Calculates total curvature from nine input values. The input values and the output value can be equal to the + /** + * Calculates total curvature from nine input values. The input values and the output value can be equal to the nodata value if not present or outside of the border. Must be implemented by subclasses*/ float processNineCellWindow( float *x11, float *x21, float *x31, float *x12, float *x22, float *x32, diff --git a/src/analysis/vector/qgszonalstatistics.h b/src/analysis/vector/qgszonalstatistics.h index 499dfb874656..563805052b5b 100644 --- a/src/analysis/vector/qgszonalstatistics.h +++ b/src/analysis/vector/qgszonalstatistics.h @@ -34,7 +34,8 @@ class QgsRasterDataProvider; class QgsRectangle; class QgsField; -/** \ingroup analysis +/** + * \ingroup analysis * A class that calculates raster statistics (count, sum, mean) for a polygon or multipolygon layer and appends the results as attributes*/ class ANALYSIS_EXPORT QgsZonalStatistics { @@ -68,7 +69,8 @@ class ANALYSIS_EXPORT QgsZonalStatistics int rasterBand = 1, QgsZonalStatistics::Statistics stats = QgsZonalStatistics::Statistics( QgsZonalStatistics::Count | QgsZonalStatistics::Sum | QgsZonalStatistics::Mean ) ); - /** Starts the calculation + /** + * Starts the calculation \returns 0 in case of success*/ int calculateStatistics( QgsFeedback *feedback ); @@ -116,7 +118,8 @@ class ANALYSIS_EXPORT QgsZonalStatistics bool mStoreValueCounts; }; - /** Analysis what cells need to be considered to cover the bounding box of a feature + /** + * Analysis what cells need to be considered to cover the bounding box of a feature \returns 0 in case of success*/ int cellInfoForBBox( const QgsRectangle &rasterBBox, const QgsRectangle &featureBBox, double cellSizeX, double cellSizeY, int &offsetX, int &offsetY, int &nCellsX, int &nCellsY ) const; diff --git a/src/app/composer/qgsatlascompositionwidget.h b/src/app/composer/qgsatlascompositionwidget.h index d6cfd56d6346..13b9000a4633 100644 --- a/src/app/composer/qgsatlascompositionwidget.h +++ b/src/app/composer/qgsatlascompositionwidget.h @@ -21,7 +21,8 @@ class QgsMapLayer; class QgsComposerMap; class QgsComposerItem; -/** \ingroup app +/** + * \ingroup app * Input widget for QgsAtlasComposition */ class QgsAtlasCompositionWidget: diff --git a/src/app/composer/qgscomposer.h b/src/app/composer/qgscomposer.h index a51768a8559c..f8b9f659f0b4 100644 --- a/src/app/composer/qgscomposer.h +++ b/src/app/composer/qgscomposer.h @@ -79,7 +79,8 @@ class QgsAppComposerInterface : public QgsComposerInterface QgsComposer *mComposer = nullptr; }; -/** \ingroup app +/** + * \ingroup app * \brief A gui for composing a printable map. */ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase @@ -122,7 +123,8 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase //! Restore the window and toolbar state void restoreWindowState(); - /** Loads the contents of a template document into the composer's composition. + /** + * Loads the contents of a template document into the composer's composition. * \param templateDoc template document to load * \param clearExisting set to true to remove all existing composition settings and items before loading template * \returns true if template load was successful @@ -619,7 +621,8 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase void dockVisibilityChanged( bool visible ); - /** Repopulates the atlas page combo box with valid items. + /** + * Repopulates the atlas page combo box with valid items. */ void updateAtlasPageComboBox( int pageCount ); diff --git a/src/app/composer/qgscomposerimageexportoptionsdialog.h b/src/app/composer/qgscomposerimageexportoptionsdialog.h index aae30b11f74d..207dc2eae5f2 100644 --- a/src/app/composer/qgscomposerimageexportoptionsdialog.h +++ b/src/app/composer/qgscomposerimageexportoptionsdialog.h @@ -22,7 +22,8 @@ #include "ui_qgscomposerimageexportoptions.h" -/** A dialog for customising the properties of an exported image file. +/** + * A dialog for customising the properties of an exported image file. * \since QGIS 2.12 */ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsComposerImageExportOptionsDialog @@ -31,7 +32,8 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos public: - /** Constructor for QgsComposerImageExportOptionsDialog + /** + * Constructor for QgsComposerImageExportOptionsDialog * \param parent parent widget * \param flags window flags */ @@ -39,46 +41,54 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos ~QgsComposerImageExportOptionsDialog(); - /** Sets the initial resolution displayed in the dialog. + /** + * Sets the initial resolution displayed in the dialog. * \param resolution default resolution in DPI * \see resolution() */ void setResolution( int resolution ); - /** Returns the selected resolution from the dialog. + /** + * Returns the selected resolution from the dialog. * \returns image resolution in DPI * \see setResolution() */ int resolution() const; - /** Sets the target image size. This is used to calculate the default size in pixels + /** + * Sets the target image size. This is used to calculate the default size in pixels * and also for determining the image's width to height ratio. * \param size image size */ void setImageSize( QSizeF size ); - /** Returns the user-set image width in pixels. + /** + * Returns the user-set image width in pixels. * \see imageHeight */ int imageWidth() const; - /** Returns the user-set image height in pixels. + /** + * Returns the user-set image height in pixels. * \see imageWidth */ int imageHeight() const; - /** Sets whether the crop to contents option should be checked in the dialog + /** + * Sets whether the crop to contents option should be checked in the dialog * \param crop set to true to check crop to contents * \see cropToContents() */ void setCropToContents( bool crop ); - /** Returns whether the crop to contents option is checked in the dialog. + /** + * Returns whether the crop to contents option is checked in the dialog. * \see setCropToContents() */ bool cropToContents() const; - /** Fetches the current crop to contents margin values, in pixels. + /** + * Fetches the current crop to contents margin values, in pixels. * \param topMargin destination for top margin * \param rightMargin destination for right margin * \param bottomMargin destination for bottom margin @@ -86,7 +96,8 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos */ void getCropMargins( int &topMargin, int &rightMargin, int &bottomMargin, int &leftMargin ) const; - /** Sets the current crop to contents margin values, in pixels. + /** + * Sets the current crop to contents margin values, in pixels. * \param topMargin top margin * \param rightMargin right margin * \param bottomMargin bottom margin diff --git a/src/app/composer/qgscomposeritemwidget.h b/src/app/composer/qgscomposeritemwidget.h index 703fbb94620f..5a9403ab2e1e 100644 --- a/src/app/composer/qgscomposeritemwidget.h +++ b/src/app/composer/qgscomposeritemwidget.h @@ -45,7 +45,8 @@ class QgsAtlasComposition; // long story short - don't change this without good reason. If you add a new item type, inherit // from QgsComposerItemWidget and trust that everything else has been done for you. -/** An object for property widgets for composer items. All composer config type widgets should contain +/** + * An object for property widgets for composer items. All composer config type widgets should contain * this object. */ class QgsComposerConfigObject: public QObject @@ -54,7 +55,8 @@ class QgsComposerConfigObject: public QObject public: QgsComposerConfigObject( QWidget *parent, QgsComposerObject *composerObject ); - /** Registers a data defined button, setting up its initial value, connections and description. + /** + * Registers a data defined button, setting up its initial value, connections and description. * \param button button to register * \param key corresponding data defined property key */ @@ -96,7 +98,8 @@ class QgsComposerItemBaseWidget: public QgsPanelWidget protected: - /** Registers a data defined button, setting up its initial value, connections and description. + /** + * Registers a data defined button, setting up its initial value, connections and description. * \param button button to register * \param property corresponding data defined property key */ @@ -118,7 +121,8 @@ class QgsComposerItemBaseWidget: public QgsPanelWidget QgsComposerConfigObject *mConfigObject = nullptr; }; -/** A class to enter generic properties for composer items (e.g. background, stroke, frame). +/** + * A class to enter generic properties for composer items (e.g. background, stroke, frame). This widget can be embedded into other item widgets*/ class QgsComposerItemWidget: public QWidget, private Ui::QgsComposerItemWidgetBase { @@ -136,12 +140,14 @@ class QgsComposerItemWidget: public QWidget, private Ui::QgsComposerItemWidgetBa public slots: - /** Set the frame color + /** + * Set the frame color */ void on_mFrameColorButton_colorChanged( const QColor &newFrameColor ); void on_mBackgroundColorButton_clicked(); - /** Set the background color + /** + * Set the background color */ void on_mBackgroundColorButton_colorChanged( const QColor &newBackgroundColor ); // void on_mTransparencySlider_valueChanged( int value ); diff --git a/src/app/composer/qgscomposerlabelwidget.h b/src/app/composer/qgscomposerlabelwidget.h index 23fab5019446..501cc9cf16f5 100644 --- a/src/app/composer/qgscomposerlabelwidget.h +++ b/src/app/composer/qgscomposerlabelwidget.h @@ -23,7 +23,8 @@ class QgsComposerLabel; -/** \ingroup app +/** + * \ingroup app * A widget to enter text, font size, box yes/no for composer labels */ class QgsComposerLabelWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerLabelWidgetBase diff --git a/src/app/composer/qgscomposerlegendlayersdialog.h b/src/app/composer/qgscomposerlegendlayersdialog.h index 40698833bd21..009feea8922d 100644 --- a/src/app/composer/qgscomposerlegendlayersdialog.h +++ b/src/app/composer/qgscomposerlegendlayersdialog.h @@ -19,7 +19,8 @@ class QgsMapLayer; -/** \ingroup app +/** + * \ingroup app * A dialog to add new layers to the legend. * */ class QgsComposerLegendLayersDialog: public QDialog, private Ui::QgsComposerLegendLayersDialogBase diff --git a/src/app/composer/qgscomposerlegendwidget.h b/src/app/composer/qgscomposerlegendwidget.h index ebbaa843e915..8a8fd36f26d5 100644 --- a/src/app/composer/qgscomposerlegendwidget.h +++ b/src/app/composer/qgscomposerlegendwidget.h @@ -26,7 +26,8 @@ class QgsComposerLegend; -/** \ingroup app +/** + * \ingroup app * A widget for setting properties relating to a composer legend. */ class QgsComposerLegendWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerLegendWidgetBase diff --git a/src/app/composer/qgscomposermanager.h b/src/app/composer/qgscomposermanager.h index c5f776c7ceb2..261d90b27fcd 100644 --- a/src/app/composer/qgscomposermanager.h +++ b/src/app/composer/qgscomposermanager.h @@ -55,7 +55,8 @@ class QgsLayoutManagerModel : public QAbstractListModel QgsLayoutManager *mLayoutManager = nullptr; }; -/** A dialog that shows the existing composer instances. Lets the user add new +/** + * A dialog that shows the existing composer instances. Lets the user add new instances and change title of existing ones*/ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase { @@ -72,7 +73,8 @@ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase private: - /** Returns the default templates (key: template name, value: absolute path to template file) + /** + * Returns the default templates (key: template name, value: absolute path to template file) * \param fromUser whether to return user templates from ~/.qgis/composer_templates */ QMap defaultTemplates( bool fromUser = false ) const; @@ -80,7 +82,8 @@ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase QMap templatesFromPath( const QString &path ) const; - /** Open local directory with user's system, creating it if not present + /** + * Open local directory with user's system, creating it if not present */ void openLocalDirectory( const QString &localDirPath ); diff --git a/src/app/composer/qgscomposermapgridwidget.h b/src/app/composer/qgscomposermapgridwidget.h index 63aa348284f5..b34cc999cef5 100644 --- a/src/app/composer/qgscomposermapgridwidget.h +++ b/src/app/composer/qgscomposermapgridwidget.h @@ -22,7 +22,8 @@ #include "qgscomposeritemwidget.h" #include "qgscomposermapgrid.h" -/** \ingroup app +/** + * \ingroup app * Input widget for the configuration of QgsComposerMapGrids * */ class QgsComposerMapGridWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerMapGridWidgetBase diff --git a/src/app/composer/qgscomposermapwidget.h b/src/app/composer/qgscomposermapwidget.h index d1ff0746c012..b1fc3f7cfec2 100644 --- a/src/app/composer/qgscomposermapwidget.h +++ b/src/app/composer/qgscomposermapwidget.h @@ -25,7 +25,8 @@ class QgsMapLayer; class QgsComposerMapOverview; -/** \ingroup app +/** + * \ingroup app * Input widget for the configuration of QgsComposerMap * */ class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerMapWidgetBase diff --git a/src/app/composer/qgscomposerpicturewidget.h b/src/app/composer/qgscomposerpicturewidget.h index dfffc5fb29d7..690ee5ac47e3 100644 --- a/src/app/composer/qgscomposerpicturewidget.h +++ b/src/app/composer/qgscomposerpicturewidget.h @@ -23,7 +23,8 @@ class QgsComposerPicture; -/** \ingroup app +/** + * \ingroup app * A widget for adding an image to a map composition. */ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerPictureWidgetBase @@ -62,7 +63,8 @@ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::Qg //! Sets the picture rotation GUI control value void setPicRotationSpinValue( double r ); - /** Load SVG and pixel-based image previews + /** + * Load SVG and pixel-based image previews * \param collapsed Whether the parent group box is collapsed */ void loadPicturePreviews( bool collapsed ); diff --git a/src/app/composer/qgscomposerscalebarwidget.h b/src/app/composer/qgscomposerscalebarwidget.h index b3f3586589dc..b926c29cf753 100644 --- a/src/app/composer/qgscomposerscalebarwidget.h +++ b/src/app/composer/qgscomposerscalebarwidget.h @@ -22,7 +22,8 @@ class QgsComposerScaleBar; -/** \ingroup app +/** + * \ingroup app * A widget to define the properties of a QgsComposerScaleBarItem. */ class QgsComposerScaleBarWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerScaleBarWidgetBase diff --git a/src/app/composer/qgscomposertablebackgroundcolorsdialog.h b/src/app/composer/qgscomposertablebackgroundcolorsdialog.h index 27a4333147a0..39d1dd2aebf8 100644 --- a/src/app/composer/qgscomposertablebackgroundcolorsdialog.h +++ b/src/app/composer/qgscomposertablebackgroundcolorsdialog.h @@ -25,7 +25,8 @@ class QCheckBox; class QgsColorButton; -/** A dialog for customisation of the cell background colors for a QgsComposerTableV2 +/** + * A dialog for customisation of the cell background colors for a QgsComposerTableV2 * \since QGIS 2.12 */ class QgsComposerTableBackgroundColorsDialog: public QDialog, private Ui::QgsComposerTableBackgroundDialog @@ -33,7 +34,8 @@ class QgsComposerTableBackgroundColorsDialog: public QDialog, private Ui::QgsCom Q_OBJECT public: - /** Constructor for QgsComposerTableBackgroundColorsDialog + /** + * Constructor for QgsComposerTableBackgroundColorsDialog * \param table associated composer table * \param parent parent widget * \param flags window flags diff --git a/src/app/composer/qgscompositionwidget.h b/src/app/composer/qgscompositionwidget.h index ab918da6db54..b3815117e5fc 100644 --- a/src/app/composer/qgscompositionwidget.h +++ b/src/app/composer/qgscompositionwidget.h @@ -20,7 +20,8 @@ class QgsComposition; class QgsComposerMap; -/** \ingroup app +/** + * \ingroup app * Struct to hold map composer paper properties. */ struct QgsCompositionPaper @@ -31,7 +32,8 @@ struct QgsCompositionPaper double mHeight; }; -/** \ingroup app +/** + * \ingroup app * Input widget for QgsComposition */ class QgsCompositionWidget: public QgsPanelWidget, private Ui::QgsCompositionWidgetBase diff --git a/src/app/gps/qgsgpsinformationwidget.h b/src/app/gps/qgsgpsinformationwidget.h index cca2b9af2064..e69fe2a7b008 100644 --- a/src/app/gps/qgsgpsinformationwidget.h +++ b/src/app/gps/qgsgpsinformationwidget.h @@ -37,7 +37,8 @@ struct QgsGPSInformation; class QFile; class QColor; -/** A dock widget that displays information from a GPS device and +/** + * A dock widget that displays information from a GPS device and * allows the user to capture features using gps readings to * specify the geometry.*/ class QgsGPSInformationWidget: public QWidget, private Ui::QgsGPSInformationWidgetBase diff --git a/src/app/gps/qgsgpsmarker.h b/src/app/gps/qgsgpsmarker.h index 7782202479e1..24f93a5d5ae2 100644 --- a/src/app/gps/qgsgpsmarker.h +++ b/src/app/gps/qgsgpsmarker.h @@ -23,7 +23,8 @@ class QPainter; -/** \ingroup app +/** + * \ingroup app * A class for marking the position of a gps pointer. */ class QgsGpsMarker : public QgsMapCanvasItem diff --git a/src/app/main.cpp b/src/app/main.cpp index 21fa78c11d41..4532329938e9 100644 --- a/src/app/main.cpp +++ b/src/app/main.cpp @@ -102,7 +102,8 @@ typedef SInt32 SRefCon; #include "qgsuserprofilemanager.h" #include "qgsuserprofile.h" -/** Print usage text +/** + * Print usage text */ void usage( const QString &appName ) { diff --git a/src/app/nodetool/qgsnodetool.h b/src/app/nodetool/qgsnodetool.h index f34c5009e87f..60d42fc79180 100644 --- a/src/app/nodetool/qgsnodetool.h +++ b/src/app/nodetool/qgsnodetool.h @@ -114,7 +114,8 @@ class APP_EXPORT QgsNodeTool : public QgsMapToolAdvancedDigitizing void removeTemporaryRubberBands(); - /** Temporarily override snapping config and snap to vertices and edges + /** + * Temporarily override snapping config and snap to vertices and edges of any editable vector layer, to allow selection of node for editing (if snapped to edge, it would offer creation of a new vertex there). */ diff --git a/src/app/pluginmanager/qgsapppluginmanagerinterface.h b/src/app/pluginmanager/qgsapppluginmanagerinterface.h index f27b504f310d..c77427cb6e49 100644 --- a/src/app/pluginmanager/qgsapppluginmanagerinterface.h +++ b/src/app/pluginmanager/qgsapppluginmanagerinterface.h @@ -21,7 +21,8 @@ class QgsPluginManager; -/** \ingroup gui +/** + * \ingroup gui * QgsPluginManagerInterface * Abstract base class to make QgsPluginManager available to pyplugin_installer. */ diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp index d2eb74953c48..e22336be991c 100644 --- a/src/app/qgisapp.cpp +++ b/src/app/qgisapp.cpp @@ -418,7 +418,8 @@ class QTreeWidgetItem; class QgsUserProfileManager; class QgsUserProfile; -/** Set the application title bar text +/** + * Set the application title bar text If the current project title is null if the project file is null then @@ -6611,7 +6612,8 @@ void QgisApp::saveAsLayerDefinition() ///@cond PRIVATE -/** Field value converter for export as vector layer +/** + * Field value converter for export as vector layer * \note Not available in Python bindings */ class QgisAppFieldValueConverter : public QgsVectorFileWriter::FieldValueConverter diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h index a25da3f17bdc..7fd1c981728b 100644 --- a/src/app/qgisapp.h +++ b/src/app/qgisapp.h @@ -159,7 +159,8 @@ class QgsGeoCmsProviderRegistry; class QgsLegendFilterButton; -/** \class QgisApp +/** + * \class QgisApp * \brief Main window for the Qgis application */ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow @@ -179,14 +180,16 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QgisApp( QgisApp const & ) = delete; QgisApp &operator=( QgisApp const & ) = delete; - /** Open a raster layer for the given file + /** + * Open a raster layer for the given file \returns false if unable to open a raster layer for rasterFile \note This is essentially a simplified version of the above */ QgsRasterLayer *addRasterLayer( const QString &rasterFile, const QString &baseName, bool guiWarning = true ); - /** Returns and adjusted uri for the layer based on current and available CRS as well as the last selected image format + /** + * Returns and adjusted uri for the layer based on current and available CRS as well as the last selected image format * \since QGIS 2.8 */ QString crsAndFormatAdjustedLayerUri( const QString &uri, const QStringList &supportedCrs, const QStringList &supportedFormats ) const; @@ -197,7 +200,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Set the extents of the map canvas void setExtent( const QgsRectangle &rect ); - /** Open a raster or vector file; ignore other files. + /** + * Open a raster or vector file; ignore other files. Used to process a commandline argument, FileOpen or Drop event. Set interactive to true if it is OK to ask the user for information (mostly for when a vector layer has sublayers and we want to ask which sublayers to use). @@ -205,7 +209,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ bool openLayer( const QString &fileName, bool allowInteractive = false ); - /** Open the specified project file; prompt to save previous project if necessary. + /** + * Open the specified project file; prompt to save previous project if necessary. Used to process a commandline argument, FileOpen or Drop event. */ void openProject( const QString &fileName ); @@ -215,13 +220,15 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Open a composer template file and create a new composition void openTemplate( const QString &fileName ); - /** Attempts to run a Python script + /** + * Attempts to run a Python script * \param filePath full path to Python script * \since QGIS 2.7 */ void runScript( const QString &filePath ); - /** Opens a qgis project file + /** + * Opens a qgis project file \returns false if unable to open the project */ bool addProject( const QString &projectFile ); @@ -305,18 +312,21 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! set up master password void masterPasswordSetup(); - /** Add a dock widget to the main window. Overloaded from QMainWindow. + /** + * Add a dock widget to the main window. Overloaded from QMainWindow. * After adding the dock widget to the ui (by delegating to the QMainWindow * parent class, it will also add it to the View menu list of docks.*/ void addDockWidget( Qt::DockWidgetArea area, QDockWidget *dockwidget ); void removeDockWidget( QDockWidget *dockwidget ); - /** Add a toolbar to the main window. Overloaded from QMainWindow. + /** + * Add a toolbar to the main window. Overloaded from QMainWindow. * After adding the toolbar to the ui (by delegating to the QMainWindow * parent class, it will also add it to the View menu list of toolbars.*/ QToolBar *addToolBar( const QString &name ); - /** Add a toolbar to the main window. Overloaded from QMainWindow. + /** + * Add a toolbar to the main window. Overloaded from QMainWindow. * After adding the toolbar to the ui (by delegating to the QMainWindow * parent class, it will also add it to the View menu list of toolbars. * \since QGIS 2.3 @@ -324,11 +334,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void addToolBar( QToolBar *toolBar, Qt::ToolBarArea area = Qt::TopToolBarArea ); - /** Add window to Window menu. The action title is the window title + /** + * Add window to Window menu. The action title is the window title * and the action should raise, unminimize and activate the window. */ void addWindow( QAction *action ); - /** Remove window from Window menu. Calling this is necessary only for + /** + * Remove window from Window menu. Calling this is necessary only for * windows which are hidden rather than deleted when closed. */ void removeWindow( QAction *action ); @@ -340,7 +352,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ QSet layoutDesigners() const { return mLayoutDesignerDialogs; } - /** Get a unique title from user for new and duplicate composers + /** + * Get a unique title from user for new and duplicate composers * \param acceptEmpty whether to accept empty titles (one will be generated) * \param currentTitle base name for initial title choice * \returns QString() if user cancels input dialog @@ -363,7 +376,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Deletes a composer and removes entry from Set void deleteComposer( QgsComposer *c ); - /** Duplicates a composer and adds it to Set + /** + * Duplicates a composer and adds it to Set */ QgsComposer *duplicateComposer( QgsComposer *currentComposer, QString title = QString() ); @@ -377,7 +391,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ QgsVectorLayerTools *vectorLayerTools() { return mVectorLayerTools; } - /** Notify the user by using the system tray notifications + /** + * Notify the user by using the system tray notifications * * \note usage of the system tray notifications should be limited * to long running tasks and to when the user needs to be notified @@ -543,7 +558,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Toolbars - /** Get a reference to a toolbar. Mainly intended + /** + * Get a reference to a toolbar. Mainly intended * to be used by plugins that want to specifically add * an icon into the file toolbar for consistency e.g. * addWFS and GPS plugins. @@ -588,7 +604,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ QgsUserProfileManager *userProfileManager(); - /** Return vector layers in edit mode + /** + * Return vector layers in edit mode * \param modified whether to return only layers that have been modified * \returns list of layers in legend order, or empty list */ QList editableLayers( bool modified = false ) const; @@ -685,13 +702,15 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Save edits for active vector layer and start new transactions void saveActiveLayerEdits(); - /** Save edits of a layer + /** + * Save edits of a layer * \param leaveEditable leave the layer in editing mode when done * \param triggerRepaint send layer signal to repaint canvas when done */ void saveEdits( QgsMapLayer *layer, bool leaveEditable = true, bool triggerRepaint = true ); - /** Cancel edits for a layer + /** + * Cancel edits for a layer * \param leaveEditable leave the layer in editing mode when done * \param triggerRepaint send layer signal to repaint canvas when done */ @@ -804,7 +823,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ void dataSourceManager( const QString &pageName = QString() ); - /** Add a raster layer directly without prompting user for location + /** + * Add a raster layer directly without prompting user for location The caller must provide information compatible with the provider plugin using the uri and baseName. The provider can use these parameters in any way necessary to initialize the layer. The baseName @@ -813,7 +833,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ QgsRasterLayer *addRasterLayer( QString const &uri, QString const &baseName, QString const &providerKey ); - /** Add a vector layer directly without prompting user for location + /** + * Add a vector layer directly without prompting user for location The caller must provide information compatible with the provider plugin using the vectorLayerPath and baseName. The provider can use these parameters in any way necessary to initialize the layer. The baseName @@ -822,7 +843,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ QgsVectorLayer *addVectorLayer( const QString &vectorLayerPath, const QString &baseName, const QString &providerKey ); - /** \brief overloaded version of the private addLayer method that takes a list of + /** + * \brief overloaded version of the private addLayer method that takes a list of * file names instead of prompting user with a dialog. \param enc encoding type for the layer \param dataSourceType type of ogr datasource @@ -830,7 +852,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ bool addVectorLayers( const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType ); - /** Overloaded version of the private addRasterLayer() + /** + * Overloaded version of the private addRasterLayer() Method that takes a list of file names instead of prompting user with a dialog. \returns true if successfully added layer(s) @@ -850,7 +873,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Opens the options dialog void showOptionsDialog( QWidget *parent = nullptr, const QString ¤tPage = QString() ); - /** Refreshes the state of the layer actions toolbar action + /** + * Refreshes the state of the layer actions toolbar action * \since QGIS 2.1 */ void refreshActionFeatureAction(); @@ -864,7 +888,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! set the active layer bool setActiveLayer( QgsMapLayer * ); - /** Reload connections emitting the connectionsChanged signal + /** + * Reload connections emitting the connectionsChanged signal * \since QGIS 3.0 */ void reloadConnections(); @@ -954,11 +979,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Assign layer CRS to project void setProjectCrsFromLayer(); - /** Zooms so that the pixels of the raster layer occupies exactly one screen pixel. + /** + * Zooms so that the pixels of the raster layer occupies exactly one screen pixel. Only works on raster layers*/ void legendLayerZoomNative(); - /** Stretches the raster layer, if stretching is active, based on the min and max of the current extent. + /** + * Stretches the raster layer, if stretching is active, based on the min and max of the current extent. Only workds on raster layers*/ void legendLayerStretchUsingCurrentExtent(); @@ -975,12 +1002,14 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! zoom to actual size of raster layer void zoomActualSize(); - /** Perform a local histogram stretch on the active raster layer + /** + * Perform a local histogram stretch on the active raster layer * (stretch based on pixel values in view extent). * Valid for non wms raster layers only. */ void localHistogramStretch(); - /** Perform a full histogram stretch on the active raster layer + /** + * Perform a full histogram stretch on the active raster layer * (stretch based on pixels values in full dataset) * Valid for non wms raster layers only. */ void fullHistogramStretch(); @@ -989,19 +1018,23 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Perform a full extent cumulative cut stretch void fullCumulativeCutStretch(); - /** Increase raster brightness + /** + * Increase raster brightness * Valid for non wms raster layers only. */ void increaseBrightness(); - /** Decrease raster brightness + /** + * Decrease raster brightness * Valid for non wms raster layers only. */ void decreaseBrightness(); - /** Increase raster contrast + /** + * Increase raster contrast * Valid for non wms raster layers only. */ void increaseContrast(); - /** Decrease raster contrast + /** + * Decrease raster contrast * Valid for non wms raster layers only. */ void decreaseContrast(); //! plugin manager @@ -1009,7 +1042,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! load Python support if possible void loadPythonSupport(); - /** Install plugin from ZIP file + /** + * Install plugin from ZIP file * \since QGIS 3.0 */ void installPluginFromZip(); @@ -1329,11 +1363,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Update the label toolbar buttons void updateLabelToolButtons(); - /** Activates or deactivates actions depending on the current maplayer type. + /** + * Activates or deactivates actions depending on the current maplayer type. Is called from the legend when the current legend item has changed*/ void activateDeactivateLayerRelatedActions( QgsMapLayer *layer ); - /** \brief Open one or more raster layers and add to the map + /** + * \brief Open one or more raster layers and add to the map * Will prompt user for file names using a file selection dialog */ void addRasterLayer(); @@ -1486,30 +1522,36 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Deletes the active QgsComposerManager instance void deleteComposerManager(); - /** Disable any preview modes shown on the map canvas + /** + * Disable any preview modes shown on the map canvas * \since QGIS 2.3 */ void disablePreviewMode(); - /** Enable a grayscale preview mode on the map canvas + /** + * Enable a grayscale preview mode on the map canvas * \since QGIS 2.3 */ void activateGrayscalePreview(); - /** Enable a monochrome preview mode on the map canvas + /** + * Enable a monochrome preview mode on the map canvas * \since QGIS 2.3 */ void activateMonoPreview(); - /** Enable a color blindness (protanope) preview mode on the map canvas + /** + * Enable a color blindness (protanope) preview mode on the map canvas * \since QGIS 2.3 */ void activateProtanopePreview(); - /** Enable a color blindness (deuteranope) preview mode on the map canvas + /** + * Enable a color blindness (deuteranope) preview mode on the map canvas * \since QGIS 2.3 */ void activateDeuteranopePreview(); void toggleFilterLegendByExpression( bool ); void updateFilterLegend(); - /** Shows the statistical summary dock widget and brings it to the foreground + /** + * Shows the statistical summary dock widget and brings it to the foreground */ void showStatisticsDockWidget(); @@ -1533,11 +1575,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ void connectionsChanged(); - /** Emitted when a key is pressed and we want non widget sublasses to be able + /** + * Emitted when a key is pressed and we want non widget sublasses to be able to pick up on this (e.g. maplayer) */ void keyPressed( QKeyEvent *e ); - /** Emitted when a project file is successfully read + /** + * Emitted when a project file is successfully read \note This is useful for plug-ins that store properties with project files. A plug-in can connect to this signal. When it is emitted, the plug-in @@ -1545,7 +1589,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ void projectRead(); - /** Emitted when starting an entirely new project + /** + * Emitted when starting an entirely new project \note This is similar to projectRead(); plug-ins might want to be notified that they're in a new project. Yes, projectRead() could have been @@ -1555,7 +1600,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow */ void newProject(); - /** Signal emitted when the current theme is changed so plugins + /** + * Signal emitted when the current theme is changed so plugins * can change there tool button icons. */ void currentThemeChanged( const QString & ); @@ -1604,7 +1650,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void customCrsValidation( QgsCoordinateReferenceSystem &crs ); - /** This signal is emitted when a layer has been saved using save as + /** + * This signal is emitted when a layer has been saved using save as \since QGIS 2.7 */ void layerSavedAs( QgsMapLayer *l, const QString &path ); @@ -1614,24 +1661,29 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void endProfile(); void functionProfile( void ( QgisApp::*fnc )(), QgisApp *instance, const QString &name ); - /** This method will open a dialog so the user can select GDAL sublayers to load + /** + * This method will open a dialog so the user can select GDAL sublayers to load * \returns true if any items were loaded */ bool askUserForZipItemLayers( const QString &path ); - /** This method will open a dialog so the user can select GDAL sublayers to load + /** + * This method will open a dialog so the user can select GDAL sublayers to load */ void askUserForGDALSublayers( QgsRasterLayer *layer ); - /** This method will verify if a GDAL layer contains sublayers + /** + * This method will verify if a GDAL layer contains sublayers */ bool shouldAskUserForGDALSublayers( QgsRasterLayer *layer ); - /** This method will open a dialog so the user can select OGR sublayers to load + /** + * This method will open a dialog so the user can select OGR sublayers to load */ void askUserForOGRSublayers( QgsVectorLayer *layer ); - /** Add a raster layer to the map (passed in as a ptr). + /** + * Add a raster layer to the map (passed in as a ptr). * It won't force a refresh. */ bool addRasterLayer( QgsRasterLayer *rasterLayer ); @@ -1641,7 +1693,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow const QString &providerKey, bool guiWarning, bool guiUpdate ); - /** Add this file to the recently opened/saved projects list + /** + * Add this file to the recently opened/saved projects list * pass settings by reference since creating more than one * instance simultaneously results in data loss. * @@ -1659,7 +1712,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Checks for running tasks dependent on the open project bool checkTasksDependOnProject(); - /** Helper function to union several geometries together (used in function mergeSelectedFeatures) + /** + * Helper function to union several geometries together (used in function mergeSelectedFeatures) \returns empty geometry in case of error or if canceled */ QgsGeometry unionGeometries( const QgsVectorLayer *vl, QgsFeatureList &featureList, bool &canceled ); @@ -1674,7 +1728,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void saveAsVectorFileGeneral( QgsVectorLayer *vlayer = nullptr, bool symbologyOption = true ); - /** Paste features from clipboard into a new memory layer. + /** + * Paste features from clipboard into a new memory layer. * If no features are in clipboard an empty layer is returned. * \returns pointer to a new layer or 0 if failed */ @@ -1916,12 +1971,14 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow //! Flag to indicate how the project properties dialog was summoned bool mShowProjectionTab = false; - /** String containing supporting vector file formats + /** + * String containing supporting vector file formats Suitable for a QFileDialog file filter. Build in ctor. */ QString mVectorFileFilter; - /** String containing supporting raster file formats + /** + * String containing supporting raster file formats Suitable for a QFileDialog file filter. Build in ctor. */ QString mRasterFileFilter; diff --git a/src/app/qgisappinterface.h b/src/app/qgisappinterface.h index 5b5851b7c354..ffef99c0c24c 100644 --- a/src/app/qgisappinterface.h +++ b/src/app/qgisappinterface.h @@ -25,7 +25,8 @@ class QgisApp; -/** \class QgisAppInterface +/** + * \class QgisAppInterface * \brief Interface class to provide access to private methods in QgisApp * for use by plugins. * @@ -175,7 +176,8 @@ class APP_EXPORT QgisAppInterface : public QgisInterface */ void addToolBar( QToolBar *toolbar, Qt::ToolBarArea area = Qt::TopToolBarArea ) override; - /** Open a url in the users browser. By default the QGIS doc directory is used + /** + * Open a url in the users browser. By default the QGIS doc directory is used * as the base for the URL. To open a URL that is not relative to the installed * QGIS documentation, set useQgisDocDirectory to false. * \param url URL to open @@ -203,7 +205,8 @@ class APP_EXPORT QgisAppInterface : public QgisInterface */ QgsLayerTreeMapCanvasBridge *layerTreeCanvasBridge() override; - /** Gives access to main QgisApp object + /** + * Gives access to main QgisApp object Plugins don't need to know about QgisApp, as we pass it as QWidget, it can be used for connecting slots and using as widget's parent @@ -230,7 +233,8 @@ class APP_EXPORT QgisAppInterface : public QgisInterface //! Return changeable options built from settings and/or defaults QMap defaultStyleSheetOptions() override; - /** Generate stylesheet + /** + * Generate stylesheet * \param opts generated default option values, or a changed copy of them */ void buildStyleSheet( const QMap &opts ) override; @@ -279,21 +283,25 @@ class APP_EXPORT QgisAppInterface : public QgisInterface //! return CAD dock widget QgsAdvancedDigitizingDockWidget *cadDockWidget() override; - /** Show layer properties dialog for layer + /** + * Show layer properties dialog for layer * \param l layer to show properties table for */ virtual void showLayerProperties( QgsMapLayer *l ) override; - /** Show layer attribute dialog for layer + /** + * Show layer attribute dialog for layer * \param l layer to show attribute table for */ virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) override; - /** Add window to Window menu. The action title is the window title + /** + * Add window to Window menu. The action title is the window title * and the action should raise, unminimize and activate the window. */ virtual void addWindow( QAction *action ) override; - /** Remove window from Window menu. Calling this is necessary only for + /** + * Remove window from Window menu. Calling this is necessary only for * windows which are hidden rather than deleted when closed. */ virtual void removeWindow( QAction *action ) override; @@ -309,19 +317,22 @@ class APP_EXPORT QgisAppInterface : public QgisInterface virtual void registerOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) override; virtual void unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) override; - /** Register a new custom drop handler. + /** + * Register a new custom drop handler. * \since QGIS 3.0 * \note Ownership of the factory is not transferred, and the factory must * be unregistered when plugin is unloaded. * \see unregisterCustomDropHandler() */ virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) override; - /** Unregister a previously registered custom drop handler. + /** + * Unregister a previously registered custom drop handler. * \since QGIS 3.0 * \see registerCustomDropHandler() */ virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) override; - /** Accessors for inserting items into menus and toolbars. + /** + * Accessors for inserting items into menus and toolbars. * An item can be inserted before any existing action. */ @@ -489,7 +500,8 @@ class APP_EXPORT QgisAppInterface : public QgisInterface */ virtual QgsVectorLayerTools *vectorLayerTools() override; - /** This method is only needed when using a UI form with a custom widget plugin and calling + /** + * This method is only needed when using a UI form with a custom widget plugin and calling * openFeatureForm or getFeatureForm from Python (PyQt4) and you haven't used the info tool first. * Python will crash bringing QGIS with it * if the custom form is not loaded from a C++ method call. @@ -502,7 +514,8 @@ class APP_EXPORT QgisAppInterface : public QgisInterface */ virtual void preloadForm( const QString &uifile ) override; - /** Return vector layers in edit mode + /** + * Return vector layers in edit mode * \param modified whether to return only layers that have been modified * \returns list of layers in legend order, or empty list */ diff --git a/src/app/qgisappstylesheet.h b/src/app/qgisappstylesheet.h index 8ef057df7730..1e457f183bc9 100644 --- a/src/app/qgisappstylesheet.h +++ b/src/app/qgisappstylesheet.h @@ -23,7 +23,8 @@ #include #include "qgis_app.h" -/** \class QgisAppStyleSheet +/** + * \class QgisAppStyleSheet * \brief Adjustable stylesheet for the Qgis application */ class APP_EXPORT QgisAppStyleSheet: public QObject @@ -36,7 +37,8 @@ class APP_EXPORT QgisAppStyleSheet: public QObject //! Return changeable options built from settings and/or defaults QMap defaultOptions(); - /** Generate stylesheet + /** + * Generate stylesheet * \param opts generated default option values, or a changed copy of them * \note on success emits appStyleSheetChanged */ @@ -50,7 +52,8 @@ class APP_EXPORT QgisAppStyleSheet: public QObject signals: - /** Signal the successful stylesheet build results + /** + * Signal the successful stylesheet build results * \note connect to (app|widget)->setStyleSheet or similar custom slot */ void appStyleSheetChanged( const QString &appStyleSheet ); diff --git a/src/app/qgsannotationwidget.h b/src/app/qgsannotationwidget.h index 76b9d67367a1..c6d3fff672ea 100644 --- a/src/app/qgsannotationwidget.h +++ b/src/app/qgsannotationwidget.h @@ -26,7 +26,8 @@ class QgsMapCanvasAnnotationItem; class QgsMarkerSymbol; class QgsFillSymbol; -/** A configuration widget to configure the annotation item properties. Usually embedded by QgsAnnotation +/** + * A configuration widget to configure the annotation item properties. Usually embedded by QgsAnnotation subclass configuration dialogs*/ class APP_EXPORT QgsAnnotationWidget: public QWidget, private Ui::QgsAnnotationWidgetBase { diff --git a/src/app/qgsclipboard.h b/src/app/qgsclipboard.h index 4e65c495ac1d..d77eee6bea11 100644 --- a/src/app/qgsclipboard.h +++ b/src/app/qgsclipboard.h @@ -149,25 +149,29 @@ class APP_EXPORT QgsClipboard : public QObject */ void setSystemClipboard(); - /** Creates a text representation of the clipboard features. + /** + * Creates a text representation of the clipboard features. * \returns clipboard text, respecting user export format */ QString generateClipboardText() const; - /** Attempts to convert a string to a list of features, by parsing the string as WKT and GeoJSON + /** + * Attempts to convert a string to a list of features, by parsing the string as WKT and GeoJSON * \param string string to convert * \param fields fields for resultant features * \returns list of features if conversion was successful */ QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields ) const; - /** Attempts to parse the clipboard contents and return a QgsFields object representing the fields + /** + * Attempts to parse the clipboard contents and return a QgsFields object representing the fields * present in the clipboard. * \note Only valid for text based clipboard contents */ QgsFields retrieveFields() const; - /** QGIS-internal vector feature clipboard. + /** + * QGIS-internal vector feature clipboard. Stored as values not pointers as each clipboard operation involves a deep copy anyway. */ diff --git a/src/app/qgsdecorationgrid.h b/src/app/qgsdecorationgrid.h index 977eed602291..8b6faea78dba 100644 --- a/src/app/qgsdecorationgrid.h +++ b/src/app/qgsdecorationgrid.h @@ -196,32 +196,37 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem QgsUnitTypes::DistanceUnit mMapUnits; - /** Draw coordinates for mGridAnnotationType Coordinate + /** + * Draw coordinates for mGridAnnotationType Coordinate \param p drawing painter \param hLines horizontal coordinate lines in item coordinates \param vLines vertical coordinate lines in item coordinates*/ void drawCoordinateAnnotations( QPainter *p, const QList< QPair< qreal, QLineF > > &hLines, const QList< QPair< qreal, QLineF > > &vLines ); void drawCoordinateAnnotation( QPainter *p, QPointF pos, const QString &annotationString ); - /** Draws a single annotation + /** + * Draws a single annotation \param p drawing painter \param pos item coordinates where to draw \param rotation text rotation \param annotationText the text to draw*/ void drawAnnotation( QPainter *p, QPointF pos, int rotation, const QString &annotationText ); - /** Returns the grid lines with associated coordinate value + /** + * Returns the grid lines with associated coordinate value \returns 0 in case of success*/ int xGridLines( const QgsMapSettings &mapSettings, QList< QPair< qreal, QLineF > > &lines ) const; - /** Returns the grid lines for the y-coordinates. Not vertical in case of rotation + /** + * Returns the grid lines for the y-coordinates. Not vertical in case of rotation \returns 0 in case of success*/ int yGridLines( const QgsMapSettings &mapSettings, QList< QPair< qreal, QLineF > > &lines ) const; //! Returns the item border of a point (in item coordinates) Border borderForLineCoord( QPointF point, QPainter *p ) const; - /** Draws Text. Takes care about all the composer specific issues (calculation to pixel, scaling of font and painter + /** + * Draws Text. Takes care about all the composer specific issues (calculation to pixel, scaling of font and painter to work around the Qt font bug)*/ void drawText( QPainter *p, double x, double y, const QString &text, const QFont &font ) const; //! Like the above, but with a rectangle for multiline text diff --git a/src/app/qgsdecorationitem.h b/src/app/qgsdecorationitem.h index a81e5c6fd776..6c3f307e0ab9 100644 --- a/src/app/qgsdecorationitem.h +++ b/src/app/qgsdecorationitem.h @@ -49,12 +49,14 @@ class APP_EXPORT QgsDecorationItem : public QObject, public QgsMapDecoration void setEnabled( bool enabled ) { mEnabled = enabled; } bool enabled() const { return mEnabled; } - /** Returns the current placement for the item. + /** + * Returns the current placement for the item. * \see setPlacement() */ Placement placement() const { return mPlacement; } - /** Sets the placement of the item. + /** + * Sets the placement of the item. * \see placement() */ void setPlacement( Placement placement ) { mPlacement = placement; } diff --git a/src/app/qgsdisplayangle.h b/src/app/qgsdisplayangle.h index ae4dd5ca78ec..961b5149bd7f 100644 --- a/src/app/qgsdisplayangle.h +++ b/src/app/qgsdisplayangle.h @@ -29,7 +29,8 @@ class APP_EXPORT QgsDisplayAngle: public QDialog, private Ui::QgsDisplayAngleBas public: QgsDisplayAngle( QgsMapToolMeasureAngle *tool = nullptr, Qt::WindowFlags f = 0 ); - /** Sets the measured angle value (in radians). The value is going to + /** + * Sets the measured angle value (in radians). The value is going to be converted to degrees / gon automatically if necessary*/ void setValueInRadians( double value ); diff --git a/src/app/qgsfieldsproperties.h b/src/app/qgsfieldsproperties.h index bedf6134a831..6960a9b9e3de 100644 --- a/src/app/qgsfieldsproperties.h +++ b/src/app/qgsfieldsproperties.h @@ -128,12 +128,14 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope ~QgsFieldsProperties(); - /** Adds an attribute to the table (but does not commit it yet) + /** + * Adds an attribute to the table (but does not commit it yet) \param field the field to add \returns false in case of a name conflict, true in case of success */ bool addAttribute( const QgsField &field ); - /** Creates the a proper item to save from the tree + /** + * Creates the a proper item to save from the tree * \returns A widget definition. Containing another container or the final field */ QgsAttributeEditorElement *createAttributeEditorWidget( QTreeWidgetItem *item, QgsAttributeEditorElement *parent, bool forceGroup = true ); diff --git a/src/app/qgslabelpropertydialog.h b/src/app/qgslabelpropertydialog.h index 55b0a33a6b55..c751b94c9294 100644 --- a/src/app/qgslabelpropertydialog.h +++ b/src/app/qgslabelpropertydialog.h @@ -40,7 +40,8 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro signals: - /** Emitted when dialog settings are applied + /** + * Emitted when dialog settings are applied * \since QGIS 2.9 */ void applied(); diff --git a/src/app/qgslayerstylingwidget.h b/src/app/qgslayerstylingwidget.h index c37f7d087047..30eaeec9a406 100644 --- a/src/app/qgslayerstylingwidget.h +++ b/src/app/qgslayerstylingwidget.h @@ -55,7 +55,8 @@ class APP_EXPORT QgsMapLayerStyleCommand : public QUndoCommand public: QgsMapLayerStyleCommand( QgsMapLayer *layer, const QString &text, const QDomNode ¤t, const QDomNode &last ); - /** Return unique ID for this kind of undo command. + /** + * Return unique ID for this kind of undo command. * Currently we do not have a central registry of undo command IDs, so it is a random magic number. */ virtual int id() const override { return 0xbeef; } @@ -94,7 +95,8 @@ class APP_EXPORT QgsLayerStylingWidget : public QWidget, private Ui::QgsLayerSty void setPageFactories( const QList &factories ); - /** Sets whether updates of the styling widget are blocked. This can be called to prevent + /** + * Sets whether updates of the styling widget are blocked. This can be called to prevent * the widget being refreshed multiple times when a batch of layer style changes are * about to be applied * \param blocked set to true to block updates, or false to re-allow updates @@ -112,7 +114,8 @@ class APP_EXPORT QgsLayerStylingWidget : public QWidget, private Ui::QgsLayerSty void redo(); void updateCurrentWidgetLayer(); - /** Sets the current visible page in the widget. + /** + * Sets the current visible page in the widget. * \param page standard page to display */ void setCurrentPage( Page page ); diff --git a/src/app/qgsmapsavedialog.h b/src/app/qgsmapsavedialog.h index 4b5cdd10f60f..49290a7c84c9 100644 --- a/src/app/qgsmapsavedialog.h +++ b/src/app/qgsmapsavedialog.h @@ -29,7 +29,8 @@ #include #include -/** \ingroup app +/** + * \ingroup app * \brief a dialog for saving a map to an image. * \since QGIS 3.0 */ @@ -45,7 +46,8 @@ class APP_EXPORT QgsMapSaveDialog: public QDialog, private Ui::QgsMapSaveDialog Pdf // PDF-specific dialog }; - /** Constructor for QgsMapSaveDialog + /** + * Constructor for QgsMapSaveDialog */ QgsMapSaveDialog( QWidget *parent = nullptr, QgsMapCanvas *mapCanvas = nullptr, const QList< QgsDecorationItem * > &decorations = QList< QgsDecorationItem * >(), diff --git a/src/app/qgsmapthemes.h b/src/app/qgsmapthemes.h index f3cdf022855f..00e25276060a 100644 --- a/src/app/qgsmapthemes.h +++ b/src/app/qgsmapthemes.h @@ -38,7 +38,8 @@ class APP_EXPORT QgsMapThemes : public QObject Q_OBJECT public: - /** Returns the instance QgsVisibilityPresets. + /** + * Returns the instance QgsVisibilityPresets. */ static QgsMapThemes *instance(); diff --git a/src/app/qgsmaptooladdcircularstring.h b/src/app/qgsmaptooladdcircularstring.h index 19a5bd0e23c8..3e29b854fdff 100644 --- a/src/app/qgsmaptooladdcircularstring.h +++ b/src/app/qgsmaptooladdcircularstring.h @@ -39,7 +39,8 @@ class QgsMapToolAddCircularString: public QgsMapToolCapture protected: - /** The parent map tool, e.g. the add feature tool. + /** + * The parent map tool, e.g. the add feature tool. * Completed circular strings will be added to this tool by calling its addCurve() method. * */ QgsMapToolCapture *mParentTool = nullptr; diff --git a/src/app/qgsmaptooladdfeature.h b/src/app/qgsmaptooladdfeature.h index fff4a79af244..8b4688e481f5 100644 --- a/src/app/qgsmaptooladdfeature.h +++ b/src/app/qgsmaptooladdfeature.h @@ -45,7 +45,8 @@ class APP_EXPORT QgsMapToolAddFeature : public QgsMapToolCapture private: - /** Check if CaptureMode matches layer type. Default is true. + /** + * Check if CaptureMode matches layer type. Default is true. * \since QGIS 2.12 */ bool mCheckGeometryType; }; diff --git a/src/app/qgsmaptoolchangelabelproperties.h b/src/app/qgsmaptoolchangelabelproperties.h index 09eba08ec754..350b4093ebf7 100644 --- a/src/app/qgsmaptoolchangelabelproperties.h +++ b/src/app/qgsmaptoolchangelabelproperties.h @@ -33,7 +33,8 @@ class APP_EXPORT QgsMapToolChangeLabelProperties: public QgsMapToolLabel protected: - /** Applies the label property changes + /** + * Applies the label property changes * \param changes attribute map of changes * \since QGIS 2.9 */ diff --git a/src/app/qgsmaptooldeletering.h b/src/app/qgsmaptooldeletering.h index 22ca46e68e62..bbac9612c758 100644 --- a/src/app/qgsmaptooldeletering.h +++ b/src/app/qgsmaptooldeletering.h @@ -51,7 +51,8 @@ class APP_EXPORT QgsMapToolDeleteRing : public QgsMapToolEdit //! return ring number in multipolygon and set parNum to index of the part int ringNumInMultiPolygon( const QgsGeometry &g, int vertexNr, int &partNum ); - /** Return the geometry of the ring under the point p and sets fid to the feature id, + /** + * Return the geometry of the ring under the point p and sets fid to the feature id, * partNum to the part number in the feature and ringNum to the ring number in the part */ QgsGeometry ringUnderPoint( const QgsPointXY &p, QgsFeatureId &fid, int &partNum, int &ringNum ); diff --git a/src/app/qgsmaptoolfillring.h b/src/app/qgsmaptoolfillring.h index 0729a7f6909f..76411adb76fd 100644 --- a/src/app/qgsmaptoolfillring.h +++ b/src/app/qgsmaptoolfillring.h @@ -17,7 +17,8 @@ #include "qgsmaptoolcapture.h" #include "qgis_app.h" -/** A tool to cut holes into polygon and multipolygon features and fill them +/** + * A tool to cut holes into polygon and multipolygon features and fill them * with new feature. Attributes are copied from parent feature. * */ class APP_EXPORT QgsMapToolFillRing: public QgsMapToolCapture @@ -29,7 +30,8 @@ class APP_EXPORT QgsMapToolFillRing: public QgsMapToolCapture private: - /** Return the geometry of the ring under the point p and sets fid to the feature id + /** + * Return the geometry of the ring under the point p and sets fid to the feature id */ QgsGeometry ringUnderPoint( const QgsPointXY &p, QgsFeatureId &fid ); diff --git a/src/app/qgsmaptoollabel.h b/src/app/qgsmaptoollabel.h index a8c62578173c..055ce2bea257 100644 --- a/src/app/qgsmaptoollabel.h +++ b/src/app/qgsmaptoollabel.h @@ -33,35 +33,41 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool QgsMapToolLabel( QgsMapCanvas *canvas ); ~QgsMapToolLabel(); - /** Returns true if label move can be applied to a layer + /** + * Returns true if label move can be applied to a layer \param xCol out: index of the attribute for data defined x coordinate \param yCol out: index of the attribute for data defined y coordinate \returns true if labels of layer can be moved*/ bool labelMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; bool labelMoveable( QgsVectorLayer *vlayer, const QgsPalLayerSettings &settings, int &xCol, int &yCol ) const; - /** Returns true if diagram move can be applied to a layer + /** + * Returns true if diagram move can be applied to a layer \param xCol out: index of the attribute for data defined x coordinate \param yCol out: index of the attribute for data defined y coordinate \returns true if labels of layer can be moved*/ bool diagramMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; - /** Returns true if layer has attribute fields set up + /** + * Returns true if layer has attribute fields set up \param xCol out: index of the attribute for data defined x coordinate \param yCol out: index of the attribute for data defined y coordinate \returns true if layer fields set up and exist*/ bool layerCanPin( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; - /** Returns true if layer has attribute field set up for diagrams + /** + * Returns true if layer has attribute field set up for diagrams \param showCol out: attribute column for data defined diagram showing \since QGIS 2.16 */ bool diagramCanShowHide( QgsVectorLayer *vlayer, int &showCol ) const; - /** Returns true if layer has attribute field set up + /** + * Returns true if layer has attribute field set up \param showCol out: attribute column for data defined label showing*/ bool labelCanShowHide( QgsVectorLayer *vlayer, int &showCol ) const; - /** Checks if labels in a layer can be rotated + /** + * Checks if labels in a layer can be rotated \param rotationCol out: attribute column for data defined label rotation*/ bool layerIsRotatable( QgsVectorLayer *layer, int &rotationCol ) const; bool labelIsRotatable( QgsVectorLayer *layer, const QgsPalLayerSettings &settings, int &rotationCol ) const; @@ -86,13 +92,15 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool LabelDetails mCurrentLabel; - /** Returns label position for mouse click location + /** + * Returns label position for mouse click location \param e mouse event \param p out: label position \returns true in case of success, false if no label at this location*/ bool labelAtPosition( QMouseEvent *e, QgsLabelPosition &p ); - /** Finds out rotation point of current label position + /** + * Finds out rotation point of current label position \param ignoreUpsideDown treat label as right-side-up \returns true in case of success*/ bool currentLabelRotationPoint( QgsPointXY &pos, bool ignoreUpsideDown = false, bool rotatingUnpinned = false ); @@ -103,13 +111,15 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool //! Removes label / feature / fixpoint rubber bands void deleteRubberBands(); - /** Returns current label's text + /** + * Returns current label's text \param trunc number of chars to truncate to, with ... added */ QString currentLabelText( int trunc = 0 ); void currentAlignment( QString &hali, QString &vali ); - /** Gets vector feature for current label pos + /** + * Gets vector feature for current label pos \returns true in case of success*/ bool currentFeature( QgsFeature &f, bool fetchGeom = false ); @@ -119,14 +129,16 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool //! Returns a data defined attribute column name for particular property or empty string if not defined QString dataDefinedColumnName( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings ) const; - /** Returns a data defined attribute column index + /** + * Returns a data defined attribute column index \returns -1 if column does not exist or an expression is used instead */ int dataDefinedColumnIndex( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings, const QgsVectorLayer *vlayer ) const; //! Returns whether to preserve predefined rotation data during label pin/unpin operations bool currentLabelPreserveRotation(); - /** Get data defined position of current label + /** + * Get data defined position of current label \param x out: data defined x-coordinate \param xSuccess out: false if attribute value is NULL \param y out: data defined y-coordinate @@ -136,7 +148,8 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool \returns false if layer does not have data defined label position enabled*/ bool currentLabelDataDefinedPosition( double &x, bool &xSuccess, double &y, bool &ySuccess, int &xCol, int &yCol ) const; - /** Returns data defined rotation of current label + /** + * Returns data defined rotation of current label \param rotation out: rotation value \param rotationSuccess out: false if rotation value is NULL \param rCol out: index of the rotation column @@ -145,7 +158,8 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool */ bool currentLabelDataDefinedRotation( double &rotation, bool &rotationSuccess, int &rCol, bool ignoreXY = false ) const; - /** Returns data defined show/hide of a feature. + /** + * Returns data defined show/hide of a feature. \param vlayer vector layer \param featureId feature identification integer \param show out: show/hide value @@ -155,7 +169,8 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool */ bool dataDefinedShowHide( QgsVectorLayer *vlayer, QgsFeatureId featureId, int &show, bool &showSuccess, int &showCol ) const; - /** Returns the pin status for the current label/diagram + /** + * Returns the pin status for the current label/diagram \returns true if the label/diagram is pinned, false otherwise \since QGIS 2.16 */ diff --git a/src/app/qgsmaptooloffsetpointsymbol.h b/src/app/qgsmaptooloffsetpointsymbol.h index 26136f459214..7d393de3ffce 100644 --- a/src/app/qgsmaptooloffsetpointsymbol.h +++ b/src/app/qgsmaptooloffsetpointsymbol.h @@ -23,7 +23,8 @@ class QgsMarkerSymbol; class QgsPointMarkerItem; -/** \ingroup app +/** + * \ingroup app * \class QgsMapToolOffsetPointSymbol * \brief A class that allows interactive manipulation of the offset field(s) for point layers. */ @@ -40,7 +41,8 @@ class APP_EXPORT QgsMapToolOffsetPointSymbol: public QgsMapToolPointSymbol void canvasMoveEvent( QgsMapMouseEvent *e ) override; void canvasReleaseEvent( QgsMapMouseEvent *e ) override; - /** Returns true if the symbols of a map layer can be offset. This means the layer + /** + * Returns true if the symbols of a map layer can be offset. This means the layer * is a vector layer, has type point or multipoint and has at least one offset attribute in the renderer. */ static bool layerIsOffsetable( QgsMapLayer *ml ); @@ -80,7 +82,8 @@ class APP_EXPORT QgsMapToolOffsetPointSymbol: public QgsMapToolPointSymbol */ QMap< int, QVariant > calculateNewOffsetAttributes( const QgsPointXY &startPoint, const QgsPointXY &endPoint ) const; - /** Updates the preview item to reflect a new offset. + /** + * Updates the preview item to reflect a new offset. * \note start and end points are in map units */ void updateOffsetPreviewItem( const QgsPointXY &startPoint, const QgsPointXY &endPoint ); diff --git a/src/app/qgsmaptoolpointsymbol.h b/src/app/qgsmaptoolpointsymbol.h index 7221ac23b98c..c16739733527 100644 --- a/src/app/qgsmaptoolpointsymbol.h +++ b/src/app/qgsmaptoolpointsymbol.h @@ -22,7 +22,8 @@ class QgsMarkerSymbol; -/** \ingroup app +/** + * \ingroup app * \class QgsMapToolPointSymbol * \brief An abstract base class that allows interactive manipulation of the symbols for point layers. Handles * snapping the mouse press to a feature, and detecting whether the clicked feature has symbology which is diff --git a/src/app/qgsmaptoolrotatepointsymbols.h b/src/app/qgsmaptoolrotatepointsymbols.h index 2e2b0c9f882d..7f9df20a08b9 100644 --- a/src/app/qgsmaptoolrotatepointsymbols.h +++ b/src/app/qgsmaptoolrotatepointsymbols.h @@ -23,7 +23,8 @@ class QgsPointRotationItem; class QgsMarkerSymbol; -/** \ingroup app +/** + * \ingroup app * \class QgsMapToolRotatePointSymbols * \brief A class that allows interactive manipulation the value of the rotation field(s) for point layers. */ @@ -40,7 +41,8 @@ class APP_EXPORT QgsMapToolRotatePointSymbols: public QgsMapToolPointSymbol void canvasMoveEvent( QgsMapMouseEvent *e ) override; void canvasReleaseEvent( QgsMapMouseEvent *e ) override; - /** Returns true if the symbols of a maplayer can be rotated. This means the layer + /** + * Returns true if the symbols of a maplayer can be rotated. This means the layer is a vector layer, has type point or multipoint and has at least one rotation attribute in the renderer*/ static bool layerIsRotatable( QgsMapLayer *ml ); diff --git a/src/app/qgsmaptoolselectutils.h b/src/app/qgsmaptoolselectutils.h index 4b1f9803c8a0..3e97056a7cf4 100644 --- a/src/app/qgsmaptoolselectutils.h +++ b/src/app/qgsmaptoolselectutils.h @@ -33,7 +33,8 @@ class QgsRubberBand; namespace QgsMapToolSelectUtils { - /** Calculates a list of features matching a selection geometry and flags. + /** + * Calculates a list of features matching a selection geometry and flags. * \param canvas the map canvas used to get the current selected vector layer and for any required geometry transformations * \param selectGeometry the geometry to select the layers features. This geometry diff --git a/src/app/qgsmeasuredialog.h b/src/app/qgsmeasuredialog.h index 62c87b915a42..bf63eeb919ea 100644 --- a/src/app/qgsmeasuredialog.h +++ b/src/app/qgsmeasuredialog.h @@ -82,7 +82,8 @@ class APP_EXPORT QgsMeasureDialog : public QDialog, private Ui::QgsMeasureBase //! shows/hides table, shows correct units void updateUi(); - /** Resets the units combo box to display either distance or area units + /** + * Resets the units combo box to display either distance or area units * \param isArea set to true to populate with areal units, or false to show distance units */ void repopulateComboBoxUnits( bool isArea ); diff --git a/src/app/qgsmergeattributesdialog.h b/src/app/qgsmergeattributesdialog.h index 3380fd08cb20..aa295357b1c0 100644 --- a/src/app/qgsmergeattributesdialog.h +++ b/src/app/qgsmergeattributesdialog.h @@ -48,14 +48,16 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA QgsAttributes mergedAttributes() const; - /** Returns a list of attribute indexes which should be skipped when merging (e.g., attributes + /** + * Returns a list of attribute indexes which should be skipped when merging (e.g., attributes * which have been set to "skip" */ QSet skippedAttributeIndexes() const; public slots: - /** Resets all columns to "skip" + /** + * Resets all columns to "skip" */ void setAllToSkip(); @@ -72,7 +74,8 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA //! Create new combo box with the options for featureXX / mean / min / max QComboBox *createMergeComboBox( QVariant::Type columnType ) const; - /** Returns the table widget column index of a combo box + /** + * Returns the table widget column index of a combo box \returns the column index or -1 in case of error*/ int findComboColumn( QComboBox *c ) const; //! Calculates the merged value of a column (depending on the selected merge behavior) and inserts the value in the corresponding cell @@ -82,7 +85,8 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA //! Appends the values of the features for the final value QVariant concatenationAttribute( int col ); - /** Calculates a summary statistic for a column. Returns null if no valid numerical + /** + * Calculates a summary statistic for a column. Returns null if no valid numerical * values found in column. */ QVariant calcStatistic( int col, QgsStatisticalSummary::Statistic stat ); diff --git a/src/app/qgsoptions.h b/src/app/qgsoptions.h index b1bdbdc4fa2a..d701f9b24b31 100644 --- a/src/app/qgsoptions.h +++ b/src/app/qgsoptions.h @@ -55,7 +55,8 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption ~QgsOptions(); - /** Sets the page with the specified widget name as the current page + /** + * Sets the page with the specified widget name as the current page * \since QGIS 2.1 */ void setCurrentPage( const QString &pageWidgetName ); @@ -85,7 +86,8 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption void uiThemeChanged( const QString &theme ); - /** Slot to handle when type of project to open after launch is changed + /** + * Slot to handle when type of project to open after launch is changed */ void on_mProjectOnLaunchCmbBx_currentIndexChanged( int indx ); @@ -184,17 +186,20 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption void on_mBrowseCacheDirectory_clicked(); void on_mClearCache_clicked(); - /** Let the user add a scale to the list of scales + /** + * Let the user add a scale to the list of scales * used in scale combobox */ void on_pbnAddScale_clicked(); - /** Let the user remove a scale from the list of scales + /** + * Let the user remove a scale from the list of scales * used in scale combobox */ void on_pbnRemoveScale_clicked(); - /** Let the user restore default scales + /** + * Let the user restore default scales * used in scale combobox */ void on_pbnDefaultScaleValues_clicked(); diff --git a/src/app/qgspointmarkeritem.h b/src/app/qgspointmarkeritem.h index 66612dcac8c5..8104e446f094 100644 --- a/src/app/qgspointmarkeritem.h +++ b/src/app/qgspointmarkeritem.h @@ -26,7 +26,8 @@ class QgsMarkerSymbol; -/** \ingroup app +/** + * \ingroup app * \class QgsPointMarkerItem * \brief An item that shows a point marker symbol centered on a map location. */ @@ -39,12 +40,14 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem void paint( QPainter *painter ) override; - /** Sets the center point of the marker symbol (in map coordinates) + /** + * Sets the center point of the marker symbol (in map coordinates) * \param p center point */ void setPointLocation( const QgsPointXY &p ); - /** Sets the marker symbol to use for rendering the point. Note - you may need to call + /** + * Sets the marker symbol to use for rendering the point. Note - you may need to call * updateSize() after setting the symbol. * \param symbol marker symbol. Ownership is transferred to item. * \see symbol() @@ -52,12 +55,14 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem */ void setSymbol( QgsMarkerSymbol *symbol ); - /** Returns the marker symbol used for rendering the point. + /** + * Returns the marker symbol used for rendering the point. * \see setSymbol() */ QgsMarkerSymbol *symbol(); - /** Sets the feature used for rendering the marker symbol. The feature's attributes + /** + * Sets the feature used for rendering the marker symbol. The feature's attributes * may affect the rendered symbol if data defined overrides are in place. * \param feature feature for symbol * \see feature() @@ -65,24 +70,28 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem */ void setFeature( const QgsFeature &feature ); - /** Returns the feature used for rendering the marker symbol. + /** + * Returns the feature used for rendering the marker symbol. * \see setFeature() */ QgsFeature feature() const { return mFeature; } - /** Must be called after setting the symbol or feature and when the symbol's size may + /** + * Must be called after setting the symbol or feature and when the symbol's size may * have changed. */ void updateSize(); - /** Sets the \a opacity for the marker. + /** + * Sets the \a opacity for the marker. * \param opacity double between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see opacity() */ void setOpacity( double opacity ); - /** Returns the opacity for the marker. + /** + * Returns the opacity for the marker. * \returns opacity value between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see setOpacity() diff --git a/src/app/qgspointrotationitem.h b/src/app/qgspointrotationitem.h index 70680d454b47..846f09cadf5f 100644 --- a/src/app/qgspointrotationitem.h +++ b/src/app/qgspointrotationitem.h @@ -39,7 +39,8 @@ class APP_EXPORT QgsPointRotationItem: public QgsMapCanvasItem //! Sets the center point of the rotation symbol (in map coordinates) void setPointLocation( const QgsPointXY &p ); - /** Sets the rotation of the symbol and displays the new rotation number. + /** + * Sets the rotation of the symbol and displays the new rotation number. Units are degrees, starting from north direction, clockwise direction*/ void setSymbolRotation( int r ) {mRotation = r;} diff --git a/src/app/qgsprojectproperties.h b/src/app/qgsprojectproperties.h index b64bbdf705a4..c75494cc0eec 100644 --- a/src/app/qgsprojectproperties.h +++ b/src/app/qgsprojectproperties.h @@ -31,7 +31,8 @@ class QgsStyle; class QgsExpressionContext; class QgsLayerTreeGroup; -/** Dialog to set project level properties +/** + * Dialog to set project level properties \note actual state is stored in QgsProject singleton instance @@ -68,11 +69,13 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui: */ void showProjectionsTab(); - /** Let the user add a scale to the list of project scales + /** + * Let the user add a scale to the list of project scales * used in scale combobox instead of global ones */ void on_pbnAddScale_clicked(); - /** Let the user remove a scale from the list of project scales + /** + * Let the user remove a scale from the list of project scales * used in scale combobox instead of global ones */ void on_pbnRemoveScale_clicked(); diff --git a/src/app/qgsrasterlayerproperties.h b/src/app/qgsrasterlayerproperties.h index b53046657fbe..c099364da6ab 100644 --- a/src/app/qgsrasterlayerproperties.h +++ b/src/app/qgsrasterlayerproperties.h @@ -1,5 +1,6 @@ -/** \brief The qgsrasterlayerproperties class is used to set up how raster layers are displayed. +/** + * \brief The qgsrasterlayerproperties class is used to set up how raster layers are displayed. */ /* ************************************************************************** qgsrasterlayerproperties.h - description @@ -37,7 +38,8 @@ class QgsRasterRenderer; class QgsRasterRendererWidget; class QgsRasterHistogramWidget; -/** Property sheet for a raster map layer +/** + * Property sheet for a raster map layer */ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private Ui::QgsRasterLayerPropertiesBase { @@ -45,7 +47,8 @@ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private public: - /** \brief Constructor + /** + * \brief Constructor * \param ml Map layer for which properties will be displayed */ QgsRasterLayerProperties( QgsMapLayer *lyr, QgsMapCanvas *canvas, QWidget *parent = nullptr, Qt::WindowFlags = QgsGuiUtils::ModalDialogFlags ); @@ -151,7 +154,8 @@ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private //! \brief Pointer to the raster layer that this property dilog changes the behavior of. QgsRasterLayer *mRasterLayer = nullptr; - /** \brief If the underlying raster layer doesn't have a provider + /** + * \brief If the underlying raster layer doesn't have a provider This variable is used to determine if various parts of the Properties UI are included or not @@ -193,7 +197,8 @@ class APP_EXPORT QgsRasterLayerProperties : public QgsOptionsDialogBase, private QVector mTransparencyToEdited; - /** Previous layer style. Used to reset style to previous state if new style + /** + * Previous layer style. Used to reset style to previous state if new style * was loaded but dialog is canceled */ QgsMapLayerStyle mOldStyle; diff --git a/src/app/qgsselectbyformdialog.h b/src/app/qgsselectbyformdialog.h index 6ca3b1e67312..73021f202d4d 100644 --- a/src/app/qgsselectbyformdialog.h +++ b/src/app/qgsselectbyformdialog.h @@ -25,7 +25,8 @@ class QgsMessageBar; class QgsVectorLayer; class QgsMapCanvas; -/** \ingroup app +/** + * \ingroup app * \class QgsSelectByFormDialog * A dialog for selecting features from a layer, using a form based off the layer's editor widgets. * \since QGIS 2.16 @@ -37,7 +38,8 @@ class APP_EXPORT QgsSelectByFormDialog : public QDialog public: - /** Constructor for QgsSelectByFormDialog + /** + * Constructor for QgsSelectByFormDialog * \param layer vector layer to select from * \param context editor context * \param parent parent widget @@ -49,7 +51,8 @@ class APP_EXPORT QgsSelectByFormDialog : public QDialog ~QgsSelectByFormDialog(); - /** Sets the message bar to display feedback from the form in. This is used in the search/filter + /** + * Sets the message bar to display feedback from the form in. This is used in the search/filter * mode to display the count of selected features. * \param messageBar target message bar * \since QGIS 2.16 diff --git a/src/app/qgsstatisticalsummarydockwidget.h b/src/app/qgsstatisticalsummarydockwidget.h index 21c3d1e13329..cf7df6609bcd 100644 --- a/src/app/qgsstatisticalsummarydockwidget.h +++ b/src/app/qgsstatisticalsummarydockwidget.h @@ -32,7 +32,8 @@ class QgsLayerItem; class QgsDataItem; class QgsBrowserTreeFilterProxyModel; -/** A dock widget which displays a statistical summary of the values in a field or expression +/** + * A dock widget which displays a statistical summary of the values in a field or expression */ class APP_EXPORT QgsStatisticalSummaryDockWidget : public QgsDockWidget, private Ui::QgsStatisticalSummaryWidgetBase, private QgsExpressionContextGenerator { @@ -41,14 +42,16 @@ class APP_EXPORT QgsStatisticalSummaryDockWidget : public QgsDockWidget, private public: QgsStatisticalSummaryDockWidget( QWidget *parent = nullptr ); - /** Returns the currently active layer for the widget + /** + * Returns the currently active layer for the widget * \since QGIS 2.12 */ QgsVectorLayer *layer() const { return mLayer; } public slots: - /** Recalculates the displayed statistics + /** + * Recalculates the displayed statistics */ void refreshStatistics(); diff --git a/src/app/qgsstatusbarmagnifierwidget.h b/src/app/qgsstatusbarmagnifierwidget.h index 7118c7d5ec9c..e02db5116d82 100644 --- a/src/app/qgsstatusbarmagnifierwidget.h +++ b/src/app/qgsstatusbarmagnifierwidget.h @@ -36,14 +36,16 @@ class APP_EXPORT QgsStatusBarMagnifierWidget : public QWidget public: - /** Constructor + /** + * Constructor * \param parent is the parent widget */ QgsStatusBarMagnifierWidget( QWidget *parent = nullptr ); void setDefaultFactor( double factor ); - /** Set the font of the text + /** + * Set the font of the text * \param font the font to use */ void setFont( const QFont &font ); diff --git a/src/app/qgsstatusbarscalewidget.h b/src/app/qgsstatusbarscalewidget.h index b5402e781316..5bd3e1e33da1 100644 --- a/src/app/qgsstatusbarscalewidget.h +++ b/src/app/qgsstatusbarscalewidget.h @@ -52,7 +52,8 @@ class APP_EXPORT QgsStatusBarScaleWidget : public QWidget */ bool isLocked() const; - /** Set the font of the text + /** + * Set the font of the text * \param font the font to use */ void setFont( const QFont &font ); diff --git a/src/app/qgsvectorlayerproperties.h b/src/app/qgsvectorlayerproperties.h index 21ce8dfcaca1..73dab335812a 100644 --- a/src/app/qgsvectorlayerproperties.h +++ b/src/app/qgsvectorlayerproperties.h @@ -146,7 +146,8 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private void aboutToShowStyleMenu(); - /** Updates the variable editor to reflect layer changes + /** + * Updates the variable editor to reflect layer changes */ void updateVariableEditor(); @@ -195,7 +196,8 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private //! A list of additional pages provided by plugins QList mLayerPropertiesPages; - /** Previous layer style. Used to reset style to previous state if new style + /** + * Previous layer style. Used to reset style to previous state if new style * was loaded but dialog is canceled */ QgsMapLayerStyle mOldStyle; diff --git a/src/auth/basic/qgsauthbasicmethod.cpp b/src/auth/basic/qgsauthbasicmethod.cpp index 8ef33cbae874..b9f2dd08b8e5 100644 --- a/src/auth/basic/qgsauthbasicmethod.cpp +++ b/src/auth/basic/qgsauthbasicmethod.cpp @@ -229,7 +229,8 @@ QGISEXTERN QgsAuthBasicMethod *classFactory() return new QgsAuthBasicMethod(); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString authMethodKey() { diff --git a/src/auth/identcert/qgsauthidentcertmethod.cpp b/src/auth/identcert/qgsauthidentcertmethod.cpp index d0c47006f006..f4c693451ff4 100644 --- a/src/auth/identcert/qgsauthidentcertmethod.cpp +++ b/src/auth/identcert/qgsauthidentcertmethod.cpp @@ -299,7 +299,8 @@ QGISEXTERN QgsAuthIdentCertMethod *classFactory() return new QgsAuthIdentCertMethod(); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString authMethodKey() { diff --git a/src/auth/pkipaths/qgsauthpkipathsmethod.cpp b/src/auth/pkipaths/qgsauthpkipathsmethod.cpp index b7fb0c83b32a..19be047431be 100644 --- a/src/auth/pkipaths/qgsauthpkipathsmethod.cpp +++ b/src/auth/pkipaths/qgsauthpkipathsmethod.cpp @@ -301,7 +301,8 @@ QGISEXTERN QgsAuthPkiPathsMethod *classFactory() return new QgsAuthPkiPathsMethod(); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString authMethodKey() { diff --git a/src/auth/pkipkcs12/qgsauthpkcs12method.cpp b/src/auth/pkipkcs12/qgsauthpkcs12method.cpp index 23917550c3b3..dd0cd4eff714 100644 --- a/src/auth/pkipkcs12/qgsauthpkcs12method.cpp +++ b/src/auth/pkipkcs12/qgsauthpkcs12method.cpp @@ -307,7 +307,8 @@ QGISEXTERN QgsAuthPkcs12Method *classFactory() return new QgsAuthPkcs12Method(); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString authMethodKey() { diff --git a/src/core/3d/qgsabstract3drenderer.h b/src/core/3d/qgsabstract3drenderer.h index 269506ce4964..5989ceae7e17 100644 --- a/src/core/3d/qgsabstract3drenderer.h +++ b/src/core/3d/qgsabstract3drenderer.h @@ -33,7 +33,8 @@ namespace Qt3DCore } #endif -/** \ingroup core +/** + * \ingroup core * Base class for all renderers that may to participate in 3D view. * * 3D renderers implement the method createEntity() that returns a new 3D entity - that entity diff --git a/src/core/annotations/qgsannotation.h b/src/core/annotations/qgsannotation.h index 5e2c5e702d04..0de129c44a28 100644 --- a/src/core/annotations/qgsannotation.h +++ b/src/core/annotations/qgsannotation.h @@ -27,7 +27,8 @@ #include "qgsmargins.h" #include "qgsmaplayer.h" -/** \ingroup core +/** + * \ingroup core * \class QgsAnnotation * \since QGIS 3.0 * diff --git a/src/core/annotations/qgsannotationmanager.h b/src/core/annotations/qgsannotationmanager.h index b4fa4903d79c..a7f33d32f00a 100644 --- a/src/core/annotations/qgsannotationmanager.h +++ b/src/core/annotations/qgsannotationmanager.h @@ -26,7 +26,8 @@ class QgsProject; class QgsAnnotation; -/** \ingroup core +/** + * \ingroup core * \class QgsAnnotationManager * \since QGIS 3.0 * diff --git a/src/core/auth/qgsauthcertutils.h b/src/core/auth/qgsauthcertutils.h index 89b1373cd8b4..f6738713a55b 100644 --- a/src/core/auth/qgsauthcertutils.h +++ b/src/core/auth/qgsauthcertutils.h @@ -32,7 +32,8 @@ class QgsAuthConfigSslServer; #define SSL_SUBJECT_INFO( var, prop ) var.subjectInfo( prop ).value(0) -/** \ingroup core +/** + * \ingroup core * \brief Utilities for working with certificates and keys */ class CORE_EXPORT QgsAuthCertUtils @@ -86,16 +87,19 @@ class CORE_EXPORT QgsAuthCertUtils //! Map certificate sha1 to certificate as simple cache static QMap mapDigestToCerts( const QList &certs ); - /** Map certificates to their oraganization. + /** + * Map certificates to their oraganization. * \note not available in Python bindings */ static QMap< QString, QList > certsGroupedByOrg( const QList &certs ) SIP_SKIP; - /** Map SSL custom configs' certificate sha1 to custom config as simple cache + /** + * Map SSL custom configs' certificate sha1 to custom config as simple cache */ static QMap mapDigestToSslConfigs( const QList &configs ); - /** Map SSL custom configs' certificates to their oraganization. + /** + * Map SSL custom configs' certificates to their oraganization. * \note not available in Python bindings */ static QMap< QString, QList > sslConfigsGroupedByOrg( const QList &configs ) SIP_SKIP; @@ -106,7 +110,8 @@ class CORE_EXPORT QgsAuthCertUtils //! Return first cert from a PEM or DER formatted file static QSslCertificate certFromFile( const QString &certpath ); - /** Return non-encrypted key from a PEM or DER formatted file + /** + * Return non-encrypted key from a PEM or DER formatted file * \param keypath File path to private key * \param keypass Passphrase for private key * \param algtype QString to set with resolved algorithm type @@ -118,7 +123,8 @@ class CORE_EXPORT QgsAuthCertUtils //! Return list of concatenated certs from a PEM Base64 text block static QList certsFromString( const QString &pemtext ); - /** Return list of certificate, private key and algorithm (as PEM text) from file path components + /** + * Return list of certificate, private key and algorithm (as PEM text) from file path components * \param certpath File path to certificate * \param keypath File path to private key * \param keypass Passphrase for private key @@ -130,7 +136,8 @@ class CORE_EXPORT QgsAuthCertUtils const QString &keypass = QString(), bool reencrypt = true ); - /** Return list of certificate, private key and algorithm (as PEM text) for a PKCS#12 bundle + /** + * Return list of certificate, private key and algorithm (as PEM text) for a PKCS#12 bundle * \param bundlepath File path to the PKCS bundle * \param bundlepass Passphrase for bundle * \param reencrypt Whether to re-encrypt the private key with the passphrase @@ -140,14 +147,16 @@ class CORE_EXPORT QgsAuthCertUtils const QString &bundlepass = QString(), bool reencrypt = true ); - /** Write a temporary file for a PEM text of cert/key/CAs bundle component + /** + * Write a temporary file for a PEM text of cert/key/CAs bundle component * \param pemtext Component content as PEM text * \param name Name of file * \returns File path to temporary file */ static QString pemTextToTempFile( const QString &name, const QByteArray &pemtext ); - /** Get the general name for CA source enum type + /** + * Get the general name for CA source enum type * \param source The enum source type for the CA * \param single Whether to return singular or plural description */ @@ -156,7 +165,8 @@ class CORE_EXPORT QgsAuthCertUtils //! Get the general name via RFC 5280 resolution static QString resolvedCertName( const QSslCertificate &cert, bool issuer = false ); - /** Get combined distinguished name for certificate + /** + * Get combined distinguished name for certificate * \param qcert Qt SSL cert object * \param acert QCA SSL cert object to add more info to the output * \param issuer Whether to return cert's subject or issuer combined name @@ -172,43 +182,51 @@ class CORE_EXPORT QgsAuthCertUtils //! Get string with colon delimiters every 2 characters static QString getColonDelimited( const QString &txt ); - /** Get the sha1 hash for certificate + /** + * Get the sha1 hash for certificate * \param cert Qt SSL certificate to generate hash from * \param formatted Whether to colon-delimit the hash */ static QString shaHexForCert( const QSslCertificate &cert, bool formatted = false ); - /** Convert a QSslCertificate to a QCA::Certificate. + /** + * Convert a QSslCertificate to a QCA::Certificate. * \note not available in Python bindings */ static QCA::Certificate qtCertToQcaCert( const QSslCertificate &cert ) SIP_SKIP; - /** Convert a QList of QSslCertificate to a QCA::CertificateCollection. + /** + * Convert a QList of QSslCertificate to a QCA::CertificateCollection. * \note not available in Python bindings */ static QCA::CertificateCollection qtCertsToQcaCollection( const QList &certs ) SIP_SKIP; - /** PKI key/cert bundle from file path, e.g. from .p12 or pfx files. + /** + * PKI key/cert bundle from file path, e.g. from .p12 or pfx files. * \note not available in Python bindings */ static QCA::KeyBundle qcaKeyBundle( const QString &path, const QString &pass ) SIP_SKIP; - /** Certificate validity check messages per enum. + /** + * Certificate validity check messages per enum. * \note not available in Python bindings */ static QString qcaValidityMessage( QCA::Validity validity ) SIP_SKIP; - /** Certificate signature algorithm strings per enum. + /** + * Certificate signature algorithm strings per enum. * \note not available in Python bindings */ static QString qcaSignatureAlgorithm( QCA::SignatureAlgorithm algorithm ) SIP_SKIP; - /** Certificate well-known constraint strings per enum. + /** + * Certificate well-known constraint strings per enum. * \note not available in Python bindings */ static QString qcaKnownConstraint( QCA::ConstraintTypeKnown constraint ) SIP_SKIP; - /** Certificate usage type strings per enum + /** + * Certificate usage type strings per enum * \note not available in Python bindings */ static QString certificateUsageTypeString( QgsAuthCertUtils::CertUsageType usagetype ) SIP_SKIP; @@ -234,7 +252,8 @@ class CORE_EXPORT QgsAuthCertUtils //! Get short strings describing an SSL error static QString sslErrorEnumString( QSslError::SslError errenum ); - /** Get short strings describing SSL errors. + /** + * Get short strings describing SSL errors. * \note not available in Python bindings */ static QList > sslErrorEnumStrings() SIP_SKIP; diff --git a/src/core/auth/qgsauthconfig.h b/src/core/auth/qgsauthconfig.h index 95842557276e..768214416ddd 100644 --- a/src/core/auth/qgsauthconfig.h +++ b/src/core/auth/qgsauthconfig.h @@ -31,7 +31,8 @@ #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * \brief Configuration storage class for authentication method configurations */ class CORE_EXPORT QgsAuthMethodConfig @@ -180,7 +181,8 @@ typedef QHash QgsAuthMethodConfigsMap; #ifndef QT_NO_SSL -/** \ingroup core +/** + * \ingroup core * \brief Storage set for PKI bundle: SSL certificate, key, optional CA cert chain * \note Useful for caching the bundle during application run sessions */ @@ -249,7 +251,8 @@ class CORE_EXPORT QgsPkiBundle }; -/** \ingroup core +/** + * \ingroup core * \brief Storage set for constructed SSL certificate, key, associated with an authentication config */ class CORE_EXPORT QgsPkiConfigBundle @@ -343,7 +346,8 @@ class CORE_EXPORT QgsPkiConfigBundle -/** \ingroup core +/** + * \ingroup core * \brief Configuration container for SSL server connection exceptions or overrides */ class CORE_EXPORT QgsAuthConfigSslServer @@ -379,12 +383,14 @@ class CORE_EXPORT QgsAuthConfigSslServer //! Set SSL client's peer verify mode to use in connections void setSslPeerVerifyMode( QSslSocket::PeerVerifyMode mode ) { mSslPeerVerifyMode = mode; } - /** Number or SSL client's peer to verify in connections + /** + * Number or SSL client's peer to verify in connections * \note When set to 0 = unlimited depth */ int sslPeerVerifyDepth() const { return mSslPeerVerifyDepth; } - /** Set number or SSL client's peer to verify in connections + /** + * Set number or SSL client's peer to verify in connections * \note When set to 0 = unlimited depth */ void setSslPeerVerifyDepth( int depth ) { mSslPeerVerifyDepth = depth; } diff --git a/src/core/auth/qgsauthcrypto.h b/src/core/auth/qgsauthcrypto.h index 1ea306700ad3..5cecf2dd49f2 100644 --- a/src/core/auth/qgsauthcrypto.h +++ b/src/core/auth/qgsauthcrypto.h @@ -24,7 +24,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * Functions for hashing/checking master password and encrypt/decrypting data with password * \since 2.8 * \note not available in Python bindings diff --git a/src/core/auth/qgsauthmanager.h b/src/core/auth/qgsauthmanager.h index d86d99f40fe1..abe23b68002e 100644 --- a/src/core/auth/qgsauthmanager.h +++ b/src/core/auth/qgsauthmanager.h @@ -53,7 +53,8 @@ class QgsAuthProvider; class QTimer; -/** \ingroup core +/** + * \ingroup core * Singleton offering an interface to manage the authentication configuration database * and to utilize configurations through various authentication method plugins */ @@ -72,7 +73,8 @@ class CORE_EXPORT QgsAuthManager : public QObject }; Q_ENUM( MessageLevel ); - /** Enforce singleton pattern + /** + * Enforce singleton pattern * \note To set up the manager instance and initialize everything use QgsAuthManager::instance()->init() */ static QgsAuthManager *instance(); @@ -97,25 +99,29 @@ class CORE_EXPORT QgsAuthManager : public QObject //! Standard message for when QCA's qca-ossl plugin is missing and system is disabled const QString disabledMessage() const; - /** The standard authentication database file in ~/.qgis3/ or defined location + /** + * The standard authentication database file in ~/.qgis3/ or defined location * \see QgsApplication::qgisAuthDatabaseFilePath */ const QString authenticationDatabasePath() const { return mAuthDbPath; } - /** Main call to initially set or continually check master password is set + /** + * Main call to initially set or continually check master password is set * \note If it is not set, the user is asked for its input * \param verify Whether password's hash was saved in authentication database */ bool setMasterPassword( bool verify = false ); - /** Overloaded call to reset master password or set it initially without user interaction + /** + * Overloaded call to reset master password or set it initially without user interaction * \note Only use this in trusted reset functions, unit tests or user/app setup scripts! * \param pass Password to use * \param verify Whether password's hash was saved in authentication database */ bool setMasterPassword( const QString &pass, bool verify = false ); - /** Verify the supplied master password against any existing hash in authentication database + /** + * Verify the supplied master password against any existing hash in authentication database * \note Do not emit verification signals when only comparing * \param compare Password to compare against */ @@ -127,17 +133,20 @@ class CORE_EXPORT QgsAuthManager : public QObject //! Verify a password hash existing in authentication database bool masterPasswordHashInDatabase() const; - /** Clear supplied master password + /** + * Clear supplied master password * \note This will not necessarily clear authenticated connections cached in network connection managers */ void clearMasterPassword() { mMasterPass = QString(); } - /** Check whether supplied password is the same as the one already set + /** + * Check whether supplied password is the same as the one already set * \param pass Password to verify */ bool masterPasswordSame( const QString &pass ) const; - /** Reset the master password to a new one, then re-encrypt all previous + /** + * Reset the master password to a new one, then re-encrypt all previous * configs in a new database file, optionally backup curren database * \param newpass New master password to replace existing * \param oldpass Current master password to replace existing @@ -146,12 +155,14 @@ class CORE_EXPORT QgsAuthManager : public QObject */ bool resetMasterPassword( const QString &newpass, const QString &oldpass, bool keepbackup, QString *backuppath SIP_INOUT = nullptr ); - /** Whether there is a scheduled opitonal erase of authentication database. + /** + * Whether there is a scheduled opitonal erase of authentication database. * \note not available in Python bindings */ bool scheduledAuthDatabaseErase() { return mScheduledDbErase; } SIP_SKIP - /** Schedule an optional erase of authentication database, starting when mutex is lockable. + /** + * Schedule an optional erase of authentication database, starting when mutex is lockable. * \note When an erase is scheduled, any attempt to set the master password, * e.g. password input dialog, is effectively canceled. * For example: In a GUI app, this keeps excess password input dialogs from popping @@ -164,7 +175,8 @@ class CORE_EXPORT QgsAuthManager : public QObject */ void setScheduledAuthDatabaseErase( bool scheduleErase ) SIP_SKIP; - /** Re-emit a signal to schedule an optional erase of authentication database. + /** + * Re-emit a signal to schedule an optional erase of authentication database. * \note This can be called from the slot connected to a previously emitted scheduling signal, * so that the slot can ask for another emit later, if the slot noticies the current GUI * processing state is not ready for interacting with the user, e.g. project is still loading @@ -368,7 +380,8 @@ class CORE_EXPORT QgsAuthManager : public QObject //! Get a certificate identity by id (sha hash) const QSslCertificate getCertIdentity( const QString &id ); - /** Get a certificate identity bundle by id (sha hash). + /** + * Get a certificate identity bundle by id (sha hash). * \note not available in Python bindings */ const QPair getCertIdentityBundle( const QString &id ) SIP_SKIP; @@ -407,7 +420,8 @@ class CORE_EXPORT QgsAuthManager : public QObject //! Remove an SSL certificate custom config bool removeSslCertCustomConfig( const QString &id, const QString &hostport ); - /** Get ignored SSL error cache, keyed with cert/connection's sha:host:port. + /** + * Get ignored SSL error cache, keyed with cert/connection's sha:host:port. * \note not available in Python bindings */ QHash > getIgnoredSslErrorCache() { return mIgnoredSslErrorsCache; } SIP_SKIP @@ -452,7 +466,8 @@ class CORE_EXPORT QgsAuthManager : public QObject //! Get sha1-mapped database-stored certificate authorities const QMap getMappedDatabaseCAs(); - /** Get all CA certs mapped to their sha1 from cache. + /** + * Get all CA certs mapped to their sha1 from cache. * \note not available in Python bindings */ const QMap > getCaCertsCache() SIP_SKIP @@ -466,7 +481,8 @@ class CORE_EXPORT QgsAuthManager : public QObject //! Store user trust value for a certificate bool storeCertTrustPolicy( const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy ); - /** Get a whether certificate is trusted by user + /** + * Get a whether certificate is trusted by user \returns DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy */ QgsAuthCertUtils::CertTrustPolicy getCertTrustPolicy( const QSslCertificate &cert ); @@ -615,7 +631,8 @@ class CORE_EXPORT QgsAuthManager : public QObject private slots: void writeToConsole( const QString &message, const QString &tag = QString(), QgsAuthManager::MessageLevel level = INFO ); - /** This slot emits the authDatabaseEraseRequested signal, instead of attempting + /** + * This slot emits the authDatabaseEraseRequested signal, instead of attempting * the erase. It relies upon a slot connected to the signal in calling application * (the one that initiated the erase) to initiate the erase, when it is ready. * Upon activation, a receiving slot should get confimation from the user, then diff --git a/src/core/auth/qgsauthmethod.h b/src/core/auth/qgsauthmethod.h index 105cbd4bd7c9..af73a381803e 100644 --- a/src/core/auth/qgsauthmethod.h +++ b/src/core/auth/qgsauthmethod.h @@ -28,7 +28,8 @@ class QgsAuthMethodConfig; -/** \ingroup core +/** + * \ingroup core * Abstract base class for authentication method plugins */ class CORE_EXPORT QgsAuthMethod : public QObject @@ -37,7 +38,8 @@ class CORE_EXPORT QgsAuthMethod : public QObject public: - /** Flags that represent the update points (where authentication configurations are expanded) + /** + * Flags that represent the update points (where authentication configurations are expanded) * supported by an authentication method. These equate to the 'update*()' virtual functions * below, and allow for update point code to skip calling an unused update by a method, because * the base virtual function will always return true, giving a false impression an update occurred. @@ -68,18 +70,21 @@ class CORE_EXPORT QgsAuthMethod : public QObject //! Increment this if method is significantly updated, allow updater code to be written for previously stored authcfg int version() const { return mVersion; } - /** Flags that represent the update points (where authentication configurations are expanded) + /** + * Flags that represent the update points (where authentication configurations are expanded) * supported by an authentication method. * \note These should directly correlate to existing 'update*()' member functions */ QgsAuthMethod::Expansions supportedExpansions() const { return mExpansions; } - /** The data providers that the method supports, allowing for filtering out authcfgs that are not + /** + * The data providers that the method supports, allowing for filtering out authcfgs that are not * applicable to a given provider, or where the updating code is not currently implemented. */ QStringList supportedDataProviders() const { return mDataProviders; } - /** Update a network request with authentication components + /** + * Update a network request with authentication components * \param request The network request to update * \param authcfg Authentication configuration ID * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows @@ -95,7 +100,8 @@ class CORE_EXPORT QgsAuthMethod : public QObject return true; // noop } - /** Update a network reply with authentication components + /** + * Update a network reply with authentication components * \param reply The network reply object to update * \param authcfg Authentication configuration ID * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows @@ -111,7 +117,8 @@ class CORE_EXPORT QgsAuthMethod : public QObject return true; // noop } - /** Update data source connection items with authentication components + /** + * Update data source connection items with authentication components * \param connectionItems QStringlist of 'key=value' pairs, as utilized in QgsDataSourceUri::connectionInfo() * \param authcfg Authentication configuration ID * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows @@ -127,7 +134,8 @@ class CORE_EXPORT QgsAuthMethod : public QObject return true; // noop } - /** Update proxy settings with authentication components + /** + * Update proxy settings with authentication components * \param proxy * \param authcfg Authentication configuration ID * \param dataprovider Textual key for a data provider, e.g. 'proxy', that allows @@ -143,14 +151,16 @@ class CORE_EXPORT QgsAuthMethod : public QObject return true; // noop } - /** Clear any cached configuration. Called when the QgsAuthManager deletes an authentication configuration (authcfg). + /** + * Clear any cached configuration. Called when the QgsAuthManager deletes an authentication configuration (authcfg). * \note It is highly recommended that a cache of authentication components (per requested authcfg) * be implemented, to avoid excessive queries on the auth database. Such a cache could be as * simple as a QHash or QMap of authcfg -> QgsAuthMethodConfig. See 'Basic' auth method plugin for example. */ virtual void clearCachedConfig( const QString &authcfg ) = 0; - /** Update an authentication configuration in place + /** + * Update an authentication configuration in place * \note Useful for updating previously stored authcfgs, when an authentication method has been significantly updated */ virtual void updateMethodConfig( QgsAuthMethodConfig &mconfig ) = 0; diff --git a/src/core/auth/qgsauthmethodmetadata.h b/src/core/auth/qgsauthmethodmetadata.h index 6f31decec2d2..19d03fd1852b 100644 --- a/src/core/auth/qgsauthmethodmetadata.h +++ b/src/core/auth/qgsauthmethodmetadata.h @@ -23,7 +23,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * Holds data auth method key, description, and associated shared library file information. The metadata class is used in a lazy load implementation in @@ -48,19 +49,22 @@ class CORE_EXPORT QgsAuthMethodMetadata */ QgsAuthMethodMetadata( const QString &_key, const QString &_description, const QString &_library ); - /** This returns the unique key associated with the method + /** + * This returns the unique key associated with the method This key string is used for the associative container in QgsAtuhMethodRegistry */ QString key() const; - /** This returns descriptive text for the method + /** + * This returns descriptive text for the method This is used to provide a descriptive list of available data methods. */ QString description() const; - /** This returns the library file name + /** + * This returns the library file name This is used to QLibrary calls to load the method. */ diff --git a/src/core/auth/qgsauthmethodregistry.cpp b/src/core/auth/qgsauthmethodregistry.cpp index e60a30355ad9..cb63cf55979c 100644 --- a/src/core/auth/qgsauthmethodregistry.cpp +++ b/src/core/auth/qgsauthmethodregistry.cpp @@ -167,7 +167,8 @@ QgsAuthMethodRegistry::~QgsAuthMethodRegistry() } -/** Convenience function for finding any existing auth methods that match "authMethodKey" +/** + * Convenience function for finding any existing auth methods that match "authMethodKey" Necessary because [] map operator will create a QgsProviderMetadata instance. Also you cannot use the map [] operator in const members for that diff --git a/src/core/auth/qgsauthmethodregistry.h b/src/core/auth/qgsauthmethodregistry.h index 62ce354095bd..54bc1e99a40d 100644 --- a/src/core/auth/qgsauthmethodregistry.h +++ b/src/core/auth/qgsauthmethodregistry.h @@ -31,7 +31,8 @@ class QgsAuthMethod; class QgsAuthMethodMetadata; -/** \ingroup core +/** + * \ingroup core * A registry / canonical manager of authentication methods. This is a Singleton class that manages authentication method plugin access. @@ -64,24 +65,28 @@ class CORE_EXPORT QgsAuthMethodRegistry //! Set library directory where to search for plugins void setLibraryDirectory( const QDir &path ); - /** Create an instance of the auth method + /** + * Create an instance of the auth method \param authMethodKey identificator of the auth method \returns instance of auth method or nullptr on error */ std::unique_ptr< QgsAuthMethod > authMethod( const QString &authMethodKey ); - /** Return the auth method capabilities + /** + * Return the auth method capabilities \param authMethodKey identificator of the auth method */ // int authMethodCapabilities( const QString& authMethodKey ) const; - /** Return the GUI edit widget associated with the auth method + /** + * Return the GUI edit widget associated with the auth method * \param parent Parent widget * \param authMethodKey identificator of the auth method */ QWidget *editWidget( const QString &authMethodKey, QWidget *parent = nullptr ); - /** Get pointer to auth method function + /** + * Get pointer to auth method function \param authMethodKey identificator of the auth method \param functionName name of function \returns pointer to function or nullptr on error diff --git a/src/core/composer/qgsaddremoveitemcommand.h b/src/core/composer/qgsaddremoveitemcommand.h index d952885cb6b3..956c3181a9a1 100644 --- a/src/core/composer/qgsaddremoveitemcommand.h +++ b/src/core/composer/qgsaddremoveitemcommand.h @@ -26,7 +26,8 @@ class QgsComposerItem; class QgsComposition; -/** \ingroup core +/** + * \ingroup core * A composer command class for adding / removing composer items. If mState == Removed, the command owns the item */ class CORE_EXPORT QgsAddRemoveItemCommand: public QObject, public QUndoCommand diff --git a/src/core/composer/qgsaddremovemultiframecommand.h b/src/core/composer/qgsaddremovemultiframecommand.h index 1a0a0a2acca2..1cf6c24cc6e7 100644 --- a/src/core/composer/qgsaddremovemultiframecommand.h +++ b/src/core/composer/qgsaddremovemultiframecommand.h @@ -26,7 +26,8 @@ class QgsComposerMultiFrame; class QgsComposition; -/** \ingroup core +/** + * \ingroup core * \class QgsAddRemoveMultiFrameCommand */ class CORE_EXPORT QgsAddRemoveMultiFrameCommand: public QUndoCommand diff --git a/src/core/composer/qgsatlascomposition.h b/src/core/composer/qgsatlascomposition.h index 543dfe8ad6b9..7732a9e793b6 100644 --- a/src/core/composer/qgsatlascomposition.h +++ b/src/core/composer/qgsatlascomposition.h @@ -33,7 +33,8 @@ class QgsComposition; class QgsVectorLayer; class QgsExpressionContext; -/** \ingroup core +/** + * \ingroup core * Class used to render an Atlas, iterating over geometry features. * prepareForFeature() modifies the atlas map's extent to zoom on the given feature. * This class is used for printing, exporting to PDF and images. @@ -47,31 +48,36 @@ class CORE_EXPORT QgsAtlasComposition : public QObject public: QgsAtlasComposition( QgsComposition *composition ); - /** Returns whether the atlas generation is enabled + /** + * Returns whether the atlas generation is enabled * \returns true if atlas is enabled * \see setEnabled */ bool enabled() const { return mEnabled; } - /** Sets whether the atlas is enabled + /** + * Sets whether the atlas is enabled * \param enabled set to true to enable to atlas * \see enabled */ void setEnabled( bool enabled ); - /** Returns true if the atlas is set to hide the coverage layer + /** + * Returns true if the atlas is set to hide the coverage layer * \returns true if coverage layer is hidden * \see setHideCoverage */ bool hideCoverage() const { return mHideCoverage; } - /** Sets whether the coverage layer should be hidden in map items in the composition + /** + * Sets whether the coverage layer should be hidden in map items in the composition * \param hide set to true to hide the coverage layer * \see hideCoverage */ void setHideCoverage( bool hide ); - /** Returns the filename expression used for generating output filenames for each + /** + * Returns the filename expression used for generating output filenames for each * atlas page. * \returns filename pattern * \see setFilenamePattern @@ -80,7 +86,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ QString filenamePattern() const { return mFilenamePattern; } - /** Sets the filename expression used for generating output filenames for each + /** + * Sets the filename expression used for generating output filenames for each * atlas page. * \returns true if filename expression could be successful set, false if expression is invalid * \param pattern expression to use for output filenames @@ -90,26 +97,30 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ bool setFilenamePattern( const QString &pattern ); - /** Returns an error string from parsing the filename expression. + /** + * Returns an error string from parsing the filename expression. * \returns filename pattern parser error * \see setFilenamePattern * \see filenamePattern */ QString filenamePatternErrorString() const { return mFilenameParserError; } - /** Returns the coverage layer used for the atlas features + /** + * Returns the coverage layer used for the atlas features * \returns atlas coverage layer * \see setCoverageLayer */ QgsVectorLayer *coverageLayer() const { return mCoverageLayer.get(); } - /** Sets the coverage layer to use for the atlas features + /** + * Sets the coverage layer to use for the atlas features * \param layer vector coverage layer * \see coverageLayer */ void setCoverageLayer( QgsVectorLayer *layer ); - /** Returns the expression used for calculating the page name. + /** + * Returns the expression used for calculating the page name. * \returns expression string, or field name from coverage layer * \see setPageNameExpression * \see nameForPage @@ -117,14 +128,16 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ QString pageNameExpression() const { return mPageNameExpression; } - /** Sets the expression used for calculating the page name. + /** + * Sets the expression used for calculating the page name. * \param pageNameExpression expression string, or field name from coverage layer * \see pageNameExpression * \since QGIS 2.12 */ void setPageNameExpression( const QString &pageNameExpression ) { mPageNameExpression = pageNameExpression; } - /** Returns the calculated name for a specified atlas page number. + /** + * Returns the calculated name for a specified atlas page number. * \param pageNumber number of page, where 0 = first page * \returns page name * \see pageNameExpression @@ -132,7 +145,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ QString nameForPage( int pageNumber ) const; - /** Returns whether the atlas will be exported to a single file. This is only + /** + * Returns whether the atlas will be exported to a single file. This is only * applicable for PDF exports. * \returns true if atlas will be exported to a single file * \see setSingleFile @@ -140,7 +154,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ bool singleFile() const { return mSingleFile; } - /** Sets whether the atlas should be exported to a single file. This is only + /** + * Sets whether the atlas should be exported to a single file. This is only * applicable for PDF exports. * \param single set to true to export atlas to a single file. * \see singleFile @@ -148,7 +163,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ void setSingleFile( bool single ) { mSingleFile = single; } - /** Returns the atlas file format used for image exports. + /** + * Returns the atlas file format used for image exports. * \returns true if atlas will be exported to a single file * \see setFileFormat * \note This property is only used for image exports. @@ -156,7 +172,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ QString fileFormat() const { return mFileFormat; } - /** Sets the atlas file format used for image exports. + /** + * Sets the atlas file format used for image exports. * \param format set the file format extension * \see fileFormat * \note This property is only used for image exports. @@ -176,7 +193,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject QString featureFilter() const { return mFeatureFilter; } void setFeatureFilter( const QString &expression ) { mFeatureFilter = expression; } - /** Returns an error string from parsing the feature filter expression. + /** + * Returns an error string from parsing the feature filter expression. * \returns filename pattern parser error * \see setFilenamePattern * \see filenamePattern @@ -186,7 +204,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject QString sortKeyAttributeName() const { return mSortKeyAttributeName; } void setSortKeyAttributeName( const QString &fieldName ) { mSortKeyAttributeName = fieldName; } - /** Returns the current list of predefined scales for the atlas. This is used + /** + * Returns the current list of predefined scales for the atlas. This is used * for maps which are set to the predefined atlas scaling mode. * \returns a vector of doubles representing predefined scales * \see setPredefinedScales @@ -194,7 +213,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ QVector predefinedScales() const { return mPredefinedScales; } - /** Sets the list of predefined scales for the atlas. This is used + /** + * Sets the list of predefined scales for the atlas. This is used * for maps which are set to the predefined atlas scaling mode. * \param scales a vector of doubles representing predefined scales * \see predefinedScales @@ -202,7 +222,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject */ void setPredefinedScales( const QVector &scales ); - /** Begins the rendering. Returns true if successful, false if no matching atlas + /** + * Begins the rendering. Returns true if successful, false if no matching atlas features found.*/ bool beginRender(); //! Ends the rendering. Restores original extent @@ -211,14 +232,16 @@ class CORE_EXPORT QgsAtlasComposition : public QObject //! Returns the number of features in the coverage layer int numFeatures() const; - /** Prepare the atlas map for the given feature. Sets the extent and context variables + /** + * Prepare the atlas map for the given feature. Sets the extent and context variables * \param i feature number * \param updateMaps set to true to redraw maps and recalculate their extent * \returns true if feature was successfully prepared */ bool prepareForFeature( const int i, const bool updateMaps = true ); - /** Prepare the atlas map for the given feature. Sets the extent and context variables + /** + * Prepare the atlas map for the given feature. Sets the extent and context variables * \returns true if feature was successfully prepared */ bool prepareForFeature( const QgsFeature *feat ); @@ -228,7 +251,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject void writeXml( QDomElement &elem, QDomDocument &doc ) const; - /** Reads general atlas settings from xml + /** + * Reads general atlas settings from xml * \param elem a QDomElement holding the atlas properties. * \param doc QDomDocument for the source xml. * \see readXMLMapSettings @@ -238,22 +262,26 @@ class CORE_EXPORT QgsAtlasComposition : public QObject QgsComposition *composition() { return mComposition; } - /** Requeries the current atlas coverage layer and applies filtering and sorting. Returns + /** + * Requeries the current atlas coverage layer and applies filtering and sorting. Returns * number of matching features. Must be called after prepareForFeature() */ int updateFeatures(); - /** Returns the current atlas feature. Must be called after prepareForFeature(). + /** + * Returns the current atlas feature. Must be called after prepareForFeature(). * \since QGIS 2.12 */ QgsFeature feature() const { return mCurrentFeature; } - /** Returns the name of the page for the current atlas feature. Must be called after prepareForFeature(). + /** + * Returns the name of the page for the current atlas feature. Must be called after prepareForFeature(). * \since QGIS 2.12 */ QString currentPageName() const; - /** Returns the current feature number, where a value of 0 corresponds to the first feature. + /** + * Returns the current feature number, where a value of 0 corresponds to the first feature. * \since QGIS 2.12 */ int currentFeatureNumber() const { return mCurrentFeatureNo; } @@ -266,7 +294,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject public slots: - /** Refreshes the current atlas feature, by refetching its attributes from the vector layer provider + /** + * Refreshes the current atlas feature, by refetching its attributes from the vector layer provider * \since QGIS 2.5 */ void refreshFeature(); @@ -298,19 +327,22 @@ class CORE_EXPORT QgsAtlasComposition : public QObject //! Is emitted when the current atlas feature changes void featureChanged( QgsFeature *feature ); - /** Is emitted when the number of features for the atlas changes. + /** + * Is emitted when the number of features for the atlas changes. * \since QGIS 2.12 */ void numberFeaturesChanged( int numFeatures ); private: - /** Updates the filename expression. + /** + * Updates the filename expression. * \returns true if expression was successfully parsed, false if expression is invalid */ bool updateFilenameExpression(); - /** Evaluates filename for current feature + /** + * Evaluates filename for current feature * \returns true if feature filename was successfully evaluated */ bool evalFeatureFilename( const QgsExpressionContext &context ); diff --git a/src/core/composer/qgscomposerarrow.h b/src/core/composer/qgscomposerarrow.h index 2629dc90a72a..fb6e91fa7b8f 100644 --- a/src/core/composer/qgscomposerarrow.h +++ b/src/core/composer/qgscomposerarrow.h @@ -26,7 +26,8 @@ class QgsLineSymbol; -/** \ingroup core +/** + * \ingroup core * An item that draws an arrow between two points. */ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem @@ -42,12 +43,14 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem SVGMarker }; - /** Constructor + /** + * Constructor * \param c parent composition */ QgsComposerArrow( QgsComposition *c SIP_TRANSFERTHIS ); - /** Constructor + /** + * Constructor * \param startPoint start point for line * \param stopPoint end point for line * \param c parent composition @@ -62,51 +65,59 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem //! \brief Reimplementation of QCanvasItem::paint - draw on canvas void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override; - /** Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect + /** + * Modifies position of start and endpoint and calls QgsComposerItem::setSceneRect */ void setSceneRect( const QRectF &rectangle ) override; - /** Sets the width of the arrow head in mm + /** + * Sets the width of the arrow head in mm * \param width width of arrow head * \see arrowHeadWidth */ void setArrowHeadWidth( double width ); - /** Returns the width of the arrow head in mm + /** + * Returns the width of the arrow head in mm * \returns width of arrow head * \see setArrowHeadWidth */ double arrowHeadWidth() const { return mArrowHeadWidth; } - /** Sets the marker to draw at the start of the line + /** + * Sets the marker to draw at the start of the line * \param svgPath file path for svg marker graphic to draw * \see startMarker * \see setEndMarker */ void setStartMarker( const QString &svgPath ); - /** Returns the marker drawn at the start of the line + /** + * Returns the marker drawn at the start of the line * \returns file path for svg marker graphic * \see setStartMarker * \see endMarker */ QString startMarker() const { return mStartMarkerFile; } - /** Sets the marker to draw at the end of the line + /** + * Sets the marker to draw at the end of the line * \param svgPath file path for svg marker graphic to draw * \see endMarker * \see setStartMarker */ void setEndMarker( const QString &svgPath ); - /** Returns the marker drawn at the end of the line + /** + * Returns the marker drawn at the end of the line * \returns file path for svg marker graphic * \see setEndMarker * \see startMarker */ QString endMarker() const { return mEndMarkerFile; } - /** Returns the color used to draw stroke around the the arrow head. + /** + * Returns the color used to draw stroke around the the arrow head. * \returns arrow head stroke color * \see arrowHeadFillColor * \see setArrowHeadStrokeColor @@ -114,7 +125,8 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem */ QColor arrowHeadStrokeColor() const { return mArrowHeadStrokeColor; } - /** Sets the color used to draw the stroke around the arrow head. + /** + * Sets the color used to draw the stroke around the arrow head. * \param color arrow head stroke color * \see setArrowHeadFillColor * \see arrowHeadStrokeColor @@ -122,7 +134,8 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem */ void setArrowHeadStrokeColor( const QColor &color ); - /** Returns the color used to fill the arrow head. + /** + * Returns the color used to fill the arrow head. * \returns arrow head fill color * \see arrowHeadStrokeColor * \see setArrowHeadFillColor @@ -130,7 +143,8 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem */ QColor arrowHeadFillColor() const { return mArrowHeadFillColor; } - /** Sets the color used to fill the arrow head. + /** + * Sets the color used to fill the arrow head. * \param color arrow head fill color * \see arrowHeadFillColor * \see setArrowHeadStrokeColor @@ -138,7 +152,8 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem */ void setArrowHeadFillColor( const QColor &color ); - /** Sets the pen width for the stroke of the arrow head + /** + * Sets the pen width for the stroke of the arrow head * \param width pen width for arrow head stroke * \see arrowHeadStrokeWidth * \see setArrowHeadStrokeColor @@ -146,7 +161,8 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem */ void setArrowHeadStrokeWidth( const double width ); - /** Returns the pen width for the stroke of the arrow head + /** + * Returns the pen width for the stroke of the arrow head * \returns pen width for arrow head stroke * \see setArrowHeadStrokeWidth * \see arrowHeadStrokeColor @@ -154,39 +170,45 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem */ double arrowHeadStrokeWidth() const { return mArrowHeadStrokeWidth; } - /** Sets the line symbol used for drawing the line portion of the arrow + /** + * Sets the line symbol used for drawing the line portion of the arrow * \param symbol line symbol * \see lineSymbol * \since QGIS 2.5 */ void setLineSymbol( QgsLineSymbol *symbol SIP_TRANSFER ); - /** Returns the line symbol used for drawing the line portion of the arrow + /** + * Returns the line symbol used for drawing the line portion of the arrow * \returns line symbol * \see setLineSymbol * \since QGIS 2.5 */ QgsLineSymbol *lineSymbol() { return mLineSymbol; } - /** Returns marker mode, which controls how the arrow endpoints are drawn + /** + * Returns marker mode, which controls how the arrow endpoints are drawn * \returns marker mode * \see setMarkerMode */ MarkerMode markerMode() const { return mMarkerMode; } - /** Sets the marker mode, which controls how the arrow endpoints are drawn + /** + * Sets the marker mode, which controls how the arrow endpoints are drawn * \param mode marker mode * \see setMarkerMode */ void setMarkerMode( MarkerMode mode ); - /** Stores state in DOM element + /** + * Stores state in DOM element * \param elem is DOM element corresponding to 'Composer' tag * \param doc document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from DOM document + /** + * Sets state from DOM document * \param itemElem is DOM node corresponding to item tag * \param doc is the document to read */ @@ -203,7 +225,8 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem QPointF mStartPoint; QPointF mStopPoint; - /** Considering the rectangle as spanning [x[0], x[1]] x [y[0], y[1]], these + /** + * Considering the rectangle as spanning [x[0], x[1]] x [y[0], y[1]], these * indices specify which index {0, 1} corresponds to the start point * coordinate of the respective dimension*/ int mStartXIdx; @@ -229,14 +252,16 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem QColor mArrowHeadStrokeColor; QColor mArrowHeadFillColor; - /** Indicates QGIS version to mimic bounding box behavior for. The line placement changed in version 2.4, so a value + /** + * Indicates QGIS version to mimic bounding box behavior for. The line placement changed in version 2.4, so a value * of 22 is used to indicate that the line should be drawn using the older placement routine. */ int mBoundsBehavior; QgsLineSymbol *mLineSymbol = nullptr; - /** Adapts the item scene rect to contain the start point, the stop point including the arrow marker and the stroke. + /** + * Adapts the item scene rect to contain the start point, the stop point including the arrow marker and the stroke. * Needs to be called whenever the arrow width/height, the stroke with or the endpoints are changed */ void adaptItemSceneRect(); @@ -249,12 +274,14 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem //! Apply default graphics settings void init(); - /** Creates the default line symbol + /** + * Creates the default line symbol * \since QGIS 2.5 */ void createDefaultLineSymbol(); - /** Draws the arrow line + /** + * Draws the arrow line * \since QGIS 2.5 */ void drawLine( QPainter *painter ); diff --git a/src/core/composer/qgscomposerattributetablemodelv2.h b/src/core/composer/qgscomposerattributetablemodelv2.h index 5d8821f4a7c6..47f53800805d 100644 --- a/src/core/composer/qgscomposerattributetablemodelv2.h +++ b/src/core/composer/qgscomposerattributetablemodelv2.h @@ -29,7 +29,8 @@ class QgsComposerTableColumn; //QgsComposerAttributeTableColumnModelV2 -/** \ingroup core +/** + * \ingroup core * A model for displaying columns shown in a QgsComposerAttributeTableV2 */ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableModel @@ -38,7 +39,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM public: - /** Controls whether a row/column is shifted up or down + /** + * Controls whether a row/column is shifted up or down */ enum ShiftDirection { @@ -46,7 +48,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM ShiftDown //!< Shift the row/column down }; - /** Constructor for QgsComposerAttributeTableColumnModel. + /** + * Constructor for QgsComposerAttributeTableColumnModel. * \param composerTable QgsComposerAttributeTable the model is attached to * \param parent optional parent */ @@ -63,7 +66,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM QModelIndex index( int row, int column, const QModelIndex &parent ) const override; QModelIndex parent( const QModelIndex &child ) const override; - /** Moves the specified row up or down in the model. Used for rearranging the attribute tables + /** + * Moves the specified row up or down in the model. Used for rearranging the attribute tables * columns. * \returns true if the move is allowed * \param row row in model representing attribute table column to move @@ -72,13 +76,15 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM */ bool moveRow( int row, ShiftDirection direction ); - /** Resets the attribute table's columns to match the source layer's fields. Remove all existing + /** + * Resets the attribute table's columns to match the source layer's fields. Remove all existing * attribute table columns and column customisations. * \since QGIS 2.3 */ void resetToLayer(); - /** Returns the QgsComposerTableColumn corresponding to an index in the model. + /** + * Returns the QgsComposerTableColumn corresponding to an index in the model. * \returns QgsComposerTableColumn for specified index * \param index a QModelIndex * \since QGIS 2.3 @@ -86,7 +92,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM */ QgsComposerTableColumn *columnFromIndex( const QModelIndex &index ) const; - /** Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model. + /** + * Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model. * \returns QModelIndex for specified QgsComposerTableColumn * \param column a QgsComposerTableColumn * \since QGIS 2.3 @@ -94,7 +101,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM */ QModelIndex indexFromColumn( QgsComposerTableColumn *column ); - /** Sets a specified column as a sorted column in the QgsComposerAttributeTable. The column will be + /** + * Sets a specified column as a sorted column in the QgsComposerAttributeTable. The column will be * added to the end of the sort rank list, ie it will take the next largest available sort rank. * \param column a QgsComposerTableColumn * \param order sort order for column @@ -104,7 +112,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM */ void setColumnAsSorted( QgsComposerTableColumn *column, Qt::SortOrder order ); - /** Sets a specified column as an unsorted column in the QgsComposerAttributeTable. The column will be + /** + * Sets a specified column as an unsorted column in the QgsComposerAttributeTable. The column will be * removed from the sort rank list. * \param column a QgsComposerTableColumn * \since QGIS 2.3 @@ -112,7 +121,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM */ void setColumnAsUnsorted( QgsComposerTableColumn *column ); - /** Moves a column up or down in the sort rank for the QgsComposerAttributeTable. + /** + * Moves a column up or down in the sort rank for the QgsComposerAttributeTable. * \param column a QgsComposerTableColumn * \param direction direction to move the column in the sort rank list * \since QGIS 2.3 @@ -128,7 +138,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM //QgsComposerTableSortColumnsProxyModelV2 -/** \ingroup core +/** + * \ingroup core * Allows for filtering QgsComposerAttributeTable columns by columns which are sorted or unsorted */ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterProxyModel @@ -137,7 +148,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro public: - /** Controls whether the proxy model shows sorted or unsorted columns + /** + * Controls whether the proxy model shows sorted or unsorted columns */ enum ColumnFilterType { @@ -145,7 +157,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro ShowUnsortedColumns//!< Show only unsorted columns }; - /** Constructor for QgsComposerTableSortColumnsProxyModel. + /** + * Constructor for QgsComposerTableSortColumnsProxyModel. * \param composerTable QgsComposerAttributeTable the model is attached to * \param filterType filter for columns, controls whether sorted or unsorted columns are shown * \param parent optional parent @@ -159,7 +172,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro Qt::ItemFlags flags( const QModelIndex &index ) const override; virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override; - /** Returns the QgsComposerTableColumn corresponding to a row in the proxy model. + /** + * Returns the QgsComposerTableColumn corresponding to a row in the proxy model. * \returns QgsComposerTableColumn for specified row * \param row a row number * \since QGIS 2.3 @@ -167,7 +181,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro */ QgsComposerTableColumn *columnFromRow( int row ); - /** Returns the QgsComposerTableColumn corresponding to an index in the proxy model. + /** + * Returns the QgsComposerTableColumn corresponding to an index in the proxy model. * \returns QgsComposerTableColumn for specified index * \param index a QModelIndex * \since QGIS 2.3 @@ -176,7 +191,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro */ QgsComposerTableColumn *columnFromIndex( const QModelIndex &index ) const; - /** Returns the QgsComposerTableColumn corresponding to an index from the source + /** + * Returns the QgsComposerTableColumn corresponding to an index from the source * QgsComposerAttributeTableColumnModel model. * \returns QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel * \param sourceIndex a QModelIndex @@ -186,7 +202,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro */ QgsComposerTableColumn *columnFromSourceIndex( const QModelIndex &sourceIndex ) const; - /** Invalidates the current filter used by the proxy model + /** + * Invalidates the current filter used by the proxy model * \since QGIS 2.3 */ void resetFilter(); @@ -198,7 +215,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro QgsComposerAttributeTableV2 *mComposerTable = nullptr; ColumnFilterType mFilterType; - /** Returns a list of QgsComposerTableColumns without a set sort rank + /** + * Returns a list of QgsComposerTableColumns without a set sort rank * \returns QgsComposerTableColumns in attribute table without a sort rank * \since QGIS 2.3 */ diff --git a/src/core/composer/qgscomposerattributetablev2.h b/src/core/composer/qgscomposerattributetablev2.h index b9d8bb89a233..ae7df5f343ce 100644 --- a/src/core/composer/qgscomposerattributetablev2.h +++ b/src/core/composer/qgscomposerattributetablev2.h @@ -27,7 +27,8 @@ class QgsComposerMap; class QgsVectorLayer; -/** \ingroup core +/** + * \ingroup core * Helper class for sorting tables, takes into account sorting column and ascending / descending */ class CORE_EXPORT QgsComposerAttributeTableCompareV2 @@ -40,12 +41,14 @@ class CORE_EXPORT QgsComposerAttributeTableCompareV2 QgsComposerAttributeTableCompareV2() = default; bool operator()( const QgsComposerTableRow &m1, const QgsComposerTableRow &m2 ); - /** Sets column number to sort by + /** + * Sets column number to sort by * \param col column number for sorting */ void setSortColumn( int col ) { mCurrentSortColumn = col; } - /** Sets sort order for column sorting + /** + * Sets sort order for column sorting * \param asc set to true to sort in ascending order, false to sort in descending order */ void setAscending( bool asc ) { mAscending = asc; } @@ -56,7 +59,8 @@ class CORE_EXPORT QgsComposerAttributeTableCompareV2 }; -/** \ingroup core +/** + * \ingroup core * A table that displays attributes from a vector layer */ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 @@ -65,7 +69,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 public: - /** Specifies the content source for the attribute table + /** + * Specifies the content source for the attribute table */ enum ContentSource { @@ -78,7 +83,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 virtual QString displayName() const override; - /** Writes properties specific to attribute tables + /** + * Writes properties specific to attribute tables * \param elem an existing QDomElement in which to store the attribute table's properties. * \param doc QDomDocument for the destination xml. * \param ignoreFrames ignore frames @@ -86,7 +92,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const override; - /** Reads the properties specific to an attribute table from xml. + /** + * Reads the properties specific to an attribute table from xml. * \param itemElem a QDomElement holding the attribute table's desired properties. * \param doc QDomDocument for the source xml. * \param ignoreFrames ignore frames @@ -96,19 +103,22 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 virtual void addFrame( QgsComposerFrame *frame SIP_TRANSFER, bool recalcFrameSizes = true ) override; - /** Sets the source for attributes to show in table body. + /** + * Sets the source for attributes to show in table body. * \param source content source * \see source */ void setSource( const ContentSource source ); - /** Returns the source for attributes shown in the table body. + /** + * Returns the source for attributes shown in the table body. * \returns content source * \see setSource */ ContentSource source() const { return mSource; } - /** Returns the source layer for the table, considering the table source mode. For example, + /** + * Returns the source layer for the table, considering the table source mode. For example, * if the table is set to atlas feature mode, then the source layer will be the * atlas coverage layer. If the table is set to layer attributes mode, then * the source layer will be the user specified vector layer. @@ -116,19 +126,22 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ QgsVectorLayer *sourceLayer(); - /** Sets the vector layer from which to display feature attributes + /** + * Sets the vector layer from which to display feature attributes * \param layer Vector layer for attribute table * \see vectorLayer */ void setVectorLayer( QgsVectorLayer *layer ); - /** Returns the vector layer the attribute table is currently using + /** + * Returns the vector layer the attribute table is currently using * \returns attribute table's current vector layer * \see setVectorLayer */ QgsVectorLayer *vectorLayer() const { return mVectorLayer.get(); } - /** Sets the relation id from which to display child features + /** + * Sets the relation id from which to display child features * \param relationId id for relation to display child features from * \see relationId * \see setSource @@ -136,7 +149,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setRelationId( const QString &relationId ); - /** Returns the relation id which the table displays child features from + /** + * Returns the relation id which the table displays child features from * \returns relation id * \see setRelationId * \see source @@ -144,12 +158,14 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ QString relationId() const { return mRelationId; } - /** Resets the attribute table's columns to match the vector layer's fields + /** + * Resets the attribute table's columns to match the vector layer's fields * \see setVectorLayer */ void resetColumns(); - /** Sets the composer map to use to limit the extent of features shown in the + /** + * Sets the composer map to use to limit the extent of features shown in the * attribute table. This setting only has an effect if setDisplayOnlyVisibleFeatures is * set to true. Changing the composer map forces the table to refetch features from its * vector layer, and may result in the table changing size to accommodate the new displayed @@ -160,7 +176,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setComposerMap( const QgsComposerMap *map ); - /** Returns the composer map whose extents are controlling the features shown in the + /** + * Returns the composer map whose extents are controlling the features shown in the * table. The extents of the map are only used if displayOnlyVisibleFeatures() is true. * \returns composer map controlling the attribute table * \see setComposerMap @@ -168,7 +185,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ const QgsComposerMap *composerMap() const { return mComposerMap; } - /** Sets the maximum number of features shown by the table. Changing this setting may result + /** + * Sets the maximum number of features shown by the table. Changing this setting may result * in the attribute table changing its size to accommodate the new number of rows, and requires * the table to refetch features from its vector layer. * \param features maximum number of features to show in the table @@ -176,27 +194,31 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setMaximumNumberOfFeatures( const int features ); - /** Returns the maximum number of features to be shown by the table. + /** + * Returns the maximum number of features to be shown by the table. * \returns maximum number of features * \see setMaximumNumberOfFeatures */ int maximumNumberOfFeatures() const { return mMaximumNumberOfFeatures; } - /** Sets attribute table to only show unique rows. + /** + * Sets attribute table to only show unique rows. * \param uniqueOnly set to true to show only unique rows. Duplicate rows * will be stripped from the table. * \see uniqueRowsOnly */ void setUniqueRowsOnly( const bool uniqueOnly ); - /** Returns true if the table is set to show only unique rows. + /** + * Returns true if the table is set to show only unique rows. * \returns true if table only shows unique rows and is stripping out * duplicate rows. * \see setUniqueRowsOnly */ bool uniqueRowsOnly() const { return mShowUniqueRowsOnly; } - /** Sets attribute table to only show features which are visible in a composer map item. Changing + /** + * Sets attribute table to only show features which are visible in a composer map item. Changing * this setting forces the table to refetch features from its vector layer, and may result in * the table changing size to accommodate the new displayed feature attributes. * \param visibleOnly set to true to show only visible features @@ -205,7 +227,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setDisplayOnlyVisibleFeatures( const bool visibleOnly ); - /** Returns true if the table is set to show only features visible on a corresponding + /** + * Returns true if the table is set to show only features visible on a corresponding * composer map item. * \returns true if table only shows visible features * \see composerMap @@ -213,7 +236,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ bool displayOnlyVisibleFeatures() const { return mShowOnlyVisibleFeatures; } - /** Sets attribute table to only show features which intersect the current atlas + /** + * Sets attribute table to only show features which intersect the current atlas * feature. * \param filterToAtlas set to true to show only features which intersect * the atlas feature @@ -221,21 +245,24 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setFilterToAtlasFeature( const bool filterToAtlas ); - /** Returns true if the table is set to only show features which intersect the current atlas + /** + * Returns true if the table is set to only show features which intersect the current atlas * feature. * \returns true if table only shows features which intersect the atlas feature * \see setFilterToAtlasFeature */ bool filterToAtlasFeature() const { return mFilterToAtlasIntersection; } - /** Returns true if a feature filter is active on the attribute table + /** + * Returns true if a feature filter is active on the attribute table * \returns bool state of the feature filter * \see setFilterFeatures * \see featureFilter */ bool filterFeatures() const { return mFilterFeatures; } - /** Sets whether the feature filter is active for the attribute table. Changing + /** + * Sets whether the feature filter is active for the attribute table. Changing * this setting forces the table to refetch features from its vector layer, and may result in * the table changing size to accommodate the new displayed feature attributes. * \param filter Set to true to enable the feature filter @@ -244,7 +271,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setFilterFeatures( const bool filter ); - /** Returns the current expression used to filter features for the table. The filter is only + /** + * Returns the current expression used to filter features for the table. The filter is only * active if filterFeatures() is true. * \returns feature filter expression * \see setFeatureFilter @@ -252,7 +280,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ QString featureFilter() const { return mFeatureFilter; } - /** Sets the expression used for filtering features in the table. The filter is only + /** + * Sets the expression used for filtering features in the table. The filter is only * active if filterFeatures() is set to true. Changing this setting forces the table * to refetch features from its vector layer, and may result in * the table changing size to accommodate the new displayed feature attributes. @@ -262,7 +291,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setFeatureFilter( const QString &expression ); - /** Sets the attributes to display in the table. + /** + * Sets the attributes to display in the table. * \param fields list of fields names from the vector layer to show. * Set to an empty list to show all feature attributes. * \param refresh set to true to force the table to refetch features from its vector layer @@ -272,7 +302,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setDisplayedFields( const QStringList &fields, bool refresh = true ); - /** Returns the attributes used to sort the table's features. + /** + * Returns the attributes used to sort the table's features. * \returns a QList of integer/bool pairs, where the integer refers to the attribute index and * the bool to the sort order for the attribute. If true the attribute is sorted ascending, * if false, the attribute is sorted in descending order. @@ -280,7 +311,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ QList > sortAttributes() const SIP_SKIP; - /** Sets a string to wrap the contents of the table cells by. Occurrences of this string will + /** + * Sets a string to wrap the contents of the table cells by. Occurrences of this string will * be replaced by a line break. * \param wrapString string to replace with line break * \since QGIS 2.12 @@ -288,7 +320,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ void setWrapString( const QString &wrapString ); - /** Returns the string used to wrap the contents of the table cells by. Occurrences of this string will + /** + * Returns the string used to wrap the contents of the table cells by. Occurrences of this string will * be replaced by a line break. * \returns string which will be replaced with line break * \since QGIS 2.12 @@ -296,7 +329,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 */ QString wrapString() const { return mWrapString; } - /** Queries the attribute table's vector layer for attributes to show in the table. + /** + * Queries the attribute table's vector layer for attributes to show in the table. * \param contents table content * \returns true if attributes were successfully fetched * \note not available in Python bindings @@ -338,18 +372,21 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2 QString mWrapString; - /** Returns a list of attribute indices corresponding to displayed fields in the table. + /** + * Returns a list of attribute indices corresponding to displayed fields in the table. * \note kept for compatibility with 2.0 api only */ QList fieldsToDisplay() const; - /** Restores a field alias map from a pre 2.4 format project file format + /** + * Restores a field alias map from a pre 2.4 format project file format * \param map QMap of integers to strings, where the string is the alias to use for the * corresponding field, and the integer is the field index from the vector layer */ void restoreFieldAliasMap( const QMap &map ); - /** Replaces occurrences of the wrap character with line breaks. + /** + * Replaces occurrences of the wrap character with line breaks. * \param variant input cell contents */ QVariant replaceWrapChar( const QVariant &variant ) const; diff --git a/src/core/composer/qgscomposereffect.h b/src/core/composer/qgscomposereffect.h index e505cb4d3d04..d09a4dfd1e3c 100644 --- a/src/core/composer/qgscomposereffect.h +++ b/src/core/composer/qgscomposereffect.h @@ -23,7 +23,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * \class QgsComposerEffect */ class CORE_EXPORT QgsComposerEffect : public QGraphicsEffect diff --git a/src/core/composer/qgscomposerframe.h b/src/core/composer/qgscomposerframe.h index a8877535a5d2..5f4da040bcfe 100644 --- a/src/core/composer/qgscomposerframe.h +++ b/src/core/composer/qgscomposerframe.h @@ -23,7 +23,8 @@ class QgsComposition; class QgsComposerMultiFrame; -/** \ingroup core +/** + * \ingroup core * Frame item for a composer multiframe item. */ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem @@ -33,14 +34,16 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem public: QgsComposerFrame( QgsComposition *c SIP_TRANSFERTHIS, QgsComposerMultiFrame *mf, qreal x, qreal y, qreal width, qreal height ); - /** Sets the visible part of the multiframe's content which is visible within + /** + * Sets the visible part of the multiframe's content which is visible within * this frame (relative to the total multiframe extent in mm). * \param section visible portion of content * \see extent */ void setContentSection( const QRectF §ion ) { mSection = section; } - /** Returns the parent multiframe for the frame. + /** + * Returns the parent multiframe for the frame. * \returns parent multiframe */ QgsComposerMultiFrame *multiFrame() const { return mMultiFrame; } @@ -58,7 +61,8 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; int type() const override { return ComposerFrame; } - /** Returns the visible portion of the multi frame's content which + /** + * Returns the visible portion of the multi frame's content which * is shown in this frame. * \returns extent of visible portion * \since QGIS 2.5 @@ -66,35 +70,40 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem */ QRectF extent() const { return mSection; } - /** Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty + /** + * Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty * \returns true if page should be hidden if frame is empty * \since QGIS 2.5 * \see setHidePageIfEmpty */ bool hidePageIfEmpty() const { return mHidePageIfEmpty; } - /** Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty + /** + * Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty * \param hidePageIfEmpty set to true if page should be hidden if frame is empty * \since QGIS 2.5 * \see hidePageIfEmpty */ void setHidePageIfEmpty( const bool hidePageIfEmpty ); - /** Returns whether the background and frame stroke should be hidden if this frame is empty + /** + * Returns whether the background and frame stroke should be hidden if this frame is empty * \returns true if background and stroke should be hidden if frame is empty * \since QGIS 2.5 * \see setHideBackgroundIfEmpty */ bool hideBackgroundIfEmpty() const { return mHideBackgroundIfEmpty; } - /** Sets whether the background and frame stroke should be hidden if this frame is empty + /** + * Sets whether the background and frame stroke should be hidden if this frame is empty * \param hideBackgroundIfEmpty set to true if background and stroke should be hidden if frame is empty * \since QGIS 2.5 * \see hideBackgroundIfEmpty */ void setHideBackgroundIfEmpty( const bool hideBackgroundIfEmpty ); - /** Returns whether the frame is empty + /** + * Returns whether the frame is empty * \returns true if frame is empty * \since QGIS 2.5 * \see hidePageIfEmpty diff --git a/src/core/composer/qgscomposerhtml.h b/src/core/composer/qgscomposerhtml.h index e52392190db1..4c0e191ea2d7 100644 --- a/src/core/composer/qgscomposerhtml.h +++ b/src/core/composer/qgscomposerhtml.h @@ -28,7 +28,8 @@ class QgsVectorLayer; class QgsNetworkContentFetcher; class QgsDistanceArea; -/** \ingroup core +/** + * \ingroup core * \class QgsComposerHtml */ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame @@ -36,7 +37,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame Q_OBJECT public: - /** Source modes for the HTML content to render in the item + /** + * Source modes for the HTML content to render in the item */ enum ContentMode { @@ -48,7 +50,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame ~QgsComposerHtml(); - /** Sets the source mode for item's HTML content. + /** + * Sets the source mode for item's HTML content. * \param mode ContentMode for the item's source * \see contentMode * \see setUrl @@ -57,7 +60,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void setContentMode( ContentMode mode ) { mContentMode = mode; } - /** Returns the source mode for item's HTML content. + /** + * Returns the source mode for item's HTML content. * \returns ContentMode for the item's source * \see setContentMode * \see url @@ -66,7 +70,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ ContentMode contentMode() const { return mContentMode; } - /** Sets the URL for content to display in the item when the item is using + /** + * Sets the URL for content to display in the item when the item is using * the QgsComposerHtml::Url mode. Content is automatically fetched and the * HTML item refreshed after calling this function. * \param url URL of content to display in the item @@ -75,7 +80,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void setUrl( const QUrl &url ); - /** Returns the URL of the content displayed in the item if the item is using + /** + * Returns the URL of the content displayed in the item if the item is using * the QgsComposerHtml::Url mode. * \returns url for content displayed in item * \see setUrl @@ -83,7 +89,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ QUrl url() const { return mUrl; } - /** Sets the HTML to display in the item when the item is using + /** + * Sets the HTML to display in the item when the item is using * the QgsComposerHtml::ManualHtml mode. Setting the HTML using this function * does not automatically refresh the item's contents. Call loadHtml to trigger * a refresh of the item after setting the HTML content. @@ -95,7 +102,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void setHtml( const QString &html ); - /** Returns the HTML source displayed in the item if the item is using + /** + * Returns the HTML source displayed in the item if the item is using * the QgsComposerHtml::ManualHtml mode. * \returns HTML displayed in item * \see setHtml @@ -104,7 +112,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ QString html() const { return mHtml; } - /** Returns whether html item will evaluate QGIS expressions prior to rendering + /** + * Returns whether html item will evaluate QGIS expressions prior to rendering * the HTML content. If set, any content inside [% %] tags will be * treated as a QGIS expression and evaluated against the current atlas * feature. @@ -114,7 +123,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ bool evaluateExpressions() const { return mEvaluateExpressions; } - /** Sets whether the html item will evaluate QGIS expressions prior to rendering + /** + * Sets whether the html item will evaluate QGIS expressions prior to rendering * the HTML content. If set, any content inside [% %] tags will be * treated as a QGIS expression and evaluated against the current atlas * feature. @@ -124,14 +134,16 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void setEvaluateExpressions( bool evaluateExpressions ); - /** Returns whether html item is using smart breaks. Smart breaks prevent + /** + * Returns whether html item is using smart breaks. Smart breaks prevent * the html frame contents from breaking mid-way though a line of text. * \returns true if html item is using smart breaks * \see setUseSmartBreaks */ bool useSmartBreaks() const { return mUseSmartBreaks; } - /** Sets whether the html item should use smart breaks. Smart breaks prevent + /** + * Sets whether the html item should use smart breaks. Smart breaks prevent * the html frame contents from breaking mid-way though a line of text. * \param useSmartBreaks set to true to prevent content from breaking * mid-way through a line of text @@ -139,7 +151,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void setUseSmartBreaks( bool useSmartBreaks ); - /** Sets the maximum distance allowed when calculating where to place page breaks + /** + * Sets the maximum distance allowed when calculating where to place page breaks * in the html. This distance is the maximum amount of empty space allowed * at the bottom of a frame after calculating the optimum break location. Setting * a larger value will result in better choice of page break location, but more @@ -153,7 +166,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void setMaxBreakDistance( double maxBreakDistance ); - /** Returns the maximum distance allowed when calculating where to place page breaks + /** + * Returns the maximum distance allowed when calculating where to place page breaks * in the html. This distance is the maximum amount of empty space allowed * at the bottom of a frame after calculating the optimum break location. This setting * is only effective if useSmartBreaks is true. @@ -164,7 +178,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ double maxBreakDistance() const { return mMaxBreakDistance; } - /** Sets the user stylesheet CSS rules to use while rendering the HTML content. These + /** + * Sets the user stylesheet CSS rules to use while rendering the HTML content. These * allow for overriding the styles specified within the HTML source. Setting the stylesheet * using this function does not automatically refresh the item's contents. Call loadHtml * to trigger a refresh of the item after setting the stylesheet rules. @@ -176,7 +191,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void setUserStylesheet( const QString &stylesheet ); - /** Returns the user stylesheet CSS rules used while rendering the HTML content. These + /** + * Returns the user stylesheet CSS rules used while rendering the HTML content. These * overriding the styles specified within the HTML source. * \returns CSS rules for user stylesheet * \see setUserStylesheet @@ -185,7 +201,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ QString userStylesheet() const { return mUserStylesheet; } - /** Sets whether user stylesheets are enabled for the HTML content. + /** + * Sets whether user stylesheets are enabled for the HTML content. * \param stylesheetEnabled set to true to enable user stylesheets * \see userStylesheetEnabled * \see setUserStylesheet @@ -193,7 +210,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame */ void setUserStylesheetEnabled( const bool stylesheetEnabled ); - /** Returns whether user stylesheets are enabled for the HTML content. + /** + * Returns whether user stylesheets are enabled for the HTML content. * \returns true if user stylesheets are enabled * \see setUserStylesheetEnabled * \see userStylesheet @@ -212,7 +230,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame public slots: - /** Reloads the html source from the url and redraws the item. + /** + * Reloads the html source from the url and redraws the item. * \param useCache set to true to use a cached copy of remote html * content * \param context expression context for evaluating data defined urls and expressions in html diff --git a/src/core/composer/qgscomposeritem.h b/src/core/composer/qgscomposeritem.h index f63109335a7c..33669f025414 100644 --- a/src/core/composer/qgscomposeritem.h +++ b/src/core/composer/qgscomposeritem.h @@ -34,7 +34,8 @@ class QgsComposition; class QgsExpressionContext; class QgsComposerEffect; -/** \ingroup core +/** + * \ingroup core * A item that forms part of a map composition. */ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRectItem @@ -197,7 +198,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //note - must sync with QgsMapCanvas::WheelAction. //TODO - QGIS 3.0 move QgsMapCanvas::WheelAction from GUI->CORE and remove this enum - /** Modes for zooming item content + /** + * Modes for zooming item content */ enum ZoomMode { @@ -207,12 +209,14 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec NoZoom //!< No zoom }; - /** Constructor + /** + * Constructor \param composition parent composition \param manageZValue true if the z-Value of this object should be managed by mComposition*/ QgsComposerItem( QgsComposition *composition SIP_TRANSFERTHIS, bool manageZValue = true ); - /** Constructor with box position and composer object + /** + * Constructor with box position and composer object \param x x coordinate of item \param y y coordinate of item \param width width of item @@ -225,7 +229,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Return correct graphics item type. virtual int type() const override { return ComposerItem; } - /** Returns whether this item has been removed from the composition. Items removed + /** + * Returns whether this item has been removed from the composition. Items removed * from the composition are not deleted so that they can be restored via an undo * command. * \returns true if the item has been removed from the composition @@ -234,7 +239,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual bool isRemoved() const { return mRemovedFromComposition; } - /** Sets whether this item has been removed from the composition. Items removed + /** + * Sets whether this item has been removed from the composition. Items removed * from the composition are not deleted so that they can be restored via an undo * command. * \param removed set to true if the item has been removed from the composition @@ -252,12 +258,14 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Moves item in canvas coordinates void move( double dx, double dy ); - /** Move Content of item. Does nothing per default (but implemented in composer map) + /** + * Move Content of item. Does nothing per default (but implemented in composer map) \param dx move in x-direction (canvas coordinates) \param dy move in y-direction(canvas coordinates)*/ virtual void moveContent( double dx, double dy ) { Q_UNUSED( dx ); Q_UNUSED( dy ); } - /** Zoom content of item. Does nothing per default (but implemented in composer map) + /** + * Zoom content of item. Does nothing per default (but implemented in composer map) * \param factor zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out * \param point item point for zoom center * \param mode zoom mode @@ -265,7 +273,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual void zoomContent( const double factor, const QPointF point, const ZoomMode mode = QgsComposerItem::Zoom ) { Q_UNUSED( factor ); Q_UNUSED( point ); Q_UNUSED( mode ); } - /** Gets the page the item is currently on. + /** + * Gets the page the item is currently on. * \returns page number for item, beginning on page 1 * \see pagePos * \see updatePagePos @@ -273,7 +282,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ int page() const; - /** Returns the item's position relative to its current page. + /** + * Returns the item's position relative to its current page. * \returns position relative to the page's top left corner. * \see page * \see updatePagePos @@ -281,7 +291,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ QPointF pagePos() const; - /** Moves the item so that it retains its relative position on the page + /** + * Moves the item so that it retains its relative position on the page * when the paper size changes. * \param newPageWidth new width of the page in mm * \param newPageHeight new height of the page in mm @@ -291,7 +302,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void updatePagePos( double newPageWidth, double newPageHeight ); - /** Moves the item to a new position (in canvas coordinates) + /** + * Moves the item to a new position (in canvas coordinates) \param x item position x (mm) \param y item position y (mm) \param itemPoint reference point which coincides with specified position @@ -300,7 +312,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void setItemPosition( double x, double y, ItemPositionMode itemPoint = UpperLeft, int page = -1 ); - /** Sets item position and width / height in one go + /** + * Sets item position and width / height in one go \param x item position x (mm) \param y item position y (mm) \param width item width (mm) @@ -312,11 +325,13 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void setItemPosition( double x, double y, double width, double height, ItemPositionMode itemPoint = UpperLeft, bool posIncludesFrame = false, int page = -1 ); - /** Returns item's last used position mode. + /** + * Returns item's last used position mode. \note: This property has no effect on actual's item position, which is always the top-left corner. */ ItemPositionMode lastUsedPositionMode() { return mLastUsedPositionMode; } - /** Sets this items bound in scene coordinates such that 1 item size units + /** + * Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit*/ virtual void setSceneRect( const QRectF &rectangle ); @@ -326,7 +341,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Reads parameter that are not subclass specific in document. Usually called from readXml methods of subclasses bool _readXml( const QDomElement &itemElem, const QDomDocument &doc ); - /** Whether this item has a frame or not. + /** + * Whether this item has a frame or not. * \returns true if there is a frame around this item, otherwise false. * \see setFrameEnabled * \see frameStrokeWidth @@ -335,7 +351,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ bool hasFrame() const {return mFrame;} - /** Set whether this item has a frame drawn around it or not. + /** + * Set whether this item has a frame drawn around it or not. * \param drawFrame draw frame * \see hasFrame * \see setFrameStrokeWidth @@ -344,7 +361,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual void setFrameEnabled( const bool drawFrame ); - /** Sets frame stroke color + /** + * Sets frame stroke color * \param color new color for stroke frame * \since QGIS 2.6 * \see frameStrokeColor @@ -354,7 +372,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual void setFrameStrokeColor( const QColor &color ); - /** Returns the frame's stroke color. Only used if hasFrame is true. + /** + * Returns the frame's stroke color. Only used if hasFrame is true. * \returns frame stroke color * \since QGIS 2.6 * \see hasFrame @@ -364,7 +383,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ QColor frameStrokeColor() const { return mFrameColor; } - /** Sets frame stroke width + /** + * Sets frame stroke width * \param strokeWidth new width for stroke frame * \since QGIS 2.2 * \see frameStrokeWidth @@ -374,7 +394,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual void setFrameStrokeWidth( const double strokeWidth ); - /** Returns the frame's stroke width. Only used if hasFrame is true. + /** + * Returns the frame's stroke width. Only used if hasFrame is true. * \returns Frame stroke width * \since QGIS 2.3 * \see hasFrame @@ -384,7 +405,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ double frameStrokeWidth() const { return mFrameWidth; } - /** Returns the join style used for drawing the item's frame + /** + * Returns the join style used for drawing the item's frame * \returns Join style for stroke frame * \since QGIS 2.3 * \see hasFrame @@ -394,7 +416,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ Qt::PenJoinStyle frameJoinStyle() const { return mFrameJoinStyle; } - /** Sets join style used when drawing the item's frame + /** + * Sets join style used when drawing the item's frame * \param style Join style for stroke frame * \since QGIS 2.3 * \see setFrameEnabled @@ -404,7 +427,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void setFrameJoinStyle( const Qt::PenJoinStyle style ); - /** Returns the estimated amount the item's frame bleeds outside the item's + /** + * Returns the estimated amount the item's frame bleeds outside the item's * actual rectangle. For instance, if the item has a 2mm frame stroke, then * 1mm of this frame is drawn outside the item's rect. In this case the * return value will be 1.0 @@ -413,7 +437,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual double estimatedFrameBleed() const; - /** Returns the item's rectangular bounds, including any bleed caused by the item's frame. + /** + * Returns the item's rectangular bounds, including any bleed caused by the item's frame. * The bounds are returned in the item's coordinate system (see Qt's QGraphicsItem docs for * more details about QGraphicsItem coordinate systems). The results differ from Qt's rect() * function, as rect() makes no allowances for the portion of outlines which are drawn @@ -423,14 +448,16 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual QRectF rectWithFrame() const; - /** Whether this item has a Background or not. + /** + * Whether this item has a Background or not. * \returns true if there is a Background around this item, otherwise false. * \see setBackgroundEnabled * \see backgroundColor */ bool hasBackground() const {return mBackground;} - /** Set whether this item has a Background drawn around it or not. + /** + * Set whether this item has a Background drawn around it or not. * \param drawBackground draw Background * \returns nothing * \see hasBackground @@ -438,14 +465,16 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void setBackgroundEnabled( const bool drawBackground ) { mBackground = drawBackground; } - /** Gets the background color for this item + /** + * Gets the background color for this item * \returns background color * \see setBackgroundColor * \see hasBackground */ QColor backgroundColor() const { return mBackgroundColor; } - /** Sets the background color for this item + /** + * Sets the background color for this item * \param backgroundColor new background color * \returns nothing * \see backgroundColor @@ -453,19 +482,22 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void setBackgroundColor( const QColor &backgroundColor ); - /** Returns the item's composition blending mode. + /** + * Returns the item's composition blending mode. * \returns item blending mode * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } - /** Sets the item's composition blending mode + /** + * Sets the item's composition blending mode * \param blendMode blending mode for item * \see blendMode */ void setBlendMode( const QPainter::CompositionMode blendMode ); - /** Returns the item's opacity. This method should be used instead of + /** + * Returns the item's opacity. This method should be used instead of * QGraphicsItem::opacity() as any data defined overrides will be * respected. * \returns opacity as double between 1.0 (opaque) and 0 (transparent). @@ -473,7 +505,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ double itemOpacity() const { return mOpacity; } - /** Sets the item's \a opacity. This method should be used instead of + /** + * Sets the item's \a opacity. This method should be used instead of * QGraphicsItem::setOpacity() as any data defined overrides will be * respected. * \param opacity double between 1.0 (opaque) and 0 (transparent). @@ -481,7 +514,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void setItemOpacity( const double opacity ); - /** Returns whether effects (e.g., blend modes) are enabled for the item + /** + * Returns whether effects (e.g., blend modes) are enabled for the item * \returns true if effects are enabled * \see setEffectsEnabled * \see itemOpacity() @@ -489,7 +523,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ bool effectsEnabled() const { return mEffectsEnabled; } - /** Sets whether effects (e.g., blend modes) are enabled for the item + /** + * Sets whether effects (e.g., blend modes) are enabled for the item * \param effectsEnabled set to true to enable effects * \see effectsEnabled * \see setItemOpacity() @@ -503,7 +538,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec virtual void beginItemCommand( const QString &text ) { beginCommand( text ); } - /** Starts new composer undo command + /** + * Starts new composer undo command \param commandText command title \param c context for mergeable commands (unknown for non-mergeable commands*/ void beginCommand( const QString &commandText, QgsComposerMergeCommand::Context c = QgsComposerMergeCommand::Unknown ); @@ -516,13 +552,15 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //functions that encapsulate the workaround for the Qt font bug (that is to scale the font size up and then scale the //painter down by the same factor for drawing - /** Locks / unlocks the item position for mouse drags + /** + * Locks / unlocks the item position for mouse drags * \param lock set to true to prevent item movement and resizing via the mouse * \see positionLock */ void setPositionLock( const bool lock ); - /** Returns whether position lock for mouse drags is enabled + /** + * Returns whether position lock for mouse drags is enabled * returns true if item is locked for mouse movement and resizing * \see setPositionLock */ @@ -545,19 +583,22 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual void updateItem(); - /** Get item's id (which is not necessarly unique) + /** + * Get item's id (which is not necessarly unique) * \returns item id * \see setId */ QString id() const { return mId; } - /** Set item's id (which is not necessarly unique) + /** + * Set item's id (which is not necessarly unique) * \param id new id for item * \see id */ virtual void setId( const QString &id ); - /** Get item identification name + /** + * Get item identification name * \returns unique item identification string * \note there is not setter since one can't manually set the id * \see id @@ -565,7 +606,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ QString uuid() const { return mUuid; } - /** Get item display name. This is the item's id if set, and if + /** + * Get item display name. This is the item's id if set, and if * not, a user-friendly string identifying item type. * \returns display name for item * \see id @@ -574,7 +616,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual QString displayName() const; - /** Sets visibility for item. + /** + * Sets visibility for item. * \param visible set to true to show item, false to hide item * \note QGraphicsItem::setVisible should not be called directly * on a QgsComposerItem, as some item types (e.g., groups) need to override @@ -583,7 +626,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual void setVisibility( const bool visible ); - /** Returns whether the item should be excluded from composer exports and prints + /** + * Returns whether the item should be excluded from composer exports and prints * \param valueType controls whether the returned value is the user specified value, * or the current evaluated value (which may be affected by data driven settings). * \returns true if item should be excluded @@ -592,28 +636,32 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ bool excludeFromExports( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ); - /** Sets whether the item should be excluded from composer exports and prints + /** + * Sets whether the item should be excluded from composer exports and prints * \param exclude set to true to exclude the item from exports * \since QGIS 2.5 * \see excludeFromExports */ virtual void setExcludeFromExports( const bool exclude ); - /** Returns whether this item is part of a group + /** + * Returns whether this item is part of a group * \returns true if item is in a group * \since QGIS 2.5 * \see setIsGroupMember */ bool isGroupMember() const { return mIsGroupMember; } - /** Sets whether this item is part of a group + /** + * Sets whether this item is part of a group * \param isGroupMember set to true if item is in a group * \since QGIS 2.5 * \see isGroupMember */ void setIsGroupMember( const bool isGroupMember ); - /** Get the number of layers that this item requires for exporting as layers + /** + * Get the number of layers that this item requires for exporting as layers * \returns 0 if this item is to be placed on the same layer as the previous item, * 1 if it should be placed on its own layer, and >1 if it requires multiple export layers * \since QGIS 2.4 @@ -621,14 +669,16 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ virtual int numberExportLayers() const { return 0; } - /** Sets the current layer to draw for exporting + /** + * Sets the current layer to draw for exporting * \param layerIdx can be set to -1 to draw all item layers, and must be less than numberExportLayers() * \since QGIS 2.4 * \see numberExportLayers */ virtual void setCurrentExportLayer( const int layerIdx = -1 ) { mCurrentExportLayer = layerIdx; } - /** Creates an expression context relating to the item's current state. The context includes + /** + * Creates an expression context relating to the item's current state. The context includes * scopes for global, project, composition, atlas and item properties. * \since QGIS 2.12 */ @@ -668,7 +718,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec void repaint() override; - /** Refreshes a data defined property for the item by reevaluating the property's value + /** + * Refreshes a data defined property for the item by reevaluating the property's value * and redrawing the item with this new value. * \param property data defined property to refresh. If property is set to * QgsComposerItem::AllProperties then all data defined properties for the item will be @@ -707,7 +758,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Background color QColor mBackgroundColor; - /** True if item position and size cannot be changed with mouse move + /** + * True if item position and size cannot be changed with mouse move */ bool mItemPositionLocked; @@ -717,7 +769,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Item rotation in degrees, clockwise double mItemRotation; - /** Temporary evaluated item rotation in degrees, clockwise. Data defined rotation may mean + /** + * Temporary evaluated item rotation in degrees, clockwise. Data defined rotation may mean * this value differs from mItemRotation. */ double mEvaluatedItemRotation; @@ -733,7 +786,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Whether item should be excluded in exports bool mExcludeFromExports; - /** Temporary evaluated item exclusion. Data defined properties may mean + /** + * Temporary evaluated item exclusion. Data defined properties may mean * this value differs from mExcludeFromExports. */ bool mEvaluatedExcludeFromExports; @@ -744,13 +798,15 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Whether or not this item is part of a group bool mIsGroupMember; - /** The layer that needs to be exported + /** + * The layer that needs to be exported * \note: if -1, all layers are to be exported * \since QGIS 2.4 */ int mCurrentExportLayer; - /** Draws additional graphics on selected items. The base implementation has + /** + * Draws additional graphics on selected items. The base implementation has * no effect. */ virtual void drawSelectionBoxes( QPainter *p ); @@ -761,11 +817,13 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Draw background virtual void drawBackground( QPainter *p ); - /** Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the + /** + * Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing*/ double rectHandlerBorderTolerance() const; - /** Returns the zoom factor of the graphics view. + /** + * Returns the zoom factor of the graphics view. * \returns the factor or -1 in case of error (e.g. graphic view does not exist) */ double horizontalViewScaleFactor() const; @@ -780,7 +838,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec void deleteVAlignSnapItem(); void deleteAlignItems(); - /** Evaluates an item's bounding rect to consider data defined position and size of item + /** + * Evaluates an item's bounding rect to consider data defined position and size of item * and reference point * \param newRect target bounding rect for item * \param resizeOnly set to true if the item is only being resized. If true then @@ -793,7 +852,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ QRectF evalItemRect( const QRectF &newRect, const bool resizeOnly = false, const QgsExpressionContext *context = nullptr ); - /** Returns whether the item should be drawn in the current context + /** + * Returns whether the item should be drawn in the current context * \returns true if item should be drawn * \since QGIS 2.5 */ @@ -805,12 +865,14 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec //! Emitted if the rectangle changes void sizeChanged(); - /** Emitted if the item's frame style changes + /** + * Emitted if the item's frame style changes * \since QGIS 2.2 */ void frameChanged(); - /** Emitted if the item's lock status changes + /** + * Emitted if the item's lock status changes * \since QGIS 2.5 */ void lockChanged(); @@ -831,7 +893,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ bool mUpdatesEnabled = true; - /** Refresh item's rotation, considering data defined rotation setting + /** + * Refresh item's rotation, considering data defined rotation setting *\param updateItem set to false to prevent the item being automatically updated *\param rotateAroundCenter set to true to rotate the item around its center rather * than its origin @@ -840,7 +903,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void refreshRotation( const bool updateItem = true, const bool rotateAroundCenter = false, const QgsExpressionContext &context = QgsExpressionContext() ); - /** Refresh item's opacity, considering data defined opacity + /** + * Refresh item's opacity, considering data defined opacity * \param updateItem set to false to prevent the item being automatically updated * after the opacity is set * \param context expression context for evaulating data defined opacity @@ -848,21 +912,24 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec */ void refreshOpacity( const bool updateItem = true, const QgsExpressionContext &context = QgsExpressionContext() ); - /** Refresh item's frame color, considering data defined colors + /** + * Refresh item's frame color, considering data defined colors * \param updateItem set to false to prevent the item being automatically updated * after the frame color is set * \param context expression context for evaulating data defined color */ void refreshFrameColor( const bool updateItem = true, const QgsExpressionContext &context = QgsExpressionContext() ); - /** Refresh item's background color, considering data defined colors + /** + * Refresh item's background color, considering data defined colors * \param updateItem set to false to prevent the item being automatically updated * after the background color is set * \param context expression context for evaulating data defined color */ void refreshBackgroundColor( const bool updateItem = true, const QgsExpressionContext &context = QgsExpressionContext() ); - /** Refresh item's blend mode, considering data defined blend mode + /** + * Refresh item's blend mode, considering data defined blend mode * \since QGIS 2.5 */ void refreshBlendMode( const QgsExpressionContext &context ); diff --git a/src/core/composer/qgscomposeritemcommand.h b/src/core/composer/qgscomposeritemcommand.h index 8eb32a683758..bbd6015f68c3 100644 --- a/src/core/composer/qgscomposeritemcommand.h +++ b/src/core/composer/qgscomposeritemcommand.h @@ -27,7 +27,8 @@ class QgsComposerItem; class QgsComposerMultiFrame; -/** \ingroup core +/** + * \ingroup core * Undo command to undo/redo all composer item related changes */ class CORE_EXPORT QgsComposerItemCommand: public QUndoCommand @@ -51,7 +52,8 @@ class CORE_EXPORT QgsComposerItemCommand: public QUndoCommand //! Returns true if previous state and after state are valid and different bool containsChange() const; - /** Returns the target item the command applies to. + /** + * Returns the target item the command applies to. * \returns target composer item */ QgsComposerItem *item() const; @@ -78,7 +80,8 @@ class CORE_EXPORT QgsComposerItemCommand: public QUndoCommand void restoreState( QDomDocument &stateDoc ) const; }; -/** \ingroup core +/** + * \ingroup core * A composer command that merges together with other commands having the same context (=id). Keeps the oldest previous state and uses the newest after state. The purpose is to avoid too many micro changes in the history */ diff --git a/src/core/composer/qgscomposeritemgroup.h b/src/core/composer/qgscomposeritemgroup.h index 7a0fe09d9b40..b741489e7381 100644 --- a/src/core/composer/qgscomposeritemgroup.h +++ b/src/core/composer/qgscomposeritemgroup.h @@ -22,7 +22,8 @@ #include "qgscomposeritem.h" #include -/** \ingroup core +/** + * \ingroup core * A container for grouping several QgsComposerItems */ class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem @@ -35,7 +36,8 @@ class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem //! Return correct graphics item type. virtual int type() const override { return ComposerItemGroup; } - /** Adds an item to the group. All the group members are deleted + /** + * Adds an item to the group. All the group members are deleted if the group is deleted*/ void addItem( QgsComposerItem *item ) override; //! Removes the items but does not delete them @@ -43,20 +45,23 @@ class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem //! Draw stroke and ev. selection handles void paint( QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr ) override; - /** Sets this items bound in scene coordinates such that 1 item size units + /** + * Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit*/ void setSceneRect( const QRectF &rectangle ) override; //overridden to also hide grouped items virtual void setVisibility( const bool visible ) override; - /** Stores state in Dom node + /** + * Stores state in Dom node * \param elem is Dom element corresponding to 'Composer' tag * \param doc is the Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom node corresponding to item tag * \param doc is the Dom document */ diff --git a/src/core/composer/qgscomposerlabel.h b/src/core/composer/qgscomposerlabel.h index a1122e75b3a5..212517cc4fcd 100644 --- a/src/core/composer/qgscomposerlabel.h +++ b/src/core/composer/qgscomposerlabel.h @@ -26,7 +26,8 @@ class QgsFeature; class QgsDistanceArea; class QgsWebPage; -/** \ingroup core +/** + * \ingroup core * A label that can be placed onto a map composition. */ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem @@ -57,43 +58,50 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem QFont font() const; void setFont( const QFont &f ); - /** Accessor for the vertical alignment of the label + /** + * Accessor for the vertical alignment of the label * \returns Qt::AlignmentFlag */ Qt::AlignmentFlag vAlign() const { return mVAlignment; } - /** Accessor for the horizontal alignment of the label + /** + * Accessor for the horizontal alignment of the label * \returns Qt::AlignmentFlag */ Qt::AlignmentFlag hAlign() const { return mHAlignment; } - /** Mutator for the horizontal alignment of the label + /** + * Mutator for the horizontal alignment of the label * \param a alignment * \returns void */ void setHAlign( Qt::AlignmentFlag a ) { mHAlignment = a; } - /** Mutator for the vertical alignment of the label + /** + * Mutator for the vertical alignment of the label * \param a alignment * \returns void */ void setVAlign( Qt::AlignmentFlag a ) { mVAlignment = a; } - /** Returns the horizontal margin between the edge of the frame and the label + /** + * Returns the horizontal margin between the edge of the frame and the label * contents. * \returns horizontal margin in mm * \since QGIS 2.7 */ double marginX() const { return mMarginX; } - /** Returns the vertical margin between the edge of the frame and the label + /** + * Returns the vertical margin between the edge of the frame and the label * contents. * \returns vertical margin in mm * \since QGIS 2.7 */ double marginY() const { return mMarginY; } - /** Sets the margin between the edge of the frame and the label contents. + /** + * Sets the margin between the edge of the frame and the label contents. * This method sets both the horizontal and vertical margins to the same * value. The margins can be individually controlled using the setMarginX * and setMarginY methods. @@ -103,7 +111,8 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem */ void setMargin( const double m ); - /** Sets the horizontal margin between the edge of the frame and the label + /** + * Sets the horizontal margin between the edge of the frame and the label * contents. * \param margin horizontal margin in mm * \see setMargin @@ -112,7 +121,8 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem */ void setMarginX( const double margin ); - /** Sets the vertical margin between the edge of the frame and the label + /** + * Sets the vertical margin between the edge of the frame and the label * contents. * \param margin vertical margin in mm * \see setMargin @@ -126,13 +136,15 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem //! Get font color QColor fontColor() const { return mFontColor; } - /** Stores state in Dom element + /** + * Stores state in Dom element * \param elem is Dom element corresponding to 'Composer' tag * \param doc document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom element corresponding to 'ComposerLabel' tag * \param doc document */ @@ -141,16 +153,19 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem //Overridden to contain part of label's text virtual QString displayName() const override; - /** In case of negative margins, the bounding rect may be larger than the + /** + * In case of negative margins, the bounding rect may be larger than the * label's frame */ QRectF boundingRect() const override; - /** Reimplemented to call prepareGeometryChange after toggling frame + /** + * Reimplemented to call prepareGeometryChange after toggling frame */ virtual void setFrameEnabled( const bool drawFrame ) override; - /** Reimplemented to call prepareGeometryChange after changing stroke width + /** + * Reimplemented to call prepareGeometryChange after changing stroke width */ virtual void setFrameStrokeWidth( const double strokeWidth ) override; diff --git a/src/core/composer/qgscomposerlegend.h b/src/core/composer/qgscomposerlegend.h index d394275a317e..435bf944116c 100644 --- a/src/core/composer/qgscomposerlegend.h +++ b/src/core/composer/qgscomposerlegend.h @@ -31,7 +31,8 @@ class QgsComposerMap; class QgsLegendRenderer; -/** \ingroup core +/** + * \ingroup core * Item model implementation based on layer tree model for composer legend. * Overrides some functionality of QgsLayerTreeModel to better fit the needs of composer legend. * @@ -51,7 +52,8 @@ class CORE_EXPORT QgsLegendModel : public QgsLayerTreeModel }; -/** \ingroup core +/** + * \ingroup core * A legend that can be placed onto a map composition */ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem @@ -73,7 +75,8 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem //! Sets item box to the whole content void adjustBoxSize(); - /** Sets whether the legend should automatically resize to fit its contents. + /** + * Sets whether the legend should automatically resize to fit its contents. * \param enabled set to false to disable automatic resizing. The legend frame will not * be expanded to fit legend items, and items may be cropped from display. * \see resizeToContents() @@ -81,7 +84,8 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem */ void setResizeToContents( bool enabled ); - /** Returns whether the legend should automatically resize to fit its contents. + /** + * Returns whether the legend should automatically resize to fit its contents. * \see setResizeToContents() * \since QGIS 3.0 */ @@ -134,14 +138,16 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem void setTitle( const QString &t ); QString title() const; - /** Returns the alignment of the legend title + /** + * Returns the alignment of the legend title * \returns Qt::AlignmentFlag for the legend title * \since QGIS 2.3 * \see setTitleAlignment */ Qt::AlignmentFlag titleAlignment() const; - /** Sets the alignment of the legend title + /** + * Sets the alignment of the legend title * \param alignment Text alignment for drawing the legend title * \since QGIS 2.3 * \see titleAlignment @@ -162,13 +168,15 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem void setStyleMargin( QgsLegendStyle::Style s, double margin ); void setStyleMargin( QgsLegendStyle::Style s, QgsLegendStyle::Side side, double margin ); - /** Returns the spacing in-between lines in mm + /** + * Returns the spacing in-between lines in mm * \since QGIS 3.0 * \see setLineSpacing */ double lineSpacing() const; - /** Sets the spacing in-between multiple lines + /** + * Sets the spacing in-between multiple lines * \param spacing Double value to use as spacing in between multiple lines * \since QGIS 3.0 * \see lineSpacing @@ -208,7 +216,8 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem bool equalColumnWidth() const; void setEqualColumnWidth( bool s ); - /** Returns whether a stroke will be drawn around raster symbol items. + /** + * Returns whether a stroke will be drawn around raster symbol items. * \see setDrawRasterStroke() * \see rasterStrokeColor() * \see rasterStrokeWidth() @@ -216,7 +225,8 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem */ bool drawRasterStroke() const; - /** Sets whether a stroke will be drawn around raster symbol items. + /** + * Sets whether a stroke will be drawn around raster symbol items. * \param enabled set to true to draw borders * \see drawRasterStroke() * \see setRasterStrokeColor() @@ -225,7 +235,8 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem */ void setDrawRasterStroke( bool enabled ); - /** Returns the stroke color for the stroke drawn around raster symbol items. The stroke is + /** + * Returns the stroke color for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. * \see setRasterStrokeColor() * \see drawRasterStroke() @@ -234,7 +245,8 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem */ QColor rasterStrokeColor() const; - /** Sets the stroke color for the stroke drawn around raster symbol items. The stroke is + /** + * Sets the stroke color for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. * \param color stroke color * \see rasterStrokeColor() @@ -244,7 +256,8 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem */ void setRasterStrokeColor( const QColor &color ); - /** Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items. The stroke is + /** + * Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. * \see setRasterStrokeWidth() * \see drawRasterStroke() @@ -253,7 +266,8 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem */ double rasterStrokeWidth() const; - /** Sets the stroke width for the stroke drawn around raster symbol items. The stroke is + /** + * Sets the stroke width for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. * \param width stroke width in millimeters * \see rasterStrokeWidth() @@ -269,13 +283,15 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem //! Updates the model and all legend entries void updateLegend(); - /** Stores state in Dom node + /** + * Stores state in Dom node * \param elem is Dom element corresponding to 'Composer' tag * \param doc Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom node corresponding to item tag * \param doc is Dom document */ diff --git a/src/core/composer/qgscomposermap.h b/src/core/composer/qgscomposermap.h index 7712a3ac0e9b..0d2c38a89215 100644 --- a/src/core/composer/qgscomposermap.h +++ b/src/core/composer/qgscomposermap.h @@ -45,7 +45,8 @@ class QgsVectorLayer; class QgsAnnotation; class QgsMapRendererCustomPainterJob; -/** \ingroup core +/** + * \ingroup core * \class QgsComposerMap * \brief Object representing map window. */ @@ -64,7 +65,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Return correct graphics item type. virtual int type() const override { return ComposerMap; } - /** Scaling modes used for the serial rendering (atlas) + /** + * Scaling modes used for the serial rendering (atlas) */ enum AtlasScalingMode { @@ -78,14 +80,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ Predefined, - /** The extent is adjusted so that each feature is fully visible. + /** + * The extent is adjusted so that each feature is fully visible. * A margin is applied around the center \see setAtlasMargin * \note This mode is only valid for polygon or line atlas coverage layers */ Auto }; - /** \brief Draw to paint device + /** + * \brief Draw to paint device * \param painter painter * \param extent map extent * \param size size in scene coordinates @@ -96,7 +100,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override; - /** Return map settings that would be used for drawing of the map + /** + * Return map settings that would be used for drawing of the map * \since QGIS 2.6 */ QgsMapSettings mapSettings( const QgsRectangle &extent, QSizeF size, int dpi ) const; @@ -109,13 +114,15 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Resizes an item in x- and y direction (canvas coordinates) void resize( double dx, double dy ); - /** Move content of map + /** + * Move content of map * \param dx move in x-direction (item and canvas coordinates) * \param dy move in y-direction (item and canvas coordinates) */ void moveContent( double dx, double dy ) override; - /** Zoom content of item. Does nothing per default (but implemented in composer map) + /** + * Zoom content of item. Does nothing per default (but implemented in composer map) * \param factor zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out * \param point item point for zoom center * \param mode zoom mode @@ -140,7 +147,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ void setNewScale( double scaleDenominator, bool forceUpdate = true ); - /** Sets new extent for the map. This method may change the width or height of the map + /** + * Sets new extent for the map. This method may change the width or height of the map * item to ensure that the extent exactly matches the specified extent, with no * overlap or margin. This method implicitly alters the map scale. * \param extent new extent for the map @@ -148,7 +156,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ void setNewExtent( const QgsRectangle &extent ); - /** Zooms the map so that the specified extent is fully visible within the map item. + /** + * Zooms the map so that the specified extent is fully visible within the map item. * This method will not change the width or height of the map, and may result in * an overlap or margin from the specified extent. This method implicitly alters the * map scale. @@ -158,12 +167,14 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ void zoomToExtent( const QgsRectangle &extent ); - /** Sets new Extent for the current atlas preview and changes width, height (and implicitly also scale). + /** + * Sets new Extent for the current atlas preview and changes width, height (and implicitly also scale). Atlas preview extents are only temporary, and are regenerated whenever the atlas feature changes */ void setNewAtlasFeatureExtent( const QgsRectangle &extent ); - /** Returns a pointer to the current map extent, which is either the original user specified + /** + * Returns a pointer to the current map extent, which is either the original user specified * extent or the temporary atlas-driven feature extent depending on the current atlas state * of the composition. Both a const and non-const version are included. * \returns pointer to current map extent @@ -254,7 +265,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Stores the current layer styles into style overrides. \since QGIS 2.8 void storeCurrentLayerStyles(); - /** Whether the map should follow a map theme. If true, the layers and layer styles + /** + * Whether the map should follow a map theme. If true, the layers and layer styles * will be used from given preset name (configured with setFollowVisibilityPresetName() method). * This means when preset's settings are changed, the new settings are automatically * picked up next time when rendering, without having to explicitly update them. @@ -265,16 +277,19 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem * \since QGIS 2.16 */ bool followVisibilityPreset() const { return mFollowVisibilityPreset; } - /** Sets whether the map should follow a map theme. See followVisibilityPreset() for more details. + /** + * Sets whether the map should follow a map theme. See followVisibilityPreset() for more details. * \since QGIS 2.16 */ void setFollowVisibilityPreset( bool follow ) { mFollowVisibilityPreset = follow; } - /** Preset name that decides which layers and layer styles are used for map rendering. It is only + /** + * Preset name that decides which layers and layer styles are used for map rendering. It is only * used when followVisibilityPreset() returns true. * \since QGIS 2.16 */ QString followVisibilityPresetName() const { return mFollowVisibilityPresetName; } - /** Sets preset name for map rendering. See followVisibilityPresetName() for more details. + /** + * Sets preset name for map rendering. See followVisibilityPresetName() for more details. * \since QGIS 2.16 */ void setFollowVisibilityPresetName( const QString &name ) { mFollowVisibilityPresetName = name; } @@ -289,19 +304,22 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! True if composer map contains layers with blend modes or flattened layers for vectors bool containsAdvancedEffects() const; - /** Stores state in Dom node + /** + * Stores state in Dom node * \param elem is Dom element corresponding to 'Composer' tag * \param doc Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom node corresponding to 'ComposerMap' tag * \param doc is Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; - /** Returns the map item's grid stack, which is used to control how grids + /** + * Returns the map item's grid stack, which is used to control how grids * are drawn over the map's contents. * \returns pointer to grid stack * \see grid() @@ -309,14 +327,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ QgsComposerMapGridStack *grids() { return mGridStack; } - /** Returns the map item's first grid. This is a convenience function. + /** + * Returns the map item's first grid. This is a convenience function. * \returns pointer to first grid for map item * \see grids() * \since QGIS 2.5 */ QgsComposerMapGrid *grid(); - /** Returns the map item's overview stack, which is used to control how overviews + /** + * Returns the map item's overview stack, which is used to control how overviews * are drawn over the map's contents. * \returns pointer to overview stack * \see overview() @@ -324,7 +344,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ QgsComposerMapOverviewStack *overviews() { return mOverviewStack; } - /** Returns the map item's first overview. This is a convenience function. + /** + * Returns the map item's first overview. This is a convenience function. * \returns pointer to first overview for map item * \see overviews() * \since QGIS 2.5 @@ -369,25 +390,29 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Returns the conversion factor map units -> mm double mapUnitsToMM() const; - /** Sets mId to a number not yet used in the composition. mId is kept if it is not in use. + /** + * Sets mId to a number not yet used in the composition. mId is kept if it is not in use. Usually, this function is called before adding the composer map to the composition*/ void assignFreeId(); - /** Returns whether the map extent is set to follow the current atlas feature. + /** + * Returns whether the map extent is set to follow the current atlas feature. * \returns true if map will follow the current atlas feature. * \see setAtlasDriven * \see atlasScalingMode */ bool atlasDriven() const { return mAtlasDriven; } - /** Sets whether the map extent will follow the current atlas feature. + /** + * Sets whether the map extent will follow the current atlas feature. * \param enabled set to true if the map extents should be set by the current atlas feature. * \see atlasDriven * \see setAtlasScalingMode */ void setAtlasDriven( bool enabled ); - /** Returns the current atlas scaling mode. This controls how the map's extents + /** + * Returns the current atlas scaling mode. This controls how the map's extents * are calculated for the current atlas feature when an atlas composition * is enabled. * \returns the current scaling mode @@ -397,7 +422,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ AtlasScalingMode atlasScalingMode() const { return mAtlasScalingMode; } - /** Sets the current atlas scaling mode. This controls how the map's extents + /** + * Sets the current atlas scaling mode. This controls how the map's extents * are calculated for the current atlas feature when an atlas composition * is enabled. * \param mode atlas scaling mode to set @@ -407,7 +433,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ void setAtlasScalingMode( AtlasScalingMode mode ) { mAtlasScalingMode = mode; } - /** Returns the margin size (percentage) used when the map is in atlas mode. + /** + * Returns the margin size (percentage) used when the map is in atlas mode. * \param valueType controls whether the returned value is the user specified atlas margin, * or the current evaluated atlas margin (which may be affected by data driven atlas margin * settings). @@ -418,7 +445,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ double atlasMargin( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ); - /** Sets the margin size (percentage) used when the map is in atlas mode. + /** + * Sets the margin size (percentage) used when the map is in atlas mode. * \param margin size in percentage to leave around the atlas feature's extent * \note this is only used if atlasScalingMode() is Auto. * \see atlasScalingMode @@ -426,14 +454,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem */ void setAtlasMargin( double margin ) { mAtlasMargin = margin; } - /** Get the number of layers that this item requires for exporting as layers + /** + * Get the number of layers that this item requires for exporting as layers * \returns 0 if this item is to be placed on the same layer as the previous item, * 1 if it should be placed on its own layer, and >1 if it requires multiple export layers * \since QGIS 2.4 */ int numberExportLayers() const override; - /** Returns a polygon representing the current visible map extent, considering map extents and rotation. + /** + * Returns a polygon representing the current visible map extent, considering map extents and rotation. * If the map rotation is 0, the result is the same as currentMapExtent * \returns polygon with the four corner points representing the visible map extent. The points are * clockwise, starting at the top-left point @@ -450,7 +480,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Transforms map coordinates to item coordinates (considering rotation and move offset) QPointF mapToItemCoords( QPointF mapCoords ) const; - /** Calculates the extent to request and the yShift of the top-left point in case of rotation. + /** + * Calculates the extent to request and the yShift of the top-left point in case of rotation. * \since QGIS 2.6 */ void requestedExtent( QgsRectangle &extent ) const; @@ -465,7 +496,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Is emitted when the map has been prepared for atlas rendering, just before actual rendering void preparedForAtlas(); - /** Emitted when layer style overrides are changed... a means to let + /** + * Emitted when layer style overrides are changed... a means to let * associated legend items know they should update * \since QGIS 2.10 */ @@ -541,7 +573,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Map rotation double mMapRotation = 0; - /** Temporary evaluated map rotation. Data defined rotation may mean this value + /** + * Temporary evaluated map rotation. Data defined rotation may mean this value * differs from mMapRotation*/ double mEvaluatedMapRotation = 0; @@ -555,12 +588,14 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Stored style names (value) to be used with particular layer IDs (key) instead of default style QMap mLayerStyleOverrides; - /** Whether layers and styles should be used from a preset (preset name is stored + /** + * Whether layers and styles should be used from a preset (preset name is stored * in mVisibilityPresetName and may be overridden by data-defined expression). * This flag has higher priority than mKeepLayerSet. */ bool mFollowVisibilityPreset = false; - /** Map theme name to be used for map's layers and styles in case mFollowVisibilityPreset + /** + * Map theme name to be used for map's layers and styles in case mFollowVisibilityPreset * is true. May be overridden by data-defined expression. */ QString mFollowVisibilityPresetName; @@ -584,7 +619,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! True if annotation items, rubber band, etc. from the main canvas should be displayed bool mDrawAnnotations = true; - /** Adjusts an extent rectangle to match the provided item width and height, so that extent + /** + * Adjusts an extent rectangle to match the provided item width and height, so that extent * center of extent remains the same */ void adjustExtentToItemShape( double itemWidth, double itemHeight, QgsRectangle &extent ) const; @@ -616,7 +652,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! MapPolygon variant using a given extent void mapPolygon( const QgsRectangle &extent, QPolygonF &poly ) const; - /** Scales a composer map shift (in MM) and rotates it by mRotation + /** + * Scales a composer map shift (in MM) and rotates it by mRotation \param xShift in: shift in x direction (in item units), out: xShift in map units \param yShift in: shift in y direction (in item units), out: yShift in map units*/ void transformShift( double &xShift, double &yShift ) const; @@ -638,7 +675,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem //! Test if a part of the copmosermap needs to be drawn, considering mCurrentExportLayer bool shouldDrawPart( PartType part ) const; - /** Refresh the map's extents, considering data defined extent, scale and rotation + /** + * Refresh the map's extents, considering data defined extent, scale and rotation * \param context expression context for evaluating data defined map parameters * \since QGIS 2.5 */ diff --git a/src/core/composer/qgscomposermapgrid.h b/src/core/composer/qgscomposermapgrid.h index 68003499d995..be760815c06d 100644 --- a/src/core/composer/qgscomposermapgrid.h +++ b/src/core/composer/qgscomposermapgrid.h @@ -37,7 +37,8 @@ class QDomElement; class QPainter; class QgsRenderContext; -/** \ingroup core +/** + * \ingroup core * \class QgsComposerMapGridStack * \brief A collection of grids which is drawn above the map content in a * QgsComposerMap. The grid stack controls which grids are drawn and the @@ -49,12 +50,14 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack { public: - /** Constructor for QgsComposerMapGridStack. + /** + * Constructor for QgsComposerMapGridStack. * \param map QgsComposerMap the grid stack is attached to */ QgsComposerMapGridStack( QgsComposerMap *map ); - /** Adds a new map grid to the stack and takes ownership of the grid. + /** + * Adds a new map grid to the stack and takes ownership of the grid. * The grid will be added to the end of the stack, and rendered * above any existing map grids already present in the stack. * \param grid QgsComposerMapGrid to add to the stack @@ -64,7 +67,8 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack */ void addGrid( QgsComposerMapGrid *grid SIP_TRANSFER ); - /** Removes a grid from the stack and deletes the corresponding QgsComposerMapGrid + /** + * Removes a grid from the stack and deletes the corresponding QgsComposerMapGrid * \param gridId id for the QgsComposerMapGrid to remove * \note after removing a grid from the stack, updateBoundingRect() and update() * should be called for the QgsComposerMap to prevent rendering artifacts @@ -72,7 +76,8 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack */ void removeGrid( const QString &gridId ); - /** Moves a grid up the stack, causing it to be rendered above other grids + /** + * Moves a grid up the stack, causing it to be rendered above other grids * \param gridId id for the QgsComposerMapGrid to move up * \note after moving a grid within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new grid stack order @@ -80,7 +85,8 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack */ void moveGridUp( const QString &gridId ); - /** Moves a grid down the stack, causing it to be rendered below other grids + /** + * Moves a grid down the stack, causing it to be rendered below other grids * \param gridId id for the QgsComposerMapGrid to move down * \note after moving a grid within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new grid stack order @@ -88,28 +94,32 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack */ void moveGridDown( const QString &gridId ); - /** Returns a const reference to a grid within the stack + /** + * Returns a const reference to a grid within the stack * \param gridId id for the QgsComposerMapGrid to find * \returns const reference to grid, if found * \see grid */ const QgsComposerMapGrid *constGrid( const QString &gridId ) const; - /** Returns a reference to a grid within the stack + /** + * Returns a reference to a grid within the stack * \param gridId id for the QgsComposerMapGrid to find * \returns reference to grid if found * \see constGrid */ QgsComposerMapGrid *grid( const QString &gridId ) const; - /** Returns a reference to a grid within the stack + /** + * Returns a reference to a grid within the stack * \param index grid position in the stack * \returns reference to grid if found * \see constGrid */ QgsComposerMapGrid *grid( const int index ) const; - /** Returns a reference to a grid within the stack + /** + * Returns a reference to a grid within the stack * \param idx grid position in the stack * \returns reference to grid if found * \see constGrid @@ -117,12 +127,14 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack */ QgsComposerMapGrid &operator[]( int idx ); - /** Returns a list of QgsComposerMapGrids contained by the stack + /** + * Returns a list of QgsComposerMapGrids contained by the stack * \returns list of grids */ QList< QgsComposerMapGrid * > asList() const; - /** Sets the grid stack's state from a DOM document + /** + * Sets the grid stack's state from a DOM document * \param elem is DOM node corresponding to 'a ComposerMap' tag * \param doc DOM document * \returns true if read was successful @@ -130,14 +142,16 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack */ bool readXml( const QDomElement &elem, const QDomDocument &doc ) override; - /** Calculates the maximum distance grids within the stack extend + /** + * Calculates the maximum distance grids within the stack extend * beyond the QgsComposerMap's item rect * \returns maximum grid extension * \see calculateMaxGridExtension() */ double maxGridExtension() const; - /** Calculates the maximum distance grids within the stack extend beyond the + /** + * Calculates the maximum distance grids within the stack extend beyond the * QgsComposerMap's item rect. This method calculates the distance for each side of the * map item separately * \param top storage for top extension @@ -154,7 +168,8 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack // QgsComposerMapGrid // -/** \ingroup core +/** + * \ingroup core * \class QgsComposerMapGrid * \brief An individual grid which is drawn above the map content in a * QgsComposerMap. @@ -168,7 +183,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem public: - /** Unit for grid values + /** + * Unit for grid values */ enum GridUnit { @@ -177,7 +193,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem CM //!< Grid units in centimeters }; - /** Grid drawing style + /** + * Grid drawing style */ enum GridStyle { @@ -187,7 +204,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem FrameAnnotationsOnly //!< No grid lines over the map, only draw frame and annotations }; - /** Display settings for grid annotations and frames + /** + * Display settings for grid annotations and frames */ enum DisplayMode { @@ -197,7 +215,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem HideAll //!< No annotations }; - /** Position for grid annotations + /** + * Position for grid annotations */ enum AnnotationPosition { @@ -205,7 +224,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem OutsideMapFrame, //!< Draw annotations outside the map frame }; - /** Direction of grid annotations + /** + * Direction of grid annotations */ enum AnnotationDirection { @@ -215,7 +235,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem BoundaryDirection //!< Annotations follow the boundary direction }; - /** Format for displaying grid annotations + /** + * Format for displaying grid annotations */ enum AnnotationFormat { @@ -230,7 +251,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem CustomFormat //!< Custom expression-based format }; - /** Border sides for annotations + /** + * Border sides for annotations */ enum BorderSide { @@ -240,7 +262,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem Top //!< Top border }; - /** Style for grid frame + /** + * Style for grid frame */ enum FrameStyle { @@ -252,7 +275,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem LineBorder //!< Simple solid line frame }; - /** Flags for controlling which side of the map a frame is drawn on + /** + * Flags for controlling which side of the map a frame is drawn on */ enum FrameSideFlag { @@ -263,7 +287,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem }; Q_DECLARE_FLAGS( FrameSideFlags, FrameSideFlag ) - /** Annotation coordinate type + /** + * Annotation coordinate type */ enum AnnotationCoordinate { @@ -271,7 +296,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem Latitude //!< Coordinate is a latitude value }; - /** Constructor for QgsComposerMapGrid. + /** + * Constructor for QgsComposerMapGrid. * \param name friendly display name for grid * \param map QgsComposerMap the grid is attached to */ @@ -279,44 +305,51 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem virtual ~QgsComposerMapGrid(); - /** Draws a grid + /** + * Draws a grid * \param painter destination QPainter */ void draw( QPainter *painter ) override; - /** Stores grid state in DOM element + /** + * Stores grid state in DOM element * \param elem is DOM element corresponding to a 'ComposerMap' tag * \param doc DOM document * \see readXml */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets grid state from a DOM document + /** + * Sets grid state from a DOM document * \param itemElem is DOM node corresponding to a 'ComposerMapGrid' tag * \param doc is DOM document * \see writeXml */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; - /** Sets the CRS for the grid. + /** + * Sets the CRS for the grid. * \param crs coordinate reference system for grid * \see crs */ void setCrs( const QgsCoordinateReferenceSystem &crs ); - /** Retrieves the CRS for the grid. + /** + * Retrieves the CRS for the grid. * \returns coordinate reference system for grid * \see setCrs */ QgsCoordinateReferenceSystem crs() const { return mCRS; } - /** Sets the blending mode used for drawing the grid. + /** + * Sets the blending mode used for drawing the grid. * \param mode blending mode for grid * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } - /** Retrieves the blending mode used for drawing the grid. + /** + * Retrieves the blending mode used for drawing the grid. * \returns blending mode for grid * \see setBlendMode */ @@ -324,13 +357,15 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem bool usesAdvancedEffects() const override; - /** Calculates the maximum distance the grid extends beyond the QgsComposerMap's + /** + * Calculates the maximum distance the grid extends beyond the QgsComposerMap's * item rect * \returns maximum extension in millimeters */ double maxExtension(); - /** Calculates the maximum distance the grid extends beyond the + /** + * Calculates the maximum distance the grid extends beyond the * QgsComposerMap's item rect. This method calculates the distance for each side of the * map item separately * \param top storage for top extension @@ -346,21 +381,24 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem // GRID UNITS // - /** Sets the units to use for grid measurements such as the interval + /** + * Sets the units to use for grid measurements such as the interval * and offset for grid lines. * \param unit unit for grid measurements * \see units */ void setUnits( const GridUnit unit ); - /** Gets the units used for grid measurements such as the interval + /** + * Gets the units used for grid measurements such as the interval * and offset for grid lines. * \returns for grid measurements * \see setUnits */ GridUnit units() const { return mGridUnit; } - /** Sets the interval between grid lines in the x-direction. The units + /** + * Sets the interval between grid lines in the x-direction. The units * are controlled through the setUnits method * \param interval interval between horizontal grid lines * \see setIntervalY @@ -368,7 +406,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setIntervalX( const double interval ); - /** Gets the interval between grid lines in the x-direction. The units + /** + * Gets the interval between grid lines in the x-direction. The units * are retrieved through the units() method. * \returns interval between horizontal grid lines * \see setIntervalX @@ -376,7 +415,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ double intervalX() const { return mGridIntervalX; } - /** Sets the interval between grid lines in the y-direction. The units + /** + * Sets the interval between grid lines in the y-direction. The units * are controlled through the setUnits method * \param interval interval between vertical grid lines * \see setIntervalX @@ -384,7 +424,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setIntervalY( const double interval ); - /** Gets the interval between grid lines in the y-direction. The units + /** + * Gets the interval between grid lines in the y-direction. The units * are retrieved through the units() method. * \returns interval between vertical grid lines * \see setIntervalY @@ -392,7 +433,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ double intervalY() const { return mGridIntervalY; } - /** Sets the offset for grid lines in the x-direction. The units + /** + * Sets the offset for grid lines in the x-direction. The units * are controlled through the setUnits method * \param offset offset for horizontal grid lines * \see setOffsetY @@ -400,7 +442,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setOffsetX( const double offset ); - /** Gets the offset for grid lines in the x-direction. The units + /** + * Gets the offset for grid lines in the x-direction. The units * are retrieved through the units() method. * \returns offset for horizontal grid lines * \see setOffsetX @@ -408,7 +451,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ double offsetX() const { return mGridOffsetX; } - /** Sets the offset for grid lines in the y-direction. The units + /** + * Sets the offset for grid lines in the y-direction. The units * are controlled through the setUnits method * \param offset offset for vertical grid lines * \see setOffsetX @@ -416,7 +460,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setOffsetY( const double offset ); - /** Gets the offset for grid lines in the y-direction. The units + /** + * Gets the offset for grid lines in the y-direction. The units * are retrieved through the units() method. * \returns offset for vertical grid lines * \see setOffsetY @@ -428,35 +473,40 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem // GRID APPEARANCE // - /** Sets the grid style, which controls how the grid is drawn + /** + * Sets the grid style, which controls how the grid is drawn * over the map's contents * \param style desired grid style * \see style */ void setStyle( const GridStyle style ); - /** Gets the grid's style, which controls how the grid is drawn + /** + * Gets the grid's style, which controls how the grid is drawn * over the map's contents * \returns current grid style * \see setStyle */ GridStyle style() const { return mGridStyle; } - /** Sets the length of the cross segments drawn for the grid. This is only used for grids + /** + * Sets the length of the cross segments drawn for the grid. This is only used for grids * with QgsComposerMapGrid::Cross styles * \param length cross length in millimeters * \see crossLength */ void setCrossLength( const double length ) { mCrossLength = length; } - /** Retrieves the length of the cross segments drawn for the grid. This is only used for grids + /** + * Retrieves the length of the cross segments drawn for the grid. This is only used for grids * with QgsComposerMapGrid::Cross styles * \returns cross length in millimeters * \see setCrossLength */ double crossLength() const { return mCrossLength; } - /** Sets width of grid lines. This is only used for grids with QgsComposerMapGrid::Solid + /** + * Sets width of grid lines. This is only used for grids with QgsComposerMapGrid::Solid * or QgsComposerMapGrid::Cross styles. For more control over grid line appearance, use * setLineSymbol instead. * \param width grid line width @@ -465,7 +515,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setGridLineWidth( const double width ); - /** Sets color of grid lines. This is only used for grids with QgsComposerMapGrid::Solid + /** + * Sets color of grid lines. This is only used for grids with QgsComposerMapGrid::Solid * or QgsComposerMapGrid::Cross styles. For more control over grid line appearance, use * setLineSymbol instead. * \param color color of grid lines @@ -474,7 +525,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setGridLineColor( const QColor &color ); - /** Sets the line symbol used for drawing grid lines. This is only used for grids with + /** + * Sets the line symbol used for drawing grid lines. This is only used for grids with * QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles. * \param symbol line symbol for grid lines * \see lineSymbol @@ -483,7 +535,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setLineSymbol( QgsLineSymbol *symbol SIP_TRANSFER ); - /** Gets the line symbol used for drawing grid lines. This is only used for grids with + /** + * Gets the line symbol used for drawing grid lines. This is only used for grids with * QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles. * \returns line symbol for grid lines * \see setLineSymbol @@ -493,7 +546,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ const QgsLineSymbol *lineSymbol() const { return mGridLineSymbol; } SIP_SKIP - /** Gets the line symbol used for drawing grid lines. This is only used for grids with + /** + * Gets the line symbol used for drawing grid lines. This is only used for grids with * QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles. * \returns line symbol for grid lines * \see setLineSymbol @@ -502,7 +556,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ QgsLineSymbol *lineSymbol() { return mGridLineSymbol; } - /** Sets the marker symbol used for drawing grid points. This is only used for grids with a + /** + * Sets the marker symbol used for drawing grid points. This is only used for grids with a * QgsComposerMapGrid::Markers style. * \param symbol marker symbol for grid intersection points * \see markerSymbol @@ -511,7 +566,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setMarkerSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER ); - /** Gets the marker symbol used for drawing grid points. This is only used for grids with a + /** + * Gets the marker symbol used for drawing grid points. This is only used for grids with a * QgsComposerMapGrid::Markers style. * \returns marker symbol for grid intersection points * \see setMarkerSymbol @@ -521,7 +577,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ const QgsMarkerSymbol *markerSymbol() const { return mGridMarkerSymbol; } SIP_SKIP - /** Gets the marker symbol used for drawing grid points. This is only used for grids with a + /** + * Gets the marker symbol used for drawing grid points. This is only used for grids with a * QgsComposerMapGrid::Markers style. * \returns marker symbol for grid intersection points * \see setMarkerSymbol @@ -534,55 +591,64 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem // ANNOTATIONS // - /** Sets whether annotations should be shown for the grid. + /** + * Sets whether annotations should be shown for the grid. * \param enabled set to true to draw annotations for the grid * \see annotationEnabled */ void setAnnotationEnabled( const bool enabled ) { mShowGridAnnotation = enabled; } - /** Gets whether annotations are shown for the grid. + /** + * Gets whether annotations are shown for the grid. * \returns true if annotations are drawn for the grid * \see setAnnotationEnabled */ bool annotationEnabled() const { return mShowGridAnnotation; } - /** Sets the font used for drawing grid annotations + /** + * Sets the font used for drawing grid annotations * \param font font for annotations * \see annotationFont */ void setAnnotationFont( const QFont &font ) { mGridAnnotationFont = font; } - /** Gets the font used for drawing grid annotations + /** + * Gets the font used for drawing grid annotations * \returns font for annotations * \see setAnnotationFont */ QFont annotationFont() const { return mGridAnnotationFont; } - /** Sets the font color used for drawing grid annotations + /** + * Sets the font color used for drawing grid annotations * \param color font color for annotations * \see annotationFontColor */ void setAnnotationFontColor( const QColor &color ) { mGridAnnotationFontColor = color; } - /** Gets the font color used for drawing grid annotations + /** + * Gets the font color used for drawing grid annotations * \returns font color for annotations * \see setAnnotationFontColor */ QColor annotationFontColor() const { return mGridAnnotationFontColor; } - /** Sets the coordinate precision for grid annotations + /** + * Sets the coordinate precision for grid annotations * \param precision number of decimal places to show when drawing grid annotations * \see annotationPrecision */ void setAnnotationPrecision( const int precision ) { mGridAnnotationPrecision = precision; } - /** Returns the coordinate precision for grid annotations + /** + * Returns the coordinate precision for grid annotations * \returns number of decimal places shown when drawing grid annotations * \see setAnnotationPrecision */ int annotationPrecision() const { return mGridAnnotationPrecision; } - /** Sets what types of grid annotations should be drawn for a specified side of the map frame, + /** + * Sets what types of grid annotations should be drawn for a specified side of the map frame, * or whether grid annotations should be disabled for the side. * \param display display mode for annotations * \param border side of map for annotations @@ -591,7 +657,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setAnnotationDisplay( const DisplayMode display, const BorderSide border ); - /** Gets the display mode for the grid annotations on a specified side of the map + /** + * Gets the display mode for the grid annotations on a specified side of the map * frame. This property also specifies whether annotations have been disabled * from a side of the map frame. * \param border side of map for annotations @@ -601,7 +668,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ DisplayMode annotationDisplay( const BorderSide border ) const; - /** Sets the position for the grid annotations on a specified side of the map + /** + * Sets the position for the grid annotations on a specified side of the map * frame. * \param position position to draw grid annotations * \param border side of map for annotations @@ -609,7 +677,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setAnnotationPosition( const AnnotationPosition position, const BorderSide border ); - /** Gets the position for the grid annotations on a specified side of the map + /** + * Gets the position for the grid annotations on a specified side of the map * frame. * \param border side of map for annotations * \returns position that grid annotations are drawn in @@ -617,51 +686,59 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ AnnotationPosition annotationPosition( const BorderSide border ) const; - /** Sets the distance between the map frame and annotations. Units are in millimeters. + /** + * Sets the distance between the map frame and annotations. Units are in millimeters. * \param distance margin between map frame and annotations * \see annotationFrameDistance */ void setAnnotationFrameDistance( const double distance ) { mAnnotationFrameDistance = distance; } - /** Gets the distance between the map frame and annotations. Units are in millimeters. + /** + * Gets the distance between the map frame and annotations. Units are in millimeters. * \returns margin between map frame and annotations * \see setAnnotationFrameDistance */ double annotationFrameDistance() const { return mAnnotationFrameDistance; } - /** Sets the direction for drawing frame annotations. + /** + * Sets the direction for drawing frame annotations. * \param direction direction for frame annotations * \param border side of map for annotations * \see annotationDirection */ void setAnnotationDirection( const AnnotationDirection direction, const BorderSide border ); - /** Sets the direction for drawing all frame annotations. + /** + * Sets the direction for drawing all frame annotations. * \param direction direction for frame annotations * \see annotationDirection */ void setAnnotationDirection( const AnnotationDirection direction ); - /** Gets the direction for drawing frame annotations. + /** + * Gets the direction for drawing frame annotations. * \param border side of map for annotations * \returns direction for frame annotations * \see setAnnotationDirection */ AnnotationDirection annotationDirection( const BorderSide border ) const; - /** Sets the format for drawing grid annotations. + /** + * Sets the format for drawing grid annotations. * \param format format for grid annotations * \see annotationFormat */ void setAnnotationFormat( const AnnotationFormat format ) { mGridAnnotationFormat = format; } - /** Gets the format for drawing grid annotations. + /** + * Gets the format for drawing grid annotations. * \returns format for grid annotations * \see setAnnotationFormat */ AnnotationFormat annotationFormat() const { return mGridAnnotationFormat; } - /** Sets the expression used for drawing grid annotations. This is only used when annotationFormat() + /** + * Sets the expression used for drawing grid annotations. This is only used when annotationFormat() * is QgsComposerMapGrid::CustomFormat. * \param expression expression for evaluating custom grid annotations * \see annotationExpression @@ -669,7 +746,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setAnnotationExpression( const QString &expression ) { mGridAnnotationExpressionString = expression; mGridAnnotationExpression.reset(); } - /** Returns the expression used for drawing grid annotations. This is only used when annotationFormat() + /** + * Returns the expression used for drawing grid annotations. This is only used when annotationFormat() * is QgsComposerMapGrid::CustomFormat. * \returns expression for evaluating custom grid annotations * \see setAnnotationExpression @@ -681,19 +759,22 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem // GRID FRAME // - /** Sets the grid frame style. + /** + * Sets the grid frame style. * \param style style for grid frame * \see frameStyle */ void setFrameStyle( const FrameStyle style ) { mGridFrameStyle = style; } - /** Gets the grid frame style. + /** + * Gets the grid frame style. * \returns style for grid frame * \see setFrameStyle */ FrameStyle frameStyle() const { return mGridFrameStyle; } - /** Sets what type of grid divisions should be used for frames on a specified side of the map. + /** + * Sets what type of grid divisions should be used for frames on a specified side of the map. * \param divisions grid divisions for frame * \param border side of map for frame * \see frameDivisions @@ -701,7 +782,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setFrameDivisions( const DisplayMode divisions, const BorderSide border ); - /** Gets the type of grid divisions which are used for frames on a specified side of the map. + /** + * Gets the type of grid divisions which are used for frames on a specified side of the map. * \param border side of map for frame * \returns grid divisions for frame * \see setFrameDivisions @@ -709,7 +791,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ DisplayMode frameDivisions( const BorderSide border ) const; - /** Sets flags for grid frame sides. Setting these flags controls which sides + /** + * Sets flags for grid frame sides. Setting these flags controls which sides * of the map item the grid frame is drawn on. * \param flags flags for grid frame sides * \see setFrameSideFlag @@ -718,7 +801,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setFrameSideFlags( QgsComposerMapGrid::FrameSideFlags flags ); - /** Sets whether the grid frame is drawn for a certain side of the map item. + /** + * Sets whether the grid frame is drawn for a certain side of the map item. * \param flag flag for grid frame side * \param on set to true to draw grid frame on that side of the map * \see setFrameSideFlags @@ -727,7 +811,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setFrameSideFlag( const FrameSideFlag flag, bool on = true ); - /** Returns the flags which control which sides of the map item the grid frame + /** + * Returns the flags which control which sides of the map item the grid frame * is drawn on. * \returns flags for side of map grid is drawn on * \see setFrameSideFlags @@ -736,7 +821,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ FrameSideFlags frameSideFlags() const; - /** Tests whether the grid frame should be drawn on a specified side of the map + /** + * Tests whether the grid frame should be drawn on a specified side of the map * item. * \param flag flag for grid frame side * \returns true if grid frame should be drawn for that side of the map @@ -746,7 +832,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ bool testFrameSideFlag( const FrameSideFlag flag ) const; - /** Sets the grid frame width. This property controls how wide the grid frame is. + /** + * Sets the grid frame width. This property controls how wide the grid frame is. * The size of the line outlines drawn in the frame is controlled through the * setFramePenSize method. * \param width width of grid frame in millimeters @@ -754,7 +841,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setFrameWidth( const double width ) { mGridFrameWidth = width; } - /** Gets the grid frame width. This property controls how wide the grid frame is. + /** + * Gets the grid frame width. This property controls how wide the grid frame is. * The size of the line outlines drawn in the frame can be retrieved via the * framePenSize method. * \returns width of grid frame in millimeters @@ -762,21 +850,24 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ double frameWidth() const { return mGridFrameWidth; } - /** Sets the width of the stroke drawn in the grid frame. + /** + * Sets the width of the stroke drawn in the grid frame. * \param width width of grid frame stroke * \see framePenSize * \see setFramePenColor */ void setFramePenSize( const double width ) { mGridFramePenThickness = width; } - /** Retrieves the width of the stroke drawn in the grid frame. + /** + * Retrieves the width of the stroke drawn in the grid frame. * \returns width of grid frame stroke * \see setFramePenSize * \see framePenColor */ double framePenSize() const { return mGridFramePenThickness; } - /** Sets the color of the stroke drawn in the grid frame. + /** + * Sets the color of the stroke drawn in the grid frame. * \param color color of grid frame stroke * \see framePenColor * \see setFramePenSize @@ -785,7 +876,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setFramePenColor( const QColor &color ) { mGridFramePenColor = color; } - /** Retrieves the color of the stroke drawn in the grid frame. + /** + * Retrieves the color of the stroke drawn in the grid frame. * \returns color of grid frame stroke * \see setFramePenColor * \see framePenSize @@ -794,7 +886,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ QColor framePenColor() const {return mGridFramePenColor;} - /** Sets the first fill color used for the grid frame. + /** + * Sets the first fill color used for the grid frame. * \param color first fill color for grid frame * \see frameFillColor1 * \see setFramePenColor @@ -802,7 +895,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setFrameFillColor1( const QColor &color ) { mGridFrameFillColor1 = color; } - /** Retrieves the first fill color for the grid frame. + /** + * Retrieves the first fill color for the grid frame. * \returns first fill color for grid frame * \see setFrameFillColor1 * \see framePenColor @@ -810,7 +904,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ QColor frameFillColor1() const { return mGridFrameFillColor1; } - /** Sets the second fill color used for the grid frame. + /** + * Sets the second fill color used for the grid frame. * \param color second fill color for grid frame * \see frameFillColor2 * \see setFramePenColor @@ -818,7 +913,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void setFrameFillColor2( const QColor &color ) { mGridFrameFillColor2 = color; } - /** Retrieves the second fill color for the grid frame. + /** + * Retrieves the second fill color for the grid frame. * \returns second fill color for grid frame * \see setFrameFillColor2 * \see framePenColor @@ -940,12 +1036,14 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem void init(); - /** Draws the map grid. If extension is specified, then no grid will be drawn and instead the maximum extension + /** + * Draws the map grid. If extension is specified, then no grid will be drawn and instead the maximum extension * for the grid outside of the map frame will be calculated. */ void drawGridFrame( QPainter *p, const QList< QPair< double, QLineF > > &hLines, const QList< QPair< double, QLineF > > &vLines, GridExtension *extension = nullptr ) const; - /** Draw coordinates for mGridAnnotationType Coordinate + /** + * Draw coordinates for mGridAnnotationType Coordinate \param p drawing painter \param hLines horizontal coordinate lines in item coordinates \param vLines vertical coordinate lines in item coordinates @@ -955,12 +1053,14 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem */ void drawCoordinateAnnotations( QPainter *p, const QList< QPair< double, QLineF > > &hLines, const QList< QPair< double, QLineF > > &vLines, QgsExpressionContext &expressionContext, GridExtension *extension = nullptr ) const; - /** Draw an annotation. If optional extension argument is specified, nothing will be drawn and instead + /** + * Draw an annotation. If optional extension argument is specified, nothing will be drawn and instead * the extension of the annotation outside of the map frame will be stored in this variable. */ void drawCoordinateAnnotation( QPainter *p, QPointF pos, const QString &annotationString, const AnnotationCoordinate coordinateType, GridExtension *extension = nullptr ) const; - /** Draws a single annotation + /** + * Draws a single annotation * \param p drawing painter * \param pos item coordinates where to draw * \param rotation text rotation @@ -970,11 +1070,13 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem QString gridAnnotationString( double value, AnnotationCoordinate coord, QgsExpressionContext &expressionContext ) const; - /** Returns the grid lines with associated coordinate value + /** + * Returns the grid lines with associated coordinate value \returns 0 in case of success*/ int xGridLines( QList< QPair< double, QLineF > > &lines ) const; - /** Returns the grid lines for the y-coordinates. Not vertical in case of rotation + /** + * Returns the grid lines for the y-coordinates. Not vertical in case of rotation \returns 0 in case of success*/ int yGridLines( QList< QPair< double, QLineF > > &lines ) const; @@ -989,12 +1091,14 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem void sortGridLinesOnBorders( const QList< QPair< double, QLineF > > &hLines, const QList< QPair< double, QLineF > > &vLines, QMap< double, double > &leftFrameEntries, QMap< double, double > &rightFrameEntries, QMap< double, double > &topFrameEntries, QMap< double, double > &bottomFrameEntries ) const; - /** Draw the grid frame's border. If optional extension argument is specified, nothing will be drawn and instead + /** + * Draw the grid frame's border. If optional extension argument is specified, nothing will be drawn and instead * the maximum extension of the frame border outside of the map frame will be stored in this variable. */ void drawGridFrameBorder( QPainter *p, const QMap< double, double > &borderPos, BorderSide border, double *extension = nullptr ) const; - /** Returns the item border of a point (in item coordinates) + /** + * Returns the item border of a point (in item coordinates) * \param p point * \param coordinateType coordinate type */ diff --git a/src/core/composer/qgscomposermapitem.h b/src/core/composer/qgscomposermapitem.h index d7d185008358..52d109577b73 100644 --- a/src/core/composer/qgscomposermapitem.h +++ b/src/core/composer/qgscomposermapitem.h @@ -23,7 +23,8 @@ class QgsComposerMap; -/** \ingroup core +/** + * \ingroup core * \class QgsComposerMapItem * \brief An item which is drawn inside a QgsComposerMap, e.g., a grid or map overview. */ @@ -33,73 +34,85 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject public: - /** Constructor for QgsComposerMapItem. + /** + * Constructor for QgsComposerMapItem. * \param name friendly display name for item * \param map QgsComposerMap the item is attached to */ QgsComposerMapItem( const QString &name, QgsComposerMap *map ); - /** Draws the item on to a painter + /** + * Draws the item on to a painter * \param painter destination QPainter */ virtual void draw( QPainter *painter ) = 0; - /** Stores map item state in DOM element + /** + * Stores map item state in DOM element * \param elem is DOM element corresponding to a 'ComposerMap' tag * \param doc DOM document * \see readXml */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets map item state from a DOM document + /** + * Sets map item state from a DOM document * \param itemElem is DOM node corresponding to a 'ComposerMapGrid' tag * \param doc is DOM document * \see writeXml */ virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; - /** Sets composer map for the item + /** + * Sets composer map for the item * \param map composer map * \see composerMap */ virtual void setComposerMap( QgsComposerMap *map ); - /** Get composer map for the item + /** + * Get composer map for the item * \returns composer map * \see setComposerMap */ virtual const QgsComposerMap *composerMap() const; - /** Get the unique id for the map item + /** + * Get the unique id for the map item * \returns unique id */ QString id() const { return mUuid; } - /** Sets the friendly display name for the item + /** + * Sets the friendly display name for the item * \param name display name * \see name */ virtual void setName( const QString &name ); - /** Get friendly display name for the item + /** + * Get friendly display name for the item * \returns display name * \see setName */ virtual QString name() const; - /** Controls whether the item will be drawn + /** + * Controls whether the item will be drawn * \param enabled set to true to enable drawing of the item * \see enabled */ virtual void setEnabled( const bool enabled ); - /** Returns whether the item will be drawn + /** + * Returns whether the item will be drawn * \returns true if item will be drawn on the map * \see setEnabled */ virtual bool enabled() const; - /** Returns true if the item is drawn using advanced effects, such as blend modes. + /** + * Returns true if the item is drawn using advanced effects, such as blend modes. * \returns true if item uses advanced effects */ virtual bool usesAdvancedEffects() const; @@ -122,7 +135,8 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject -/** \ingroup core +/** + * \ingroup core * \class QgsComposerMapItemStack * \brief A collection of map items which are drawn above the map content in a * QgsComposerMap. The item stack controls which items are drawn and the @@ -134,19 +148,22 @@ class CORE_EXPORT QgsComposerMapItemStack { public: - /** Constructor for QgsComposerMapItemStack. + /** + * Constructor for QgsComposerMapItemStack. * \param map QgsComposerMap the item stack is attached to */ QgsComposerMapItemStack( QgsComposerMap *map ); virtual ~QgsComposerMapItemStack(); - /** Returns the number of items in the stack + /** + * Returns the number of items in the stack * \returns number of items in the stack */ int size() const { return mItems.size(); } - /** Stores the state of the item stack in a DOM node + /** + * Stores the state of the item stack in a DOM node * \param elem is DOM element corresponding to a 'ComposerMap' tag * \param doc DOM document * \returns true if write was successful @@ -154,7 +171,8 @@ class CORE_EXPORT QgsComposerMapItemStack */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const; - /** Sets the item stack's state from a DOM document + /** + * Sets the item stack's state from a DOM document * \param elem is DOM node corresponding to 'a ComposerMap' tag * \param doc DOM document * \returns true if read was successful @@ -162,12 +180,14 @@ class CORE_EXPORT QgsComposerMapItemStack */ virtual bool readXml( const QDomElement &elem, const QDomDocument &doc ) = 0; - /** Draws the items from the stack on a specified painter + /** + * Draws the items from the stack on a specified painter * \param painter destination QPainter */ void drawItems( QPainter *painter ); - /** Returns whether any items within the stack contain advanced effects, + /** + * Returns whether any items within the stack contain advanced effects, * such as blending modes * \returns true if item stack contains advanced effects */ @@ -175,7 +195,8 @@ class CORE_EXPORT QgsComposerMapItemStack protected: - /** Adds a new map item to the stack and takes ownership of the item. + /** + * Adds a new map item to the stack and takes ownership of the item. * The item will be added to the end of the stack, and rendered * above any existing map items already present in the stack. * \param item QgsComposerMapItem to add to the stack @@ -185,7 +206,8 @@ class CORE_EXPORT QgsComposerMapItemStack */ void addItem( QgsComposerMapItem *item SIP_TRANSFER ); - /** Removes an item from the stack and deletes the corresponding QgsComposerMapItem + /** + * Removes an item from the stack and deletes the corresponding QgsComposerMapItem * \param itemId id for the QgsComposerMapItem to remove * \note after removing an item from the stack, update() * should be called for the QgsComposerMap to prevent rendering artifacts @@ -193,7 +215,8 @@ class CORE_EXPORT QgsComposerMapItemStack */ void removeItem( const QString &itemId ); - /** Moves an item up the stack, causing it to be rendered above other items + /** + * Moves an item up the stack, causing it to be rendered above other items * \param itemId id for the QgsComposerMapItem to move up * \note after moving an item within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new item stack order @@ -201,7 +224,8 @@ class CORE_EXPORT QgsComposerMapItemStack */ void moveItemUp( const QString &itemId ); - /** Moves an item up the stack, causing it to be rendered above other items + /** + * Moves an item up the stack, causing it to be rendered above other items * \param itemId id for the QgsComposerMapItem to move down * \note after moving an item within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new item stack order @@ -209,28 +233,32 @@ class CORE_EXPORT QgsComposerMapItemStack */ void moveItemDown( const QString &itemId ); - /** Returns a const reference to an item within the stack + /** + * Returns a const reference to an item within the stack * \param itemId id for the QgsComposerMapItem to find * \returns const reference to item, if found * \see item */ const QgsComposerMapItem *constItem( const QString &itemId ) const; - /** Returns a reference to an item within the stack + /** + * Returns a reference to an item within the stack * \param itemId id for the QgsComposerMapItem to find * \returns reference to item if found * \see constItem */ QgsComposerMapItem *item( const QString &itemId ) const; - /** Returns a reference to an item within the stack + /** + * Returns a reference to an item within the stack * \param index item position in the stack * \returns reference to item if found * \see constItem */ QgsComposerMapItem *item( const int index ) const; - /** Returns a reference to an item within the stack + /** + * Returns a reference to an item within the stack * \param idx item position in the stack * \returns reference to item if found * \see constItem @@ -239,7 +267,8 @@ class CORE_EXPORT QgsComposerMapItemStack */ QgsComposerMapItem &operator[]( int idx ) SIP_SKIP; - /** Returns a list of QgsComposerMapItems contained by the stack + /** + * Returns a list of QgsComposerMapItems contained by the stack * \returns list of items */ QList< QgsComposerMapItem * > asList() const; @@ -250,7 +279,8 @@ class CORE_EXPORT QgsComposerMapItemStack QgsComposerMap *mComposerMap = nullptr; - /** Clears the item stack and deletes all QgsComposerMapItems contained + /** + * Clears the item stack and deletes all QgsComposerMapItems contained * by the stack */ void removeItems(); diff --git a/src/core/composer/qgscomposermapoverview.h b/src/core/composer/qgscomposermapoverview.h index d97daf13c2ea..54f47407d269 100644 --- a/src/core/composer/qgscomposermapoverview.h +++ b/src/core/composer/qgscomposermapoverview.h @@ -31,7 +31,8 @@ class QDomElement; class QgsFillSymbol; class QgsComposerMapOverview; -/** \ingroup core +/** + * \ingroup core * \class QgsComposerMapOverviewStack * \brief A collection of overviews which are drawn above the map content in a * QgsComposerMap. The overview stack controls which overviews are drawn and the @@ -43,12 +44,14 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack { public: - /** Constructor for QgsComposerMapOverviewStack. + /** + * Constructor for QgsComposerMapOverviewStack. * \param map QgsComposerMap the overview stack is attached to */ QgsComposerMapOverviewStack( QgsComposerMap *map ); - /** Adds a new map overview to the stack and takes ownership of the overview. + /** + * Adds a new map overview to the stack and takes ownership of the overview. * The overview will be added to the end of the stack, and rendered * above any existing map overviews already present in the stack. * \param overview QgsComposerMapOverview to add to the stack @@ -58,7 +61,8 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack */ void addOverview( QgsComposerMapOverview *overview SIP_TRANSFER ); - /** Removes an overview from the stack and deletes the corresponding QgsComposerMapOverview + /** + * Removes an overview from the stack and deletes the corresponding QgsComposerMapOverview * \param overviewId id for the QgsComposerMapOverview to remove * \note after removing an overview from the stack, update() * should be called for the QgsComposerMap to prevent rendering artifacts @@ -66,7 +70,8 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack */ void removeOverview( const QString &overviewId ); - /** Moves an overview up the stack, causing it to be rendered above other overviews + /** + * Moves an overview up the stack, causing it to be rendered above other overviews * \param overviewId id for the QgsComposerMapOverview to move up * \note after moving an overview within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new overview stack order @@ -74,7 +79,8 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack */ void moveOverviewUp( const QString &overviewId ); - /** Moves an overview down the stack, causing it to be rendered below other overviews + /** + * Moves an overview down the stack, causing it to be rendered below other overviews * \param overviewId id for the QgsComposerMapOverview to move down * \note after moving an overview within the stack, update() should be * called for the QgsComposerMap to redraw the map with the new overview stack order @@ -82,28 +88,32 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack */ void moveOverviewDown( const QString &overviewId ); - /** Returns a const reference to an overview within the stack + /** + * Returns a const reference to an overview within the stack * \param overviewId id for the QgsComposerMapOverview to find * \returns const reference to overview, if found * \see overview */ const QgsComposerMapOverview *constOverview( const QString &overviewId ) const; - /** Returns a reference to an overview within the stack + /** + * Returns a reference to an overview within the stack * \param overviewId id for the QgsComposerMapOverview to find * \returns reference to overview if found * \see constOverview */ QgsComposerMapOverview *overview( const QString &overviewId ) const; - /** Returns a reference to an overview within the stack + /** + * Returns a reference to an overview within the stack * \param index overview position in the stack * \returns reference to overview if found * \see constOverview */ QgsComposerMapOverview *overview( const int index ) const; - /** Returns a reference to an overview within the stack + /** + * Returns a reference to an overview within the stack * \param idx overview position in the stack * \returns reference to overview if found * \see constOverview @@ -111,12 +121,14 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack */ QgsComposerMapOverview &operator[]( int idx ); - /** Returns a list of QgsComposerMapOverviews contained by the stack + /** + * Returns a list of QgsComposerMapOverviews contained by the stack * \returns list of overviews */ QList< QgsComposerMapOverview * > asList() const; - /** Sets the overview stack's state from a DOM document + /** + * Sets the overview stack's state from a DOM document * \param elem is DOM node corresponding to a 'ComposerMap' tag * \param doc DOM document * \returns true if read was successful @@ -126,7 +138,8 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack }; -/** \ingroup core +/** + * \ingroup core * \class QgsComposerMapOverview * \brief An individual overview which is drawn above the map content in a * QgsComposerMap, and shows the extent of another QgsComposerMap. @@ -139,7 +152,8 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem public: - /** Constructor for QgsComposerMapOverview. + /** + * Constructor for QgsComposerMapOverview. * \param name friendly display name for overview * \param map QgsComposerMap the overview is attached to */ @@ -147,19 +161,22 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem virtual ~QgsComposerMapOverview(); - /** Draws an overview + /** + * Draws an overview * \param painter destination QPainter */ void draw( QPainter *painter ) override; - /** Stores overview state in DOM element + /** + * Stores overview state in DOM element * \param elem is DOM element corresponding to a 'ComposerMap' tag * \param doc DOM document * \see readXml */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets overview state from a DOM document + /** + * Sets overview state from a DOM document * \param itemElem is DOM node corresponding to a 'ComposerMapOverview' tag * \param doc is DOM document * \see writeXml @@ -168,82 +185,95 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem bool usesAdvancedEffects() const override; - /** Sets overview frame map. + /** + * Sets overview frame map. * \param mapId source map id. -1 disables the overview frame * \see frameMapId */ void setFrameMap( const int mapId ); - /** Returns id of source map. + /** + * Returns id of source map. * \returns source map id, or -1 if no source map set */ int frameMapId() const { return mFrameMapId; } - /** Sets the fill symbol used for drawing the overview extent. + /** + * Sets the fill symbol used for drawing the overview extent. * \param symbol fill symbol for overview * \see frameSymbol */ void setFrameSymbol( QgsFillSymbol *symbol SIP_TRANSFER ); - /** Gets the fill symbol used for drawing the overview extent. + /** + * Gets the fill symbol used for drawing the overview extent. * \returns fill symbol for overview * \see setFrameSymbol */ QgsFillSymbol *frameSymbol() { return mFrameSymbol; } - /** Gets the fill symbol used for drawing the overview extent. + /** + * Gets the fill symbol used for drawing the overview extent. * \returns fill symbol for overview * \see setFrameSymbol * \note not available in Python bindings */ const QgsFillSymbol *frameSymbol() const { return mFrameSymbol; } SIP_SKIP - /** Retrieves the blending mode used for drawing the overview. + /** + * Retrieves the blending mode used for drawing the overview. * \returns blending mode for overview * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } - /** Sets the blending mode used for drawing the overview. + /** + * Sets the blending mode used for drawing the overview. * \param blendMode blending mode for overview * \see blendMode */ void setBlendMode( const QPainter::CompositionMode blendMode ); - /** Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside + /** + * Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside * the extent of the overview map. * \returns true if overview frame is inverted * \see setInverted */ bool inverted() const { return mInverted; } - /** Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside + /** + * Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside * the extent of the overview map. * \param inverted set to true if overview frame is to be inverted * \see inverted */ void setInverted( const bool inverted ); - /** Returns whether the extent of the map is forced to center on the overview + /** + * Returns whether the extent of the map is forced to center on the overview * \returns true if map will be centered on overview * \see setCentered */ bool centered() const { return mCentered; } - /** Sets whether the extent of the map is forced to center on the overview + /** + * Sets whether the extent of the map is forced to center on the overview * \param centered set to true if map will be centered on overview * \see centered */ void setCentered( const bool centered ); - /** Reconnects signals for overview map, so that overview correctly follows changes to source + /** + * Reconnects signals for overview map, so that overview correctly follows changes to source * map's extent */ void connectSignals(); public slots: - /** Handles recentering of the map and redrawing of the map's overview + /** + * Handles recentering of the map and redrawing of the map's overview */ void overviewExtentChanged(); diff --git a/src/core/composer/qgscomposermodel.h b/src/core/composer/qgscomposermodel.h index 26deedd5f594..547400a3bab2 100644 --- a/src/core/composer/qgscomposermodel.h +++ b/src/core/composer/qgscomposermodel.h @@ -61,7 +61,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel ItemId, //!< Item ID }; - /** Constructor + /** + * Constructor * \param composition composition to attach to * \param parent parent object */ @@ -82,38 +83,44 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) override; bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override; - /** Clears all items from z-order list and resets the model + /** + * Clears all items from z-order list and resets the model * \since QGIS 2.5 */ void clear(); - /** Returns the size of the z-order list, which includes items which may + /** + * Returns the size of the z-order list, which includes items which may * have been removed from the composition. * \returns size of z-order list * \since QGIS 2.5 */ int zOrderListSize() const; - /** Rebuilds the z-order list, based on the current stacking of items in the composition. + /** + * Rebuilds the z-order list, based on the current stacking of items in the composition. * This method should be called after adding multiple items to the composition. * \since QGIS 2.5 */ void rebuildZList(); - /** Adds an item to the top of the composition z stack. + /** + * Adds an item to the top of the composition z stack. * \param item item to add. The item must not already exist in the z-order list. * \since QGIS 2.5 * \see reorderItemToTop */ void addItemAtTop( QgsComposerItem *item ); - /** Removes an item from the z-order list. + /** + * Removes an item from the z-order list. * \param item item to remove * \since QGIS 2.5 */ void removeItem( QgsComposerItem *item ); - /** Moves an item up the z-order list. + /** + * Moves an item up the z-order list. * \param item item to move * \returns true if item was moved. Returns false if item was not found * in z-order list or was already at the top of the z-order list. @@ -124,7 +131,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ bool reorderItemUp( QgsComposerItem *item ); - /** Moves an item down the z-order list. + /** + * Moves an item down the z-order list. * \param item item to move * \returns true if item was moved. Returns false if item was not found * in z-order list or was already at the bottom of the z-order list. @@ -135,7 +143,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ bool reorderItemDown( QgsComposerItem *item ); - /** Moves an item to the top of the z-order list. + /** + * Moves an item to the top of the z-order list. * \param item item to move * \returns true if item was moved. Returns false if item was not found * in z-order list or was already at the top of the z-order list. @@ -146,7 +155,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ bool reorderItemToTop( QgsComposerItem *item ); - /** Moves an item to the bottom of the z-order list. + /** + * Moves an item to the bottom of the z-order list. * \param item item to move * \returns true if item was moved. Returns false if item was not found * in z-order list or was already at the bottom of the z-order list. @@ -157,7 +167,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ bool reorderItemToBottom( QgsComposerItem *item ); - /** Finds the next composer item above an item. This method only considers + /** + * Finds the next composer item above an item. This method only considers * items which are currently in the composition, and ignores items which have been * removed from the composition. * \param item item to search above @@ -168,7 +179,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ QgsComposerItem *getComposerItemAbove( QgsComposerItem *item ) const; - /** Finds the next composer item below an item. This method only considers + /** + * Finds the next composer item below an item. This method only considers * items which are currently in the composition, and ignores items which have been * removed from the composition. * \param item item to search above @@ -179,14 +191,16 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ QgsComposerItem *getComposerItemBelow( QgsComposerItem *item ) const; - /** Returns the item z-order list. This list includes both items currently in the + /** + * Returns the item z-order list. This list includes both items currently in the * composition and items which have been removed from the composition. * \returns item z-order list * \since QGIS 2.5 */ QList *zOrderList(); - /** Marks an item as removed from the composition. This must be called whenever an item + /** + * Marks an item as removed from the composition. This must be called whenever an item * has been removed from the composition. * \param item to mark as removed from the composition * \see setItemRestored @@ -194,7 +208,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ void setItemRemoved( QgsComposerItem *item ); - /** Restores an item to the composition. This must be called whenever an item removed + /** + * Restores an item to the composition. This must be called whenever an item removed * from the composition is restored to the composition. * \param item to mark as restored to the composition * \see setItemRemoved @@ -202,7 +217,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ void setItemRestored( QgsComposerItem *item ); - /** Must be called when an item's display name is modified + /** + * Must be called when an item's display name is modified * \param item item to update * \see updateItemLockStatus * \see updateItemVisibility @@ -211,7 +227,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ void updateItemDisplayName( QgsComposerItem *item ); - /** Must be called when an item's lock status changes + /** + * Must be called when an item's lock status changes * \param item item to update * \see updateItemDisplayName * \see updateItemVisibility @@ -220,7 +237,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ void updateItemLockStatus( QgsComposerItem *item ); - /** Must be called when an item's visibility changes + /** + * Must be called when an item's visibility changes * \param item item to update * \see updateItemDisplayName * \see updateItemLockStatus @@ -229,7 +247,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ void updateItemVisibility( QgsComposerItem *item ); - /** Must be called when an item's selection status changes + /** + * Must be called when an item's selection status changes * \param item item to update * \see updateItemDisplayName * \see updateItemVisibility @@ -238,7 +257,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ void updateItemSelectStatus( QgsComposerItem *item ); - /** Returns the QModelIndex corresponding to a QgsComposerItem, if possible + /** + * Returns the QModelIndex corresponding to a QgsComposerItem, if possible * \param item QgsComposerItem to find index for * \param column column number for created QModelIndex * \returns QModelIndex corresponding to item and specified column @@ -247,7 +267,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel public slots: - /** Sets an item as the current selection from a QModelIndex + /** + * Sets an item as the current selection from a QModelIndex * \param index QModelIndex of item to set as selected * \since QGIS 2.5 */ @@ -266,13 +287,15 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel //! Parent composition QgsComposition *mComposition = nullptr; - /** Returns the QgsComposerItem corresponding to a QModelIndex, if possible + /** + * Returns the QgsComposerItem corresponding to a QModelIndex, if possible * \param index QModelIndex for item * \returns item corresponding to index */ QgsComposerItem *itemFromIndex( const QModelIndex &index ) const; - /** Rebuilds the list of all composer items which are present in the composition. This is + /** + * Rebuilds the list of all composer items which are present in the composition. This is * called when the stacking of order changes or when items are removed/restored to the * composition. Unlike rebuildSceneItemList, this method clears the existing scene item * list and does not emit QAbstractItemModel signals. Accordingly, this method should @@ -282,7 +305,8 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel */ void refreshItemsInScene(); - /** Steps through the item z-order list and rebuilds the items in composition list, + /** + * Steps through the item z-order list and rebuilds the items in composition list, * emitting QAbstractItemModel signals as required. * \see refreshItemsInScene */ @@ -305,41 +329,48 @@ class CORE_EXPORT QgsComposerProxyModel: public QSortFilterProxyModel public: - /** Constructor for QgsComposerProxyModel. + /** + * Constructor for QgsComposerProxyModel. * \param composition composition to attach model to * \param parent optional parent */ QgsComposerProxyModel( QgsComposition *composition, QObject *parent SIP_TRANSFERTHIS = 0 ); - /** Returns the current item type filter, or QgsComposerItem::ComposerItem if no + /** + * Returns the current item type filter, or QgsComposerItem::ComposerItem if no * item type filter is set. * \see setFilterType() */ QgsComposerItem::ItemType filterType() const { return mItemTypeFilter; } - /** Sets the item type filter. Only matching item types will be shown. + /** + * Sets the item type filter. Only matching item types will be shown. * \param itemType type to filter. Set to QgsComposerItem::ComposerItem to show all * item types. * \see filterType() */ void setFilterType( QgsComposerItem::ItemType itemType ); - /** Sets a list of specific items to exclude from the model + /** + * Sets a list of specific items to exclude from the model * \param exceptList list of items to exclude * \see exceptedItemList() */ void setExceptedItemList( const QList< QgsComposerItem * > &exceptList ); - /** Returns the list of specific items excluded from the model. + /** + * Returns the list of specific items excluded from the model. * \see setExceptedItemList() */ QList< QgsComposerItem * > exceptedItemList() const { return mExceptedList; } - /** Returns the QgsComposerModel used in this proxy model. + /** + * Returns the QgsComposerModel used in this proxy model. */ QgsComposerModel *sourceLayerModel() const { return static_cast< QgsComposerModel * >( sourceModel() ); } - /** Returns the QgsComposerItem corresponding to an index from the source + /** + * Returns the QgsComposerItem corresponding to an index from the source * QgsComposerModel model. * \param sourceIndex a QModelIndex * \returns QgsComposerItem for specified index from QgsComposerModel diff --git a/src/core/composer/qgscomposermousehandles.h b/src/core/composer/qgscomposermousehandles.h index 573d308b5c6e..1a52edb2f1c3 100644 --- a/src/core/composer/qgscomposermousehandles.h +++ b/src/core/composer/qgscomposermousehandles.h @@ -29,7 +29,8 @@ class QgsComposition; class QgsComposerItem; class QGraphicsView; -/** \ingroup core +/** + * \ingroup core * Handles drawing of selection outlines and mouse handles. Responsible for mouse * interactions such as resizing and moving selected items. * \note not available in Python bindings @@ -156,7 +157,8 @@ class CORE_EXPORT QgsComposerMouseHandles: public QObject, public QGraphicsRectI //! Draw outlines for selected items void drawSelectedItemBounds( QPainter *painter ); - /** Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the + /** + * Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing*/ double rectHandlerBorderTolerance(); diff --git a/src/core/composer/qgscomposermultiframe.h b/src/core/composer/qgscomposermultiframe.h index b2d59ebce366..9d8065ba3f05 100644 --- a/src/core/composer/qgscomposermultiframe.h +++ b/src/core/composer/qgscomposermultiframe.h @@ -69,7 +69,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject public: - /** Specifies the behavior for creating new frames to fit the multiframe's content + /** + * Specifies the behavior for creating new frames to fit the multiframe's content */ enum ResizeMode { @@ -80,7 +81,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject until the entire multiframe content is visible */ }; - /** Construct a new multiframe item. + /** + * Construct a new multiframe item. * \param c parent composition * \param createUndoCommands */ @@ -88,12 +90,14 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject virtual ~QgsComposerMultiFrame(); - /** Returns the total size of the multiframe's content. + /** + * Returns the total size of the multiframe's content. * \returns total size required for content */ virtual QSizeF totalSize() const = 0; - /** Returns the fixed size for a frame, if desired. If the fixed frame size changes, + /** + * Returns the fixed size for a frame, if desired. If the fixed frame size changes, * the sizes of all frames can be recalculated by calling recalculateFrameRects(). * \param frameIndex frame number * \returns fixed size for frame. If the size has a width or height of 0, then @@ -105,7 +109,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ virtual QSizeF fixedFrameSize( const int frameIndex = -1 ) const; - /** Returns the minimum size for a frames, if desired. If the minimum + /** + * Returns the minimum size for a frames, if desired. If the minimum * size changes, the sizes of all frames can be recalculated by calling * recalculateFrameRects(). * \param frameIndex frame number @@ -117,7 +122,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ virtual QSizeF minFrameSize( const int frameIndex = -1 ) const; - /** Renders a portion of the multiframe's content into a painter. + /** + * Renders a portion of the multiframe's content into a painter. * \param painter destination painter * \param renderExtent visible extent of content to render into the painter. * \param frameIndex frame number for content @@ -125,14 +131,16 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ virtual void render( QPainter *painter, const QRectF &renderExtent, const int frameIndex ) = 0; - /** Adds a frame to the multiframe. + /** + * Adds a frame to the multiframe. * \param frame frame to add * \param recalcFrameSizes set to true to force recalculation of all existing frame sizes * \see removeFrame */ virtual void addFrame( QgsComposerFrame *frame SIP_TRANSFER, bool recalcFrameSizes = true ) = 0; - /** Finds the optimal position to break a frame at. + /** + * Finds the optimal position to break a frame at. * \param yPos maximum vertical position for break * \returns the optimal breakable position which occurs in the multi frame close * to and before the specified yPos @@ -140,7 +148,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ virtual double findNearbyPageBreak( double yPos ); - /** Removes a frame from the multiframe. This method automatically removes the frame from the + /** + * Removes a frame from the multiframe. This method automatically removes the frame from the * composition. * \param i index of frame to remove * \param removeEmptyPages set to true to remove pages which are empty after the frame is removed @@ -149,24 +158,28 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ void removeFrame( int i, const bool removeEmptyPages = false ); - /** Removes and deletes all child frames. + /** + * Removes and deletes all child frames. * \see removeFrame */ void deleteFrames(); - /** Sets the resize mode for the multiframe, and recalculates frame sizes to match. + /** + * Sets the resize mode for the multiframe, and recalculates frame sizes to match. * \param mode resize mode * \see resizeMode */ void setResizeMode( ResizeMode mode ); - /** Returns the resize mode for the multiframe. + /** + * Returns the resize mode for the multiframe. * \returns resize mode * \see setResizeMode */ ResizeMode resizeMode() const { return mResizeMode; } - /** Stores state information about multiframe in DOM element. Implementations of writeXml + /** + * Stores state information about multiframe in DOM element. Implementations of writeXml * should also call the _writeXML method to save general multiframe properties. * \param elem is DOM element * \param doc is the DOM document @@ -175,7 +188,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const = 0; - /** Stores state information about base multiframe object in DOM element. Implementations of writeXml + /** + * Stores state information about base multiframe object in DOM element. Implementations of writeXml * should call this method. * \param elem is DOM element * \param doc is the DOM document @@ -184,7 +198,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ bool _writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const; - /** Reads multiframe state information from a DOM element. Implementations of readXml + /** + * Reads multiframe state information from a DOM element. Implementations of readXml * should also call the _readXML method to restore general multiframe properties. * \param itemElem is DOM element * \param doc is the DOM document @@ -193,7 +208,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false ) = 0; - /** Restores state information about base multiframe object from a DOM element. Implementations of readXml + /** + * Restores state information about base multiframe object from a DOM element. Implementations of readXml * should call this method. * \param itemElem is DOM element * \param doc is the DOM document @@ -202,36 +218,42 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ bool _readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false ); - /** Returns the parent composition for the multiframe. + /** + * Returns the parent composition for the multiframe. * \returns composition */ QgsComposition *composition() { return mComposition; } - /** Returns whether undo commands should be created for interactions with the multiframe. + /** + * Returns whether undo commands should be created for interactions with the multiframe. * \returns true if undo commands should be created * \see setCreateUndoCommands */ bool createUndoCommands() const { return mCreateUndoCommands; } - /** Sets whether undo commands should be created for interactions with the multiframe. + /** + * Sets whether undo commands should be created for interactions with the multiframe. * \param enabled set to true if undo commands should be created * \see createUndoCommands */ void setCreateUndoCommands( bool enabled ) { mCreateUndoCommands = enabled; } - /** Returns the number of frames associated with this multiframe. + /** + * Returns the number of frames associated with this multiframe. * \returns number of child frames **/ int frameCount() const { return mFrameItems.size(); } - /** Returns a child frame from the multiframe. + /** + * Returns a child frame from the multiframe. * \param i index of frame * \returns child frame if found * \see frameIndex */ QgsComposerFrame *frame( int i ) const; - /** Returns the index of a frame within the multiframe + /** + * Returns the index of a frame within the multiframe * \param frame frame to find index of * \returns index for frame if found, -1 if frame not found in multiframe * \since QGIS 2.5 @@ -239,7 +261,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ int frameIndex( QgsComposerFrame *frame ) const; - /** Creates a new frame and adds it to the multi frame and composition. + /** + * Creates a new frame and adds it to the multi frame and composition. * \param currentFrame an existing QgsComposerFrame from which to copy the size * and general frame properties (e.g., frame style, background, rendering settings). * \param pos position of top-left corner of the new frame @@ -249,7 +272,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ QgsComposerFrame *createNewFrame( QgsComposerFrame *currentFrame, QPointF pos, QSizeF size ); - /** Get multiframe display name. + /** + * Get multiframe display name. * \returns display name for item * \since QGIS 2.5 */ @@ -257,11 +281,13 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject public slots: - /** Forces a redraw of all child frames. + /** + * Forces a redraw of all child frames. */ void update(); - /** Recalculates the portion of the multiframe item which is shown in each of it's + /** + * Recalculates the portion of the multiframe item which is shown in each of it's * component frames. If the resize mode is set to anything but UseExistingFrames then * this may cause new frames to be added or frames to be removed, in order to fit * the current size of the multiframe's content. @@ -269,7 +295,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ virtual void recalculateFrameSizes(); - /** Forces a recalculation of all the associated frame's scene rectangles. This + /** + * Forces a recalculation of all the associated frame's scene rectangles. This * method is useful for multiframes which implement a minFrameSize() or * fixedFrameSize() method. * \since QGIS 2.5 @@ -279,19 +306,22 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject */ void recalculateFrameRects(); - /** Called before a frame is going to be removed. Updates frame list and recalculates + /** + * Called before a frame is going to be removed. Updates frame list and recalculates * content of remaining frames. */ void handleFrameRemoval( QgsComposerItem *item ); signals: - /** Emitted when the properties of a multi frame have changed, and the GUI item widget + /** + * Emitted when the properties of a multi frame have changed, and the GUI item widget * must be updated. */ void changed(); - /** Emitted when the contents of the multi frame have changed and the frames + /** + * Emitted when the contents of the multi frame have changed and the frames * must be redrawn. */ void contentsChanged(); @@ -307,7 +337,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject protected slots: - /** Adapts to changed number of composition pages if resize type is RepeatOnEveryPage. + /** + * Adapts to changed number of composition pages if resize type is RepeatOnEveryPage. */ void handlePageChange(); diff --git a/src/core/composer/qgscomposermultiframecommand.h b/src/core/composer/qgscomposermultiframecommand.h index f38ee72f4fb9..5b5eb06429ca 100644 --- a/src/core/composer/qgscomposermultiframecommand.h +++ b/src/core/composer/qgscomposermultiframecommand.h @@ -26,7 +26,8 @@ class QgsComposerMultiFrame; -/** \ingroup core +/** + * \ingroup core * \class QgsComposerMultiFrameCommand */ class CORE_EXPORT QgsComposerMultiFrameCommand: public QUndoCommand @@ -62,7 +63,8 @@ class CORE_EXPORT QgsComposerMultiFrameCommand: public QUndoCommand bool checkFirstRun(); }; -/** \ingroup core +/** + * \ingroup core * A composer command that merges together with other commands having the same context (=id) * for multi frame items. Keeps the oldest previous state and uses the newest after state. * The purpose is to avoid too many micro changes in the history*/ diff --git a/src/core/composer/qgscomposernodesitem.h b/src/core/composer/qgscomposernodesitem.h index c4ace64a15aa..422332d95e65 100644 --- a/src/core/composer/qgscomposernodesitem.h +++ b/src/core/composer/qgscomposernodesitem.h @@ -22,7 +22,8 @@ #include #include -/** \ingroup core +/** + * \ingroup core * An abstract composer item that provides generic methods for nodes based * shapes such as polygon or polylines. * \since QGIS 2.16 @@ -33,20 +34,23 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem public: - /** Constructor + /** + * Constructor * \param mTagName tag used in XML file * \param c parent composition */ QgsComposerNodesItem( const QString &mTagName, QgsComposition *c ); - /** Constructor + /** + * Constructor * \param mTagName tag used in XML file * \param polygon nodes of the shape * \param c parent composition */ QgsComposerNodesItem( const QString &mTagName, const QPolygonF &polygon, QgsComposition *c ); - /** Add a node in current shape. + /** + * Add a node in current shape. * \param pt is the location of the new node * \param checkArea is a flag to indicate if there's a space constraint. * \param radius is the space contraint and is used only if checkArea is @@ -55,12 +59,14 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem */ bool addNode( QPointF pt, const bool checkArea = true, const double radius = 10 ); - /** Set a tag to indicate if we want to draw or not the shape's nodes. + /** + * Set a tag to indicate if we want to draw or not the shape's nodes. * \param display */ void setDisplayNodes( const bool display = true ) { mDrawNodes = display; } - /** Move a node to a new position. + /** + * Move a node to a new position. * \param index the index of the node to move * \param node is the new position in scene coordinate */ @@ -69,7 +75,8 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem //! \brief Reimplementation of QCanvasItem::paint - draw on canvas void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override; - /** Search the nearest node in shape within a maximal area. Returns the + /** + * Search the nearest node in shape within a maximal area. Returns the * index of the nearest node or -1. * \param node is where a shape's node is searched * \param searchInRadius is a flag to indicate if the area of research is @@ -78,20 +85,23 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem */ int nodeAtPosition( QPointF node, const bool searchInRadius = true, const double radius = 10 ); - /** Gets the position of a node in scene coordinate. + /** + * Gets the position of a node in scene coordinate. * \param index of the node * \param position the position of the node * \returns true if the index is valid and the position is set, false otherwise */ bool nodePosition( const int index, QPointF &position ); - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom node corresponding to item tag * \param doc is Dom document */ bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override; - /** Remove a node from the shape. + /** + * Remove a node from the shape. * \param index of the node to delete */ bool removeNode( const int index ); @@ -99,21 +109,25 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem //! Returns the number of nodes in the shape. int nodesSize() { return mPolygon.size(); } - /** Select a node. + /** + * Select a node. * \param index the node to select */ bool setSelectedNode( const int index ); - /** Returns the currently selected node. + /** + * Returns the currently selected node. * \returns the index of the selected node, -1 otherwise */ int selectedNode() { return mSelectedNode; } - /** Deselect a node. + /** + * Deselect a node. */ void deselectNode() { mSelectedNode = -1; } - /** Stores state in Dom element + /** + * Stores state in Dom element * \param elem is Dom element corresponding to 'Composer' tag * \param doc write template file */ @@ -139,7 +153,8 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem //! Method called in writeXml. virtual void _writeXmlStyle( QDomDocument &doc, QDomElement &elmt ) const = 0; - /** Rescale the current shape according to the boudning box. Useful when + /** + * Rescale the current shape according to the boudning box. Useful when * the shape is resized thanks to the rubber band. */ void rescaleToFitBoundingBox(); @@ -156,7 +171,8 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem //! The index of the node currently selected. int mSelectedNode; - /** This tag is used to indicate if we have to draw nodes or not during + /** + * This tag is used to indicate if we have to draw nodes or not during * the painting. */ bool mDrawNodes; diff --git a/src/core/composer/qgscomposerobject.h b/src/core/composer/qgscomposerobject.h index 5d84075c696e..9fe14de5be86 100644 --- a/src/core/composer/qgscomposerobject.h +++ b/src/core/composer/qgscomposerobject.h @@ -29,7 +29,8 @@ class QgsComposition; class QPainter; -/** \ingroup core +/** + * \ingroup core * A base class for objects which belong to a map composition. */ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContextGenerator @@ -37,7 +38,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext Q_OBJECT public: - /** Data defined properties for different item types + /** + * Data defined properties for different item types */ enum DataDefinedProperty { @@ -90,7 +92,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext ScalebarLineWidth, //!< Scalebar line width }; - /** Specifies whether the value returned by a function should be the original, user + /** + * Specifies whether the value returned by a function should be the original, user * set value, or the current evaluated value for the property. This may differ if * a property has a data defined expression active. */ @@ -106,13 +109,15 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext */ static const QgsPropertiesDefinition &propertyDefinitions(); - /** Constructor + /** + * Constructor * \param composition parent composition */ QgsComposerObject( QgsComposition *composition ); virtual ~QgsComposerObject() = default; - /** Returns the composition the item is attached to. + /** + * Returns the composition the item is attached to. * \returns QgsComposition for item. */ const QgsComposition *composition() const { return mComposition; } @@ -120,38 +125,44 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext //! \note not available in Python bindings QgsComposition *composition() { return mComposition; } SIP_SKIP - /** Stores item state in DOM element + /** + * Stores item state in DOM element * \param elem is DOM element corresponding to item tag * \param doc is the DOM document */ virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const; - /** Sets item state from DOM element + /** + * Sets item state from DOM element * \param itemElem is DOM node corresponding to item tag * \param doc is DOM document */ virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc ); - /** Returns a reference to the object's property collection, used for data defined overrides. + /** + * Returns a reference to the object's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } - /** Returns a reference to the object's property collection, used for data defined overrides. + /** + * Returns a reference to the object's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP - /** Sets the objects's property collection, used for data defined overrides. + /** + * Sets the objects's property collection, used for data defined overrides. * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 * \see dataDefinedProperties() */ void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; } - /** Set a custom property for the object. + /** + * Set a custom property for the object. * \param key property key. If a property with the same key already exists it will be overwritten. * \param value property value * \see customProperty() @@ -161,7 +172,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext */ void setCustomProperty( const QString &key, const QVariant &value ); - /** Read a custom property from the object. + /** + * Read a custom property from the object. * \param key property key * \param defaultValue default value to return if property with matching key does not exist * \returns value of matching property @@ -172,7 +184,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext */ QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const; - /** Remove a custom property from the object. + /** + * Remove a custom property from the object. * \param key property key * \see setCustomProperty() * \see customProperty() @@ -181,7 +194,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext */ void removeCustomProperty( const QString &key ); - /** Return list of keys stored in custom properties for the object. + /** + * Return list of keys stored in custom properties for the object. * \see setCustomProperty() * \see customProperty() * \see removeCustomProperty() @@ -189,7 +203,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext */ QStringList customProperties() const; - /** Creates an expression context relating to the objects' current state. The context includes + /** + * Creates an expression context relating to the objects' current state. The context includes * scopes for global, project and composition properties. * \since QGIS 2.12 */ @@ -200,7 +215,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext //! Triggers a redraw for the item virtual void repaint(); - /** Refreshes a data defined property for the item by reevaluating the property's value + /** + * Refreshes a data defined property for the item by reevaluating the property's value * and redrawing the item with this new value. * \param property data defined property to refresh. If property is set to * QgsComposerItem::AllProperties then all data defined properties for the item will be @@ -221,7 +237,8 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext signals: - /** Emitted when the item changes. Signifies that the item widgets must update the + /** + * Emitted when the item changes. Signifies that the item widgets must update the * gui elements. */ void itemChanged(); diff --git a/src/core/composer/qgscomposerpicture.h b/src/core/composer/qgscomposerpicture.h index 8a847387fb13..f39f8670e9cb 100644 --- a/src/core/composer/qgscomposerpicture.h +++ b/src/core/composer/qgscomposerpicture.h @@ -26,7 +26,8 @@ class QgsComposerMap; class QgsExpression; -/** \ingroup core +/** + * \ingroup core * A composer class that displays svg files or raster format (jpg, png, ...) * */ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem @@ -34,7 +35,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem Q_OBJECT public: - /** Controls how pictures are scaled within the item's frame + /** + * Controls how pictures are scaled within the item's frame */ enum ResizeMode { @@ -45,7 +47,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem FrameToImageSize //!< Sets size of frame to match original size of image without scaling }; - /** Format of source image + /** + * Format of source image */ enum Mode { @@ -69,7 +72,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem //! Reimplementation of QCanvasItem::paint void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override; - /** Sets the source path of the image (may be svg or a raster format). Data defined + /** + * Sets the source path of the image (may be svg or a raster format). Data defined * picture source may override this value. The path can either be a local path * or a remote (http) path. * \param path path for the source image @@ -79,7 +83,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ void setPicturePath( const QString &path ); - /** Returns the path of the source image. Data defined picture source may override + /** + * Returns the path of the source image. Data defined picture source may override * this value. The path can either be a local path or a remote (http) path. * \returns path for the source image * \see usePictureExpression @@ -88,18 +93,21 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ QString picturePath() const; - /** Sets this items bound in scene coordinates such that 1 item size units + /** + * Sets this items bound in scene coordinates such that 1 item size units * corresponds to 1 scene size unit and resizes the svg symbol / image */ void setSceneRect( const QRectF &rectangle ) override; - /** Stores state in Dom element + /** + * Stores state in Dom element * \param elem is Dom element corresponding to 'Composer' tag * \param doc is Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom node corresponding to item tag * \param doc is Dom document */ @@ -114,7 +122,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ double pictureRotation() const { return mPictureRotation; } - /** Sets the map object for rotation (by id). A value of -1 disables the map + /** + * Sets the map object for rotation (by id). A value of -1 disables the map * rotation. If this is set then the picture will be rotated by the same * amount as the specified map object. This is useful especially for * syncing north arrows with a map item. @@ -124,7 +133,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ void setRotationMap( int composerMapId ); - /** Returns the id of the rotation map. A value of -1 means map rotation is + /** + * Returns the id of the rotation map. A value of -1 means map rotation is * disabled. If this is set then the picture is rotated by the same amount * as the specified map object. * \returns id of map object @@ -133,7 +143,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ int rotationMap() const; - /** True if the picture rotation is matched to a map item. + /** + * True if the picture rotation is matched to a map item. * \returns true if rotation map is in use * \see rotationMap * \see setRotationMap @@ -172,7 +183,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ void setNorthOffset( double offset ); - /** Returns the resize mode used for drawing the picture within the composer + /** + * Returns the resize mode used for drawing the picture within the composer * item's frame. * \returns resize mode of picture * \since QGIS 2.3 @@ -180,7 +192,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ ResizeMode resizeMode() const { return mResizeMode; } - /** Sets the picture's anchor point, which controls how it is placed + /** + * Sets the picture's anchor point, which controls how it is placed * within the picture item's frame. * \param anchor anchor point for picture * \since QGIS 2.3 @@ -188,7 +201,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ void setPictureAnchor( QgsComposerItem::ItemPositionMode anchor ); - /** Returns the picture's current anchor, which controls how it is placed + /** + * Returns the picture's current anchor, which controls how it is placed * within the picture item's frame. * \returns anchor point for picture * \since QGIS 2.3 @@ -196,14 +210,16 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ ItemPositionMode pictureAnchor() const { return mPictureAnchor; } - /** Returns the fill color used for parametrized SVG files. + /** + * Returns the fill color used for parametrized SVG files. * \see setSvgFillColor() * \see svgStrokeColor() * \since QGIS 2.14.1 */ QColor svgFillColor() const { return mSvgFillColor; } - /** Sets the fill color used for parametrized SVG files. + /** + * Sets the fill color used for parametrized SVG files. * \param color fill color. * \note this setting only has an effect on parametrized SVG files, and is ignored for * non-parametrized SVG files. @@ -213,14 +229,16 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ void setSvgFillColor( const QColor &color ); - /** Returns the stroke color used for parametrized SVG files. + /** + * Returns the stroke color used for parametrized SVG files. * \see setSvgStrokeColor() * \see svgFillColor() * \since QGIS 2.14.1 */ QColor svgStrokeColor() const { return mSvgStrokeColor; } - /** Sets the stroke color used for parametrized SVG files. + /** + * Sets the stroke color used for parametrized SVG files. * \param color stroke color. * \note this setting only has an effect on parametrized SVG files, and is ignored for * non-parametrized SVG files. @@ -230,14 +248,16 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ void setSvgStrokeColor( const QColor &color ); - /** Returns the stroke width (in mm) used for parametrized SVG files. + /** + * Returns the stroke width (in mm) used for parametrized SVG files. * \see setSvgStrokeWidth() * \see svgStrokeColor() * \since QGIS 2.14.1 */ double svgStrokeWidth() const { return mSvgStrokeWidth; } - /** Sets the stroke width used for parametrized SVG files. + /** + * Sets the stroke width used for parametrized SVG files. * \param width stroke width in mm * \note this setting only has an effect on parametrized SVG files, and is ignored for * non-parametrized SVG files. @@ -247,7 +267,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ void setSvgStrokeWidth( double width ); - /** Returns the current picture mode (image format). + /** + * Returns the current picture mode (image format). * \returns picture mode * \since QGIS 2.3 */ @@ -263,21 +284,24 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem */ virtual void setPictureRotation( double rotation ); - /** Sets the resize mode used for drawing the picture within the item bounds. + /** + * Sets the resize mode used for drawing the picture within the item bounds. * \param mode ResizeMode to use for image file * \since QGIS 2.3 * \see resizeMode */ virtual void setResizeMode( ResizeMode mode ); - /** Recalculates the source image (if using an expression for picture's source) + /** + * Recalculates the source image (if using an expression for picture's source) * and reloads and redraws the picture. * \param context expression context for evaluating data defined picture sources * \since QGIS 2.3 */ void refreshPicture( const QgsExpressionContext *context = nullptr ); - /** Forces a recalculation of the picture's frame size + /** + * Forces a recalculation of the picture's frame size * \since QGIS 2.3 */ void recalculateSize(); @@ -340,16 +364,19 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem //! Sets up the picture item and connects to relevant signals void init(); - /** Returns part of a raster image which will be shown, given current picture + /** + * Returns part of a raster image which will be shown, given current picture * anchor settings */ QRect clippedImageRect( double &boundRectWidthMM, double &boundRectHeightMM, QSize imageRectPixels ); - /** Loads a remote picture for the item + /** + * Loads a remote picture for the item */ void loadRemotePicture( const QString &url ); - /** Loads a local picture for the item + /** + * Loads a local picture for the item */ void loadLocalPicture( const QString &path ); diff --git a/src/core/composer/qgscomposerpolygon.h b/src/core/composer/qgscomposerpolygon.h index 152c04c2d21a..def405f7350e 100644 --- a/src/core/composer/qgscomposerpolygon.h +++ b/src/core/composer/qgscomposerpolygon.h @@ -25,7 +25,8 @@ class QgsFillSymbol; -/** \ingroup core +/** + * \ingroup core * Composer item for polygons. * \since QGIS 2.16 */ @@ -36,12 +37,14 @@ class CORE_EXPORT QgsComposerPolygon: public QgsComposerNodesItem public: - /** Constructor + /** + * Constructor * \param c parent composition */ QgsComposerPolygon( QgsComposition *c ); - /** Constructor + /** + * Constructor * \param polygon nodes of the shape * \param c parent composition */ @@ -64,7 +67,8 @@ class CORE_EXPORT QgsComposerPolygon: public QgsComposerNodesItem //! QgsSymbol use to draw the shape. std::unique_ptr mPolygonStyleSymbol; - /** Add the node newPoint at the given position according to some + /** + * Add the node newPoint at the given position according to some * criteres. */ bool _addNode( const int indexPoint, QPointF newPoint, const double radius ) override; diff --git a/src/core/composer/qgscomposerpolyline.h b/src/core/composer/qgscomposerpolyline.h index dadd3a0867a8..e81f41331d90 100644 --- a/src/core/composer/qgscomposerpolyline.h +++ b/src/core/composer/qgscomposerpolyline.h @@ -25,7 +25,8 @@ class QgsLineSymbol; -/** \ingroup core +/** + * \ingroup core * Composer item for polylines. * \since QGIS 2.16 */ @@ -35,12 +36,14 @@ class CORE_EXPORT QgsComposerPolyline: public QgsComposerNodesItem public: - /** Constructor + /** + * Constructor * \param c parent composition */ QgsComposerPolyline( QgsComposition *c ); - /** Constructor + /** + * Constructor * \param polyline nodes of the shape * \param c parent composition */ @@ -63,7 +66,8 @@ class CORE_EXPORT QgsComposerPolyline: public QgsComposerNodesItem //! QgsSymbol use to draw the shape. std::unique_ptr mPolylineStyleSymbol; - /** Add the node newPoint at the given position according to some + /** + * Add the node newPoint at the given position according to some * criteres. */ bool _addNode( const int indexPoint, QPointF newPoint, const double radius ) override; diff --git a/src/core/composer/qgscomposerscalebar.h b/src/core/composer/qgscomposerscalebar.h index f3268e64b2ec..5acdd3fe1649 100644 --- a/src/core/composer/qgscomposerscalebar.h +++ b/src/core/composer/qgscomposerscalebar.h @@ -27,7 +27,8 @@ class QgsComposerMap; -/** \ingroup core +/** + * \ingroup core * A scale bar item that can be added to a map composition. */ @@ -56,7 +57,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem double numUnitsPerSegment() const {return mSettings.unitsPerSegment();} void setNumUnitsPerSegment( double units ); - /** Returns the size mode for scale bar segments. + /** + * Returns the size mode for scale bar segments. * \see setSegmentSizeMode * \see minBarWidth * \see maxBarWidth @@ -64,7 +66,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ QgsScaleBarSettings::SegmentSizeMode segmentSizeMode() const { return mSettings.segmentSizeMode(); } - /** Sets the size mode for scale bar segments. + /** + * Sets the size mode for scale bar segments. * \param mode size mode * \see segmentSizeMode * \see setMinBarWidth @@ -73,7 +76,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ void setSegmentSizeMode( QgsScaleBarSettings::SegmentSizeMode mode ); - /** Returns the minimum size (in millimeters) for scale bar segments. This + /** + * Returns the minimum size (in millimeters) for scale bar segments. This * property is only effective if the segmentSizeMode() is set * to SegmentSizeFitWidth. * \see segmentSizeMode @@ -83,7 +87,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ double minBarWidth() const { return mSettings.minimumBarWidth(); } - /** Sets the minimum size (in millimeters) for scale bar segments. This + /** + * Sets the minimum size (in millimeters) for scale bar segments. This * property is only effective if the segmentSizeMode() is set * to SegmentSizeFitWidth. * \param minWidth minimum width in millimeters @@ -94,7 +99,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ void setMinBarWidth( double minWidth ); - /** Returns the maximum size (in millimeters) for scale bar segments. This + /** + * Returns the maximum size (in millimeters) for scale bar segments. This * property is only effective if the segmentSizeMode() is set * to SegmentSizeFitWidth. * \see segmentSizeMode @@ -104,7 +110,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ double maxBarWidth() const { return mSettings.maximumBarWidth(); } - /** Sets the maximum size (in millimeters) for scale bar segments. This + /** + * Sets the maximum size (in millimeters) for scale bar segments. This * property is only effective if the segmentSizeMode() is set * to SegmentSizeFitWidth. * \param maxWidth maximum width in millimeters @@ -124,80 +131,92 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem QFont font() const; void setFont( const QFont &font ); - /** Returns the color used for drawing text in the scalebar. + /** + * Returns the color used for drawing text in the scalebar. * \returns font color for scalebar. * \see setFontColor * \see font */ QColor fontColor() const {return mSettings.fontColor();} - /** Sets the color used for drawing text in the scalebar. + /** + * Sets the color used for drawing text in the scalebar. * \param c font color for scalebar. * \see fontColor * \see setFont */ void setFontColor( const QColor &c ) {mSettings.setFontColor( c );} - /** Returns the color used for fills in the scalebar. + /** + * Returns the color used for fills in the scalebar. * \see setFillColor() * \see fillColor2() * \since QGIS 3.0 */ QColor fillColor() const {return mSettings.fillColor();} - /** Sets the color used for fills in the scalebar. + /** + * Sets the color used for fills in the scalebar. * \see fillColor() * \see setFillColor2() * \since QGIS 3.0 */ void setFillColor( const QColor &color ) {mSettings.setFillColor( color ); } - /** Returns the secondary color used for fills in the scalebar. + /** + * Returns the secondary color used for fills in the scalebar. * \see setFillColor2() * \see fillColor() * \since QGIS 3.0 */ QColor fillColor2() const {return mSettings.fillColor2();} - /** Sets the secondary color used for fills in the scalebar. + /** + * Sets the secondary color used for fills in the scalebar. * \see fillColor2() * \see setFillColor2() * \since QGIS 3.0 */ void setFillColor2( const QColor &color ) {mSettings.setFillColor2( color ); } - /** Returns the color used for lines in the scalebar. + /** + * Returns the color used for lines in the scalebar. * \see setLineColor() * \since QGIS 3.0 */ QColor lineColor() const {return mSettings.lineColor();} - /** Sets the color used for lines in the scalebar. + /** + * Sets the color used for lines in the scalebar. * \see lineColor() * \since QGIS 3.0 */ void setLineColor( const QColor &color ) { mSettings.setLineColor( color ); } - /** Returns the line width in millimeters for lines in the scalebar. + /** + * Returns the line width in millimeters for lines in the scalebar. * \see setLineWidth() * \since QGIS 3.0 */ double lineWidth() const {return mSettings.lineWidth();} - /** Sets the line width in millimeters for lines in the scalebar. + /** + * Sets the line width in millimeters for lines in the scalebar. * \see lineWidth() * \since QGIS 3.0 */ void setLineWidth( double width ) { mSettings.setLineWidth( width ); } - /** Returns the pen used for drawing the scalebar. + /** + * Returns the pen used for drawing the scalebar. * \returns QPen used for drawing the scalebar outlines. * \see setPen * \see brush */ QPen pen() const {return mSettings.pen();} - /** Returns the primary brush for the scalebar. + /** + * Returns the primary brush for the scalebar. * \returns QBrush used for filling the scalebar * \see setBrush * \see brush2 @@ -205,7 +224,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ QBrush brush() const {return mSettings.brush();} - /** Returns the secondary brush for the scalebar. This is used for alternating color style scalebars, such + /** + * Returns the secondary brush for the scalebar. This is used for alternating color style scalebars, such * as single and double box styles. * \returns QBrush used for secondary color areas * \see setBrush2 @@ -252,14 +272,16 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ void setUnits( QgsUnitTypes::DistanceUnit u ); - /** Returns the join style used for drawing lines in the scalebar + /** + * Returns the join style used for drawing lines in the scalebar * \returns Join style for lines * \since QGIS 2.3 * \see setLineJoinStyle */ Qt::PenJoinStyle lineJoinStyle() const { return mSettings.lineJoinStyle(); } - /** Sets join style used when drawing the lines in the scalebar + /** + * Sets join style used when drawing the lines in the scalebar * \param style Join style for lines * \returns nothing * \since QGIS 2.3 @@ -267,14 +289,16 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem */ void setLineJoinStyle( Qt::PenJoinStyle style ); - /** Returns the cap style used for drawing lines in the scalebar + /** + * Returns the cap style used for drawing lines in the scalebar * \returns Cap style for lines * \since QGIS 2.3 * \see setLineCapStyle */ Qt::PenCapStyle lineCapStyle() const { return mSettings.lineCapStyle(); } - /** Sets cap style used when drawing the lines in the scalebar + /** + * Sets cap style used when drawing the lines in the scalebar * \param style Cap style for lines * \returns nothing * \since QGIS 2.3 @@ -287,7 +311,8 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem //! Apply default size (scale bar 1/5 of map item width) void applyDefaultSize( QgsUnitTypes::DistanceUnit u = QgsUnitTypes::DistanceMeters ); - /** Sets style by name + /** + * Sets style by name \param styleName (untranslated) style name. Possibilities are: 'Single Box', 'Double Box', 'Line Ticks Middle', 'Line Ticks Down', 'Line Ticks Up', 'Numeric'*/ void setStyle( const QString &styleName ); @@ -301,13 +326,15 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem void update(); - /** Stores state in Dom element + /** + * Stores state in Dom element * \param elem is Dom element corresponding to 'Composer' tag * \param doc Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom node corresponding to item tag * \param doc is Dom document */ diff --git a/src/core/composer/qgscomposershape.h b/src/core/composer/qgscomposershape.h index fd7d0d451386..1aea14192d20 100644 --- a/src/core/composer/qgscomposershape.h +++ b/src/core/composer/qgscomposershape.h @@ -26,7 +26,8 @@ class QgsFillSymbol; -/** \ingroup core +/** + * \ingroup core * A composer items that draws common shapes (ellipse, triangle, rectangle)*/ class CORE_EXPORT QgsComposerShape: public QgsComposerItem { @@ -50,13 +51,15 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem //! \brief Reimplementation of QCanvasItem::paint - draw on canvas void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override; - /** Stores state in Dom element + /** + * Stores state in Dom element * \param elem is Dom element corresponding to 'Composer' tag * \param doc write template file */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom node corresponding to item tag * \param doc is Dom document */ @@ -71,24 +74,29 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem //! Returns the radius for rounded rectangle corners double cornerRadius() const { return mCornerRadius; } - /** Sets the QgsFillSymbol used to draw the shape. Must also call setUseSymbol( true ) to + /** + * Sets the QgsFillSymbol used to draw the shape. Must also call setUseSymbol( true ) to * enable drawing with a symbol. * Note: added in version 2.1*/ void setShapeStyleSymbol( QgsFillSymbol *symbol ); - /** Returns the QgsFillSymbol used to draw the shape. + /** + * Returns the QgsFillSymbol used to draw the shape. * Note: added in version 2.1*/ QgsFillSymbol *shapeStyleSymbol() { return mShapeStyleSymbol; } - /** Controls whether the shape should be drawn using a QgsFillSymbol. + /** + * Controls whether the shape should be drawn using a QgsFillSymbol. * Note: Added in v2.1 */ void setUseSymbol( bool useSymbol ); - /** Depending on the symbol style, the bounding rectangle can be larger than the shape + /** + * Depending on the symbol style, the bounding rectangle can be larger than the shape \since QGIS 2.3*/ QRectF boundingRect() const override; - /** Sets new scene rectangle bounds and recalculates hight and extent. Reimplemented from + /** + * Sets new scene rectangle bounds and recalculates hight and extent. Reimplemented from * QgsComposerItem as it needs to call updateBoundingRect after the shape's size changes */ void setSceneRect( const QRectF &rectangle ) override; @@ -102,13 +110,15 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem /* reimplement drawBackground, since it's not a rect, but a custom shape */ virtual void drawBackground( QPainter *p ) override; - /** Reimplement estimatedFrameBleed, since frames on shapes are drawn using symbology + /** + * Reimplement estimatedFrameBleed, since frames on shapes are drawn using symbology * rather than the item's pen */ virtual double estimatedFrameBleed() const override; public slots: - /** Should be called after the shape's symbol is changed. Redraws the shape and recalculates + /** + * Should be called after the shape's symbol is changed. Redraws the shape and recalculates * its selection bounds. * Note: added in version 2.1*/ void refreshSymbol(); diff --git a/src/core/composer/qgscomposertablecolumn.h b/src/core/composer/qgscomposertablecolumn.h index e54592d88364..d0e0508d38ed 100644 --- a/src/core/composer/qgscomposertablecolumn.h +++ b/src/core/composer/qgscomposertablecolumn.h @@ -25,7 +25,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * Stores properties of a column in a QgsComposerTable. Some properties of a QgsComposerTableColumn are applicable only in certain contexts. For instance, the attribute and setAttribute methods only have an effect for QgsComposerAttributeTables, and have no effect for QgsComposerTextTables.*/ @@ -35,12 +36,14 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject public: - /** Constructor for QgsComposerTableColumn. + /** + * Constructor for QgsComposerTableColumn. * \param heading column heading */ QgsComposerTableColumn( const QString &heading = QString() ); - /** Writes the column's properties to xml for storage. + /** + * Writes the column's properties to xml for storage. * \param columnElem an existing QDomElement in which to store the column's properties. * \param doc QDomDocument for the destination xml. * \since QGIS 2.3 @@ -48,28 +51,32 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ virtual bool writeXml( QDomElement &columnElem, QDomDocument &doc ) const; - /** Reads the column's properties from xml. + /** + * Reads the column's properties from xml. * \param columnElem a QDomElement holding the column's desired properties. * \since QGIS 2.3 * \see writeXml */ virtual bool readXml( const QDomElement &columnElem ); - /** Returns the width for a column. + /** + * Returns the width for a column. * \returns column width in mm, or 0 if column width is automatically calculated. * \since QGIS 2.5 * \see setWidth */ double width() const { return mWidth; } - /** Sets the width for a column. + /** + * Sets the width for a column. * \param width column width in mm, or 0 if column width is to be automatically calculated. * \since QGIS 2.5 * \see width */ void setWidth( const double width ) { mWidth = width; } - /** Returns the heading for a column, which is the value displayed in the columns + /** + * Returns the heading for a column, which is the value displayed in the columns * header cell. * \returns Heading for column. * \since QGIS 2.3 @@ -77,7 +84,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ QString heading() const { return mHeading; } - /** Sets the heading for a column, which is the value displayed in the columns + /** + * Sets the heading for a column, which is the value displayed in the columns * header cell. * \param heading Heading for column. * \since QGIS 2.3 @@ -85,7 +93,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ void setHeading( const QString &heading ) { mHeading = heading; } - /** Returns the horizontal alignment for a column, which controls the alignment + /** + * Returns the horizontal alignment for a column, which controls the alignment * used for drawing column values within cells. * \returns horizontal alignment. * \since QGIS 2.3 @@ -94,7 +103,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ Qt::AlignmentFlag hAlignment() const { return mHAlignment; } - /** Sets the horizontal alignment for a column, which controls the alignment + /** + * Sets the horizontal alignment for a column, which controls the alignment * used for drawing column values within cells. * \param alignment horizontal alignment for cell. * \since QGIS 2.3 @@ -103,7 +113,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ void setHAlignment( Qt::AlignmentFlag alignment ) { mHAlignment = alignment; } - /** Returns the vertical alignment for a column, which controls the alignment + /** + * Returns the vertical alignment for a column, which controls the alignment * used for drawing column values within cells. * \returns vertical alignment. * \since QGIS 2.12 @@ -112,7 +123,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ Qt::AlignmentFlag vAlignment() const { return mVAlignment; } - /** Sets the vertical alignment for a column, which controls the alignment + /** + * Sets the vertical alignment for a column, which controls the alignment * used for drawing column values within cells. * \param alignment vertical alignment for cell. * \since QGIS 2.12 @@ -121,7 +133,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ void setVAlignment( Qt::AlignmentFlag alignment ) { mVAlignment = alignment; } - /** Returns the attribute name or expression used for the column's values. This property + /** + * Returns the attribute name or expression used for the column's values. This property * is only used when the column is part of a QgsComposerAttributeTable. * \returns attribute name or expression text for column * \since QGIS 2.3 @@ -130,7 +143,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ QString attribute() const { return mAttribute; } - /** Sets the attribute name or expression used for the column's values. This property + /** + * Sets the attribute name or expression used for the column's values. This property * is only used when the column is part of a QgsComposerAttributeTable. * \param attribute attribute name or expression text for column * \since QGIS 2.3 @@ -139,7 +153,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ void setAttribute( const QString &attribute ) { mAttribute = attribute; } - /** Returns the sort order for the column. This property is only used when the column + /** + * Returns the sort order for the column. This property is only used when the column * is part of a QgsComposerAttributeTable and when sortByRank is > 0. * \returns sort order for column * \since QGIS 2.3 @@ -149,7 +164,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ Qt::SortOrder sortOrder() const { return mSortOrder; } - /** Sets the sort order for the column. This property is only used when the column + /** + * Sets the sort order for the column. This property is only used when the column * is part of a QgsComposerAttributeTable and when sortByRank is > 0. * \param sortOrder sort order for column * \since QGIS 2.3 @@ -159,7 +175,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ void setSortOrder( Qt::SortOrder sortOrder ) { mSortOrder = sortOrder; } - /** Returns the sort rank for the column. If the sort rank is > 0 then the column + /** + * Returns the sort rank for the column. If the sort rank is > 0 then the column * will be sorted in the table. The sort rank specifies the priority given to the * column when the table is sorted by multiple columns, with lower sort ranks * having higher priority. This property is only used when the column @@ -173,7 +190,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ int sortByRank() const { return mSortByRank; } - /** Sets the sort rank for the column. If the sort rank is > 0 then the column + /** + * Sets the sort rank for the column. If the sort rank is > 0 then the column * will be sorted in the table. The sort rank specifies the priority given to the * column when the table is sorted by multiple columns, with lower sort ranks * having higher priority. This property is only used when the column @@ -187,7 +205,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject */ void setSortByRank( int sortByRank ) { mSortByRank = sortByRank; } - /** Creates a duplicate column which is a deep copy of this column. + /** + * Creates a duplicate column which is a deep copy of this column. * \returns a new QgsComposerTableColumn with same properties as this column. * \since QGIS 2.3 */ diff --git a/src/core/composer/qgscomposertablev2.h b/src/core/composer/qgscomposertablev2.h index 9debbf663e78..c6e4cd5f7179 100644 --- a/src/core/composer/qgscomposertablev2.h +++ b/src/core/composer/qgscomposertablev2.h @@ -28,14 +28,16 @@ class QgsComposerTableColumn; -/** \ingroup core +/** + * \ingroup core * List of QVariants, representing a the contents of a single row in * a QgsComposerTable * \since QGIS 2.5 */ typedef QList< QVariant > QgsComposerTableRow; -/** \ingroup core +/** + * \ingroup core * List of QgsComposerTableRows, representing rows and column cell contents * for a QgsComposerTable * \since QGIS 2.5 @@ -47,14 +49,16 @@ typedef QList< QList< QVariant > > QgsComposerTableContents; #endif -/** \ingroup core +/** + * \ingroup core * List of column definitions for a QgsComposerTable * \since QGIS 2.5 */ typedef QList QgsComposerTableColumns; -/** \ingroup core +/** + * \ingroup core * \class QgsComposerTableStyle * \brief Styling option for a composer table cell * \since QGIS 2.12 @@ -74,14 +78,16 @@ class CORE_EXPORT QgsComposerTableStyle //! Cell background color QColor cellBackgroundColor; - /** Writes the style's properties to XML for storage. + /** + * Writes the style's properties to XML for storage. * \param styleElem an existing QDomElement in which to store the style's properties. * \param doc QDomDocument for the destination XML. * \see readXml */ bool writeXml( QDomElement &styleElem, QDomDocument &doc ) const; - /** Reads the style's properties from XML. + /** + * Reads the style's properties from XML. * \param styleElem a QDomElement holding the style's desired properties. * \see writeXml */ @@ -89,7 +95,8 @@ class CORE_EXPORT QgsComposerTableStyle }; -/** A class to display a table in the print composer, and allow +/** + * A class to display a table in the print composer, and allow * the table to span over multiple frames * \ingroup core * \since QGIS 2.5 @@ -100,7 +107,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame public: - /** Controls how headers are horizontally aligned in a table + /** + * Controls how headers are horizontally aligned in a table */ enum HeaderHAlignment { @@ -110,7 +118,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame HeaderRight //!< Align headers right }; - /** Controls where headers are shown in the table + /** + * Controls where headers are shown in the table */ enum HeaderMode { @@ -119,7 +128,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame NoHeaders //!< No headers shown for table }; - /** Controls how empty tables are displayed + /** + * Controls how empty tables are displayed */ enum EmptyTableMode { @@ -128,7 +138,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame ShowMessage //!< Shows preset message instead of table contents }; - /** Controls how long strings in the table are handled + /** + * Controls how long strings in the table are handled */ enum WrapBehavior { @@ -136,7 +147,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame WrapText //!< Text which doesn't fit inside the cell is wrapped. Note that this only applies to text in columns with a fixed width. }; - /** Row or column groups for cell styling + /** + * Row or column groups for cell styling */ enum CellStyleGroup { @@ -156,32 +168,37 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame virtual ~QgsComposerTableV2(); - /** Sets the margin distance between cell borders and their contents. + /** + * Sets the margin distance between cell borders and their contents. * \param margin margin for cell contents * \see cellMargin */ void setCellMargin( const double margin ); - /** Returns the margin distance between cell borders and their contents. + /** + * Returns the margin distance between cell borders and their contents. * \returns margin for cell contents * \see setCellMargin */ double cellMargin() const { return mCellMargin; } - /** Sets the behavior for empty tables with no content rows. + /** + * Sets the behavior for empty tables with no content rows. * \param mode behavior mode for empty tables * \see emptyTableBehavior */ void setEmptyTableBehavior( const EmptyTableMode mode ); - /** Returns the behavior mode for empty tables. This property controls + /** + * Returns the behavior mode for empty tables. This property controls * how the table is drawn if it contains no content rows. * \returns behavior mode for empty tables * \see setEmptyTableBehavior */ EmptyTableMode emptyTableBehavior() const { return mEmptyTableMode; } - /** Sets the message for empty tables with no content rows. This message + /** + * Sets the message for empty tables with no content rows. This message * is displayed in the table body if the empty table behavior is * set to ShowMessage * \param message message to show for empty tables @@ -190,7 +207,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setEmptyTableMessage( const QString &message ); - /** Returns the message for empty tables with no content rows. This message + /** + * Returns the message for empty tables with no content rows. This message * is displayed in the table body if the empty table behavior is * set to ShowMessage * \returns message to show for empty tables @@ -199,33 +217,38 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ QString emptyTableMessage() const { return mEmptyTableMessage; } - /** Sets whether empty rows should be drawn. Tables default to hiding empty rows. + /** + * Sets whether empty rows should be drawn. Tables default to hiding empty rows. * \param showEmpty set to true to show empty rows in the table * \see showEmptyRows */ void setShowEmptyRows( const bool showEmpty ); - /** Returns whether empty rows are drawn in the table + /** + * Returns whether empty rows are drawn in the table * \returns true if empty rows are drawn * \see setShowEmptyRows */ bool showEmptyRows() const { return mShowEmptyRows; } - /** Sets the font used to draw header text in the table. + /** + * Sets the font used to draw header text in the table. * \param font font for header cells * \see headerFont * \see setContentFont */ void setHeaderFont( const QFont &font ); - /** Returns the font used to draw header text in the table. + /** + * Returns the font used to draw header text in the table. * \returns font for header cells * \see setHeaderFont * \see contentFont */ QFont headerFont() const { return mHeaderFont; } - /** Sets the color used to draw header text in the table. + /** + * Sets the color used to draw header text in the table. * \param color header text color * \see headerFontColor * \see setHeaderFont @@ -233,7 +256,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setHeaderFontColor( const QColor &color ); - /** Returns the color used to draw header text in the table. + /** + * Returns the color used to draw header text in the table. * \returns color for header text * \see setHeaderFontColor * \see headerFont @@ -241,47 +265,54 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ QColor headerFontColor() const { return mHeaderFontColor; } - /** Sets the horizontal alignment for table headers + /** + * Sets the horizontal alignment for table headers * \param alignment Horizontal alignment for table header cells * \see headerHAlignment */ void setHeaderHAlignment( const HeaderHAlignment alignment ); - /** Returns the horizontal alignment for table headers + /** + * Returns the horizontal alignment for table headers * \returns Horizontal alignment for table header cells * \see setHeaderHAlignment */ HeaderHAlignment headerHAlignment() const { return mHeaderHAlignment; } - /** Sets the display mode for headers in the table. This property controls + /** + * Sets the display mode for headers in the table. This property controls * if and where headers are shown in the table. * \param mode display mode for headers * \see headerMode */ void setHeaderMode( const HeaderMode mode ); - /** Returns the display mode for headers in the table. This property controls + /** + * Returns the display mode for headers in the table. This property controls * if and where headers are shown in the table. * \returns display mode for headers * \see setHeaderMode */ HeaderMode headerMode() const { return mHeaderMode; } - /** Sets the font used to draw text in table body cells. + /** + * Sets the font used to draw text in table body cells. * \param font font for table cells * \see contentFont * \see setHeaderFont */ void setContentFont( const QFont &font ); - /** Returns the font used to draw text in table body cells. + /** + * Returns the font used to draw text in table body cells. * \returns font for table cells * \see setContentFont * \see headerFont */ QFont contentFont() const { return mContentFont; } - /** Sets the color used to draw text in table body cells. + /** + * Sets the color used to draw text in table body cells. * \param color table cell text color * \see contentFontColor * \see setContentFont @@ -289,7 +320,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setContentFontColor( const QColor &color ); - /** Returns the color used to draw text in table body cells. + /** + * Returns the color used to draw text in table body cells. * \returns text color for table cells * \see setContentFontColor * \see contentFont @@ -297,7 +329,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ QColor contentFontColor() const { return mContentFontColor; } - /** Sets whether grid lines should be drawn in the table + /** + * Sets whether grid lines should be drawn in the table * \param showGrid set to true to show grid lines * \see showGrid * \see setGridStrokeWidth @@ -305,7 +338,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setShowGrid( const bool showGrid ); - /** Returns whether grid lines are drawn in the table + /** + * Returns whether grid lines are drawn in the table * \returns true if grid lines are shown * \see setShowGrid * \see gridStrokeWidth @@ -313,7 +347,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ bool showGrid() const { return mShowGrid; } - /** Sets the width for grid lines in the table. + /** + * Sets the width for grid lines in the table. * \param width grid line width * \see gridStrokeWidth * \see setShowGrid @@ -321,7 +356,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setGridStrokeWidth( const double width ); - /** Returns the width of grid lines in the table. + /** + * Returns the width of grid lines in the table. * \returns grid line width * \see setGridStrokeWidth * \see showGrid @@ -329,7 +365,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ double gridStrokeWidth() const { return mGridStrokeWidth; } - /** Sets color used for grid lines in the table. + /** + * Sets color used for grid lines in the table. * \param color grid line color * \see gridColor * \see setShowGrid @@ -337,7 +374,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setGridColor( const QColor &color ); - /** Returns the color used for grid lines in the table. + /** + * Returns the color used for grid lines in the table. * \returns grid line color * \see setGridColor * \see showGrid @@ -345,7 +383,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ QColor gridColor() const { return mGridColor; } - /** Sets whether the grid's horizontal lines should be drawn in the table + /** + * Sets whether the grid's horizontal lines should be drawn in the table * \param horizontalGrid set to true to draw grid's horizontal lines * \see setShowGrid * \see setGridStrokeWidth @@ -355,7 +394,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setHorizontalGrid( const bool horizontalGrid ); - /** Returns whether the grid's horizontal lines are drawn in the table + /** + * Returns whether the grid's horizontal lines are drawn in the table * \returns true if grid's horizontal lines are drawn * \see setShowGrid * \see setGridStrokeWidth @@ -365,7 +405,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ bool horizontalGrid() const { return mHorizontalGrid; } - /** Sets whether the grid's vertical lines should be drawn in the table + /** + * Sets whether the grid's vertical lines should be drawn in the table * \param verticalGrid set to true to draw grid's vertical lines * \see setShowGrid * \see setGridStrokeWidth @@ -375,7 +416,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setVerticalGrid( const bool verticalGrid ); - /** Returns whether the grid's vertical lines are drawn in the table + /** + * Returns whether the grid's vertical lines are drawn in the table * \returns true if grid's vertical lines are drawn * \see setShowGrid * \see setGridStrokeWidth @@ -385,21 +427,24 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ bool verticalGrid() const { return mVerticalGrid; } - /** Sets color used for background of table. + /** + * Sets color used for background of table. * \param color table background color * \see backgroundColor * \see setGridColor */ void setBackgroundColor( const QColor &color ); - /** Returns the color used for the background of the table. + /** + * Returns the color used for the background of the table. * \returns table background color * \see setBackgroundColor * \see gridColor */ QColor backgroundColor() const { return mBackgroundColor; } - /** Sets the wrap behavior for the table, which controls how text within cells is + /** + * Sets the wrap behavior for the table, which controls how text within cells is * automatically wrapped. * \param behavior wrap behavior * \see wrapBehavior @@ -407,7 +452,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setWrapBehavior( WrapBehavior behavior ); - /** Returns the wrap behavior for the table, which controls how text within cells is + /** + * Returns the wrap behavior for the table, which controls how text within cells is * automatically wrapped. * \returns current wrap behavior * \see setWrapBehavior @@ -415,20 +461,23 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ WrapBehavior wrapBehavior() const { return mWrapBehavior; } - /** Returns a pointer to the list of QgsComposerTableColumns shown in the table + /** + * Returns a pointer to the list of QgsComposerTableColumns shown in the table * \returns pointer to list of columns in table * \see setColumns */ QgsComposerTableColumns *columns() { return &mColumns; } - /** Replaces the columns in the table with a specified list of QgsComposerTableColumns. + /** + * Replaces the columns in the table with a specified list of QgsComposerTableColumns. * \param columns list of QgsComposerTableColumns to show in table. Ownership of columns * is transferred to the table. * \see columns */ void setColumns( const QgsComposerTableColumns &columns SIP_TRANSFER ); - /** Sets the cell style for a cell group. + /** + * Sets the cell style for a cell group. * \param group group to set style for * \param style new cell style * \see cellStyle() @@ -436,27 +485,31 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void setCellStyle( CellStyleGroup group, const QgsComposerTableStyle &style ); - /** Returns the cell style for a cell group. + /** + * Returns the cell style for a cell group. * \param group group to retrieve style for * \see setCellStyle() * \since QGIS 2.12 */ const QgsComposerTableStyle *cellStyle( CellStyleGroup group ) const; - /** Returns the text used in the column headers for the table. + /** + * Returns the text used in the column headers for the table. * \returns QMap of int to QString, where the int is the column index (starting at 0), * and the string is the text to use for the column's header * \note not available in Python bindings */ virtual QMap headerLabels() const SIP_SKIP; - /** Fetches the contents used for the cells in the table. + /** + * Fetches the contents used for the cells in the table. * \returns true if table contents were successfully retrieved. * \param contents QgsComposerTableContents to store retrieved row data in */ virtual bool getTableContents( QgsComposerTableContents &contents ) = 0; - /** Returns the current contents of the table. Excludes header cells. + /** + * Returns the current contents of the table. Excludes header cells. * \returns table contents */ QgsComposerTableContents *contents() { return &mTableContents; } @@ -474,7 +527,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame public slots: - /** Refreshes the contents shown in the table by querying for new data. + /** + * Refreshes the contents shown in the table by querying for new data. * This also causes the column widths and size of the table to change to accommodate the * new data. * \see adjustFrameToSize @@ -550,30 +604,35 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame QMap< CellStyleGroup, QgsComposerTableStyle * > mCellStyles; - /** Calculates the maximum width of text shown in columns. + /** + * Calculates the maximum width of text shown in columns. */ virtual bool calculateMaxColumnWidths(); - /** Calculates the maximum height of text shown in rows. + /** + * Calculates the maximum height of text shown in rows. * \since QGIS 2.12 */ virtual bool calculateMaxRowHeights(); - /** Returns total width of table contents. + /** + * Returns total width of table contents. * \returns table width * \see totalHeight */ //not const, as needs to call calculateMaxColumnWidths() double totalWidth(); - /** Returns total height of table contents. + /** + * Returns total height of table contents. * \returns total height * \see totalWidth */ //not const, as needs to call calculateMaxRowHeights() double totalHeight(); - /** Calculates how many content rows would be visible within a frame of the specified + /** + * Calculates how many content rows would be visible within a frame of the specified * height. * \param frameHeight height of frame * \param firstRow index of first row visible in frame (where 0 = first row in table) @@ -586,7 +645,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ int rowsVisible( double frameHeight, int firstRow, bool includeHeader, bool includeEmptyRows ) const; - /** Calculates how many content rows are visible within a given frame. + /** + * Calculates how many content rows are visible within a given frame. * \param frameIndex index number for frame * \param firstRow index of first row visible in frame (where 0 = first row in table) * \param includeEmptyRows set to true to also include rows which would be empty in the returned count. For instance, @@ -597,14 +657,16 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ int rowsVisible( int frameIndex, int firstRow, bool includeEmptyRows ) const; - /** Calculates a range of rows which should be visible in a given frame. + /** + * Calculates a range of rows which should be visible in a given frame. * \param frameIndex index number for frame * \returns row range * \since QGIS 2.12 */ QPair rowRange( const int frameIndex ) const; - /** Draws the horizontal grid lines for the table. + /** + * Draws the horizontal grid lines for the table. * \param painter destination painter for grid lines * \param firstRow index corresponding to first row shown in frame * \param lastRow index corresponding to last row shown in frame. If greater than the number of content rows in the @@ -615,7 +677,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void drawHorizontalGridLines( QPainter *painter, int firstRow, int lastRow, bool drawHeaderLines ) const; - /** Draws the vertical grid lines for the table. + /** + * Draws the vertical grid lines for the table. * \param painter destination painter for grid lines * \param maxWidthMap QMap of int to double, where the int contains the column number and the double is the * maximum width of text present in the column. @@ -632,11 +695,13 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame */ void drawVerticalGridLines( QPainter *painter, const QMap &maxWidthMap, int firstRow, int lastRow, bool hasHeader, bool mergeCells = false ) const SIP_SKIP; - /** Recalculates and updates the size of the table and all table frames. + /** + * Recalculates and updates the size of the table and all table frames. */ void recalculateTableSize(); - /** Checks whether a table contents contains a given row + /** + * Checks whether a table contents contains a given row * \param contents table contents to check * \param row row to check for * \returns true if contents contains rows @@ -654,7 +719,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame QString wrappedText( const QString &value, double columnWidth, const QFont &font ) const; - /** Returns the calculated background color for a row and column combination. + /** + * Returns the calculated background color for a row and column combination. * \param row row number, where -1 is the header row, and 0 is the first body row * \param column column number, where 0 is the first column * \returns background color, or invalid QColor if no background should be drawn diff --git a/src/core/composer/qgscomposertexttable.h b/src/core/composer/qgscomposertexttable.h index 9db1542798f0..11c2c2da1f57 100644 --- a/src/core/composer/qgscomposertexttable.h +++ b/src/core/composer/qgscomposertexttable.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgscomposertablev2.h" -/** \ingroup core +/** + * \ingroup core * A text table item that reads text from string lists * \since QGIS 2.10 */ @@ -34,7 +35,8 @@ class CORE_EXPORT QgsComposerTextTableV2 : public QgsComposerTableV2 public: QgsComposerTextTableV2( QgsComposition *c SIP_TRANSFERTHIS, bool createUndoCommands ); - /** Adds a row to the table + /** + * Adds a row to the table * \param row list of strings to use for each cell's value in the newly added row * \note If row is shorter than the number of columns in the table than blank cells * will be inserted at the end of the row. If row contains more strings then the number @@ -43,7 +45,8 @@ class CORE_EXPORT QgsComposerTextTableV2 : public QgsComposerTableV2 */ void addRow( const QStringList &row ); - /** Sets the contents of the text table. + /** + * Sets the contents of the text table. * \param contents list of table rows * \see addRow */ diff --git a/src/core/composer/qgscomposerutils.h b/src/core/composer/qgscomposerutils.h index 4c709dfeb85d..167c9c8d81ef 100644 --- a/src/core/composer/qgscomposerutils.h +++ b/src/core/composer/qgscomposerutils.h @@ -25,14 +25,16 @@ class QPainter; -/** \ingroup core +/** + * \ingroup core * Utilities for compositions. */ class CORE_EXPORT QgsComposerUtils { public: - /** Draws an arrow head on to a QPainter. + /** + * Draws an arrow head on to a QPainter. * \param p destination painter * \param x x-coordinate of arrow center * \param y y-coordinate of arrow center @@ -42,7 +44,8 @@ class CORE_EXPORT QgsComposerUtils */ static void drawArrowHead( QPainter *p, const double x, const double y, const double angle, const double arrowHeadWidth ); - /** Calculates the angle of the line from p1 to p2 (counter clockwise, + /** + * Calculates the angle of the line from p1 to p2 (counter clockwise, * starting from a line from north to south) * \param p1 start point of line * \param p2 end point of line @@ -50,27 +53,31 @@ class CORE_EXPORT QgsComposerUtils */ static double angle( QPointF p1, QPointF p2 ); - /** Rotates a point / vector around the origin. + /** + * Rotates a point / vector around the origin. * \param angle rotation angle in degrees, counterclockwise * \param x in/out: x coordinate before / after the rotation * \param y in/out: y cooreinate before / after the rotation */ static void rotate( const double angle, double &x, double &y ); - /** Ensures that an angle is in the range 0 <= angle < 360 + /** + * Ensures that an angle is in the range 0 <= angle < 360 * \param angle angle in degrees * \returns equivalent angle within the range [0, 360) * \see snappedAngle */ static double normalizedAngle( const double angle ); - /** Snaps an angle to its closest 45 degree angle + /** + * Snaps an angle to its closest 45 degree angle * \param angle angle in degrees * \returns angle snapped to 0, 45/90/135/180/225/270 or 315 degrees */ static double snappedAngle( const double angle ); - /** Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by + /** + * Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by * a specified amount. * \param originalRect QRectF to be rotated and scaled * \param boundsRect QRectF specifying the bounds which the rotated and scaled rectangle must fit within @@ -79,19 +86,22 @@ class CORE_EXPORT QgsComposerUtils */ static QRectF largestRotatedRectWithinBounds( const QRectF &originalRect, const QRectF &boundsRect, const double rotation ); - /** Returns the size in mm corresponding to a font point size + /** + * Returns the size in mm corresponding to a font point size * \param pointSize font size in points * \see mmToPoints */ static double pointsToMM( const double pointSize ); - /** Returns the size in mm corresponding to a font point size + /** + * Returns the size in mm corresponding to a font point size * \param mmSize font size in mm * \see pointsToMM */ static double mmToPoints( const double mmSize ); - /** Resizes a QRectF relative to a resized bounding rectangle. + /** + * Resizes a QRectF relative to a resized bounding rectangle. * \param rectToResize QRectF to resize, contained within boundsBefore. The * rectangle is linearly scaled to retain its relative position and size within * boundsAfter. @@ -100,7 +110,8 @@ class CORE_EXPORT QgsComposerUtils */ static void relativeResizeRect( QRectF &rectToResize, const QRectF &boundsBefore, const QRectF &boundsAfter ); - /** Returns a scaled position given a before and after range + /** + * Returns a scaled position given a before and after range * \param position initial position within before range to scale * \param beforeMin minimum value in before range * \param beforeMax maximum value in before range @@ -110,14 +121,16 @@ class CORE_EXPORT QgsComposerUtils */ static double relativePosition( const double position, const double beforeMin, const double beforeMax, const double afterMin, const double afterMax ); - /** Decodes a string representing a paper orientation + /** + * Decodes a string representing a paper orientation * \param orientationString string to decode * \param ok will be true if string could be decoded * \returns decoded paper orientation */ static QgsComposition::PaperOrientation decodePaperOrientation( const QString &orientationString, bool &ok ); - /** Decodes a string representing a preset page size + /** + * Decodes a string representing a preset page size * \param presetString string to decode * \param width double for decoded paper width * \param height double for decoded paper height @@ -125,7 +138,8 @@ class CORE_EXPORT QgsComposerUtils */ static bool decodePresetPaperSize( const QString &presetString, double &width, double &height ); - /** Reads all pre 3.0 data defined properties from an XML element. + /** + * Reads all pre 3.0 data defined properties from an XML element. * \since QGIS 3.0 * \see readDataDefinedProperty * \see writeDataDefinedPropertyMap @@ -133,13 +147,15 @@ class CORE_EXPORT QgsComposerUtils static void readOldDataDefinedPropertyMap( const QDomElement &itemElem, QgsPropertyCollection &dataDefinedProperties ); - /** Reads a pre 3.0 data defined property from an XML DOM element. + /** + * Reads a pre 3.0 data defined property from an XML DOM element. * \since QGIS 3.0 * \see readDataDefinedPropertyMap */ static QgsProperty readOldDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property, const QDomElement &ddElem ); - /** Returns a font where size is set in pixels and the size has been upscaled with FONT_WORKAROUND_SCALE + /** + * Returns a font where size is set in pixels and the size has been upscaled with FONT_WORKAROUND_SCALE * to workaround QT font rendering bugs * \param font source font with size set in points * \returns font with size set in pixels @@ -147,7 +163,8 @@ class CORE_EXPORT QgsComposerUtils */ static QFont scaledFontPixelSize( const QFont &font ); - /** Calculate font ascent in millimeters, including workarounds for QT font rendering issues + /** + * Calculate font ascent in millimeters, including workarounds for QT font rendering issues * \param font input font * \returns font ascent in millimeters * \since QGIS 2.5 @@ -158,7 +175,8 @@ class CORE_EXPORT QgsComposerUtils */ static double fontAscentMM( const QFont &font ); - /** Calculate font descent in millimeters, including workarounds for QT font rendering issues + /** + * Calculate font descent in millimeters, including workarounds for QT font rendering issues * \param font input font * \returns font descent in millimeters * \since QGIS 2.5 @@ -169,7 +187,8 @@ class CORE_EXPORT QgsComposerUtils */ static double fontDescentMM( const QFont &font ); - /** Calculate font height in millimeters, including workarounds for QT font rendering issues + /** + * Calculate font height in millimeters, including workarounds for QT font rendering issues * The font height is the font ascent + descent + 1 (for the baseline). * \param font input font * \returns font height in millimeters @@ -181,7 +200,8 @@ class CORE_EXPORT QgsComposerUtils */ static double fontHeightMM( const QFont &font ); - /** Calculate font height in millimeters of a single character, including workarounds for QT font + /** + * Calculate font height in millimeters of a single character, including workarounds for QT font * rendering issues * \param font input font * \param character character to calculate height for @@ -194,7 +214,8 @@ class CORE_EXPORT QgsComposerUtils */ static double fontHeightCharacterMM( const QFont &font, QChar character ); - /** Calculate font width in millimeters for a string, including workarounds for QT font + /** + * Calculate font width in millimeters for a string, including workarounds for QT font * rendering issues * \param font input font * \param text string to calculate width of @@ -208,7 +229,8 @@ class CORE_EXPORT QgsComposerUtils */ static double textWidthMM( const QFont &font, const QString &text ); - /** Calculate font height in millimeters for a string, including workarounds for QT font + /** + * Calculate font height in millimeters for a string, including workarounds for QT font * rendering issues. Note that this method uses a non-standard measure of text height, * where only the font ascent is considered for the first line of text. * \param font input font @@ -220,7 +242,8 @@ class CORE_EXPORT QgsComposerUtils */ static double textHeightMM( const QFont &font, const QString &text, double multiLineHeight = 1.0 ); - /** Draws text on a painter at a specific position, taking care of composer specific issues (calculation to pixel, + /** + * Draws text on a painter at a specific position, taking care of composer specific issues (calculation to pixel, * scaling of font and painter to work around Qt font bugs) * \param painter destination QPainter * \param pos position to draw text @@ -231,7 +254,8 @@ class CORE_EXPORT QgsComposerUtils */ static void drawText( QPainter *painter, QPointF pos, const QString &text, const QFont &font, const QColor &color = QColor() ); - /** Draws text on a painter within a rectangle, taking care of composer specific issues (calculation to pixel, + /** + * Draws text on a painter within a rectangle, taking care of composer specific issues (calculation to pixel, * scaling of font and painter to work around Qt font bugs) * \param painter destination QPainter * \param rect rectangle to draw into diff --git a/src/core/composer/qgscomposition.h b/src/core/composer/qgscomposition.h index 71be753be8c9..99d615919646 100644 --- a/src/core/composer/qgscomposition.h +++ b/src/core/composer/qgscomposition.h @@ -67,7 +67,8 @@ class QgsFillSymbol; class QgsComposerModel; class QgsPaperItem; -/** \ingroup core +/** + * \ingroup core * Graphics scene for map printing. The class manages the paper item which always * is the item in the back (z-value 0). It maintains the z-Values of the items and stores * them in a list in ascending z-Order. This list can be changed to lower/raise items one position @@ -145,7 +146,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void setName( const QString &name ); - /** Changes size of paper item. + /** + * Changes size of paper item. * \param width page width in mm * \param height page height in mm * \param keepRelativeItemPosition if true, all items and guides will be moved so that they retain @@ -156,21 +158,24 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void setPaperSize( double width, double height, bool keepRelativeItemPosition = true ); - /** Height of paper item + /** + * Height of paper item * \returns height in mm * \see paperWidth * \see setPaperSize */ double paperHeight() const; - /** Width of paper item + /** + * Width of paper item * \returns width in mm * \see paperHeight * \see setPaperSize */ double paperWidth() const; - /** Resizes the composition page to fit the current contents of the composition. + /** + * Resizes the composition page to fit the current contents of the composition. * Calling this method resets the number of pages to 1, with the size set to the * minimum size required to fit all existing composer items. Items will also be * repositioned so that the new top-left bounds of the composition is at the point @@ -186,7 +191,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void resizePageToContents( double marginTop = 0.0, double marginRight = 0.0, double marginBottom = 0.0, double marginLeft = 0.0 ); - /** Sets the resize to contents margins. These margins are saved in the composition + /** + * Sets the resize to contents margins. These margins are saved in the composition * so that they can be restored with the composer. * \param marginTop top margin (millimeters) * \param marginRight right margin (millimeters) @@ -199,7 +205,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void setResizeToContentsMargins( double marginTop, double marginRight, double marginBottom, double marginLeft ); - /** Returns the resize to contents margins. These margins are saved in the composition + /** + * Returns the resize to contents margins. These margins are saved in the composition * so that they can be restored with the composer. * \param marginTop reference for top margin (millimeters) * \param marginRight reference for right margin (millimeters) @@ -212,24 +219,28 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void resizeToContentsMargins( double &marginTop SIP_OUT, double &marginRight SIP_OUT, double &marginBottom SIP_OUT, double &marginLeft SIP_OUT ) const; - /** Returns the vertical space between pages in a composer view + /** + * Returns the vertical space between pages in a composer view * \returns space between pages in mm */ double spaceBetweenPages() const { return mSpaceBetweenPages; } - /** Sets the number of pages for the composition. + /** + * Sets the number of pages for the composition. * \param pages number of pages * \see numPages */ void setNumPages( const int pages ); - /** Returns the number of pages in the composition. + /** + * Returns the number of pages in the composition. * \returns number of pages * \see setNumPages */ int numPages() const; - /** Returns whether a page is empty, ie, it contains no items except for the background + /** + * Returns whether a page is empty, ie, it contains no items except for the background * paper item. * \param page page number, starting with 1 * \returns true if page is empty @@ -240,7 +251,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ bool pageIsEmpty( const int page ) const; - /** Returns whether a specified page number should be included in exports of the composition. + /** + * Returns whether a specified page number should be included in exports of the composition. * \param page page number, starting with 1 * \returns true if page should be exported * \since QGIS 2.5 @@ -254,22 +266,26 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Note: added in version 2.1 QgsFillSymbol *pageStyleSymbol() { return mPageStyleSymbol; } - /** Returns the position within a page of a point in the composition + /** + * Returns the position within a page of a point in the composition \since QGIS 2.1 */ QPointF positionOnPage( QPointF position ) const; - /** Returns the page number corresponding to a point in the composition + /** + * Returns the page number corresponding to a point in the composition \since QGIS 2.1 */ int pageNumberForPoint( QPointF position ) const; - /** Sets the status bar message for the composer window + /** + * Sets the status bar message for the composer window \since QGIS 2.1 */ void setStatusMessage( const QString &message ); - /** Refreshes the composition when composer related options change + /** + * Refreshes the composition when composer related options change \since QGIS 2.1 */ void updateSettings(); @@ -290,7 +306,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void setSmartGuidesEnabled( const bool b ) { mSmartGuides = b; } bool smartGuidesEnabled() const {return mSmartGuides;} - /** Sets whether the page items should be visible in the composition. Removing + /** + * Sets whether the page items should be visible in the composition. Removing * them will prevent both display of the page boundaries in composer views and * will also prevent them from being rendered in composition exports. * \param visible set to true to show pages, false to hide pages @@ -299,7 +316,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void setPagesVisible( bool visible ); - /** Returns whether the page items are be visible in the composition. This setting + /** + * Returns whether the page items are be visible in the composition. This setting * effects both display of the page boundaries in composer views and * whether they will be rendered in composition exports. * \since QGIS 2.12 @@ -325,7 +343,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void setGridStyle( const GridStyle s ); GridStyle gridStyle() const {return mGridStyle;} - /** Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides + /** + * Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides * and the edges and centers of other items. * \param snapTolerance snap tolerance in pixels * \see alignmentSnapTolerance @@ -333,7 +352,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void setSnapTolerance( const int snapTolerance ) { mSnapTolerance = snapTolerance; } - /** Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides + /** + * Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides * and the edges and centers of other items. * \returns snap tolerance in pixels * \see setAlignmentSnapTolerance @@ -341,14 +361,16 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ int snapTolerance() const { return mSnapTolerance; } - /** Sets whether selection bounding boxes should be shown in the composition + /** + * Sets whether selection bounding boxes should be shown in the composition * \param boundsVisible set to true to show selection bounding box * \see boundingBoxesVisible * \since QGIS 2.7 */ void setBoundingBoxesVisible( const bool boundsVisible ); - /** Returns whether selection bounding boxes should be shown in the composition + /** + * Returns whether selection bounding boxes should be shown in the composition * \returns true if selection bounding boxes should be shown * \see setBoundingBoxesVisible * \since QGIS 2.7 @@ -358,14 +380,16 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Returns pointer to undo/redo command storage QUndoStack *undoStack() { return mUndoStack; } - /** Returns the topmost composer item at a specified position. Ignores paper items. + /** + * Returns the topmost composer item at a specified position. Ignores paper items. * \param position point to search for item at * \param ignoreLocked set to true to ignore locked items * \returns composer item at position */ QgsComposerItem *composerItemAt( QPointF position, const bool ignoreLocked = false ) const; - /** Returns the topmost composer item at a specified position which is below a specified item. Ignores paper items. + /** + * Returns the topmost composer item at a specified position which is below a specified item. Ignores paper items. * \param position point to search for item at * \param belowItem item to search below * \param ignoreLocked set to true to ignore locked items @@ -379,24 +403,28 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Returns on which page number (0-based) is displayed an item int itemPageNumber( const QgsComposerItem * ) const; - /** Returns list of selected composer items + /** + * Returns list of selected composer items * \param includeLockedItems set to true to include locked items in list * \returns list of selected items */ QList selectedComposerItems( const bool includeLockedItems = true ); - /** Returns pointers to all composer maps in the scene + /** + * Returns pointers to all composer maps in the scene \note available in Python bindings only with PyQt >= 4.8.4 */ QList composerMapItems() const; - /** Return composer items of a specific type + /** + * Return composer items of a specific type * \param itemList list of item type to store matching items in * \note not available in Python bindings */ template void composerItems( QList &itemList ) SIP_SKIP; - /** Return composer items of a specific type on a specified page + /** + * Return composer items of a specific type on a specified page * \param itemList list of item type to store matching items in * \param pageNumber page number (0 based) * \note not available in Python bindings @@ -404,19 +432,22 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ template void composerItemsOnPage( QList &itemList, const int pageNumber ) const SIP_SKIP; - /** Returns the composer map with specified id + /** + * Returns the composer map with specified id * \returns QgsComposerMap or 0 pointer if the composer map item does not exist */ const QgsComposerMap *getComposerMapById( const int id ) const; - /** Returns a composer item given its text identifier. + /** + * Returns a composer item given its text identifier. * Ids are not necessarely unique, but this function returns only one element. * \param id - A QString representing the identifier of the item to retrieve. * \returns QgsComposerItem pointer or 0 pointer if no such item exists. */ const QgsComposerItem *getComposerItemById( const QString &id ) const; - /** Returns a composer item given its unique identifier. + /** + * Returns a composer item given its unique identifier. * \param uuid A QString representing the UUID of the item to */ const QgsComposerItem *getComposerItemByUuid( const QString &uuid ) const; @@ -427,14 +458,16 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo bool printAsRaster() const {return mPrintAsRaster;} void setPrintAsRaster( const bool enabled ) { mPrintAsRaster = enabled; } - /** Returns true if the composition will generate corresponding world files when pages + /** + * Returns true if the composition will generate corresponding world files when pages * are exported. * \see setGenerateWorldFile() * \see referenceMap() */ bool generateWorldFile() const { return mGenerateWorldFile; } - /** Sets whether the composition will generate corresponding world files when pages + /** + * Sets whether the composition will generate corresponding world files when pages * are exported. * \param enabled set to true to generate world files * \see generateWorldFile() @@ -442,7 +475,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void setGenerateWorldFile( bool enabled ) { mGenerateWorldFile = enabled; } - /** Returns the map item which will be used to generate corresponding world files when the + /** + * Returns the map item which will be used to generate corresponding world files when the * composition is exported. If no map was explicitly set via setReferenceMap(), the largest * map in the composition will be returned (or nullptr if there are no maps in the composition). * \see setReferenceMap() @@ -450,7 +484,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ QgsComposerMap *referenceMap() const; - /** Sets the map item which will be used to generate corresponding world files when the + /** + * Sets the map item which will be used to generate corresponding world files when the * composition is exported. * \param map composer map item * \see referenceMap() @@ -472,7 +507,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Reads settings from xml file bool readXml( const QDomElement &compositionElem, const QDomDocument &doc ); - /** Load a template document + /** + * Load a template document * \param doc template document * \param substitutionMap map with text to replace. Text needs to be enclosed by brackets (e.g. '[text]' ) * \param addUndoCommands whether or not to add undo commands @@ -483,7 +519,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo bool loadFromTemplate( const QDomDocument &doc, QMap *substitutionMap = nullptr, bool addUndoCommands = false, const bool clearComposition = true ); - /** Add items from XML representation to the graphics scene (for project file reading, pasting items from clipboard) + /** + * Add items from XML representation to the graphics scene (for project file reading, pasting items from clipboard) * \param elem items parent element, e.g. \verbatim \endverbatim or \verbatim \endverbatim * \param doc xml document * \param addUndoCommands insert AddItem commands if true (e.g. for copy/paste) @@ -532,14 +569,16 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Unlock all items void unlockAllItems(); - /** Creates a new group from a list of composer items and adds it to the composition. + /** + * Creates a new group from a list of composer items and adds it to the composition. * \param items items to include in group * \returns QgsComposerItemGroup of grouped items, if grouping was possible * \since QGIS 2.6 */ QgsComposerItemGroup *groupItems( QList items ); - /** Ungroups items by removing them from an item group and removing the group from the + /** + * Ungroups items by removing them from an item group and removing the group from the * composition. * \param group item group to ungroup * \returns list of items removed from the group, or an empty list if ungrouping @@ -548,7 +587,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ QList ungroupItems( QgsComposerItemGroup *group ); - /** Rebuilds the z order list by adding any item which are present in the composition + /** + * Rebuilds the z order list by adding any item which are present in the composition * but missing from the z order list. */ void refreshZList(); @@ -559,7 +599,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Returns pointer to snap lines collection QList< QGraphicsLineItem * > *snapLines() {return &mSnapLines;} - /** Returns pointer to selection handles + /** + * Returns pointer to selection handles * \note not available in Python bindings */ QgsComposerMouseHandles *selectionHandles() {return mSelectionHandles;} SIP_SKIP @@ -569,12 +610,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Remove custom snap line (and delete the object) void removeSnapLine( QGraphicsLineItem *line ); - /** Get nearest snap line + /** + * Get nearest snap line * \note not available in Python bindings */ QGraphicsLineItem *nearestSnapLine( const bool horizontal, const double x, const double y, const double tolerance, QList< QPair< QgsComposerItem *, QgsComposerItem::ItemPositionMode > > &snappedItems ) const SIP_SKIP; - /** Allocates new item command and saves initial state in it + /** + * Allocates new item command and saves initial state in it * \param item target item * \param commandText descriptive command text * \param c context for merge commands (unknown for non-mergeable commands) @@ -625,7 +668,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Convenience function to create a QgsAddRemoveItemCommand, connect its signals and push it to the undo stack void pushAddRemoveCommand( QgsComposerItem *item, const QString &text, const QgsAddRemoveItemCommand::State state = QgsAddRemoveItemCommand::Added ); - /** If true, prevents any mouse cursor changes by the composition or by any composer items + /** + * If true, prevents any mouse cursor changes by the composition or by any composer items * Used by QgsComposer and QgsComposerView to prevent unwanted cursor changes */ void setPreventCursorChange( const bool preventChange ) { mPreventCursorChange = preventChange; } @@ -638,25 +682,29 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Prepare the printer for printing in a PDF void beginPrintAsPDF( QPrinter &printer, const QString &file ); - /** Print on a preconfigured printer + /** + * Print on a preconfigured printer * \param printer QPrinter destination * \param painter QPainter source * \param startNewPage set to true to begin the print on a new page */ void doPrint( QPrinter &printer, QPainter &painter, bool startNewPage = false ); - /** Convenience function that prepares the printer and prints + /** + * Convenience function that prepares the printer and prints * \returns true if print was successful */ bool print( QPrinter &printer, const bool evaluateDDPageSize = false ); - /** Convenience function that prepares the printer for printing in PDF and prints + /** + * Convenience function that prepares the printer for printing in PDF and prints * \returns true if export was successful */ bool exportAsPDF( const QString &file ); #endif - /** Renders a composer page to an image. + /** + * Renders a composer page to an image. * \param page page number, 0 based such that the first page is page 0 * \param imageSize optional target image size, in pixels. It is the caller's responsibility * to ensure that the ratio of the target image size matches the ratio of the composition @@ -669,7 +717,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ QImage printPageAsRaster( int page, QSize imageSize = QSize(), int dpi = 0 ); - /** Renders a portion of the composition to an image. This method can be used to render + /** + * Renders a portion of the composition to an image. This method can be used to render * sections of pages rather than full pages. * \param rect region of composition to render * \param imageSize optional target image size, in pixels. It is the caller's responsibility @@ -684,7 +733,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ QImage renderRectAsRaster( const QRectF &rect, QSize imageSize = QSize(), int dpi = 0 ); - /** Renders a full page to a paint device. + /** + * Renders a full page to a paint device. * \param p destination painter * \param page page number, 0 based such that the first page is page 0 * \see renderRect() @@ -692,7 +742,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void renderPage( QPainter *p, int page ); - /** Renders a portion of the composition to a paint device. This method can be used + /** + * Renders a portion of the composition to a paint device. This method can be used * to render sections of pages rather than full pages. * \param p destination painter * \param rect region of composition to render @@ -702,7 +753,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void renderRect( QPainter *p, const QRectF &rect ); - /** Georeferences a file (image of PDF) exported from the composition. + /** + * Georeferences a file (image of PDF) exported from the composition. * \param file filename of exported file * \param referenceMap map item to use for georeferencing, or leave as nullptr to use the * currently defined referenceMap(). @@ -714,12 +766,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void georeferenceOutput( const QString &file, QgsComposerMap *referenceMap = nullptr, const QRectF &exportRegion = QRectF(), double dpi = -1 ) const; - /** Compute world file parameters. Assumes the whole page containing the associated map item + /** + * Compute world file parameters. Assumes the whole page containing the associated map item * will be exported. */ void computeWorldFileParameters( double &a, double &b, double &c, double &d, double &e, double &f ) const; - /** Computes the world file parameters for a specified region of the composition. + /** + * Computes the world file parameters for a specified region of the composition. * \param exportRegion region of the composition which will be associated with world file * \param a * \param b @@ -733,32 +787,37 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo QgsAtlasComposition &atlasComposition() { return mAtlasComposition; } - /** Returns the current atlas mode of the composition + /** + * Returns the current atlas mode of the composition * \returns current atlas mode * \see setAtlasMode */ QgsComposition::AtlasMode atlasMode() const { return mAtlasMode; } - /** Sets the current atlas mode of the composition. + /** + * Sets the current atlas mode of the composition. * \param mode atlas mode to switch to * \returns false if the mode could not be changed. * \see atlasMode */ bool setAtlasMode( const QgsComposition::AtlasMode mode ); - /** Return pages in the correct order + /** + * Return pages in the correct order * \note composerItems(QList< QgsPaperItem* > &) may not return pages in the correct order * \since QGIS 2.4 */ QList< QgsPaperItem * > pages() { return mPages; } - /** Returns the items model attached to the composition + /** + * Returns the items model attached to the composition * \returns QgsComposerModel for composition * \since QGIS 2.5 */ QgsComposerModel *itemsModel() { return mItemsModel; } - /** Set a custom property for the composition. + /** + * Set a custom property for the composition. * \param key property key. If a property with the same key already exists it will be overwritten. * \param value property value * \see customProperty() @@ -768,7 +827,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void setCustomProperty( const QString &key, const QVariant &value ); - /** Read a custom property from the composition. + /** + * Read a custom property from the composition. * \param key property key * \param defaultValue default value to return if property with matching key does not exist * \returns value of matching property @@ -779,7 +839,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const; - /** Remove a custom property from the composition. + /** + * Remove a custom property from the composition. * \param key property key * \see setCustomProperty() * \see customProperty() @@ -788,7 +849,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void removeCustomProperty( const QString &key ); - /** Return list of keys stored in custom properties for composition. + /** + * Return list of keys stored in custom properties for composition. * \see setCustomProperty() * \see customProperty() * \see removeCustomProperty() @@ -796,14 +858,16 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ QStringList customProperties() const; - /** Returns the bounding box of the items contained on a specified page. + /** + * Returns the bounding box of the items contained on a specified page. * \param pageNumber page number, where 0 is the first page * \param visibleOnly set to true to only include visible items * \since QGIS 2.12 */ QRectF pageItemBounds( int pageNumber, bool visibleOnly = false ) const; - /** Calculates the bounds of all non-gui items in the composition. Ignores snap lines and mouse handles. + /** + * Calculates the bounds of all non-gui items in the composition. Ignores snap lines and mouse handles. * \param ignorePages set to true to ignore page items * \param margin optional marginal (in percent, e.g., 0.05 = 5% ) to add around items */ @@ -813,29 +877,34 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Casts object to the proper subclass type and calls corresponding itemAdded signal void sendItemAddedSignal( QgsComposerItem *item ); - /** Updates the scene bounds of the composition + /** + * Updates the scene bounds of the composition \since QGIS 2.2*/ void updateBounds(); - /** Forces items in the composition to refresh. For instance, this causes maps to redraw + /** + * Forces items in the composition to refresh. For instance, this causes maps to redraw * and rebuild cached images, html items to reload their source url, and attribute tables * to refresh their contents. Calling this also triggers a recalculation of all data defined * attributes within the composition. * \since QGIS 2.3*/ void refreshItems(); - /** Clears any selected items and sets an item as the current selection. + /** + * Clears any selected items and sets an item as the current selection. * \param item item to set as selected * \since QGIS 2.3*/ void setSelectedItem( QgsComposerItem *item ); - /** Clears any selected items in the composition. Call this method rather than + /** + * Clears any selected items in the composition. Call this method rather than * QGraphicsScene::clearSelection, as the latter does not correctly emit signals to allow * the composition's model to update. * \since QGIS 2.5*/ void setAllDeselected(); - /** Refreshes a data defined property for the composition by reevaluating the property's value + /** + * Refreshes a data defined property for the composition by reevaluating the property's value * and redrawing the composition with this new value. * \param property data defined property to refresh. If property is set to * QgsComposerItem::AllProperties then all data defined properties for the composition will be @@ -845,25 +914,29 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo */ void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext *context = nullptr ); - /** Creates an expression context relating to the compositions's current state. The context includes + /** + * Creates an expression context relating to the compositions's current state. The context includes * scopes for global, project, composition and atlas properties. * \since QGIS 2.12 */ QgsExpressionContext createExpressionContext() const override; - /** Returns a reference to the composition's property collection, used for data defined overrides. + /** + * Returns a reference to the composition's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } - /** Returns a reference to the composition's property collection, used for data defined overrides. + /** + * Returns a reference to the composition's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP - /** Sets the composition's property collection, used for data defined overrides. + /** + * Sets the composition's property collection, used for data defined overrides. * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 * \see dataDefinedProperties() @@ -959,7 +1032,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Reset z-values of items based on position in z list void updateZValues( const bool addUndoCommands = true ); - /** Returns the bounding rectangle of the selected items in scene coordinates + /** + * Returns the bounding rectangle of the selected items in scene coordinates \returns 0 in case of success*/ int boundingRectOfSelectedItems( QRectF &bRect ); @@ -984,18 +1058,21 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //tries to return the current QGraphicsView attached to the composition QGraphicsView *graphicsView() const; - /** Recalculates the page size using data defined page settings + /** + * Recalculates the page size using data defined page settings * \param context expression context for data defined page sizes */ void refreshPageSize( const QgsExpressionContext *context = nullptr ); - /** Check whether any data defined page settings are active. + /** + * Check whether any data defined page settings are active. * \returns true if any data defined page settings are active. * \since QGIS 2.5 */ bool ddPageSizeActive() const; - /** Computes a GDAL style geotransform for georeferencing a composition. + /** + * Computes a GDAL style geotransform for georeferencing a composition. * \param referenceMap map item to use for georeferencing, or leave as nullptr to use the * currently defined referenceMap(). * \param exportRegion set to a valid rectangle to indicate that only part of the composition is @@ -1046,7 +1123,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo //! Is emitted when the composition has an updated status bar message for the composer window void statusMsgChanged( const QString &message ); - /** Emitted whenever the expression variables stored in the composition have been changed. + /** + * Emitted whenever the expression variables stored in the composition have been changed. * \since QGIS 3.0 */ void variablesChanged(); diff --git a/src/core/composer/qgsgroupungroupitemscommand.h b/src/core/composer/qgsgroupungroupitemscommand.h index b33e26158850..df8328a87fce 100644 --- a/src/core/composer/qgsgroupungroupitemscommand.h +++ b/src/core/composer/qgsgroupungroupitemscommand.h @@ -25,7 +25,8 @@ class QgsComposition; class QgsComposerItemGroup; -/** \ingroup core +/** + * \ingroup core * A composer command class for grouping / ungrouping composer items. * * If mState == Ungrouped, the command owns the group item @@ -43,7 +44,8 @@ class CORE_EXPORT QgsGroupUngroupItemsCommand: public QObject, public QUndoComma Ungrouped }; - /** Create a group or ungroup command + /** + * Create a group or ungroup command * * \param s command kind (\see State) * \param item the group item being created or ungrouped diff --git a/src/core/composer/qgslayoutmanager.h b/src/core/composer/qgslayoutmanager.h index b035127ee7e6..16b550ac0b7c 100644 --- a/src/core/composer/qgslayoutmanager.h +++ b/src/core/composer/qgslayoutmanager.h @@ -23,7 +23,8 @@ class QgsProject; -/** \ingroup core +/** + * \ingroup core * \class QgsLayoutManager * \since QGIS 3.0 * diff --git a/src/core/composer/qgspaperitem.h b/src/core/composer/qgspaperitem.h index 2f8c25a6e81a..16e00f955380 100644 --- a/src/core/composer/qgspaperitem.h +++ b/src/core/composer/qgspaperitem.h @@ -23,7 +23,8 @@ #include "qgscomposeritem.h" #include -/** \ingroup core +/** + * \ingroup core * Item representing a grid. This is drawn separately to the underlying paper item since the grid needs to be * drawn above all other composer items, while the paper item is drawn below all others. */ @@ -39,7 +40,8 @@ class CORE_EXPORT QgsPaperGrid: public QGraphicsRectItem QgsComposition *mComposition = nullptr; }; -/** \ingroup core +/** + * \ingroup core * Item representing the paper.*/ class CORE_EXPORT QgsPaperItem : public QgsComposerItem { @@ -56,13 +58,15 @@ class CORE_EXPORT QgsPaperItem : public QgsComposerItem //! \brief Reimplementation of QCanvasItem::paint void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override; - /** Stores state in Dom element + /** + * Stores state in Dom element * \param elem is Dom element corresponding to 'Composer' tag * \param doc Dom document */ bool writeXml( QDomElement &elem, QDomDocument &doc ) const override; - /** Sets state from Dom document + /** + * Sets state from Dom document * \param itemElem is Dom node corresponding to item tag * \param doc is the Dom document */ diff --git a/src/core/diagram/qgsdiagram.h b/src/core/diagram/qgsdiagram.h index 7ee0ecc8b3aa..ae9a9021cf1b 100644 --- a/src/core/diagram/qgsdiagram.h +++ b/src/core/diagram/qgsdiagram.h @@ -32,7 +32,8 @@ class QgsFields; class QgsAttributes; -/** \ingroup core +/** + * \ingroup core * Base class for all diagram types*/ class CORE_EXPORT QgsDiagram { @@ -40,13 +41,15 @@ class CORE_EXPORT QgsDiagram virtual ~QgsDiagram() { clearCache(); } - /** Returns an instance that is equivalent to this one + /** + * Returns an instance that is equivalent to this one * \since QGIS 2.4 */ virtual QgsDiagram *clone() const = 0 SIP_FACTORY; void clearCache(); - /** Returns a prepared expression for the specified context. + /** + * Returns a prepared expression for the specified context. * \param expression expression string * \param context expression context * \since QGIS 2.12 @@ -65,7 +68,8 @@ class CORE_EXPORT QgsDiagram //! Returns the size in map units the diagram will use to render. Interpolate size virtual QSizeF diagramSize( const QgsFeature &feature, const QgsRenderContext &c, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is ) = 0; - /** Returns the size of the legend item for the diagram corresponding to a specified value. + /** + * Returns the size of the legend item for the diagram corresponding to a specified value. * \param value value to return legend item size for * \param s diagram settings * \param is interpolation settings @@ -81,14 +85,16 @@ class CORE_EXPORT QgsDiagram QgsDiagram() = default; QgsDiagram( const QgsDiagram &other ); - /** Changes the pen width to match the current settings and rendering context + /** + * Changes the pen width to match the current settings and rendering context * \param pen The pen to modify * \param s The settings that specify the pen width * \param c The rendering specifying the proper scale units for pixel conversion */ void setPenWidth( QPen &pen, const QgsDiagramSettings &s, const QgsRenderContext &c ); - /** Calculates a size to match the current settings and rendering context + /** + * Calculates a size to match the current settings and rendering context * \param size The size to convert * \param s The settings that specify the size type * \param c The rendering specifying the proper scale units for pixel conversion @@ -97,7 +103,8 @@ class CORE_EXPORT QgsDiagram */ QSizeF sizePainterUnits( QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c ); - /** Calculates a length to match the current settings and rendering context + /** + * Calculates a length to match the current settings and rendering context * \param l The length to convert * \param s Unused * \param c The rendering specifying the proper scale units for pixel conversion @@ -106,7 +113,8 @@ class CORE_EXPORT QgsDiagram */ double sizePainterUnits( double l, const QgsDiagramSettings &s, const QgsRenderContext &c ); - /** Calculates a size to match the current settings and rendering context + /** + * Calculates a size to match the current settings and rendering context * \param s The settings that contain the font size and size type * \param c The rendering specifying the proper scale units for pixel conversion * @@ -114,7 +122,8 @@ class CORE_EXPORT QgsDiagram */ QFont scaledFont( const QgsDiagramSettings &s, const QgsRenderContext &c ); - /** Returns the scaled size of a diagram for a value, respecting the specified diagram interpolation settings. + /** + * Returns the scaled size of a diagram for a value, respecting the specified diagram interpolation settings. * \param value value to calculate corresponding circular size for * \param s diagram settings * \param is interpolation settings diff --git a/src/core/diagram/qgshistogramdiagram.h b/src/core/diagram/qgshistogramdiagram.h index e8d5680bc48b..de188432c1c9 100644 --- a/src/core/diagram/qgshistogramdiagram.h +++ b/src/core/diagram/qgshistogramdiagram.h @@ -32,7 +32,8 @@ class QgsDiagramInterpolationSettings; class QgsRenderContext; -/** \ingroup core +/** + * \ingroup core * \class QgsHistogramDiagram */ class CORE_EXPORT QgsHistogramDiagram: public QgsDiagram diff --git a/src/core/diagram/qgspiediagram.h b/src/core/diagram/qgspiediagram.h index 9d9c79ca8dd3..1d973d6b4deb 100644 --- a/src/core/diagram/qgspiediagram.h +++ b/src/core/diagram/qgspiediagram.h @@ -30,7 +30,8 @@ class QgsDiagramInterpolationSettings; class QgsFeature; class QgsRenderContext; -/** \ingroup core +/** + * \ingroup core * \class QgsPieDiagram */ class CORE_EXPORT QgsPieDiagram: public QgsDiagram diff --git a/src/core/diagram/qgstextdiagram.h b/src/core/diagram/qgstextdiagram.h index 898a67f465a6..f44c9b24846d 100644 --- a/src/core/diagram/qgstextdiagram.h +++ b/src/core/diagram/qgstextdiagram.h @@ -30,7 +30,8 @@ class QgsDiagramInterpolationSettings; class QgsFeature; class QgsRenderContext; -/** \ingroup core +/** + * \ingroup core * \class QgsTextDiagram */ class CORE_EXPORT QgsTextDiagram: public QgsDiagram @@ -66,7 +67,8 @@ class CORE_EXPORT QgsTextDiagram: public QgsDiagram QBrush mBrush; //transparent brush QPen mPen; - /** Calculates intersection points between a line and an ellipse + /** + * Calculates intersection points between a line and an ellipse \returns intersection points*/ void lineEllipseIntersection( QPointF lineStart, QPointF lineEnd, QPointF ellipseMid, double r1, double r2, QList &result ) const; }; diff --git a/src/core/dxf/qgsdxfexport.h b/src/core/dxf/qgsdxfexport.h index 2001b5c271e1..ee47ca4ecce6 100644 --- a/src/core/dxf/qgsdxfexport.h +++ b/src/core/dxf/qgsdxfexport.h @@ -44,7 +44,8 @@ namespace pal SIP_SKIP class LabelPosition; } -/** \ingroup core +/** + * \ingroup core * \class QgsDxfExport */ class CORE_EXPORT QgsDxfExport @@ -351,7 +352,8 @@ class CORE_EXPORT QgsDxfExport //! return list of available DXF encodings static QStringList encodings(); - /** Output the label + /** + * Output the label * \param layerId id of the layer * \param context render context * \param label position of label @@ -360,7 +362,8 @@ class CORE_EXPORT QgsDxfExport */ void drawLabel( const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings ) SIP_SKIP; - /** Register name of layer for feature + /** + * Register name of layer for feature * \param layerId id of layer * \param fid id of feature * \param layer dxf layer of feature diff --git a/src/core/dxf/qgsdxfpaintdevice.h b/src/core/dxf/qgsdxfpaintdevice.h index 3bbd46618346..5833de92fe4a 100644 --- a/src/core/dxf/qgsdxfpaintdevice.h +++ b/src/core/dxf/qgsdxfpaintdevice.h @@ -28,7 +28,8 @@ class QgsDxfPaintEngine; class QgsDxfExport; class QPaintEngine; -/** \ingroup core +/** + * \ingroup core * A paint device for drawing into dxf files. * \note not available in Python bindings */ diff --git a/src/core/dxf/qgsdxfpaintengine.h b/src/core/dxf/qgsdxfpaintengine.h index 09beabbd9701..52b14537d7e1 100644 --- a/src/core/dxf/qgsdxfpaintengine.h +++ b/src/core/dxf/qgsdxfpaintengine.h @@ -29,7 +29,8 @@ class QgsDxfExport; class QgsDxfPaintDevice; -/** \ingroup core +/** + * \ingroup core * \class QgsDxfPaintEngine * \note not available in Python bindings */ diff --git a/src/core/dxf/qgsdxfpallabeling.h b/src/core/dxf/qgsdxfpallabeling.h index 4aaebec77267..0f832ea296fc 100644 --- a/src/core/dxf/qgsdxfpallabeling.h +++ b/src/core/dxf/qgsdxfpallabeling.h @@ -28,7 +28,8 @@ class QgsPalLayerSettings; class QgsRuleBasedLabeling; -/** \ingroup core +/** + * \ingroup core * Implements a derived label provider internally used for DXF export * * Internal class, not in public API. Added in QGIS 2.12 @@ -40,13 +41,15 @@ class QgsDxfLabelProvider : public QgsVectorLayerLabelProvider //! construct the provider explicit QgsDxfLabelProvider( QgsVectorLayer *layer, const QString &providerId, QgsDxfExport *dxf, const QgsPalLayerSettings *settings ); - /** Re-implementation that writes to DXF file instead of drawing with QPainter + /** + * Re-implementation that writes to DXF file instead of drawing with QPainter * \param context render context * \param label label */ void drawLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override; - /** Registration method that keeps track of DXF layer names of individual features + /** + * Registration method that keeps track of DXF layer names of individual features * \param feature feature * \param context render context * \param dxfLayerName name of dxf layer @@ -58,7 +61,8 @@ class QgsDxfLabelProvider : public QgsVectorLayerLabelProvider QgsDxfExport *mDxfExport = nullptr; }; -/** \ingroup core +/** + * \ingroup core * Implements a derived label provider for rule based labels internally used * for DXF export * @@ -71,18 +75,21 @@ class QgsDxfRuleBasedLabelProvider : public QgsRuleBasedLabelProvider //! construct the provider explicit QgsDxfRuleBasedLabelProvider( const QgsRuleBasedLabeling &rules, QgsVectorLayer *layer, QgsDxfExport *dxf ); - /** Reinitialize the subproviders with QgsDxfLabelProviders + /** + * Reinitialize the subproviders with QgsDxfLabelProviders * \param layer layer */ void reinit( QgsVectorLayer *layer ); - /** Re-implementation that writes to DXF file instead of drawing with QPainter + /** + * Re-implementation that writes to DXF file instead of drawing with QPainter * \param context render context * \param label label */ void drawLabel( QgsRenderContext &context, pal::LabelPosition *label ) const override; - /** Registration method that keeps track of DXF layer names of individual features + /** + * Registration method that keeps track of DXF layer names of individual features * \param feature feature * \param context render context * \param dxfLayerName name of dxf layer diff --git a/src/core/effects/qgsblureffect.h b/src/core/effects/qgsblureffect.h index 0b474b44709e..4d6c80835b4e 100644 --- a/src/core/effects/qgsblureffect.h +++ b/src/core/effects/qgsblureffect.h @@ -22,7 +22,8 @@ #include "qgis.h" #include -/** \ingroup core +/** + * \ingroup core * \class QgsBlurEffect * \brief A paint effect which blurs a source picture, using a number of different blur * methods. @@ -42,7 +43,8 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect GaussianBlur //!< Gaussian blur, a slower but high quality blur. Blur level values are the distance in pixels for the blur operation. }; - /** Creates a new QgsBlurEffect effect from a properties string map. + /** + * Creates a new QgsBlurEffect effect from a properties string map. * \param map encoded properties string map * \returns new QgsBlurEffect */ @@ -58,7 +60,8 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect virtual void readProperties( const QgsStringMap &props ) override; virtual QgsBlurEffect *clone() const override SIP_FACTORY; - /** Sets blur level (strength) + /** + * Sets blur level (strength) * \param level blur level. Depending on the current blurMethod(), this parameter * has different effects * \see blurLevel @@ -66,7 +69,8 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect */ void setBlurLevel( const int level ) { mBlurLevel = level; } - /** Returns the blur level (strength) + /** + * Returns the blur level (strength) * \returns blur level. Depending on the current blurMethod(), this parameter * has different effects * \see setBlurLevel @@ -74,40 +78,46 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect */ int blurLevel() const { return mBlurLevel; } - /** Sets the blur method (algorithm) to use for performing the blur. + /** + * Sets the blur method (algorithm) to use for performing the blur. * \param method blur method * \see blurMethod */ void setBlurMethod( const BlurMethod method ) { mBlurMethod = method; } - /** Returns the blur method (algorithm) used for performing the blur. + /** + * Returns the blur method (algorithm) used for performing the blur. * \returns blur method * \see setBlurMethod */ BlurMethod blurMethod() const { return mBlurMethod; } - /** Sets the \a opacity for the effect. + /** + * Sets the \a opacity for the effect. * \param opacity double between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see opacity() */ void setOpacity( const double opacity ) { mOpacity = opacity; } - /** Returns the opacity for the effect. + /** + * Returns the opacity for the effect. * \returns opacity value between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see setOpacity() */ double opacity() const { return mOpacity; } - /** Sets the blend mode for the effect + /** + * Sets the blend mode for the effect * \param mode blend mode used for drawing the effect on to a destination * paint device * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } - /** Returns the blend mode for the effect + /** + * Returns the blend mode for the effect * \returns blend mode used for drawing the effect on to a destination * paint device * \see setBlendMode diff --git a/src/core/effects/qgscoloreffect.h b/src/core/effects/qgscoloreffect.h index 4ed9ea48a05e..fece22fa400f 100644 --- a/src/core/effects/qgscoloreffect.h +++ b/src/core/effects/qgscoloreffect.h @@ -23,7 +23,8 @@ #include "qgis.h" #include -/** \ingroup core +/** + * \ingroup core * \class QgsColorEffect * \brief A paint effect which alters the colors (e.g., brightness, contrast) in a * source picture. @@ -36,7 +37,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect public: - /** Creates a new QgsColorEffect effect from a properties string map. + /** + * Creates a new QgsColorEffect effect from a properties string map. * \param map encoded properties string map * \returns new QgsColorEffect */ @@ -49,7 +51,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect virtual void readProperties( const QgsStringMap &props ) override; virtual QgsColorEffect *clone() const override SIP_FACTORY; - /** Sets the brightness modification for the effect. + /** + * Sets the brightness modification for the effect. * \param brightness Valid values are between -255 and 255, where 0 represents * no change, negative values indicate darkening and positive values indicate * lightening @@ -57,7 +60,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ void setBrightness( int brightness ) { mBrightness = qBound( -255, brightness, 255 ); } - /** Returns the brightness modification for the effect. + /** + * Returns the brightness modification for the effect. * \returns brightness value. Values are between -255 and 255, where 0 represents * no change, negative values indicate darkening and positive values indicate * lightening @@ -65,7 +69,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ int brightness() const { return mBrightness; } - /** Sets the contrast modification for the effect. + /** + * Sets the contrast modification for the effect. * \param contrast Valid values are between -100 and 100, where 0 represents * no change, negative values indicate less contrast and positive values indicate * greater contrast @@ -73,7 +78,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ void setContrast( int contrast ) { mContrast = qBound( -100, contrast, 100 ); } - /** Returns the contrast modification for the effect. + /** + * Returns the contrast modification for the effect. * \returns contrast value. Values are between -100 and 100, where 0 represents * no change, negative values indicate less contrast and positive values indicate * greater contrast @@ -81,7 +87,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ int contrast() const { return mContrast; } - /** Sets the saturation modification for the effect. + /** + * Sets the saturation modification for the effect. * \param saturation Valid values are between 0 and 2.0, where 1.0 represents * no change, 0.0 represents totally desaturated (grayscale), and positive values indicate * greater saturation @@ -89,7 +96,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ void setSaturation( double saturation ) { mSaturation = saturation; } - /** Returns the saturation modification for the effect. + /** + * Returns the saturation modification for the effect. * \returns saturation value. Values are between 0 and 2.0, where 1.0 represents * no change, 0.0 represents totally desaturated (grayscale), and positive values indicate * greater saturation @@ -97,19 +105,22 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ double saturation() const { return mSaturation; } - /** Sets whether the effect should convert a picture to grayscale. + /** + * Sets whether the effect should convert a picture to grayscale. * \param grayscaleMode method for grayscale conversion * \see grayscaleMode */ void setGrayscaleMode( QgsImageOperation::GrayscaleMode grayscaleMode ) { mGrayscaleMode = grayscaleMode; } - /** Returns whether the effect will convert a picture to grayscale. + /** + * Returns whether the effect will convert a picture to grayscale. * \returns method for grayscale conversion * \see setGrayscaleMode */ QgsImageOperation::GrayscaleMode grayscaleMode() const { return mGrayscaleMode; } - /** Sets whether the effect should colorize a picture. + /** + * Sets whether the effect should colorize a picture. * \param colorizeOn set to true to enable colorization * \see colorizeOn * \see setColorizeColor @@ -117,7 +128,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ void setColorizeOn( bool colorizeOn ) { mColorizeOn = colorizeOn; } - /** Returns whether the effect will colorize a picture. + /** + * Returns whether the effect will colorize a picture. * \returns true if colorization is enableds * \see setColorizeOn * \see colorizeColor @@ -125,7 +137,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ bool colorizeOn() const { return mColorizeOn; } - /** Sets the color used for colorizing a picture. This is only used if + /** + * Sets the color used for colorizing a picture. This is only used if * setColorizeOn() is set to true. * \param colorizeColor colorization color * \see colorizeColor @@ -134,7 +147,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ void setColorizeColor( const QColor &colorizeColor ); - /** Returns the color used for colorizing a picture. This is only used if + /** + * Returns the color used for colorizing a picture. This is only used if * colorizeOn() is set to true. * \returns colorization color * \see setColorizeColor @@ -143,7 +157,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ QColor colorizeColor() const { return mColorizeColor; } - /** Sets the strength for colorizing a picture. This is only used if + /** + * Sets the strength for colorizing a picture. This is only used if * setColorizeOn() is set to true. * \param colorizeStrength colorization strength, between 0 and 100 * \see colorizeStrength @@ -152,7 +167,8 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ void setColorizeStrength( int colorizeStrength ) { mColorizeStrength = colorizeStrength; } - /** Returns the strength used for colorizing a picture. This is only used if + /** + * Returns the strength used for colorizing a picture. This is only used if * setColorizeOn() is set to true. * \returns colorization strength, between 0 and 100 * \see setColorizeStrengths @@ -161,28 +177,32 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect */ int colorizeStrength() const { return mColorizeStrength; } - /** Sets the \a opacity for the effect. + /** + * Sets the \a opacity for the effect. * \param opacity double between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see opacity() */ void setOpacity( const double opacity ) { mOpacity = opacity; } - /** Returns the opacity for the effect. + /** + * Returns the opacity for the effect. * \returns opacity value between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque. * \see setOpacity() */ double opacity() const { return mOpacity; } - /** Sets the blend mode for the effect + /** + * Sets the blend mode for the effect * \param mode blend mode used for drawing the effect on to a destination * paint device * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } - /** Returns the blend mode for the effect + /** + * Returns the blend mode for the effect * \returns blend mode used for drawing the effect on to a destination * paint device * \see setBlendMode diff --git a/src/core/effects/qgseffectstack.h b/src/core/effects/qgseffectstack.h index 7496b67f2498..8e27925c34c7 100644 --- a/src/core/effects/qgseffectstack.h +++ b/src/core/effects/qgseffectstack.h @@ -21,7 +21,8 @@ #include "qgis.h" #include "qgspainteffect.h" -/** \ingroup core +/** + * \ingroup core * \class QgsEffectStack * \brief A paint effect which consists of a stack of other chained paint effects * @@ -45,7 +46,8 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect public: - /** Creates a new QgsEffectStack effect. This method ignores + /** + * Creates a new QgsEffectStack effect. This method ignores * the map parameter, and always returns an empty effect stack. * \param map unused encoded properties string map * \returns new QgsEffectStack @@ -59,7 +61,8 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect QgsEffectStack( const QgsEffectStack &other ); - /** Creates a new QgsEffectStack effect from a single initial effect. + /** + * Creates a new QgsEffectStack effect from a single initial effect. * \param effect initial effect to add to the stack. The effect will * be cloned, so ownership is not transferred to the stack. * \returns new QgsEffectStack containing initial effect @@ -73,22 +76,26 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect virtual bool saveProperties( QDomDocument &doc, QDomElement &element ) const override; virtual bool readProperties( const QDomElement &element ) override; - /** Unused for QgsEffectStack, will always return an empty string map + /** + * Unused for QgsEffectStack, will always return an empty string map */ virtual QgsStringMap properties() const override; - /** Unused for QgsEffectStack, props parameter will be ignored + /** + * Unused for QgsEffectStack, props parameter will be ignored */ virtual void readProperties( const QgsStringMap &props ) override; - /** Appends an effect to the end of the stack. + /** + * Appends an effect to the end of the stack. * \param effect QgsPaintEffect to append. Ownership of the effect will be * transferred to the stack object. * \see insertEffect */ void appendEffect( QgsPaintEffect *effect SIP_TRANSFER ); - /** Inserts an effect at a specified index within the stack. + /** + * Inserts an effect at a specified index within the stack. * \param index position to insert the effect * \param effect QgsPaintEffect to insert. Ownership of the effect will be * transferred to the stack object. @@ -96,30 +103,35 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect */ bool insertEffect( const int index, QgsPaintEffect *effect SIP_TRANSFER ); - /** Replaces the effect at a specified position within the stack. + /** + * Replaces the effect at a specified position within the stack. * \param index position of effect to replace * \param effect QgsPaintEffect to replace with. Ownership of the effect will be * transferred to the stack object. */ bool changeEffect( const int index, QgsPaintEffect *effect SIP_TRANSFER ); - /** Removes an effect from the stack and returns a pointer to it. + /** + * Removes an effect from the stack and returns a pointer to it. * \param index position of effect to take */ QgsPaintEffect *takeEffect( const int index SIP_TRANSFERBACK ); - /** Returns a pointer to the list of effects currently contained by + /** + * Returns a pointer to the list of effects currently contained by * the stack * \returns list of QgsPaintEffects within the stack */ QList< QgsPaintEffect * > *effectList(); - /** Returns count of effects contained by the stack + /** + * Returns count of effects contained by the stack * \returns count of effects */ int count() const { return mEffectList.count(); } - /** Returns a pointer to the effect at a specified index within the stack + /** + * Returns a pointer to the effect at a specified index within the stack * \param index position of effect to return * \returns QgsPaintEffect at specified position */ diff --git a/src/core/effects/qgsgloweffect.h b/src/core/effects/qgsgloweffect.h index 6a657324b0ed..b0605f7a760f 100644 --- a/src/core/effects/qgsgloweffect.h +++ b/src/core/effects/qgsgloweffect.h @@ -26,7 +26,8 @@ #include -/** \ingroup core +/** + * \ingroup core * \class QgsGlowEffect * \brief Base class for paint effect which draw a glow inside or outside a * picture. @@ -53,7 +54,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect virtual QgsStringMap properties() const override; virtual void readProperties( const QgsStringMap &props ) override; - /** Sets the spread distance for drawing the glow effect. + /** + * Sets the spread distance for drawing the glow effect. * \param spread spread distance. Units are specified via setSpreadUnit() * \see spread * \see setSpreadUnit @@ -61,7 +63,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ void setSpread( const double spread ) { mSpread = spread; } - /** Returns the spread distance used for drawing the glow effect. + /** + * Returns the spread distance used for drawing the glow effect. * \returns spread distance. Units are retrieved via spreadUnit() * \see setSpread * \see spreadUnit @@ -69,7 +72,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ double spread() const { return mSpread; } - /** Sets the units used for the glow spread distance. + /** + * Sets the units used for the glow spread distance. * \param unit units for spread distance * \see spreadUnit * \see setSpread @@ -77,7 +81,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ void setSpreadUnit( const QgsUnitTypes::RenderUnit unit ) { mSpreadUnit = unit; } - /** Returns the units used for the glow spread distance. + /** + * Returns the units used for the glow spread distance. * \returns units for spread distance * \see setSpreadUnit * \see spread @@ -85,7 +90,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ QgsUnitTypes::RenderUnit spreadUnit() const { return mSpreadUnit; } - /** Sets the map unit scale used for the spread distance. + /** + * Sets the map unit scale used for the spread distance. * \param scale map unit scale for spread distance * \see spreadMapUnitScale * \see setSpread @@ -93,7 +99,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ void setSpreadMapUnitScale( const QgsMapUnitScale &scale ) { mSpreadMapUnitScale = scale; } - /** Returns the map unit scale used for the spread distance. + /** + * Returns the map unit scale used for the spread distance. * \returns map unit scale for spread distance * \see setSpreadMapUnitScale * \see spread @@ -101,7 +108,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ const QgsMapUnitScale &spreadMapUnitScale() const { return mSpreadMapUnitScale; } - /** Sets blur level (strength) for the glow. This can be used to smooth the + /** + * Sets blur level (strength) for the glow. This can be used to smooth the * output from the glow effect. * \param level blur level. Values between 0 and 16 are valid, with larger * values indicating greater blur strength. @@ -109,28 +117,32 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ void setBlurLevel( const int level ) { mBlurLevel = level; } - /** Returns the blur level (strength) for the glow. + /** + * Returns the blur level (strength) for the glow. * \returns blur level. Value will be between 0 and 16, with larger * values indicating greater blur strength. * \see setBlurLevel */ int blurLevel() const { return mBlurLevel; } - /** Sets the \a opacity for the effect. + /** + * Sets the \a opacity for the effect. * \param opacity double between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see opacity() */ void setOpacity( const double opacity ) { mOpacity = opacity; } - /** Returns the opacity for the effect. + /** + * Returns the opacity for the effect. * \returns opacity value between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see setOpacity(). */ double opacity() const { return mOpacity; } - /** Sets the color for the glow. This only applies if the colorType() + /** + * Sets the color for the glow. This only applies if the colorType() * is set to SingleColor. The glow will fade between the specified color and * a totally transparent version of the color. * \param color glow color @@ -139,7 +151,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ void setColor( const QColor &color ) { mColor = color; } - /** Returns the color for the glow. This only applies if the colorType() + /** + * Returns the color for the glow. This only applies if the colorType() * is set to SingleColor. The glow will fade between the specified color and * a totally transparent version of the color. * \returns glow color @@ -148,7 +161,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ QColor color() const { return mColor; } - /** Sets the color ramp for the glow. This only applies if the colorType() + /** + * Sets the color ramp for the glow. This only applies if the colorType() * is set to ColorRamp. The glow will utilize colors from the ramp. * \param ramp color ramp for glow. Ownership of the ramp is transferred to the effect. * \see ramp @@ -156,7 +170,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ void setRamp( QgsColorRamp *ramp SIP_TRANSFER ); - /** Returns the color ramp used for the glow. This only applies if the colorType() + /** + * Returns the color ramp used for the glow. This only applies if the colorType() * is set to ColorRamp. The glow will utilize colors from the ramp. * \returns color ramp for glow * \see setRamp @@ -164,21 +179,24 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ QgsColorRamp *ramp() const { return mRamp; } - /** Sets the blend mode for the effect + /** + * Sets the blend mode for the effect * \param mode blend mode used for drawing the effect on to a destination * paint device * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } - /** Returns the blend mode for the effect + /** + * Returns the blend mode for the effect * \returns blend mode used for drawing the effect on to a destination * paint device * \see setBlendMode */ QPainter::CompositionMode blendMode() const { return mBlendMode; } - /** Sets the color mode to use for the glow. The glow can either be drawn using a QgsColorRamp + /** + * Sets the color mode to use for the glow. The glow can either be drawn using a QgsColorRamp * color ramp or by simply specificing a single color. setColorType is used to specify which mode to use * for the glow. * \param colorType color type to use for glow @@ -188,7 +206,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect */ void setColorType( GlowColorType colorType ) { mColorType = colorType; } - /** Returns the color mode used for the glow. The glow can either be drawn using a QgsColorRamp + /** + * Returns the color mode used for the glow. The glow can either be drawn using a QgsColorRamp * color ramp or by specificing a single color. * \returns current color mode used for the glow * \see setColorType @@ -204,7 +223,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const override; virtual void draw( QgsRenderContext &context ) override; - /** Specifies whether the glow is drawn outside the picture or within + /** + * Specifies whether the glow is drawn outside the picture or within * the picture. * \returns true if glow is to be drawn outside the picture, or false * to draw glow within the picture @@ -224,7 +244,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect }; -/** \ingroup core +/** + * \ingroup core * \class QgsOuterGlowEffect * \brief A paint effect which draws a glow outside of a picture. * @@ -236,7 +257,8 @@ class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect public: - /** Creates a new QgsOuterGlowEffect effect from a properties string map. + /** + * Creates a new QgsOuterGlowEffect effect from a properties string map. * \param map encoded properties string map * \returns new QgsOuterGlowEffect */ @@ -254,7 +276,8 @@ class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect }; -/** \ingroup core +/** + * \ingroup core * \class QgsInnerGlowEffect * \brief A paint effect which draws a glow within a picture. * @@ -266,7 +289,8 @@ class CORE_EXPORT QgsInnerGlowEffect : public QgsGlowEffect public: - /** Creates a new QgsInnerGlowEffect effect from a properties string map. + /** + * Creates a new QgsInnerGlowEffect effect from a properties string map. * \param map encoded properties string map * \returns new QgsInnerGlowEffect */ diff --git a/src/core/effects/qgsimageoperation.h b/src/core/effects/qgsimageoperation.h index 23ab2934c4d1..fd5a4361d775 100644 --- a/src/core/effects/qgsimageoperation.h +++ b/src/core/effects/qgsimageoperation.h @@ -26,7 +26,8 @@ class QgsColorRamp; -/** \ingroup core +/** + * \ingroup core * \class QgsImageOperation * \brief Contains operations and filters which apply to QImages * @@ -45,7 +46,8 @@ class CORE_EXPORT QgsImageOperation public: - /** Modes for converting a QImage to grayscale + /** + * Modes for converting a QImage to grayscale */ enum GrayscaleMode { @@ -55,7 +57,8 @@ class CORE_EXPORT QgsImageOperation GrayscaleOff //!< No change }; - /** Flip operation types + /** + * Flip operation types */ enum FlipType { @@ -63,13 +66,15 @@ class CORE_EXPORT QgsImageOperation FlipVertical //!< Flip the image vertically }; - /** Convert a QImage to a grayscale image. Alpha channel is preserved. + /** + * Convert a QImage to a grayscale image. Alpha channel is preserved. * \param image QImage to convert * \param mode mode to use during grayscale conversion */ static void convertToGrayscale( QImage &image, const GrayscaleMode mode = GrayscaleLuminosity ); - /** Alter the brightness or contrast of a QImage. + /** + * Alter the brightness or contrast of a QImage. * \param image QImage to alter * \param brightness brightness value, in the range -255 to 255. A brightness value of 0 indicates * no change to brightness, a negative value will darken the image, and a positive value will brighten @@ -80,7 +85,8 @@ class CORE_EXPORT QgsImageOperation */ static void adjustBrightnessContrast( QImage &image, const int brightness, const double contrast ); - /** Alter the hue or saturation of a QImage. + /** + * Alter the hue or saturation of a QImage. * \param image QImage to alter * \param saturation double between 0 and 2 inclusive, where 0 = desaturate and 1.0 = no change * \param colorizeColor color to use for colorizing image. Set to an invalid QColor to disable @@ -90,13 +96,15 @@ class CORE_EXPORT QgsImageOperation static void adjustHueSaturation( QImage &image, const double saturation, const QColor &colorizeColor = QColor(), const double colorizeStrength = 1.0 ); - /** Multiplies opacity of image pixel values by a factor. + /** + * Multiplies opacity of image pixel values by a factor. * \param image QImage to alter * \param factor factor to multiple pixel's opacity by */ static void multiplyOpacity( QImage &image, const double factor ); - /** Overlays a color onto an image. This operation retains the alpha channel of the + /** + * Overlays a color onto an image. This operation retains the alpha channel of the * original image, but replaces all image pixel colors with the specified color. * \param image QImage to alter * \param color color to overlay (any alpha component of the color is ignored) @@ -109,28 +117,33 @@ class CORE_EXPORT QgsImageOperation DistanceTransformProperties() { } - /** Set to true to perform the distance transform on transparent pixels + /** + * Set to true to perform the distance transform on transparent pixels * in the source image, set to false to perform the distance transform * on opaque pixels */ bool shadeExterior = true; - /** Set to true to automatically calculate the maximum distance in the + /** + * Set to true to automatically calculate the maximum distance in the * transform to use as the spread value */ bool useMaxDistance = true; - /** Maximum distance (in pixels) for the distance transform shading to + /** + * Maximum distance (in pixels) for the distance transform shading to * spread */ double spread = 10.0; - /** Color ramp to use for shading the distance transform + /** + * Color ramp to use for shading the distance transform */ QgsColorRamp *ramp = nullptr; }; - /** Performs a distance transform on the source image and shades the result + /** + * Performs a distance transform on the source image and shades the result * using a color ramp. * \param image QImage to alter * \param properties DistanceTransformProperties object with parameters @@ -138,7 +151,8 @@ class CORE_EXPORT QgsImageOperation */ static void distanceTransform( QImage &image, const QgsImageOperation::DistanceTransformProperties &properties ); - /** Performs a stack blur on an image. Stack blur represents a good balance between + /** + * Performs a stack blur on an image. Stack blur represents a good balance between * speed and blur quality. * \param image QImage to blur * \param radius blur radius in pixels, maximum value of 16 @@ -148,7 +162,8 @@ class CORE_EXPORT QgsImageOperation */ static void stackBlur( QImage &image, const int radius, const bool alphaOnly = false ); - /** Performs a gaussian blur on an image. Gaussian blur is slower but results in a high + /** + * Performs a gaussian blur on an image. Gaussian blur is slower but results in a high * quality blur. * \param image QImage to blur * \param radius blur radius in pixels @@ -157,13 +172,15 @@ class CORE_EXPORT QgsImageOperation */ static QImage *gaussianBlur( QImage &image, const int radius ) SIP_FACTORY; - /** Flips an image horizontally or vertically + /** + * Flips an image horizontally or vertically * \param image QImage to flip * \param type type of flip to perform (horizontal or vertical) */ static void flipImage( QImage &image, FlipType type ); - /** Calculates the non-transparent region of an image. + /** + * Calculates the non-transparent region of an image. * \param image source image * \param minSize minimum size for returned region, if desired. If the * non-transparent region of the image is smaller than this minimum size, @@ -174,7 +191,8 @@ class CORE_EXPORT QgsImageOperation */ static QRect nonTransparentImageRect( const QImage &image, QSize minSize = QSize(), bool center = false ); - /** Crop any transparent border from around an image. + /** + * Crop any transparent border from around an image. * \param image source image * \param minSize minimum size for cropped image, if desired. If the * cropped image is smaller than the minimum size, it will be centered diff --git a/src/core/effects/qgspainteffect.h b/src/core/effects/qgspainteffect.h index 438227894a91..bf6d62279fad 100644 --- a/src/core/effects/qgspainteffect.h +++ b/src/core/effects/qgspainteffect.h @@ -25,7 +25,8 @@ class QgsRenderContext; -/** \ingroup core +/** + * \ingroup core * \class QgsPaintEffect * \brief Base class for visual effects which can be applied to QPicture drawings * @@ -94,7 +95,8 @@ class CORE_EXPORT QgsPaintEffect public: - /** Drawing modes for effects. These modes are used only when effects are + /** + * Drawing modes for effects. These modes are used only when effects are * drawn as part of an effects stack * \see QgsEffectStack */ @@ -113,17 +115,20 @@ class CORE_EXPORT QgsPaintEffect QgsPaintEffect( const QgsPaintEffect &other ); virtual ~QgsPaintEffect(); - /** Returns the effect type. + /** + * Returns the effect type. * \returns unique string representation of the effect type */ virtual QString type() const = 0; - /** Duplicates an effect by creating a deep copy of the effect + /** + * Duplicates an effect by creating a deep copy of the effect * \returns clone of paint effect */ virtual QgsPaintEffect *clone() const = 0 SIP_FACTORY; - /** Returns the properties describing the paint effect encoded in a + /** + * Returns the properties describing the paint effect encoded in a * string format. * \returns string map of properties, in the form property key, value * \see readProperties @@ -131,14 +136,16 @@ class CORE_EXPORT QgsPaintEffect */ virtual QgsStringMap properties() const = 0; - /** Reads a string map of an effect's properties and restores the effect + /** + * Reads a string map of an effect's properties and restores the effect * to the state described by the properties map. * \param props effect properties encoded in a string map * \see properties */ virtual void readProperties( const QgsStringMap &props ) = 0; - /** Saves the current state of the effect to a DOM element. The default + /** + * Saves the current state of the effect to a DOM element. The default * behavior is to save the properties string map returned by * properties(). * \param doc destination DOM document @@ -148,21 +155,24 @@ class CORE_EXPORT QgsPaintEffect */ virtual bool saveProperties( QDomDocument &doc, QDomElement &element ) const; - /** Restores the effect to the state described by a DOM element. + /** + * Restores the effect to the state described by a DOM element. * \param element DOM element describing an effect's state * \returns true if read was successful * \see saveProperties */ virtual bool readProperties( const QDomElement &element ); - /** Renders a picture using the effect. + /** + * Renders a picture using the effect. * \param picture source QPicture to render * \param context destination render context * \see begin */ virtual void render( QPicture &picture, QgsRenderContext &context ); - /** Begins intercepting paint operations to a render context. When the corresponding + /** + * Begins intercepting paint operations to a render context. When the corresponding * end() member is called all intercepted paint operations will be * drawn to the render context after being modified by the effect. * \param context destination render context @@ -171,33 +181,38 @@ class CORE_EXPORT QgsPaintEffect */ virtual void begin( QgsRenderContext &context ); - /** Ends interception of paint operations to a render context, and draws the result + /** + * Ends interception of paint operations to a render context, and draws the result * to the render context after being modified by the effect. * \param context destination render context * \see begin */ virtual void end( QgsRenderContext &context ); - /** Returns whether the effect is enabled + /** + * Returns whether the effect is enabled * \returns true if effect is enabled * \see setEnabled */ bool enabled() const { return mEnabled; } - /** Sets whether the effect is enabled + /** + * Sets whether the effect is enabled * \param enabled set to false to disable the effect * \see enabled */ void setEnabled( const bool enabled ); - /** Returns the draw mode for the effect. This property only has an + /** + * Returns the draw mode for the effect. This property only has an * effect if the paint effect is used in a QgsEffectStack. * \returns draw mode for effect * \see setDrawMode */ DrawMode drawMode() const { return mDrawMode; } - /** Sets the draw mode for the effect. This property only has an + /** + * Sets the draw mode for the effect. This property only has an * effect if the paint effect is used in a QgsEffectStack. * \param drawMode draw mode for effect * \see drawMode @@ -210,7 +225,8 @@ class CORE_EXPORT QgsPaintEffect DrawMode mDrawMode = ModifyAndRender; bool requiresQPainterDpiFix = true; - /** Handles drawing of the effect's result on to the specified render context. + /** + * Handles drawing of the effect's result on to the specified render context. * Derived classes must reimplement this method to apply any transformations to * the source QPicture and draw the result using the context's painter. * \param context destination render context @@ -218,7 +234,8 @@ class CORE_EXPORT QgsPaintEffect */ virtual void draw( QgsRenderContext &context ) = 0; - /** Draws the source QPicture onto the specified painter. Handles scaling of the picture + /** + * Draws the source QPicture onto the specified painter. Handles scaling of the picture * to account for the destination painter's DPI. * \param painter destination painter * \see source @@ -226,7 +243,8 @@ class CORE_EXPORT QgsPaintEffect */ void drawSource( QPainter &painter ); - /** Returns the source QPicture. The draw() member can utilize this when + /** + * Returns the source QPicture. The draw() member can utilize this when * drawing the effect. * \returns source QPicture * \see drawSource @@ -234,7 +252,8 @@ class CORE_EXPORT QgsPaintEffect */ const QPicture *source() const { return mPicture; } - /** Returns the source QPicture rendered to a new QImage. The draw() member can + /** + * Returns the source QPicture rendered to a new QImage. The draw() member can * utilize this when drawing the effect. The image will be padded or cropped from the original * source QPicture by the results of the boundingRect() method. * The result is cached to speed up subsequent calls to sourceAsImage. @@ -246,7 +265,8 @@ class CORE_EXPORT QgsPaintEffect */ QImage *sourceAsImage( QgsRenderContext &context ); - /** Returns the offset which should be used when drawing the source image on to a destination + /** + * Returns the offset which should be used when drawing the source image on to a destination * render context. * \param context destination render context * \returns point offset for image top left corner @@ -254,7 +274,8 @@ class CORE_EXPORT QgsPaintEffect */ QPointF imageOffset( const QgsRenderContext &context ) const; - /** Returns the bounding rect required for drawing the effect. This method can be used + /** + * Returns the bounding rect required for drawing the effect. This method can be used * to expand the bounding rect of a source picture to account for offset or blurring * effects. * \param rect original source bounding rect @@ -264,7 +285,8 @@ class CORE_EXPORT QgsPaintEffect */ virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const; - /** Applies a workaround to a QPainter to avoid an issue with incorrect scaling + /** + * Applies a workaround to a QPainter to avoid an issue with incorrect scaling * when drawing QPictures. This may need to be called by derived classes prior * to rendering results onto a painter. * \param painter destination painter @@ -287,7 +309,8 @@ class CORE_EXPORT QgsPaintEffect }; -/** \ingroup core +/** + * \ingroup core * \class QgsDrawSourceEffect * \brief A paint effect which draws the source picture with minor or no alterations * @@ -305,7 +328,8 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect QgsDrawSourceEffect(); - /** Creates a new QgsDrawSource effect from a properties string map. + /** + * Creates a new QgsDrawSource effect from a properties string map. * \param map encoded properties string map * \returns new QgsDrawSourceEffect */ @@ -316,28 +340,32 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect virtual QgsStringMap properties() const override; virtual void readProperties( const QgsStringMap &props ) override; - /** Sets the \a opacity for the effect. + /** + * Sets the \a opacity for the effect. * \param opacity double between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see opacity() */ void setOpacity( const double opacity ) { mOpacity = opacity; } - /** Returns the opacity for the effect + /** + * Returns the opacity for the effect * \returns opacity value between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see setOpacity() */ double opacity() const { return mOpacity; } - /** Sets the blend mode for the effect + /** + * Sets the blend mode for the effect * \param mode blend mode used for drawing the source on to a destination * paint device * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } - /** Returns the blend mode for the effect + /** + * Returns the blend mode for the effect * \returns blend mode used for drawing the source on to a destination * paint device * \see setBlendMode @@ -354,7 +382,8 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver; }; -/** \ingroup core +/** + * \ingroup core * \class QgsEffectPainter * \brief A class to manager painter saving and restoring required for effect drawing * diff --git a/src/core/effects/qgspainteffectregistry.h b/src/core/effects/qgspainteffectregistry.h index 31619ec870f6..9a419209a494 100644 --- a/src/core/effects/qgspainteffectregistry.h +++ b/src/core/effects/qgspainteffectregistry.h @@ -24,7 +24,8 @@ class QgsPaintEffect; class QgsPaintEffectWidget SIP_EXTERNAL; -/** \ingroup core +/** + * \ingroup core * \class QgsPaintEffectAbstractMetadata * \brief Stores metadata about a paint effect class. * @@ -38,7 +39,8 @@ class CORE_EXPORT QgsPaintEffectAbstractMetadata { public: - /** Construct a new QgsPaintEffectAbstractMetadata + /** + * Construct a new QgsPaintEffectAbstractMetadata * \param name unique string representing paint effect class * \param visibleName user visible name representing paint effect class */ @@ -46,25 +48,29 @@ class CORE_EXPORT QgsPaintEffectAbstractMetadata virtual ~QgsPaintEffectAbstractMetadata() = default; - /** Returns the unique string representing the paint effect class + /** + * Returns the unique string representing the paint effect class * \returns unique string * \see visibleName */ QString name() const { return mName; } - /** Returns the user visible string representing the paint effect class + /** + * Returns the user visible string representing the paint effect class * \returns friendly user visible string * \see name */ QString visibleName() const { return mVisibleName; } - /** Create a paint effect of this class given an encoded map of properties. + /** + * Create a paint effect of this class given an encoded map of properties. * \param map properties string map * \returns new paint effect */ virtual QgsPaintEffect *createPaintEffect( const QgsStringMap &map ) = 0 SIP_FACTORY; - /** Create configuration widget for paint effect of this class. Can return nullptr + /** + * Create configuration widget for paint effect of this class. Can return nullptr * if there's no GUI for the paint effect class. * \returns configuration widget */ @@ -79,7 +85,8 @@ class CORE_EXPORT QgsPaintEffectAbstractMetadata typedef QgsPaintEffect *( *QgsPaintEffectCreateFunc )( const QgsStringMap & ) SIP_SKIP; typedef QgsPaintEffectWidget *( *QgsPaintEffectWidgetFunc )() SIP_SKIP; -/** \ingroup core +/** + * \ingroup core * \class QgsPaintEffectMetadata * \brief Convenience metadata class that uses static functions to create an effect and its widget. * @@ -91,7 +98,8 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata public: - /** Create effect metadata from static functions + /** + * Create effect metadata from static functions * \param name unique string representing paint effect class * \param visibleName user visible name representing paint effect class * \param pfCreate paint effect creation function @@ -106,27 +114,31 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata , mWidgetFunc( pfWidget ) {} - /** Returns the paint effect creation function for the paint effect class + /** + * Returns the paint effect creation function for the paint effect class * \returns creation function * \note not available in Python bindings */ QgsPaintEffectCreateFunc createFunction() const { return mCreateFunc; } SIP_SKIP - /** Returns the paint effect properties widget creation function for the paint effect class + /** + * Returns the paint effect properties widget creation function for the paint effect class * \returns widget creation function * \note not available in Python bindings * \see setWidgetFunction */ QgsPaintEffectWidgetFunc widgetFunction() const { return mWidgetFunc; } SIP_SKIP - /** Sets the paint effect properties widget creation function for the paint effect class + /** + * Sets the paint effect properties widget creation function for the paint effect class * \param f widget creation function * \note not available in Python bindings * \see widgetFunction */ void setWidgetFunction( QgsPaintEffectWidgetFunc f ) { mWidgetFunc = f; } SIP_SKIP - /** Creates a new paint effect of the metadata's effect class + /** + * Creates a new paint effect of the metadata's effect class * \param map string map of effect properties * \returns new paint effect * \note not available in Python bindings @@ -134,7 +146,8 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata */ virtual QgsPaintEffect *createPaintEffect( const QgsStringMap &map ) override { return mCreateFunc ? mCreateFunc( map ) : nullptr; } SIP_SKIP - /** Creates a new paint effect properties widget for the metadata's effect class + /** + * Creates a new paint effect properties widget for the metadata's effect class * \returns effect properties widget * \note not available in Python bindings * \see createWidget @@ -147,7 +160,8 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata }; -/** \ingroup core +/** + * \ingroup core * \class QgsPaintEffectRegistry * \brief Registry of available paint effects. * @@ -168,19 +182,22 @@ class CORE_EXPORT QgsPaintEffectRegistry //! QgsPaintEffectRegistry cannot be copied. QgsPaintEffectRegistry &operator=( const QgsPaintEffectRegistry &rh ) = delete; - /** Returns the metadata for a specific effect. + /** + * Returns the metadata for a specific effect. * \param name unique string name for paint effect class * \returns paint effect metadata if found, otherwise nullptr */ QgsPaintEffectAbstractMetadata *effectMetadata( const QString &name ) const; - /** Registers a new effect type. + /** + * Registers a new effect type. * \param metadata effect metadata. Ownership is transferred to the registry. * \returns true if add was successful. */ bool addEffectType( QgsPaintEffectAbstractMetadata *metadata SIP_TRANSFER ); - /** Creates a new paint effect given the effect name and properties map. + /** + * Creates a new paint effect given the effect name and properties map. * \param name unique name representing paint effect class * \param properties encoded string map of effect properties * \returns new paint effect of specified class, or nullptr if matching @@ -188,7 +205,8 @@ class CORE_EXPORT QgsPaintEffectRegistry */ QgsPaintEffect *createEffect( const QString &name, const QgsStringMap &properties = QgsStringMap() ) const SIP_FACTORY; - /** Creates a new paint effect given a DOM element storing paint effect + /** + * Creates a new paint effect given a DOM element storing paint effect * properties. * \param element encoded DOM element of effect properties * \returns new paint effect, or nullptr if matching @@ -196,12 +214,14 @@ class CORE_EXPORT QgsPaintEffectRegistry */ QgsPaintEffect *createEffect( const QDomElement &element ) const SIP_FACTORY; - /** Returns a list of known paint effects. + /** + * Returns a list of known paint effects. * \returns list of paint effect names */ QStringList effects() const; - /** Returns a new effect stack consisting of a sensible selection of default + /** + * Returns a new effect stack consisting of a sensible selection of default * effects. All effects except the standard draw source effect are disabled, * but are included so that they can be easily drawn just by enabling the effect. * \returns default effects stack @@ -209,7 +229,8 @@ class CORE_EXPORT QgsPaintEffectRegistry */ static QgsPaintEffect *defaultStack() SIP_FACTORY; - /** Tests whether a paint effect matches the default effects stack. + /** + * Tests whether a paint effect matches the default effects stack. * \param effect paint effect to test * \returns true if effect is default stack * \since QGIS 2.12 diff --git a/src/core/effects/qgsshadoweffect.h b/src/core/effects/qgsshadoweffect.h index 2addb374eaa4..f21741c95141 100644 --- a/src/core/effects/qgsshadoweffect.h +++ b/src/core/effects/qgsshadoweffect.h @@ -23,7 +23,8 @@ #include "qgssymbol.h" #include -/** \ingroup core +/** + * \ingroup core * \class QgsShadowEffect * \brief Base class for paint effects which offset, blurred shadows * @@ -40,35 +41,40 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect virtual QgsStringMap properties() const override; virtual void readProperties( const QgsStringMap &props ) override; - /** Sets blur level (strength) for the shadow. + /** + * Sets blur level (strength) for the shadow. * \param level blur level. Values between 0 and 16 are valid, with larger * values indicating greater blur strength. * \see blurLevel */ void setBlurLevel( const int level ) { mBlurLevel = level; } - /** Returns the blur level (strength) for the shadow. + /** + * Returns the blur level (strength) for the shadow. * \returns blur level. Value will be between 0 and 16, with larger * values indicating greater blur strength. * \see setBlurLevel */ int blurLevel() const { return mBlurLevel; } - /** Sets the angle for offsetting the shadow. + /** + * Sets the angle for offsetting the shadow. * \param angle offset angle in degrees clockwise from North * \see offsetAngle * \see setOffsetDistance */ void setOffsetAngle( const int angle ) { mOffsetAngle = angle; } - /** Returns the angle used for offsetting the shadow. + /** + * Returns the angle used for offsetting the shadow. * \returns offset angle in degrees clockwise from North * \see setOffsetAngle * \see offsetDistance */ int offsetAngle() const { return mOffsetAngle; } - /** Sets the distance for offsetting the shadow. + /** + * Sets the distance for offsetting the shadow. * \param distance offset distance. Units are specified via setOffsetUnit() * \see offsetDistance * \see setOffsetUnit @@ -76,7 +82,8 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect */ void setOffsetDistance( const double distance ) { mOffsetDist = distance; } - /** Returns the distance used for offsetting the shadow. + /** + * Returns the distance used for offsetting the shadow. * \returns offset distance. Distance units are retrieved via offsetUnit() * \see setOffsetDistance * \see offsetUnit @@ -84,7 +91,8 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect */ double offsetDistance() const { return mOffsetDist; } - /** Sets the units used for the shadow offset distance. + /** + * Sets the units used for the shadow offset distance. * \param unit units for offset distance * \see offsetUnit * \see setOffsetDistance @@ -92,7 +100,8 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect */ void setOffsetUnit( const QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } - /** Returns the units used for the shadow offset distance. + /** + * Returns the units used for the shadow offset distance. * \returns units for offset distance * \see setOffsetUnit * \see offsetDistance @@ -100,7 +109,8 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } - /** Sets the map unit scale used for the shadow offset distance. + /** + * Sets the map unit scale used for the shadow offset distance. * \param scale map unit scale for offset distance * \see offsetMapUnitScale * \see setOffsetDistance @@ -108,7 +118,8 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; } - /** Returns the map unit scale used for the shadow offset distance. + /** + * Returns the map unit scale used for the shadow offset distance. * \returns map unit scale for offset distance * \see setOffsetMapUnitScale * \see offsetDistance @@ -116,40 +127,46 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect */ const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; } - /** Sets the color for the shadow. + /** + * Sets the color for the shadow. * \param color shadow color * \see color */ void setColor( const QColor &color ) { mColor = color; } - /** Returns the color used for the shadow. + /** + * Returns the color used for the shadow. * \returns shadow color * \see setColor */ QColor color() const { return mColor; } - /** Sets the \a opacity for the effect. + /** + * Sets the \a opacity for the effect. * \param opacity double between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see opacity() */ void setOpacity( const double opacity ) { mOpacity = opacity; } - /** Returns the opacity for the effect. + /** + * Returns the opacity for the effect. * \returns opacity value between 0 and 1 inclusive, where 0 is fully transparent * and 1 is fully opaque * \see setOpacity() */ double opacity() const { return mOpacity; } - /** Sets the blend mode for the effect + /** + * Sets the blend mode for the effect * \param mode blend mode used for drawing the effect on to a destination * paint device * \see blendMode */ void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; } - /** Returns the blend mode for the effect + /** + * Returns the blend mode for the effect * \returns blend mode used for drawing the effect on to a destination * paint device * \see setBlendMode @@ -161,7 +178,8 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const override; virtual void draw( QgsRenderContext &context ) override; - /** Specifies whether the shadow is drawn outside the picture or within + /** + * Specifies whether the shadow is drawn outside the picture or within * the picture. * \returns true if shadow is to be drawn outside the picture, or false * to draw shadow within the picture @@ -180,7 +198,8 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect }; -/** \ingroup core +/** + * \ingroup core * \class QgsDropShadowEffect * \brief A paint effect which draws an offset and optionally blurred drop shadow * @@ -191,7 +210,8 @@ class CORE_EXPORT QgsDropShadowEffect : public QgsShadowEffect public: - /** Creates a new QgsDropShadowEffect effect from a properties string map. + /** + * Creates a new QgsDropShadowEffect effect from a properties string map. * \param map encoded properties string map * \returns new QgsDropShadowEffect */ @@ -208,7 +228,8 @@ class CORE_EXPORT QgsDropShadowEffect : public QgsShadowEffect }; -/** \ingroup core +/** + * \ingroup core * \class QgsInnerShadowEffect * \brief A paint effect which draws an offset and optionally blurred drop shadow * within a picture. @@ -220,7 +241,8 @@ class CORE_EXPORT QgsInnerShadowEffect : public QgsShadowEffect public: - /** Creates a new QgsInnerShadowEffect effect from a properties string map. + /** + * Creates a new QgsInnerShadowEffect effect from a properties string map. * \param map encoded properties string map * \returns new QgsInnerShadowEffect */ diff --git a/src/core/effects/qgstransformeffect.h b/src/core/effects/qgstransformeffect.h index 34133d2969a9..f90cf144a1b9 100644 --- a/src/core/effects/qgstransformeffect.h +++ b/src/core/effects/qgstransformeffect.h @@ -24,7 +24,8 @@ #include "qgsunittypes.h" #include -/** \ingroup core +/** + * \ingroup core * \class QgsTransformEffect * \brief A paint effect which applies transformations (such as move, * scale and rotate) to a picture. @@ -37,7 +38,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect public: - /** Creates a new QgsTransformEffect effect from a properties string map. + /** + * Creates a new QgsTransformEffect effect from a properties string map. * \param map encoded properties string map * \returns new QgsTransformEffect */ @@ -53,7 +55,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect virtual void readProperties( const QgsStringMap &props ) override; virtual QgsTransformEffect *clone() const override SIP_FACTORY; - /** Sets the transform x translation. + /** + * Sets the transform x translation. * \param translateX distance to translate along the x axis * \see translateX * \see setTranslateY @@ -62,7 +65,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ void setTranslateX( const double translateX ) { mTranslateX = translateX; } - /** Returns the transform x translation. + /** + * Returns the transform x translation. * \returns X distance translated along the x axis * \see setTranslateX * \see translateY @@ -71,7 +75,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ double translateX() const { return mTranslateX; } - /** Sets the transform y translation. + /** + * Sets the transform y translation. * \param translateY distance to translate along the y axis * \see translateY * \see setTranslateX @@ -80,7 +85,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ void setTranslateY( const double translateY ) { mTranslateY = translateY; } - /** Returns the transform y translation. + /** + * Returns the transform y translation. * \returns Y distance translated along the y axis * \see setTranslateY * \see translateX @@ -89,7 +95,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ double translateY() const { return mTranslateY; } - /** Sets the units used for the transform translation. + /** + * Sets the units used for the transform translation. * \param unit units for translation * \see translateUnit * \see setTranslateX @@ -98,7 +105,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ void setTranslateUnit( const QgsUnitTypes::RenderUnit unit ) { mTranslateUnit = unit; } - /** Returns the units used for the transform translation. + /** + * Returns the units used for the transform translation. * \returns units for translation * \see setTranslateUnit * \see translateX @@ -107,7 +115,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ QgsUnitTypes::RenderUnit translateUnit() const { return mTranslateUnit; } - /** Sets the map unit scale used for the transform translation. + /** + * Sets the map unit scale used for the transform translation. * \param scale map unit scale for translation * \see translateMapUnitScale * \see setTranslateX @@ -116,7 +125,8 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ void setTranslateMapUnitScale( const QgsMapUnitScale &scale ) { mTranslateMapUnitScale = scale; } - /** Returns the map unit scale used for the transform translation. + /** + * Returns the map unit scale used for the transform translation. * \returns map unit scale for translation * \see setTranslateMapUnitScale * \see translateX @@ -125,27 +135,31 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ const QgsMapUnitScale &translateMapUnitScale() const { return mTranslateMapUnitScale; } - /** Sets the x axis scaling factor. + /** + * Sets the x axis scaling factor. * \param scaleX factor to scale x axis by, where 1.0 = no scaling * \see scaleX * \see setScaleY */ void setScaleX( const double scaleX ) { mScaleX = scaleX; } - /** Returns the x axis scaling factor. + /** + * Returns the x axis scaling factor. * \returns x axis scaling factor, where 1.0 = no scaling * \see setScaleX * \see scaleY */ double scaleX() const { return mScaleX; } - /** Sets the y axis scaling factor. + /** + * Sets the y axis scaling factor. * \param scaleY factor to scale y axis by, where 1.0 = no scaling * \see scaleX */ void setScaleY( const double scaleY ) { mScaleY = scaleY; } - /** Returns the y axis scaling factor. + /** + * Returns the y axis scaling factor. * \returns y axis scaling factor, where 1.0 = no scaling * \see setScaleY * \see scaleX @@ -164,56 +178,64 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect */ double rotation() const { return mRotation; } - /** Sets the x axis shearing factor. + /** + * Sets the x axis shearing factor. * \param shearX x axis shearing * \see shearX * \see setShearY */ void setShearX( const double shearX ) { mShearX = shearX; } - /** Returns the x axis shearing factor. + /** + * Returns the x axis shearing factor. * \returns x axis shearing * \see setShearX * \see shearY */ double shearX() const { return mShearX; } - /** Sets the y axis shearing factor. + /** + * Sets the y axis shearing factor. * \param shearY y axis shearing * \see shearY * \see setShearX */ void setShearY( const double shearY ) { mShearY = shearY; } - /** Returns the y axis shearing factor. + /** + * Returns the y axis shearing factor. * \returns y axis shearing * \see setShearY * \see shearX */ double shearY() const { return mShearY; } - /** Sets whether to reflect along the x-axis + /** + * Sets whether to reflect along the x-axis * \param reflectX true to reflect horizontally * \see reflectX * \see setReflectY */ void setReflectX( const bool reflectX ) { mReflectX = reflectX; } - /** Returns whether transform will be reflected along the x-axis + /** + * Returns whether transform will be reflected along the x-axis * \returns true if transform will reflect horizontally * \see setReflectX * \see reflectY */ bool reflectX() const { return mReflectX; } - /** Sets whether to reflect along the y-axis + /** + * Sets whether to reflect along the y-axis * \param reflectY true to reflect horizontally * \see reflectY * \see setReflectX */ void setReflectY( const bool reflectY ) { mReflectY = reflectY; } - /** Returns whether transform will be reflected along the y-axis + /** + * Returns whether transform will be reflected along the y-axis * \returns true if transform will reflect horizontally * \see setReflectY * \see reflectX diff --git a/src/core/expression/qgsexpression.h b/src/core/expression/qgsexpression.h index edc3a312d468..f4e8cf424b7d 100644 --- a/src/core/expression/qgsexpression.h +++ b/src/core/expression/qgsexpression.h @@ -44,7 +44,8 @@ class QgsExpressionPrivate; class QgsExpressionNode; class QgsExpressionFunction; -/** \ingroup core +/** + * \ingroup core Class for parsing and evaluation of expressions (formerly called "search strings"). The expressions try to follow both syntax and semantics of SQL expressions. @@ -169,7 +170,8 @@ class CORE_EXPORT QgsExpression //! Returns root node of the expression. Root node is null is parsing has failed const QgsExpressionNode *rootNode() const; - /** Get the expression ready for evaluation - find out column indexes. + /** + * Get the expression ready for evaluation - find out column indexes. * \param context context for preparing expression * \since QGIS 2.12 */ @@ -207,13 +209,15 @@ class CORE_EXPORT QgsExpression // evaluation - /** Evaluate the feature and return the result. + /** + * Evaluate the feature and return the result. * \note this method does not expect that prepare() has been called on this instance * \since QGIS 2.12 */ QVariant evaluate(); - /** Evaluate the expression against the specified context and return the result. + /** + * Evaluate the expression against the specified context and return the result. * \param context context for evaluating expression * \note prepare() should be called before calling this method. * \since QGIS 2.12 @@ -227,12 +231,14 @@ class CORE_EXPORT QgsExpression //! Set evaluation error (used internally by evaluation functions) void setEvalErrorString( const QString &str ); - /** Checks whether an expression consists only of a single field reference + /** + * Checks whether an expression consists only of a single field reference * \since QGIS 2.9 */ bool isField() const; - /** Tests whether a string is a valid expression. + /** + * Tests whether a string is a valid expression. * \param text string to test * \param context optional expression context * \param errorMessage will be filled with any error message from the validation @@ -263,7 +269,8 @@ class CORE_EXPORT QgsExpression */ QString dump() const; - /** Return calculator used for distance and area calculations + /** + * Return calculator used for distance and area calculations * (used by $length, $area and $perimeter functions only) * \see setGeomCalculator() * \see distanceUnits() @@ -271,7 +278,8 @@ class CORE_EXPORT QgsExpression */ QgsDistanceArea *geomCalculator(); - /** Sets the geometry calculator used for distance and area calculations in expressions. + /** + * Sets the geometry calculator used for distance and area calculations in expressions. * (used by $length, $area and $perimeter functions only). By default, no geometry * calculator is set and all distance and area calculations are performed using simple * Cartesian methods (ie no ellipsoidal calculations). @@ -281,7 +289,8 @@ class CORE_EXPORT QgsExpression */ void setGeomCalculator( const QgsDistanceArea *calc ); - /** Returns the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter". + /** + * Returns the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter". * \note distances are only converted when a geomCalculator() has been set * \since QGIS 2.14 * \see setDistanceUnits() @@ -289,7 +298,8 @@ class CORE_EXPORT QgsExpression */ QgsUnitTypes::DistanceUnit distanceUnits() const; - /** Sets the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter". + /** + * Sets the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter". * \note distances are only converted when a geomCalculator() has been set * \since QGIS 2.14 * \see distanceUnits() @@ -297,7 +307,8 @@ class CORE_EXPORT QgsExpression */ void setDistanceUnits( QgsUnitTypes::DistanceUnit unit ); - /** Returns the desired areal units for calculations involving geomCalculator(), e.g., "$area". + /** + * Returns the desired areal units for calculations involving geomCalculator(), e.g., "$area". * \note areas are only converted when a geomCalculator() has been set * \since QGIS 2.14 * \see setAreaUnits() @@ -305,7 +316,8 @@ class CORE_EXPORT QgsExpression */ QgsUnitTypes::AreaUnit areaUnits() const; - /** Sets the desired areal units for calculations involving geomCalculator(), e.g., "$area". + /** + * Sets the desired areal units for calculations involving geomCalculator(), e.g., "$area". * \note areas are only converted when a geomCalculator() has been set * \since QGIS 2.14 * \see areaUnits() @@ -313,7 +325,8 @@ class CORE_EXPORT QgsExpression */ void setAreaUnits( QgsUnitTypes::AreaUnit unit ); - /** This function replaces each expression between [% and %] + /** + * This function replaces each expression between [% and %] * in the string with the result of its evaluation with the specified context * * Additional substitutions can be passed through the substitutionMap parameter @@ -326,7 +339,8 @@ class CORE_EXPORT QgsExpression static QString replaceExpressionText( const QString &action, const QgsExpressionContext *context, const QgsDistanceArea *distanceArea = nullptr ); - /** Attempts to evaluate a text string as an expression to a resultant double + /** + * Attempts to evaluate a text string as an expression to a resultant double * value. * \param text text to evaluate as expression * \param fallbackValue value to return if text can not be evaluated as a double @@ -358,7 +372,8 @@ class CORE_EXPORT QgsExpression static QStringList sBuiltinFunctions SIP_SKIP; static const QStringList &BuiltinFunctions(); - /** Registers a function to the expression engine. This is required to allow expressions to utilize the function. + /** + * Registers a function to the expression engine. This is required to allow expressions to utilize the function. * \param function function to register * \param transferOwnership set to true to transfer ownership of function to expression engine * \returns true on successful registration @@ -366,7 +381,8 @@ class CORE_EXPORT QgsExpression */ static bool registerFunction( QgsExpressionFunction *function, bool transferOwnership = false ); - /** Unregisters a function from the expression engine. The function will no longer be usable in expressions. + /** + * Unregisters a function from the expression engine. The function will no longer be usable in expressions. * \param name function name * \see registerFunction */ @@ -378,7 +394,8 @@ class CORE_EXPORT QgsExpression */ static QList sOwnedFunctions SIP_SKIP; - /** Deletes all registered functions whose ownership have been transferred to the expression engine. + /** + * Deletes all registered functions whose ownership have been transferred to the expression engine. * \since QGIS 2.12 */ static void cleanRegisteredFunctions(); @@ -389,24 +406,28 @@ class CORE_EXPORT QgsExpression //! return index of the function in Functions array static int functionIndex( const QString &name ); - /** Returns the number of functions defined in the parser + /** + * Returns the number of functions defined in the parser * \returns The number of function defined in the parser. */ static int functionCount(); - /** Returns a quoted column reference (in double quotes) + /** + * Returns a quoted column reference (in double quotes) * \see quotedString() * \see quotedValue() */ static QString quotedColumnRef( QString name ); - /** Returns a quoted version of a string (in single quotes) + /** + * Returns a quoted version of a string (in single quotes) * \see quotedValue() * \see quotedColumnRef() */ static QString quotedString( QString text ); - /** Returns a string representation of a literal value, including appropriate + /** + * Returns a string representation of a literal value, including appropriate * quotations where required. * \param value value to convert to a string representation * \since QGIS 2.14 @@ -415,7 +436,8 @@ class CORE_EXPORT QgsExpression */ static QString quotedValue( const QVariant &value ); - /** Returns a string representation of a literal value, including appropriate + /** + * Returns a string representation of a literal value, including appropriate * quotations where required. * \param value value to convert to a string representation * \param type value type @@ -427,14 +449,16 @@ class CORE_EXPORT QgsExpression ////// - /** Returns the help text for a specified function. + /** + * Returns the help text for a specified function. * \param name function name * \see variableHelpText() * \see formatVariableHelp() */ static QString helpText( QString name ); - /** Returns the help text for a specified variable. + /** + * Returns the help text for a specified variable. * \param variableName name of variable * \param showValue set to true to include current value of variable in help text * \param value current value of variable to show in help text @@ -454,12 +478,14 @@ class CORE_EXPORT QgsExpression */ static QString formatVariableHelp( const QString &description, bool showValue = true, const QVariant &value = QVariant() ); - /** Returns the translated name for a function group. + /** + * Returns the translated name for a function group. * \param group untranslated group name */ static QString group( const QString &group ); - /** Formats an expression result for friendly display to the user. Truncates the result to a sensible + /** + * Formats an expression result for friendly display to the user. Truncates the result to a sensible * length, and presents text representations of non numeric/text types (e.g., geometries and features). * \param value expression result to format * \returns formatted string, may contain HTML formatting characters @@ -467,7 +493,8 @@ class CORE_EXPORT QgsExpression */ static QString formatPreviewString( const QVariant &value ); - /** Create an expression allowing to evaluate if a field is equal to a + /** + * Create an expression allowing to evaluate if a field is equal to a * value. The value may be null. * \param fieldName the name of the field * \param value the value of the field diff --git a/src/core/expression/qgsexpressionfunction.h b/src/core/expression/qgsexpressionfunction.h index 1dd0bd8b4104..52ef15581a9b 100644 --- a/src/core/expression/qgsexpressionfunction.h +++ b/src/core/expression/qgsexpressionfunction.h @@ -31,18 +31,21 @@ class QgsExpression; class QgsExpressionContext; class QgsExpressionContextScope; -/** \ingroup core +/** + * \ingroup core * A abstract base class for defining QgsExpression functions. */ class CORE_EXPORT QgsExpressionFunction { public: - /** Function definition for evaluation against an expression context, using a list of values as parameters to the function. + /** + * Function definition for evaluation against an expression context, using a list of values as parameters to the function. */ typedef QVariant( *FcnEval )( const QVariantList &values, const QgsExpressionContext *context, QgsExpression *parent, const QgsExpressionNodeFunction *node ) SIP_SKIP; - /** \ingroup core + /** + * \ingroup core * Represents a single parameter passed to a function. * \since QGIS 2.16 */ @@ -50,7 +53,8 @@ class CORE_EXPORT QgsExpressionFunction { public: - /** Constructor for Parameter. + /** + * Constructor for Parameter. * \param name parameter name, used when named parameter are specified in an expression * \param optional set to true if parameter should be optional * \param defaultValue default value to use for optional parameters @@ -104,7 +108,8 @@ class CORE_EXPORT QgsExpressionFunction { } - /** Constructor for function which uses unnamed parameters and group list + /** + * Constructor for function which uses unnamed parameters and group list * \since QGIS 3.0 */ QgsExpressionFunction( const QString &fnname, @@ -124,7 +129,8 @@ class CORE_EXPORT QgsExpressionFunction { } - /** Constructor for function which uses named parameter list. + /** + * Constructor for function which uses named parameter list. * \since QGIS 2.16 */ QgsExpressionFunction( const QString &fnname, @@ -144,7 +150,8 @@ class CORE_EXPORT QgsExpressionFunction , mIsContextual( isContextual ) {} - /** Constructor for function which uses named parameter list and group list. + /** + * Constructor for function which uses named parameter list and group list. * \since QGIS 3.0 */ QgsExpressionFunction( const QString &fnname, @@ -187,7 +194,8 @@ class CORE_EXPORT QgsExpressionFunction return min; } - /** Returns the list of named parameters for the function, if set. + /** + * Returns the list of named parameters for the function, if set. * \since QGIS 2.16 */ const QgsExpressionFunction::ParameterList ¶meters() const { return mParameterList; } @@ -242,23 +250,27 @@ class CORE_EXPORT QgsExpressionFunction */ virtual QSet referencedColumns( const QgsExpressionNodeFunction *node ) const; - /** Returns whether the function is only available if provided by a QgsExpressionContext object. + /** + * Returns whether the function is only available if provided by a QgsExpressionContext object. * \since QGIS 2.12 */ bool isContextual() const { return mIsContextual; } - /** Returns true if the function is deprecated and should not be presented as a valid option + /** + * Returns true if the function is deprecated and should not be presented as a valid option * to users in expression builders. * \since QGIS 3.0 */ virtual bool isDeprecated() const; - /** Returns the first group which the function belongs to. + /** + * Returns the first group which the function belongs to. * \note consider using groups() instead, as some functions naturally belong in multiple groups */ QString group() const { return mGroups.isEmpty() ? QString() : mGroups.at( 0 ); } - /** Returns a list of the groups the function belongs to. + /** + * Returns a list of the groups the function belongs to. * \since QGIS 3.0 * \see group() */ @@ -267,7 +279,8 @@ class CORE_EXPORT QgsExpressionFunction //! The help text for the function. const QString helpText() const; - /** Returns result of evaluating the function. + /** + * Returns result of evaluating the function. * \param values list of values passed to the function * \param context context expression is being evaluated against * \param parent parent expression @@ -306,7 +319,8 @@ class CORE_EXPORT QgsExpressionFunction bool mIsContextual; //if true function is only available through an expression context }; -/** \ingroup core +/** + * \ingroup core * c++ helper class for defining QgsExpression functions. * \note not available in Python bindings */ @@ -315,7 +329,8 @@ class QgsStaticExpressionFunction : public QgsExpressionFunction { public: - /** Static function for evaluation against a QgsExpressionContext, using an unnamed list of parameter values. + /** + * Static function for evaluation against a QgsExpressionContext, using an unnamed list of parameter values. */ QgsStaticExpressionFunction( const QString &fnname, int params, @@ -335,7 +350,8 @@ class QgsStaticExpressionFunction : public QgsExpressionFunction { } - /** Static function for evaluation against a QgsExpressionContext, using a named list of parameter values. + /** + * Static function for evaluation against a QgsExpressionContext, using a named list of parameter values. */ QgsStaticExpressionFunction( const QString &fnname, const QgsExpressionFunction::ParameterList ¶ms, @@ -377,7 +393,8 @@ class QgsStaticExpressionFunction : public QgsExpressionFunction bool handlesNull = false ); - /** Static function for evaluation against a QgsExpressionContext, using a named list of parameter values and list + /** + * Static function for evaluation against a QgsExpressionContext, using a named list of parameter values and list * of groups. */ QgsStaticExpressionFunction( const QString &fnname, @@ -397,7 +414,8 @@ class QgsStaticExpressionFunction : public QgsExpressionFunction , mReferencedColumns( referencedColumns ) {} - /** Returns result of evaluating the function. + /** + * Returns result of evaluating the function. * \param values list of values passed to the function * \param context context expression is being evaluated against * \param parent parent expression diff --git a/src/core/expression/qgsexpressionnode.h b/src/core/expression/qgsexpressionnode.h index e8e26275c4c3..1346a89a8ce0 100644 --- a/src/core/expression/qgsexpressionnode.h +++ b/src/core/expression/qgsexpressionnode.h @@ -90,7 +90,8 @@ class CORE_EXPORT QgsExpressionNode SIP_ABSTRACT { public: - /** Constructor for NamedNode + /** + * Constructor for NamedNode * \param name node name * \param node node */ @@ -106,7 +107,8 @@ class CORE_EXPORT QgsExpressionNode SIP_ABSTRACT QgsExpressionNode *node = nullptr; }; - /** \ingroup core + /** + * \ingroup core */ class CORE_EXPORT NodeList { @@ -115,12 +117,14 @@ class CORE_EXPORT QgsExpressionNode SIP_ABSTRACT //! Takes ownership of the provided node void append( QgsExpressionNode *node SIP_TRANSFER ) { mList.append( node ); mNameList.append( QString() ); } - /** Adds a named node. Takes ownership of the provided node. + /** + * Adds a named node. Takes ownership of the provided node. * \since QGIS 2.16 */ void append( QgsExpressionNode::NamedNode *node SIP_TRANSFER ); - /** Returns the number of nodes in the list. + /** + * Returns the number of nodes in the list. */ int count() const { return mList.count(); } diff --git a/src/core/expression/qgsexpressionnodeimpl.h b/src/core/expression/qgsexpressionnodeimpl.h index e7b8009e1d38..1b7753c1d433 100644 --- a/src/core/expression/qgsexpressionnodeimpl.h +++ b/src/core/expression/qgsexpressionnodeimpl.h @@ -20,7 +20,8 @@ #include "qgsexpressionnode.h" #include "qgsinterval.h" -/** \ingroup core +/** + * \ingroup core * A unary node is either negative as in boolean (not) or as in numbers (minus). */ class CORE_EXPORT QgsExpressionNodeUnaryOperator : public QgsExpressionNode @@ -74,7 +75,8 @@ class CORE_EXPORT QgsExpressionNodeUnaryOperator : public QgsExpressionNode static const char *UNARY_OPERATOR_TEXT[]; }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsExpressionNodeBinaryOperator : public QgsExpressionNode { @@ -157,7 +159,8 @@ class CORE_EXPORT QgsExpressionNodeBinaryOperator : public QgsExpressionNode qlonglong computeInt( qlonglong x, qlonglong y ); double computeDouble( double x, double y ); - /** Computes the result date time calculation from a start datetime and an interval + /** + * Computes the result date time calculation from a start datetime and an interval * \param d start datetime * \param i interval to add or subtract (depending on mOp) */ @@ -170,7 +173,8 @@ class CORE_EXPORT QgsExpressionNodeBinaryOperator : public QgsExpressionNode static const char *BINARY_OPERATOR_TEXT[]; }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsExpressionNodeInOperator : public QgsExpressionNode { @@ -207,7 +211,8 @@ class CORE_EXPORT QgsExpressionNodeInOperator : public QgsExpressionNode bool mNotIn; }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsExpressionNodeFunction : public QgsExpressionNode { @@ -243,7 +248,8 @@ class CORE_EXPORT QgsExpressionNodeFunction : public QgsExpressionNode NodeList *mArgs = nullptr; }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsExpressionNodeLiteral : public QgsExpressionNode { @@ -270,7 +276,8 @@ class CORE_EXPORT QgsExpressionNodeLiteral : public QgsExpressionNode QVariant mValue; }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsExpressionNodeColumnRef : public QgsExpressionNode { @@ -300,7 +307,8 @@ class CORE_EXPORT QgsExpressionNodeColumnRef : public QgsExpressionNode int mIndex; }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsExpressionNodeCondition : public QgsExpressionNode { diff --git a/src/core/geometry/qgsabstractgeometry.h b/src/core/geometry/qgsabstractgeometry.h index 5aac447ca60e..753972ac7882 100644 --- a/src/core/geometry/qgsabstractgeometry.h +++ b/src/core/geometry/qgsabstractgeometry.h @@ -43,7 +43,8 @@ typedef QList< QList< QgsPoint > > QgsRingSequence; typedef QList< QList< QList< QgsPoint > > > QgsCoordinateSequence; #endif -/** \ingroup core +/** + * \ingroup core * \class QgsAbstractGeometry * \brief Abstract base class for all geometries * \since QGIS 2.10 @@ -89,11 +90,13 @@ class CORE_EXPORT QgsAbstractGeometry enum SegmentationToleranceType { - /** Maximum angle between generating radii (lines from arc center + /** + * Maximum angle between generating radii (lines from arc center * to output vertices) */ MaximumAngle = 0, - /** Maximum distance between an arbitrary point on the original + /** + * Maximum distance between an arbitrary point on the original * curve and closest point on its approximation. */ MaximumDifference }; @@ -106,54 +109,64 @@ class CORE_EXPORT QgsAbstractGeometry QgsAbstractGeometry( const QgsAbstractGeometry &geom ); QgsAbstractGeometry &operator=( const QgsAbstractGeometry &geom ); - /** Clones the geometry by performing a deep copy + /** + * Clones the geometry by performing a deep copy */ virtual QgsAbstractGeometry *clone() const = 0 SIP_FACTORY; - /** Clears the geometry, ie reset it to a null geometry + /** + * Clears the geometry, ie reset it to a null geometry */ virtual void clear() = 0; - /** Returns the minimal bounding box for the geometry + /** + * Returns the minimal bounding box for the geometry */ virtual QgsRectangle boundingBox() const = 0; //mm-sql interface - /** Returns the inherent dimension of the geometry. For example, this is 0 for a point geometry, + /** + * Returns the inherent dimension of the geometry. For example, this is 0 for a point geometry, * 1 for a linestring and 2 for a polygon. */ virtual int dimension() const = 0; - /** Returns a unique string representing the geometry type. + /** + * Returns a unique string representing the geometry type. * \see wkbType * \see wktTypeStr */ virtual QString geometryType() const = 0; - /** Returns the WKB type of the geometry. + /** + * Returns the WKB type of the geometry. * \see geometryType * \see wktTypeStr */ inline QgsWkbTypes::Type wkbType() const { return mWkbType; } - /** Returns the WKT type string of the geometry. + /** + * Returns the WKT type string of the geometry. * \see geometryType * \see wkbType */ QString wktTypeStr() const; - /** Returns true if the geometry is 3D and contains a z-value. + /** + * Returns true if the geometry is 3D and contains a z-value. * \see isMeasure */ bool is3D() const; - /** Returns true if the geometry contains m values. + /** + * Returns true if the geometry contains m values. * \see is3D */ bool isMeasure() const; - /** Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). + /** + * Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). * For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon. * \returns boundary for geometry. May be null for some geometry types. * \since QGIS 3.0 @@ -162,20 +175,23 @@ class CORE_EXPORT QgsAbstractGeometry //import - /** Sets the geometry from a WKB string. + /** + * Sets the geometry from a WKB string. * After successful read the wkb argument will be at the position where the reading has stopped. * \see fromWkt */ virtual bool fromWkb( QgsConstWkbPtr &wkb ) = 0; - /** Sets the geometry from a WKT string. + /** + * Sets the geometry from a WKT string. * \see fromWkb */ virtual bool fromWkt( const QString &wkt ) = 0; //export - /** Returns a WKB representation of the geometry. + /** + * Returns a WKB representation of the geometry. * \see asWkt * \see asGML2 * \see asGML3 @@ -184,7 +200,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual QByteArray asWkb() const = 0; - /** Returns a WKT representation of the geometry. + /** + * Returns a WKT representation of the geometry. * \param precision number of decimal places for coordinates * \see asWkb * \see asGML2 @@ -193,7 +210,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual QString asWkt( int precision = 17 ) const = 0; - /** Returns a GML2 representation of the geometry. + /** + * Returns a GML2 representation of the geometry. * \param doc DOM document * \param precision number of decimal places for coordinates * \param ns XML namespace @@ -204,7 +222,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual QDomElement asGML2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const = 0; - /** Returns a GML3 representation of the geometry. + /** + * Returns a GML3 representation of the geometry. * \param doc DOM document * \param precision number of decimal places for coordinates * \param ns XML namespace @@ -215,7 +234,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual QDomElement asGML3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const = 0; - /** Returns a GeoJSON representation of the geometry. + /** + * Returns a GeoJSON representation of the geometry. * \param precision number of decimal places for coordinates * \see asWkb * \see asWkt @@ -226,7 +246,8 @@ class CORE_EXPORT QgsAbstractGeometry //render pipeline - /** Transforms the geometry using a coordinate transform + /** + * Transforms the geometry using a coordinate transform * \param ct coordinate transform * \param d transformation direction * \param transformZ set to true to also transform z coordinates. This requires that @@ -239,17 +260,20 @@ class CORE_EXPORT QgsAbstractGeometry QgsCoordinateTransform::TransformDirection d = QgsCoordinateTransform::ForwardTransform, bool transformZ = false ) = 0; - /** Transforms the geometry using a QTransform object + /** + * Transforms the geometry using a QTransform object * \param t QTransform transformation */ virtual void transform( const QTransform &t ) = 0; - /** Draws the geometry using the specified QPainter. + /** + * Draws the geometry using the specified QPainter. * \param p destination QPainter */ virtual void draw( QPainter &p ) const = 0; - /** Returns next vertex id and coordinates + /** + * Returns next vertex id and coordinates * \param id initial value should be the starting vertex id. The next vertex id will be stored * in this variable if found. * \param vertex container for found node @@ -257,20 +281,24 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const = 0; - /** Retrieves the sequence of geometries, rings and nodes. + /** + * Retrieves the sequence of geometries, rings and nodes. * \returns coordinate sequence */ virtual QgsCoordinateSequence coordinateSequence() const = 0; - /** Returns the number of nodes contained in the geometry + /** + * Returns the number of nodes contained in the geometry */ virtual int nCoordinates() const; - /** Returns the point corresponding to a specified vertex id + /** + * Returns the point corresponding to a specified vertex id */ virtual QgsPoint vertexAt( QgsVertexId id ) const = 0; - /** Searches for the closest segment of the geometry to a given point. + /** + * Searches for the closest segment of the geometry to a given point. * \param pt specifies the point to find closest segment to * \param segmentPt storage for the closest point within the geometry * \param vertexAfter storage for the ID of the vertex at the end of the closest segment @@ -285,7 +313,8 @@ class CORE_EXPORT QgsAbstractGeometry //low-level editing - /** Inserts a vertex into the geometry + /** + * Inserts a vertex into the geometry * \param position vertex id for position of inserted vertex * \param vertex vertex to insert * \returns true if insert was successful @@ -294,7 +323,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual bool insertVertex( QgsVertexId position, const QgsPoint &vertex ) = 0; - /** Moves a vertex within the geometry + /** + * Moves a vertex within the geometry * \param position vertex id for vertex to move * \param newPos new position of vertex * \returns true if move was successful @@ -303,7 +333,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual bool moveVertex( QgsVertexId position, const QgsPoint &newPos ) = 0; - /** Deletes a vertex within the geometry + /** + * Deletes a vertex within the geometry * \param position vertex id for vertex to delete * \returns true if delete was successful * \see insertVertex @@ -311,19 +342,22 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual bool deleteVertex( QgsVertexId position ) = 0; - /** Returns the length of the geometry. + /** + * Returns the length of the geometry. * \see area() * \see perimeter() */ virtual double length() const; - /** Returns the perimeter of the geometry. + /** + * Returns the perimeter of the geometry. * \see area() * \see length() */ virtual double perimeter() const; - /** Returns the area of the geometry. + /** + * Returns the area of the geometry. * \see length() * \see perimeter() */ @@ -332,15 +366,18 @@ class CORE_EXPORT QgsAbstractGeometry //! Returns the centroid of the geometry virtual QgsPoint centroid() const; - /** Returns true if the geometry is empty + /** + * Returns true if the geometry is empty */ virtual bool isEmpty() const; - /** Returns true if the geometry contains curved segments + /** + * Returns true if the geometry contains curved segments */ virtual bool hasCurvedSegments() const; - /** Returns a version of the geometry without curves. Caller takes ownership of + /** + * Returns a version of the geometry without curves. Caller takes ownership of * the returned geometry. * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve @@ -355,7 +392,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual QgsAbstractGeometry *toCurveType() const = 0 SIP_FACTORY; - /** Returns approximate angle at a vertex. This is usually the average angle between adjacent + /** + * Returns approximate angle at a vertex. This is usually the average angle between adjacent * segments, and can be pictured as the orientation of a line following the curvature of the * geometry at the specified vertex. * \param vertex the vertex id @@ -373,13 +411,15 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual int ringCount( int part = 0 ) const = 0; - /** Returns count of parts contained in the geometry. + /** + * Returns count of parts contained in the geometry. * \see vertexCount * \see ringCount */ virtual int partCount() const = 0; - /** Adds a z-dimension to the geometry, initialized to a preset value. + /** + * Adds a z-dimension to the geometry, initialized to a preset value. * \param zValue initial z-value for all nodes * \returns true on success * \since QGIS 2.12 @@ -388,7 +428,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual bool addZValue( double zValue = 0 ) = 0; - /** Adds a measure to the geometry, initialized to a preset value. + /** + * Adds a measure to the geometry, initialized to a preset value. * \param mValue initial m-value for all nodes * \returns true on success * \since QGIS 2.12 @@ -397,7 +438,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual bool addMValue( double mValue = 0 ) = 0; - /** Drops any z-dimensions which exist in the geometry. + /** + * Drops any z-dimensions which exist in the geometry. * \returns true if Z values were present and have been removed * \see addZValue() * \see dropMValue() @@ -405,7 +447,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual bool dropZValue() = 0; - /** Drops any measure values which exist in the geometry. + /** + * Drops any measure values which exist in the geometry. * \returns true if m-values were present and have been removed * \see addMValue() * \see dropZValue() @@ -413,7 +456,8 @@ class CORE_EXPORT QgsAbstractGeometry */ virtual bool dropMValue() = 0; - /** Converts the geometry to a specified type. + /** + * Converts the geometry to a specified type. * \returns true if conversion was successful * \since QGIS 2.14 */ @@ -422,23 +466,27 @@ class CORE_EXPORT QgsAbstractGeometry protected: QgsWkbTypes::Type mWkbType = QgsWkbTypes::Unknown; - /** Updates the geometry type based on whether sub geometries contain z or m values. + /** + * Updates the geometry type based on whether sub geometries contain z or m values. */ void setZMTypeFromSubGeometry( const QgsAbstractGeometry *subggeom, QgsWkbTypes::Type baseGeomType ); - /** Default calculator for the minimal bounding box for the geometry. Derived classes should override this method + /** + * Default calculator for the minimal bounding box for the geometry. Derived classes should override this method * if a more efficient bounding box calculation is available. */ virtual QgsRectangle calculateBoundingBox() const; - /** Clears any cached parameters associated with the geometry, e.g., bounding boxes + /** + * Clears any cached parameters associated with the geometry, e.g., bounding boxes */ virtual void clearCache() const; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVertexId * \brief Utility class for identifying a unique vertex within a geometry. * \since QGIS 2.10 @@ -458,7 +506,8 @@ struct CORE_EXPORT QgsVertexId , type( _type ) {} - /** Returns true if the vertex id is valid + /** + * Returns true if the vertex id is valid */ bool isValid() const { return part >= 0 && ring >= 0 && vertex >= 0; } diff --git a/src/core/geometry/qgsbox3d.h b/src/core/geometry/qgsbox3d.h index 2917fefdfcf2..24571d662c12 100644 --- a/src/core/geometry/qgsbox3d.h +++ b/src/core/geometry/qgsbox3d.h @@ -22,7 +22,8 @@ #include "qgsrectangle.h" #include "qgspoint.h" -/** \ingroup core +/** + * \ingroup core * A 3-dimensional box composed of x, y, z coordinates. * * A box composed of x/y/z minimum and maximum values. It is often used to return the 3D diff --git a/src/core/geometry/qgscircle.h b/src/core/geometry/qgscircle.h index 0c5a125c47b2..5179126b63c4 100644 --- a/src/core/geometry/qgscircle.h +++ b/src/core/geometry/qgscircle.h @@ -28,7 +28,8 @@ #include "qgscircularstring.h" -/** \ingroup core +/** + * \ingroup core * \class QgsCircle * \brief Circle geometry type. * @@ -43,7 +44,8 @@ class CORE_EXPORT QgsCircle : public QgsEllipse public: QgsCircle(); - /** Constructs a circle by defining all the members. + /** + * Constructs a circle by defining all the members. * \param center The center of the circle. * \param radius The radius of the circle. * \param azimuth Angle in degrees started from the North to the first quadrant. @@ -139,13 +141,15 @@ class CORE_EXPORT QgsCircle : public QgsEllipse // double azimuth() const {return mAzimuth; } - /** Inherited method. Use setRadius instead. + /** + * Inherited method. Use setRadius instead. * \see radius() * \see setRadius() */ void setSemiMajorAxis( const double semiMajorAxis ) override; - /** Inherited method. Use setRadius instead. + /** + * Inherited method. Use setRadius instead. * \see radius() * \see setRadius() */ @@ -160,14 +164,16 @@ class CORE_EXPORT QgsCircle : public QgsEllipse mSemiMinorAxis = mSemiMajorAxis; } - /** The four quadrants of the ellipse. + /** + * The four quadrants of the ellipse. * They are oriented and started from North. * \return quadrants defined by four points. * \see quadrant() */ QVector northQuadrant() const SIP_FACTORY; - /** Returns a circular string from the circle. + /** + * Returns a circular string from the circle. * \param oriented If oriented is true the start point is from azimuth instead from north. */ QgsCircularString *toCircularString( bool oriented = false ) const; diff --git a/src/core/geometry/qgscircularstring.h b/src/core/geometry/qgscircularstring.h index 70dd9ea4d80b..c8b65344ca6b 100644 --- a/src/core/geometry/qgscircularstring.h +++ b/src/core/geometry/qgscircularstring.h @@ -25,7 +25,8 @@ #include "qgscurve.h" -/** \ingroup core +/** + * \ingroup core * \class QgsCircularString * \brief Circular string geometry type * \since QGIS 2.10 @@ -55,13 +56,15 @@ class CORE_EXPORT QgsCircularString: public QgsCurve bool isEmpty() const override; int numPoints() const override; - /** Returns the point at index i within the circular string. + /** + * Returns the point at index i within the circular string. */ QgsPoint pointN( int i ) const; void points( QgsPointSequence &pts SIP_OUT ) const override; - /** Sets the circular string's points + /** + * Sets the circular string's points */ void setPoints( const QgsPointSequence &points ); @@ -69,7 +72,8 @@ class CORE_EXPORT QgsCircularString: public QgsCurve virtual QgsPoint startPoint() const override; virtual QgsPoint endPoint() const override; - /** Returns a new line string geometry corresponding to a segmentized approximation + /** + * Returns a new line string geometry corresponding to a segmentized approximation * of the curve. * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve @@ -99,7 +103,8 @@ class CORE_EXPORT QgsCircularString: public QgsCurve void sumUpArea( double &sum SIP_OUT ) const override; bool hasCurvedSegments() const override; - /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. + /** + * Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. \param vertex the vertex id \returns rotation in radians, clockwise from north*/ double vertexAngle( QgsVertexId vertex ) const override; diff --git a/src/core/geometry/qgscompoundcurve.h b/src/core/geometry/qgscompoundcurve.h index 9d09a32f1f21..4a1807532aeb 100644 --- a/src/core/geometry/qgscompoundcurve.h +++ b/src/core/geometry/qgscompoundcurve.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgscurve.h" -/** \ingroup core +/** + * \ingroup core * \class QgsCompoundCurve * \brief Compound curve geometry type * \since QGIS 2.10 @@ -60,30 +61,36 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve virtual int numPoints() const override; bool isEmpty() const override; - /** Returns a new line string geometry corresponding to a segmentized approximation + /** + * Returns a new line string geometry corresponding to a segmentized approximation * of the curve. * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY; - /** Returns the number of curves in the geometry. + /** + * Returns the number of curves in the geometry. */ int nCurves() const { return mCurves.size(); } - /** Returns the curve at the specified index. + /** + * Returns the curve at the specified index. */ const QgsCurve *curveAt( int i ) const; - /** Adds a curve to the geometry (takes ownership) + /** + * Adds a curve to the geometry (takes ownership) */ void addCurve( QgsCurve *c SIP_TRANSFER ); - /** Removes a curve from the geometry. + /** + * Removes a curve from the geometry. * \param i index of curve to remove */ void removeCurve( int i ); - /** Adds a vertex to the end of the geometry. + /** + * Adds a vertex to the end of the geometry. */ void addVertex( const QgsPoint &pt ); @@ -111,7 +118,8 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve bool hasCurvedSegments() const override; - /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. + /** + * Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. \param vertex the vertex id \returns rotation in radians, clockwise from north*/ double vertexAngle( QgsVertexId vertex ) const override; @@ -150,7 +158,8 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve private: QList< QgsCurve * > mCurves; - /** Turns a vertex id for the compound curve into one or more ids for the subcurves + /** + * Turns a vertex id for the compound curve into one or more ids for the subcurves \returns the index of the subcurve or -1 in case of error*/ QList< QPair > curveVertexId( QgsVertexId id ) const; diff --git a/src/core/geometry/qgscurve.h b/src/core/geometry/qgscurve.h index d65f911a0904..a3509cb401dc 100644 --- a/src/core/geometry/qgscurve.h +++ b/src/core/geometry/qgscurve.h @@ -26,7 +26,8 @@ class QgsLineString; class QPainterPath; -/** \ingroup core +/** + * \ingroup core * \class QgsCurve * \brief Abstract base class for curved geometry type * \since QGIS 2.10 @@ -45,55 +46,66 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry QgsCurve *clone() const override = 0 SIP_FACTORY; - /** Returns the starting point of the curve. + /** + * Returns the starting point of the curve. * \see endPoint */ virtual QgsPoint startPoint() const = 0; - /** Returns the end point of the curve. + /** + * Returns the end point of the curve. * \see startPoint */ virtual QgsPoint endPoint() const = 0; - /** Returns true if the curve is closed. + /** + * Returns true if the curve is closed. */ virtual bool isClosed() const; - /** Returns true if the curve is a ring. + /** + * Returns true if the curve is a ring. */ virtual bool isRing() const; - /** Returns a new line string geometry corresponding to a segmentized approximation + /** + * Returns a new line string geometry corresponding to a segmentized approximation * of the curve. * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ virtual QgsLineString *curveToLine( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const = 0 SIP_FACTORY; - /** Adds a curve to a painter path. + /** + * Adds a curve to a painter path. */ virtual void addToPainterPath( QPainterPath &path ) const = 0; - /** Draws the curve as a polygon on the specified QPainter. + /** + * Draws the curve as a polygon on the specified QPainter. * \param p destination QPainter */ virtual void drawAsPolygon( QPainter &p ) const = 0; - /** Returns a list of points within the curve. + /** + * Returns a list of points within the curve. */ virtual void points( QgsPointSequence &pt SIP_OUT ) const = 0; - /** Returns the number of points in the curve. + /** + * Returns the number of points in the curve. */ virtual int numPoints() const = 0; - /** Sums up the area of the curve by iterating over the vertices (shoelace formula). + /** + * Sums up the area of the curve by iterating over the vertices (shoelace formula). */ virtual void sumUpArea( double &sum SIP_OUT ) const = 0; QgsCoordinateSequence coordinateSequence() const override; bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const override; - /** Returns the point and vertex id of a point within the curve. + /** + * Returns the point and vertex id of a point within the curve. * \param node node number, where the first node is 0 * \param point will be set to point at corresponding node in the curve * \param type will be set to the vertex type of the node @@ -101,14 +113,16 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry */ virtual bool pointAt( int node, QgsPoint &point SIP_OUT, QgsVertexId::VertexType &type SIP_OUT ) const = 0; - /** Returns a reversed copy of the curve, where the direction of the curve has been flipped. + /** + * Returns a reversed copy of the curve, where the direction of the curve has been flipped. * \since QGIS 2.14 */ virtual QgsCurve *reversed() const = 0 SIP_FACTORY; QgsAbstractGeometry *boundary() const override SIP_FACTORY; - /** Returns a geometry without curves. Caller takes ownership + /** + * Returns a geometry without curves. Caller takes ownership * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ QgsCurve *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY; @@ -121,21 +135,24 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry QgsRectangle boundingBox() const override; - /** Returns the x-coordinate of the specified node in the line string. + /** + * Returns the x-coordinate of the specified node in the line string. * \param index index of node, where the first node in the line is 0 * \returns x-coordinate of node, or 0.0 if index is out of bounds * \see setXAt() */ virtual double xAt( int index ) const = 0; - /** Returns the y-coordinate of the specified node in the line string. + /** + * Returns the y-coordinate of the specified node in the line string. * \param index index of node, where the first node in the line is 0 * \returns y-coordinate of node, or 0.0 if index is out of bounds * \see setYAt() */ virtual double yAt( int index ) const = 0; - /** Returns a QPolygonF representing the points. + /** + * Returns a QPolygonF representing the points. */ QPolygonF asQPolygonF() const; diff --git a/src/core/geometry/qgscurvepolygon.h b/src/core/geometry/qgscurvepolygon.h index b969567b81a4..4ffff2cc105d 100644 --- a/src/core/geometry/qgscurvepolygon.h +++ b/src/core/geometry/qgscurvepolygon.h @@ -25,7 +25,8 @@ class QgsPolygonV2; -/** \ingroup core +/** + * \ingroup core * \class QgsCurvePolygon * \brief Curve polygon geometry type * \since QGIS 2.10 @@ -67,13 +68,15 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface const QgsCurve *exteriorRing() const; const QgsCurve *interiorRing( int i ) const; - /** Returns a new polygon geometry corresponding to a segmentized approximation + /** + * Returns a new polygon geometry corresponding to a segmentized approximation * of the curve. * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ virtual QgsPolygonV2 *toPolygon( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const SIP_FACTORY; - /** Sets the exterior ring of the polygon. The CurvePolygon type will be updated to match the dimensionality + /** + * Sets the exterior ring of the polygon. The CurvePolygon type will be updated to match the dimensionality * of the exterior ring. For instance, setting a 2D exterior ring on a 3D CurvePolygon will drop the z dimension * from the CurvePolygon and all interior rings. * \param ring new exterior ring. Ownership is transferred to the CurvePolygon. @@ -122,12 +125,14 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface bool hasCurvedSegments() const override; - /** Returns a geometry without curves. Caller takes ownership + /** + * Returns a geometry without curves. Caller takes ownership * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY; - /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. + /** + * Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. * \param vertex the vertex id * \returns rotation in radians, clockwise from north */ diff --git a/src/core/geometry/qgsellipse.h b/src/core/geometry/qgsellipse.h index f0c7dfebe438..6a5ff08a8267 100644 --- a/src/core/geometry/qgsellipse.h +++ b/src/core/geometry/qgsellipse.h @@ -26,7 +26,8 @@ #include "qgslinestring.h" #include "qgsrectangle.h" -/** \ingroup core +/** + * \ingroup core * \class QgsEllipse * \brief Ellipse geometry type. * @@ -47,7 +48,8 @@ class CORE_EXPORT QgsEllipse virtual ~QgsEllipse() = default; - /** Constructs an ellipse by defining all the members. + /** + * Constructs an ellipse by defining all the members. * \param center The center of the ellipse. * \param semiMajorAxis Semi-major axis of the ellipse. * \param semiMinorAxis Semi-minor axis of the ellipse. @@ -103,28 +105,33 @@ class CORE_EXPORT QgsEllipse //! An ellipse is empty if axes are equal to 0 virtual bool isEmpty() const; - /** Returns the center point. + /** + * Returns the center point. * \see setCenter() * \see rcenter() */ QgsPoint center() const {return mCenter; } - /** Returns the semi-major axis. + /** + * Returns the semi-major axis. * \see setSemiMajorAxis() */ double semiMajorAxis() const {return mSemiMajorAxis; } - /** Returns the semi-minor axis. + /** + * Returns the semi-minor axis. * \see setSemiMinorAxis() */ double semiMinorAxis() const {return mSemiMinorAxis; } - /** Returns the azimuth. + /** + * Returns the azimuth. * \see setAzimuth() */ double azimuth() const {return mAzimuth; } - /** Returns a reference to the center point of this ellipse. + /** + * Returns a reference to the center point of this ellipse. * Using a reference makes it possible to directly manipulate center in place. * \see center() * \see setCenter() @@ -132,42 +139,49 @@ class CORE_EXPORT QgsEllipse */ QgsPoint &rcenter() SIP_SKIP { return mCenter; } - /** Sets the center point. + /** + * Sets the center point. * \see center() * \see rcenter() */ void setCenter( const QgsPoint ¢er ) {mCenter = center; } - /** Sets the semi-major axis. + /** + * Sets the semi-major axis. * \see semiMajorAxis() */ virtual void setSemiMajorAxis( const double semiMajorAxis ); - /** Sets the semi-minor axis. + /** + * Sets the semi-minor axis. * \see semiMinorAxis() */ virtual void setSemiMinorAxis( const double semiMinorAxis ); - /** Sets the azimuth (orientation). + /** + * Sets the azimuth (orientation). * \see azimuth() */ void setAzimuth( const double azimuth ); - /** The distance between the center and each foci. + /** + * The distance between the center and each foci. * \see fromFoci() * \see foci() * \return The distance between the center and each foci. */ virtual double focusDistance() const; - /** Two foci of the ellipse. The axes are oriented by the azimuth and are on the semi-major axis. + /** + * Two foci of the ellipse. The axes are oriented by the azimuth and are on the semi-major axis. * \see fromFoci() * \see focusDistance() * \return the two foci. */ virtual QVector foci() const; - /** The eccentricity of the ellipse. + /** + * The eccentricity of the ellipse. * nan is returned if the ellipse is empty. */ virtual double eccentricity() const; @@ -176,33 +190,39 @@ class CORE_EXPORT QgsEllipse //! The circumference of the ellipse using first approximation of Ramanujan. virtual double perimeter() const; - /** The four quadrants of the ellipse. + /** + * The four quadrants of the ellipse. * They are oriented and started always from semi-major axis. * \return quadrants defined by four points. */ virtual QVector quadrant() const; - /** Returns a list of points with segmentation from \a segments. + /** + * Returns a list of points with segmentation from \a segments. * \param segments Number of segments used to segment geometry. */ virtual QgsPointSequence points( unsigned int segments = 36 ) const; - /** Returns a segmented polygon. + /** + * Returns a segmented polygon. * \param segments Number of segments used to segment geometry. */ virtual QgsPolygonV2 *toPolygon( unsigned int segments = 36 ) const SIP_FACTORY; - /** Returns a segmented linestring. + /** + * Returns a segmented linestring. * \param segments Number of segments used to segment geometry. */ virtual QgsLineString *toLineString( unsigned int segments = 36 ) const SIP_FACTORY; //virtual QgsCurvePolygon toCurvePolygon() const; - /** Returns the oriented minimal bounding box for the ellipse. + /** + * Returns the oriented minimal bounding box for the ellipse. */ virtual QgsPolygonV2 *orientedBoundingBox() const SIP_FACTORY; - /** Returns the minimal bounding box for the ellipse. + /** + * Returns the minimal bounding box for the ellipse. */ virtual QgsRectangle boundingBox() const; diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h index 661108509a26..9d0d1564bfa8 100644 --- a/src/core/geometry/qgsgeometry.h +++ b/src/core/geometry/qgsgeometry.h @@ -80,7 +80,8 @@ class QgsConstWkbPtr; struct QgsGeometryPrivate; -/** \ingroup core +/** + * \ingroup core * A geometry is the spatial representation of a feature. Since QGIS 2.10, QgsGeometry acts as a generic container * for geometry objects. QgsGeometry is implicitly shared, so making copies of geometries is inexpensive. The geometry * container class can also be stored inside a QVariant object. @@ -200,19 +201,22 @@ class CORE_EXPORT QgsGeometry */ void fromWkb( const QByteArray &wkb ); - /** Returns a geos geometry - caller takes ownership of the object (should be deleted with GEOSGeom_destroy_r) + /** + * Returns a geos geometry - caller takes ownership of the object (should be deleted with GEOSGeom_destroy_r) * \param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed. * \since QGIS 3.0 * \note not available in Python bindings */ GEOSGeometry *exportToGeos( double precision = 0 ) const SIP_SKIP; - /** Returns type of the geometry as a WKB type (point / linestring / polygon etc.) + /** + * Returns type of the geometry as a WKB type (point / linestring / polygon etc.) * \see type */ QgsWkbTypes::Type wkbType() const; - /** Returns type of the geometry as a QgsWkbTypes::GeometryType + /** + * Returns type of the geometry as a QgsWkbTypes::GeometryType * \see wkbType */ QgsWkbTypes::GeometryType type() const; @@ -228,17 +232,20 @@ class CORE_EXPORT QgsGeometry //! Returns true if WKB of the geometry is of WKBMulti* type bool isMultipart() const; - /** Compares the geometry with another geometry using GEOS + /** + * Compares the geometry with another geometry using GEOS * \since QGIS 1.5 */ bool isGeosEqual( const QgsGeometry & ) const; - /** Checks validity of the geometry using GEOS + /** + * Checks validity of the geometry using GEOS * \since QGIS 1.5 */ bool isGeosValid() const; - /** Determines whether the geometry is simple (according to OGC definition), + /** + * Determines whether the geometry is simple (according to OGC definition), * i.e. it has no anomalous geometric points, such as self-intersection or self-tangency. * Uses GEOS library for the test. * \note This is useful mainly for linestrings and linear rings. Polygons are simple by definition, @@ -352,7 +359,8 @@ class CORE_EXPORT QgsGeometry */ void adjacentVertices( int atVertex, int &beforeVertex SIP_OUT, int &afterVertex SIP_OUT ) const; - /** Insert a new vertex before the given vertex index, + /** + * Insert a new vertex before the given vertex index, * ring and item (first number is index 0) * If the requested vertex number (beforeVertex.back()) is greater * than the last actual vertex on the requested ring and item, @@ -365,7 +373,8 @@ class CORE_EXPORT QgsGeometry */ bool insertVertex( double x, double y, int beforeVertex ); - /** Insert a new vertex before the given vertex index, + /** + * Insert a new vertex before the given vertex index, * ring and item (first number is index 0) * If the requested vertex number (beforeVertex.back()) is greater * than the last actual vertex on the requested ring and item, @@ -637,37 +646,44 @@ class CORE_EXPORT QgsGeometry //! Tests for containment of a point (uses GEOS) bool contains( const QgsPointXY *p ) const; - /** Tests for if geometry is contained in another (uses GEOS) + /** + * Tests for if geometry is contained in another (uses GEOS) * \since QGIS 1.5 */ bool contains( const QgsGeometry &geometry ) const; - /** Tests for if geometry is disjoint of another (uses GEOS) + /** + * Tests for if geometry is disjoint of another (uses GEOS) * \since QGIS 1.5 */ bool disjoint( const QgsGeometry &geometry ) const; - /** Test for if geometry equals another (uses GEOS) + /** + * Test for if geometry equals another (uses GEOS) * \since QGIS 1.5 */ bool equals( const QgsGeometry &geometry ) const; - /** Test for if geometry touch another (uses GEOS) + /** + * Test for if geometry touch another (uses GEOS) * \since QGIS 1.5 */ bool touches( const QgsGeometry &geometry ) const; - /** Test for if geometry overlaps another (uses GEOS) + /** + * Test for if geometry overlaps another (uses GEOS) * \since QGIS 1.5 */ bool overlaps( const QgsGeometry &geometry ) const; - /** Test for if geometry is within another (uses GEOS) + /** + * Test for if geometry is within another (uses GEOS) * \since QGIS 1.5 */ bool within( const QgsGeometry &geometry ) const; - /** Test for if geometry crosses another (uses GEOS) + /** + * Test for if geometry crosses another (uses GEOS) * \since QGIS 1.5 */ bool crosses( const QgsGeometry &geometry ) const; @@ -981,7 +997,8 @@ class CORE_EXPORT QgsGeometry //! Returns an extruded version of this geometry. QgsGeometry extrude( double x, double y ); - /** Export the geometry to WKB + /** + * Export the geometry to WKB * \since QGIS 3.0 */ QByteArray exportToWkb() const; @@ -1139,7 +1156,8 @@ class CORE_EXPORT QgsGeometry */ QgsGeometry makeValid(); - /** \ingroup core + /** + * \ingroup core */ class CORE_EXPORT Error { @@ -1184,7 +1202,8 @@ class CORE_EXPORT QgsGeometry **/ void validateGeometry( QList &errors SIP_OUT, ValidationMethod method = ValidatorQgisInternal ); - /** Compute the unary union on a list of \a geometries. May be faster than an iterative union on a set of geometries. + /** + * Compute the unary union on a list of \a geometries. May be faster than an iterative union on a set of geometries. * The returned geometry will be fully noded, i.e. a node will be created at every common intersection of the * input geometries. An empty geometry will be returned in the case of errors. */ @@ -1298,7 +1317,8 @@ class CORE_EXPORT QgsGeometry #ifndef SIP_RUN - /** Compares two polylines for equality within a specified tolerance. + /** + * Compares two polylines for equality within a specified tolerance. * \param p1 first polyline * \param p2 second polyline * \param epsilon maximum difference for coordinates between the polylines @@ -1518,7 +1538,8 @@ class CORE_EXPORT QgsGeometry //! Try to convert the geometry to a polygon QgsGeometry convertToPolygon( bool destMultipart ) const; - /** Smooths a polyline using the Chaikin algorithm + /** + * Smooths a polyline using the Chaikin algorithm * \param line line to smooth * \param iterations number of smoothing iterations to run. More iterations results * in a smoother geometry @@ -1531,7 +1552,8 @@ class CORE_EXPORT QgsGeometry QgsLineString *smoothLine( const QgsLineString &line, const unsigned int iterations = 1, const double offset = 0.25, double minimumDistance = -1, double maxAngle = 180.0 ) const; - /** Smooths a polygon using the Chaikin algorithm + /** + * Smooths a polygon using the Chaikin algorithm * \param polygon polygon to smooth * \param iterations number of smoothing iterations to run. More iterations results * in a smoother geometry diff --git a/src/core/geometry/qgsgeometrycollection.h b/src/core/geometry/qgsgeometrycollection.h index e88c332b1097..a6d02c911a22 100644 --- a/src/core/geometry/qgsgeometrycollection.h +++ b/src/core/geometry/qgsgeometrycollection.h @@ -25,7 +25,8 @@ email : marco.hugentobler at sourcepole dot com #include "qgspoint.h" -/** \ingroup core +/** + * \ingroup core * \class QgsGeometryCollection * \brief Geometry collection * \since QGIS 2.10 @@ -40,17 +41,20 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry QgsGeometryCollection *clone() const override SIP_FACTORY; - /** Returns the number of geometries within the collection. + /** + * Returns the number of geometries within the collection. */ int numGeometries() const; - /** Returns a const reference to a geometry from within the collection. + /** + * Returns a const reference to a geometry from within the collection. * \param n index of geometry to return * \note not available in Python bindings */ const QgsAbstractGeometry *geometryN( int n ) const SIP_SKIP; - /** Returns a geometry from within the collection. + /** + * Returns a geometry from within the collection. * \param n index of geometry to return */ QgsAbstractGeometry *geometryN( int n ); @@ -65,13 +69,15 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry //! Adds a geometry and takes ownership. Returns true in case of success. virtual bool addGeometry( QgsAbstractGeometry *g SIP_TRANSFER ); - /** Inserts a geometry before a specified index and takes ownership. Returns true in case of success. + /** + * Inserts a geometry before a specified index and takes ownership. Returns true in case of success. * \param g geometry to insert. Ownership is transferred to the collection. * \param index position to insert geometry before */ virtual bool insertGeometry( QgsAbstractGeometry *g SIP_TRANSFER, int index ); - /** Removes a geometry from the collection. + /** + * Removes a geometry from the collection. * \param nr index of geometry to remove * \returns true if removal was successful. */ @@ -110,12 +116,14 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry bool hasCurvedSegments() const override; - /** Returns a geometry without curves. Caller takes ownership + /** + * Returns a geometry without curves. Caller takes ownership * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ QgsAbstractGeometry *segmentize( double tolerance = M_PI_2 / 90, SegmentationToleranceType toleranceType = MaximumAngle ) const override SIP_FACTORY; - /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. + /** + * Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. * \param vertex the vertex id * \returns rotation in radians, clockwise from north */ @@ -152,12 +160,14 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry protected: QVector< QgsAbstractGeometry * > mGeometries; - /** Returns whether child type names are omitted from Wkt representations of the collection + /** + * Returns whether child type names are omitted from Wkt representations of the collection * \since QGIS 2.12 */ virtual bool wktOmitChildType() const; - /** Reads a collection from a WKT string. + /** + * Reads a collection from a WKT string. */ bool fromCollectionWkt( const QString &wkt, const QList &subtypes, const QString &defaultChildWkbType = QString() ); diff --git a/src/core/geometry/qgsgeometryeditutils.h b/src/core/geometry/qgsgeometryeditutils.h index 8c393d4efdbe..3b40d612a96d 100644 --- a/src/core/geometry/qgsgeometryeditutils.h +++ b/src/core/geometry/qgsgeometryeditutils.h @@ -28,7 +28,8 @@ class QgsVectorLayer; #include #include -/** \ingroup core +/** + * \ingroup core * \class QgsGeometryEditUtils * \brief Convenience functions for geometry editing * \since QGIS 2.10 @@ -60,12 +61,14 @@ class QgsGeometryEditUtils */ static bool deleteRing( QgsAbstractGeometry *geom, int ringNum, int partNum = 0 ); - /** Deletes a part from a geometry. + /** + * Deletes a part from a geometry. * \returns true if delete was successful */ static bool deletePart( QgsAbstractGeometry *geom, int partNum ); - /** Alters a geometry so that it avoids intersections with features from all open vector layers. + /** + * Alters a geometry so that it avoids intersections with features from all open vector layers. * \param geom geometry to alter * \param avoidIntersectionsLayers list of layers to check for intersections * \param ignoreFeatures map of layer to feature id of features to ignore diff --git a/src/core/geometry/qgsgeometryengine.h b/src/core/geometry/qgsgeometryengine.h index 79e6bafd60e0..484ec2f74ded 100644 --- a/src/core/geometry/qgsgeometryengine.h +++ b/src/core/geometry/qgsgeometryengine.h @@ -24,7 +24,8 @@ email : marco.hugentobler at sourcepole dot com class QgsAbstractGeometry; -/** \ingroup core +/** + * \ingroup core * \class QgsGeometryEngine * \brief Contains geometry relation and modification algorithms. * \since QGIS 2.10 @@ -172,7 +173,8 @@ class CORE_EXPORT QgsGeometryEngine */ virtual bool disjoint( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const = 0; - /** Returns the Dimensional Extended 9 Intersection Model (DE-9IM) representation of the + /** + * Returns the Dimensional Extended 9 Intersection Model (DE-9IM) representation of the * relationship between the geometries. * \param geom geometry to relate to * \param errorMsg destination storage for any error message @@ -181,7 +183,8 @@ class CORE_EXPORT QgsGeometryEngine */ virtual QString relate( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const = 0; - /** Tests whether two geometries are related by a specified Dimensional Extended 9 Intersection Model (DE-9IM) + /** + * Tests whether two geometries are related by a specified Dimensional Extended 9 Intersection Model (DE-9IM) * pattern. * \param geom geometry to relate to * \param pattern DE-9IM pattern for match @@ -204,7 +207,8 @@ class CORE_EXPORT QgsGeometryEngine virtual bool isEqual( const QgsAbstractGeometry *geom, QString *errorMsg = nullptr ) const = 0; virtual bool isEmpty( QString *errorMsg ) const = 0; - /** Determines whether the geometry is simple (according to OGC definition). + /** + * Determines whether the geometry is simple (according to OGC definition). * \since QGIS 3.0 */ virtual bool isSimple( QString *errorMsg = nullptr ) const = 0; diff --git a/src/core/geometry/qgsgeometryfactory.h b/src/core/geometry/qgsgeometryfactory.h index b18e85b2002d..af8c64849c20 100644 --- a/src/core/geometry/qgsgeometryfactory.h +++ b/src/core/geometry/qgsgeometryfactory.h @@ -42,7 +42,8 @@ typedef QVector QgsMultiPoint; typedef QVector QgsMultiPolyline; typedef QVector QgsMultiPolygon; -/** \ingroup core +/** + * \ingroup core * \class QgsGeometryFactory * \brief Contains geometry creation routines. * \since QGIS 2.10 @@ -52,12 +53,14 @@ class CORE_EXPORT QgsGeometryFactory { public: - /** Construct geometry from a WKB string. + /** + * Construct geometry from a WKB string. * Updates position of the passed WKB pointer. */ static std::unique_ptr< QgsAbstractGeometry > geomFromWkb( QgsConstWkbPtr &wkb ); - /** Construct geometry from a WKT string. + /** + * Construct geometry from a WKT string. */ static std::unique_ptr< QgsAbstractGeometry > geomFromWkt( const QString &text ); diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h index 2f28d22ffb20..52bcc04e002d 100644 --- a/src/core/geometry/qgsgeometryutils.h +++ b/src/core/geometry/qgsgeometryutils.h @@ -25,7 +25,8 @@ email : marco.hugentobler at sourcepole dot com class QgsLineString; -/** \ingroup core +/** + * \ingroup core * \class QgsGeometryUtils * \brief Contains various geometry utility functions. * \since QGIS 2.10 @@ -34,12 +35,14 @@ class CORE_EXPORT QgsGeometryUtils { public: - /** Returns list of linestrings extracted from the passed geometry. The returned objects + /** + * Returns list of linestrings extracted from the passed geometry. The returned objects * have to be deleted by the caller. */ static QList extractLineStrings( const QgsAbstractGeometry *geom ) SIP_FACTORY; - /** Returns the closest vertex to a geometry for a specified point. + /** + * Returns the closest vertex to a geometry for a specified point. * On error null point will be returned and "id" argument will be invalid. */ static QgsPoint closestVertex( const QgsAbstractGeometry &geom, const QgsPoint &pt, QgsVertexId &id SIP_OUT ); @@ -51,7 +54,8 @@ class CORE_EXPORT QgsGeometryUtils */ static QgsPoint closestPoint( const QgsAbstractGeometry &geometry, const QgsPoint &point ); - /** Returns the distance along a geometry from its first vertex to the specified vertex. + /** + * Returns the distance along a geometry from its first vertex to the specified vertex. * \param geom geometry * \param id vertex id to find distance to * \returns distance to vertex (following geometry) @@ -59,7 +63,8 @@ class CORE_EXPORT QgsGeometryUtils */ static double distanceToVertex( const QgsAbstractGeometry &geom, QgsVertexId id ); - /** Retrieves the vertices which are before and after the interpolated point at a specified distance along a linestring + /** + * Retrieves the vertices which are before and after the interpolated point at a specified distance along a linestring * (or polygon boundary). * \param geometry line or polygon geometry * \param distance distance to traverse along geometry @@ -74,15 +79,18 @@ class CORE_EXPORT QgsGeometryUtils QgsVertexId &previousVertex SIP_OUT, QgsVertexId &nextVertex SIP_OUT ); - /** Returns vertices adjacent to a specified vertex within a geometry. + /** + * Returns vertices adjacent to a specified vertex within a geometry. */ static void adjacentVertices( const QgsAbstractGeometry &geom, QgsVertexId atVertex, QgsVertexId &beforeVertex SIP_OUT, QgsVertexId &afterVertex SIP_OUT ); - /** Returns the squared 2D distance between two points. + /** + * Returns the squared 2D distance between two points. */ static double sqrDistance2D( const QgsPoint &pt1, const QgsPoint &pt2 ); - /** Returns the squared distance between a point and a line. + /** + * Returns the squared distance between a point and a line. */ static double sqrDistToLine( double ptX, double ptY, double x1, double y1, double x2, double y2, double &minDistX SIP_OUT, double &minDistY SIP_OUT, double epsilon ); @@ -147,7 +155,8 @@ class CORE_EXPORT QgsGeometryUtils //! Returns < 0 if point(x/y) is left of the line x1,y1 -> x2,y2 static double leftOfLine( double x, double y, double x1, double y1, double x2, double y2 ); - /** Returns a point a specified distance toward a second point. + /** + * Returns a point a specified distance toward a second point. */ static QgsPoint pointOnLineWithDistance( const QgsPoint &startPoint, const QgsPoint &directionPoint, double distance ); @@ -164,7 +173,8 @@ class CORE_EXPORT QgsGeometryUtils //! Returns true if, in a circle, angle is between angle1 and angle2 static bool circleAngleBetween( double angle, double angle1, double angle2, bool clockwise ); - /** Returns true if an angle is between angle1 and angle3 on a circle described by + /** + * Returns true if an angle is between angle1 and angle3 on a circle described by * angle1, angle2 and angle3. */ static bool angleOnCircle( double angle, double angle1, double angle2, double angle3 ); @@ -181,7 +191,8 @@ class CORE_EXPORT QgsGeometryUtils //! Calculates the direction angle of a circle tangent (clockwise from north in radians) static double circleTangentDirection( const QgsPoint &tangentPoint, const QgsPoint &cp1, const QgsPoint &cp2, const QgsPoint &cp3 ); - /** Convert circular arc defined by p1, p2, p3 (p1/p3 being start resp. end point, p2 lies on the arc) into a sequence of points. + /** + * Convert circular arc defined by p1, p2, p3 (p1/p3 being start resp. end point, p2 lies on the arc) into a sequence of points. * \since 3.0 */ static void segmentizeArc( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &p3, @@ -189,18 +200,21 @@ class CORE_EXPORT QgsGeometryUtils QgsAbstractGeometry::SegmentationToleranceType toleranceType = QgsAbstractGeometry::MaximumAngle, bool hasZ = false, bool hasM = false ); - /** For line defined by points pt1 and pt3, find out on which side of the line is point pt3. + /** + * For line defined by points pt1 and pt3, find out on which side of the line is point pt3. * Returns -1 if pt3 on the left side, 1 if pt3 is on the right side or 0 if pt3 lies on the line. * \since 3.0 */ static int segmentSide( const QgsPoint &pt1, const QgsPoint &pt3, const QgsPoint &pt2 ); - /** Interpolate a value at given angle on circular arc given values (zm1, zm2, zm3) at three different angles (a1, a2, a3). + /** + * Interpolate a value at given angle on circular arc given values (zm1, zm2, zm3) at three different angles (a1, a2, a3). * \since 3.0 */ static double interpolateArcValue( double angle, double a1, double a2, double a3, double zm1, double zm2, double zm3 ); - /** Returns a list of points contained in a WKT string. + /** + * Returns a list of points contained in a WKT string. * \note not available in Python bindings */ static QgsPointSequence pointsFromWKT( const QString &wktCoordinateList, bool is3D, bool isMeasure ) SIP_SKIP; @@ -235,13 +249,15 @@ class CORE_EXPORT QgsGeometryUtils */ static QString pointsToJSON( const QgsPointSequence &points, int precision ) SIP_SKIP; - /** Ensures that an angle is in the range 0 <= angle < 2 pi. + /** + * Ensures that an angle is in the range 0 <= angle < 2 pi. * \param angle angle in radians * \returns equivalent angle within the range [0, 2 pi) */ static double normalizedAngle( double angle ); - /** Calculates the direction of line joining two points in radians, clockwise from the north direction. + /** + * Calculates the direction of line joining two points in radians, clockwise from the north direction. * \param x1 x-coordinate of line start * \param y1 y-coordinate of line start * \param x2 x-coordinate of line end @@ -250,7 +266,8 @@ class CORE_EXPORT QgsGeometryUtils */ static double lineAngle( double x1, double y1, double x2, double y2 ); - /** Calculates the angle between the lines AB and BC, where AB and BC described + /** + * Calculates the angle between the lines AB and BC, where AB and BC described * by points a, b and b, c. * \param x1 x-coordinate of point a * \param y1 y-coordinate of point a @@ -263,7 +280,8 @@ class CORE_EXPORT QgsGeometryUtils static double angleBetweenThreePoints( double x1, double y1, double x2, double y2, double x3, double y3 ); - /** Calculates the perpendicular angle to a line joining two points. Returned angle is in radians, + /** + * Calculates the perpendicular angle to a line joining two points. Returned angle is in radians, * clockwise from the north direction. * \param x1 x-coordinate of line start * \param y1 y-coordinate of line start @@ -276,7 +294,8 @@ class CORE_EXPORT QgsGeometryUtils //! Angle between two linear segments static double averageAngle( double x1, double y1, double x2, double y2, double x3, double y3 ); - /** Averages two angles, correctly handling negative angles and ensuring the result is between 0 and 2 pi. + /** + * Averages two angles, correctly handling negative angles and ensuring the result is between 0 and 2 pi. * \param a1 first angle (in radians) * \param a2 second angle (in radians) * \returns average angle (in radians) @@ -298,7 +317,8 @@ class CORE_EXPORT QgsGeometryUtils */ static QStringList wktGetChildBlocks( const QString &wkt, const QString &defaultType = QString() ) SIP_SKIP; - /** Returns a middle point between points pt1 and pt2. + /** + * Returns a middle point between points pt1 and pt2. * Z value is computed if one of this point have Z. * M value is computed if one of this point have M. * \param pt1 first point. @@ -320,7 +340,8 @@ class CORE_EXPORT QgsGeometryUtils */ static QgsPoint midpoint( const QgsPoint &pt1, const QgsPoint &pt2 ); - /** Return the gradient of a line defined by points \a pt1 and \a pt2. + /** + * Return the gradient of a line defined by points \a pt1 and \a pt2. * \param pt1 first point. * \param pt2 second point. * \returns The gradient of this linear entity, or infinity if vertical @@ -328,7 +349,8 @@ class CORE_EXPORT QgsGeometryUtils */ static double gradient( const QgsPoint &pt1, const QgsPoint &pt2 ); - /** Return the coefficients (a, b, c for equation "ax + by + c = 0") of a line defined by points \a pt1 and \a pt2. + /** + * Return the coefficients (a, b, c for equation "ax + by + c = 0") of a line defined by points \a pt1 and \a pt2. * \param pt1 first point. * \param pt2 second point. * \param a Output parameter, a coefficient of the equation. diff --git a/src/core/geometry/qgsgeos.cpp b/src/core/geometry/qgsgeos.cpp index c9d68625b048..3377ba9ee9c8 100644 --- a/src/core/geometry/qgsgeos.cpp +++ b/src/core/geometry/qgsgeos.cpp @@ -104,7 +104,8 @@ static GEOSInit geosinit; ///@endcond -/** \ingroup core +/** + * \ingroup core * \brief Scoped GEOS pointer * \note not available in Python bindings */ diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h index 365485fef7f1..1cb7dee2558f 100644 --- a/src/core/geometry/qgsgeos.h +++ b/src/core/geometry/qgsgeos.h @@ -28,7 +28,8 @@ class QgsPolygonV2; class QgsGeometry; class QgsGeometryCollection; -/** \ingroup core +/** + * \ingroup core * Does vector analysis using the geos library and handles import, export, exception handling* * \note not available in Python bindings */ @@ -36,7 +37,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine { public: - /** GEOS geometry engine constructor + /** + * GEOS geometry engine constructor * \param geometry The geometry * \param precision The precision of the grid to which to snap the geometry vertices. If 0, no snapping is performed. */ @@ -136,7 +138,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine bool isEmpty( QString *errorMsg = nullptr ) const override; bool isSimple( QString *errorMsg = nullptr ) const override; - /** Splits this geometry according to a given line. + /** + * Splits this geometry according to a given line. \param splitLine the line that splits the geometry \param[out] newGeometries list of new geometries that have been created with the split \param topological true if topological editing is enabled @@ -177,7 +180,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine */ QgsAbstractGeometry *reshapeGeometry( const QgsLineString &reshapeWithLine, EngineOperationResult *errorCode, QString *errorMsg = nullptr ) const; - /** Merges any connected lines in a LineString/MultiLineString geometry and + /** + * Merges any connected lines in a LineString/MultiLineString geometry and * converts them to single line strings. * \param errorMsg if specified, will be set to any reported GEOS errors * \returns a LineString or MultiLineString geometry, with any connected lines @@ -187,19 +191,22 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine */ QgsGeometry mergeLines( QString *errorMsg = nullptr ) const; - /** Returns the closest point on the geometry to the other geometry. + /** + * Returns the closest point on the geometry to the other geometry. * \since QGIS 2.14 * \see shortestLine() */ QgsGeometry closestPoint( const QgsGeometry &other, QString *errorMsg = nullptr ) const; - /** Returns the shortest line joining this geometry to the other geometry. + /** + * Returns the shortest line joining this geometry to the other geometry. * \since QGIS 2.14 * \see closestPoint() */ QgsGeometry shortestLine( const QgsGeometry &other, QString *errorMsg = nullptr ) const; - /** Returns a distance representing the location along this linestring of the closest point + /** + * Returns a distance representing the location along this linestring of the closest point * on this linestring geometry to the specified point. Ie, the returned value indicates * how far along this linestring you need to traverse to get to the closest location * where this linestring comes to the specified point. @@ -249,7 +256,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine */ QgsGeometry delaunayTriangulation( double tolerance = 0.0, bool edgesOnly = false, QString *errorMsg = nullptr ) const; - /** Create a geometry from a GEOSGeometry + /** + * Create a geometry from a GEOSGeometry * \param geos GEOSGeometry. Ownership is NOT transferred. */ static QgsAbstractGeometry *fromGeos( const GEOSGeometry *geos ); @@ -294,7 +302,8 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine static GEOSGeometry *nodeGeometries( const GEOSGeometry *splitLine, const GEOSGeometry *geom ); int mergeGeometriesMultiTypeSplit( QVector &splitResult ) const; - /** Ownership of geoms is transferred + /** + * Ownership of geoms is transferred */ static GEOSGeometry *createGeosCollection( int typeId, const QVector &geoms ); diff --git a/src/core/geometry/qgslinestring.h b/src/core/geometry/qgslinestring.h index 88c0a3b7a2e5..c0b43a8e2dff 100644 --- a/src/core/geometry/qgslinestring.h +++ b/src/core/geometry/qgslinestring.h @@ -32,7 +32,8 @@ * See details in QEP #17 ****************************************************************************/ -/** \ingroup core +/** + * \ingroup core * \class QgsLineString * \brief Line string geometry type, with support for z-dimension and m-values. * \since QGIS 2.10 @@ -73,7 +74,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve bool operator==( const QgsCurve &other ) const override; bool operator!=( const QgsCurve &other ) const override; - /** Returns the specified point from inside the line string. + /** + * Returns the specified point from inside the line string. * \param i index of point, starting at 0 for the first point */ QgsPoint pointN( int i ) const; @@ -81,7 +83,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve double xAt( int index ) const override; double yAt( int index ) const override; - /** Returns the z-coordinate of the specified node in the line string. + /** + * Returns the z-coordinate of the specified node in the line string. * \param index index of node, where the first node in the line is 0 * \returns z-coordinate of node, or ``nan`` if index is out of bounds or the line * does not have a z dimension @@ -89,7 +92,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve */ double zAt( int index ) const; - /** Returns the m value of the specified node in the line string. + /** + * Returns the m value of the specified node in the line string. * \param index index of node, where the first node in the line is 0 * \returns m value of node, or ``nan`` if index is out of bounds or the line * does not have m values @@ -97,7 +101,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve */ double mAt( int index ) const; - /** Sets the x-coordinate of the specified node in the line string. + /** + * Sets the x-coordinate of the specified node in the line string. * \param index index of node, where the first node in the line is 0. Corresponding * node must already exist in line string. * \param x x-coordinate of node @@ -105,7 +110,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve */ void setXAt( int index, double x ); - /** Sets the y-coordinate of the specified node in the line string. + /** + * Sets the y-coordinate of the specified node in the line string. * \param index index of node, where the first node in the line is 0. Corresponding * node must already exist in line string. * \param y y-coordinate of node @@ -113,7 +119,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve */ void setYAt( int index, double y ); - /** Sets the z-coordinate of the specified node in the line string. + /** + * Sets the z-coordinate of the specified node in the line string. * \param index index of node, where the first node in the line is 0. Corresponding * node must already exist in line string, and the line string must have z-dimension. * \param z z-coordinate of node @@ -121,7 +128,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve */ void setZAt( int index, double z ); - /** Sets the m value of the specified node in the line string. + /** + * Sets the m value of the specified node in the line string. * \param index index of node, where the first node in the line is 0. Corresponding * node must already exist in line string, and the line string must have m values. * \param m m value of node @@ -129,18 +137,21 @@ class CORE_EXPORT QgsLineString: public QgsCurve */ void setMAt( int index, double m ); - /** Resets the line string to match the specified list of points. The line string will + /** + * Resets the line string to match the specified list of points. The line string will * inherit the dimensionality of the first point in the list. * \param points new points for line string. If empty, line string will be cleared. */ void setPoints( const QgsPointSequence &points ); - /** Appends the contents of another line string to the end of this line string. + /** + * Appends the contents of another line string to the end of this line string. * \param line line to append. Ownership is not transferred. */ void append( const QgsLineString *line ); - /** Adds a new vertex to the end of the line string. + /** + * Adds a new vertex to the end of the line string. * \param pt vertex to add */ void addVertex( const QgsPoint &pt ); @@ -148,7 +159,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve //! Closes the line string by appending the first point to the end of the line, if it is not already closed. void close(); - /** Returns the geometry converted to the more generic curve type QgsCompoundCurve + /** + * Returns the geometry converted to the more generic curve type QgsCompoundCurve \returns the converted geometry. Caller takes ownership*/ QgsCompoundCurve *toCurveType() const override SIP_FACTORY; @@ -182,7 +194,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve QgsPoint startPoint() const override; QgsPoint endPoint() const override; - /** Returns a new line string geometry corresponding to a segmentized approximation + /** + * Returns a new line string geometry corresponding to a segmentized approximation * of the curve. * \param tolerance segmentation tolerance * \param toleranceType maximum segmentation angle or maximum difference between approximation and curve*/ @@ -251,7 +264,8 @@ class CORE_EXPORT QgsLineString: public QgsCurve void importVerticesFromWkb( const QgsConstWkbPtr &wkb ); - /** Resets the line string to match the line string in a WKB geometry. + /** + * Resets the line string to match the line string in a WKB geometry. * \param type WKB type * \param wkb WKB representation of line geometry */ diff --git a/src/core/geometry/qgsmulticurve.h b/src/core/geometry/qgsmulticurve.h index 15e4a8adc8fb..9af5f934701b 100644 --- a/src/core/geometry/qgsmulticurve.h +++ b/src/core/geometry/qgsmulticurve.h @@ -20,7 +20,8 @@ email : marco.hugentobler at sourcepole dot com #include "qgis.h" #include "qgsgeometrycollection.h" -/** \ingroup core +/** + * \ingroup core * \class QgsMultiCurve * \brief Multi curve geometry collection. * \since QGIS 2.10 @@ -40,7 +41,8 @@ class CORE_EXPORT QgsMultiCurve: public QgsGeometryCollection bool addGeometry( QgsAbstractGeometry *g SIP_TRANSFER ) override; bool insertGeometry( QgsAbstractGeometry *g SIP_TRANSFER, int index ) override; - /** Returns a copy of the multi curve, where each component curve has had its line direction reversed. + /** + * Returns a copy of the multi curve, where each component curve has had its line direction reversed. * \since QGIS 2.14 */ QgsMultiCurve *reversed() const SIP_FACTORY; diff --git a/src/core/geometry/qgsmultilinestring.h b/src/core/geometry/qgsmultilinestring.h index efc6f0917713..52dd89816ee8 100644 --- a/src/core/geometry/qgsmultilinestring.h +++ b/src/core/geometry/qgsmultilinestring.h @@ -20,7 +20,8 @@ email : marco.hugentobler at sourcepole dot com #include "qgis.h" #include "qgsmulticurve.h" -/** \ingroup core +/** + * \ingroup core * \class QgsMultiLineString * \brief Multi line string geometry collection. * \since QGIS 2.10 @@ -40,7 +41,8 @@ class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve bool addGeometry( QgsAbstractGeometry *g SIP_TRANSFER ) override; bool insertGeometry( QgsAbstractGeometry *g SIP_TRANSFER, int index ) override; - /** Returns the geometry converted to the more generic curve type QgsMultiCurve + /** + * Returns the geometry converted to the more generic curve type QgsMultiCurve \returns the converted geometry. Caller takes ownership*/ QgsMultiCurve *toCurveType() const override SIP_FACTORY; diff --git a/src/core/geometry/qgsmultipoint.h b/src/core/geometry/qgsmultipoint.h index 2b7794cd9343..d83e16bd86dc 100644 --- a/src/core/geometry/qgsmultipoint.h +++ b/src/core/geometry/qgsmultipoint.h @@ -20,7 +20,8 @@ email : marco.hugentobler at sourcepole dot com #include "qgis.h" #include "qgsgeometrycollection.h" -/** \ingroup core +/** + * \ingroup core * \class QgsMultiPointV2 * \brief Multi point geometry collection. * \since QGIS 2.10 diff --git a/src/core/geometry/qgsmultipolygon.h b/src/core/geometry/qgsmultipolygon.h index 7b4fba80e4a2..f01761962a9d 100644 --- a/src/core/geometry/qgsmultipolygon.h +++ b/src/core/geometry/qgsmultipolygon.h @@ -20,7 +20,8 @@ email : marco.hugentobler at sourcepole dot com #include "qgis.h" #include "qgsmultisurface.h" -/** \ingroup core +/** + * \ingroup core * \class QgsMultiPolygonV2 * \brief Multi polygon geometry collection. * \since QGIS 2.10 @@ -39,7 +40,8 @@ class CORE_EXPORT QgsMultiPolygonV2: public QgsMultiSurface bool addGeometry( QgsAbstractGeometry *g SIP_TRANSFER ) override; bool insertGeometry( QgsAbstractGeometry *g SIP_TRANSFER, int index ) override; - /** Returns the geometry converted to the more generic curve type QgsMultiSurface + /** + * Returns the geometry converted to the more generic curve type QgsMultiSurface \returns the converted geometry. Caller takes ownership*/ QgsMultiSurface *toCurveType() const override SIP_FACTORY; diff --git a/src/core/geometry/qgsmultisurface.h b/src/core/geometry/qgsmultisurface.h index 7d0669fa110f..3474dbaede25 100644 --- a/src/core/geometry/qgsmultisurface.h +++ b/src/core/geometry/qgsmultisurface.h @@ -20,7 +20,8 @@ email : marco.hugentobler at sourcepole dot com #include "qgis.h" #include "qgsgeometrycollection.h" -/** \ingroup core +/** + * \ingroup core * \class QgsMultiSurface * \brief Multi surface geometry collection. * \since QGIS 2.10 diff --git a/src/core/geometry/qgspoint.h b/src/core/geometry/qgspoint.h index 2651c89df300..b6cc3c4b02b2 100644 --- a/src/core/geometry/qgspoint.h +++ b/src/core/geometry/qgspoint.h @@ -29,7 +29,8 @@ * See details in QEP #17 ****************************************************************************/ -/** \ingroup core +/** + * \ingroup core * \brief Point geometry type, with support for z-dimension and m-values. * \since QGIS 3.0, (previously QgsPointv2 since QGIS 2.10) */ @@ -99,11 +100,13 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry % End #endif - /** Construct a QgsPoint from a QgsPointXY object + /** + * Construct a QgsPoint from a QgsPointXY object */ explicit QgsPoint( const QgsPointXY &p ); - /** Construct a QgsPoint from a QPointF + /** + * Construct a QgsPoint from a QPointF */ explicit QgsPoint( QPointF p ); @@ -117,31 +120,36 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry bool operator==( const QgsPoint &pt ) const; bool operator!=( const QgsPoint &pt ) const; - /** Returns the point's x-coordinate. + /** + * Returns the point's x-coordinate. * \see setX() * \see rx() */ double x() const { return mX; } - /** Returns the point's y-coordinate. + /** + * Returns the point's y-coordinate. * \see setY() * \see ry() */ double y() const { return mY; } - /** Returns the point's z-coordinate. + /** + * Returns the point's z-coordinate. * \see setZ() * \see rz() */ double z() const { return mZ; } - /** Returns the point's m value. + /** + * Returns the point's m value. * \see setM() * \see rm() */ double m() const { return mM; } - /** Returns a reference to the x-coordinate of this point. + /** + * Returns a reference to the x-coordinate of this point. * Using a reference makes it possible to directly manipulate x in place. * \see x() * \see setX() @@ -149,7 +157,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry */ double &rx() SIP_SKIP { clearCache(); return mX; } - /** Returns a reference to the y-coordinate of this point. + /** + * Returns a reference to the y-coordinate of this point. * Using a reference makes it possible to directly manipulate y in place. * \see y() * \see setY() @@ -157,7 +166,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry */ double &ry() SIP_SKIP { clearCache(); return mY; } - /** Returns a reference to the z-coordinate of this point. + /** + * Returns a reference to the z-coordinate of this point. * Using a reference makes it possible to directly manipulate z in place. * \see z() * \see setZ() @@ -165,7 +175,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry */ double &rz() SIP_SKIP { clearCache(); return mZ; } - /** Returns a reference to the m value of this point. + /** + * Returns a reference to the m value of this point. * Using a reference makes it possible to directly manipulate m in place. * \see m() * \see setM() @@ -173,7 +184,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry */ double &rm() SIP_SKIP { clearCache(); return mM; } - /** Sets the point's x-coordinate. + /** + * Sets the point's x-coordinate. * \see x() * \see rx() */ @@ -183,7 +195,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry mX = x; } - /** Sets the point's y-coordinate. + /** + * Sets the point's y-coordinate. * \see y() * \see ry() */ @@ -193,7 +206,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry mY = y; } - /** Sets the point's z-coordinate. + /** + * Sets the point's z-coordinate. * \note calling this will have no effect if the point does not contain a z-dimension. Use addZValue() to * add a z value and force the point to have a z dimension. * \see z() @@ -207,7 +221,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry mZ = z; } - /** Sets the point's m-value. + /** + * Sets the point's m-value. * \note calling this will have no effect if the point does not contain a m-dimension. Use addMValue() to * add a m value and force the point to have an m dimension. * \see m() @@ -221,7 +236,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry mM = m; } - /** Returns the point as a QPointF. + /** + * Returns the point as a QPointF. * \since QGIS 2.14 */ QPointF toQPointF() const; @@ -309,7 +325,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry */ double inclination( const QgsPoint &other ) const; - /** Returns a new point which correspond to this point projected by a specified distance + /** + * Returns a new point which correspond to this point projected by a specified distance * with specified angles (azimuth and inclination). * M value is preserved. * \param distance distance to project @@ -398,7 +415,8 @@ class CORE_EXPORT QgsPoint: public QgsAbstractGeometry double closestSegment( const QgsPoint &pt, QgsPoint &segmentPt SIP_OUT, QgsVertexId &vertexAfter SIP_OUT, bool *leftOf SIP_OUT = nullptr, double epsilon = 4 * DBL_EPSILON ) const override; bool nextVertex( QgsVertexId &id, QgsPoint &vertex SIP_OUT ) const override; - /** Angle undefined. Always returns 0.0 + /** + * Angle undefined. Always returns 0.0 \param vertex the vertex id \returns 0.0*/ double vertexAngle( QgsVertexId vertex ) const override; diff --git a/src/core/geometry/qgspolygon.h b/src/core/geometry/qgspolygon.h index 8198db98f27e..a0579d8d69d7 100644 --- a/src/core/geometry/qgspolygon.h +++ b/src/core/geometry/qgspolygon.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgscurvepolygon.h" -/** \ingroup core +/** + * \ingroup core * \class QgsPolygonV2 * \brief Polygon geometry type. * \since QGIS 2.10 @@ -39,7 +40,8 @@ class CORE_EXPORT QgsPolygonV2: public QgsCurvePolygon QByteArray asWkb() const override; QgsPolygonV2 *surfaceToPolygon() const override SIP_FACTORY; - /** Returns the geometry converted to the more generic curve type QgsCurvePolygon + /** + * Returns the geometry converted to the more generic curve type QgsCurvePolygon \returns the converted geometry. Caller takes ownership*/ QgsCurvePolygon *toCurveType() const override SIP_FACTORY; diff --git a/src/core/geometry/qgsrectangle.h b/src/core/geometry/qgsrectangle.h index 51dc94965f43..1f7da8680580 100644 --- a/src/core/geometry/qgsrectangle.h +++ b/src/core/geometry/qgsrectangle.h @@ -28,7 +28,8 @@ class QgsBox3d; #include "qgspointxy.h" -/** \ingroup core +/** + * \ingroup core * A rectangle specified with double values. * * QgsRectangle is used to store a rectangle when double values are required. diff --git a/src/core/geometry/qgsregularpolygon.h b/src/core/geometry/qgsregularpolygon.h index b0a561e95775..8b0f74e52d1d 100644 --- a/src/core/geometry/qgsregularpolygon.h +++ b/src/core/geometry/qgsregularpolygon.h @@ -28,7 +28,8 @@ #include "qgstriangle.h" -/** \ingroup core +/** + * \ingroup core * \class QgsRegularPolygon * \brief Regular Polygon geometry type. * @@ -56,7 +57,8 @@ class CORE_EXPORT QgsRegularPolygon */ QgsRegularPolygon() = default; - /** Constructs a regular polygon by \a center and parameters for the first vertex. An empty regular polygon is returned if \a numberSides < 3 or \a ConstructionOption isn't valid. + /** + * Constructs a regular polygon by \a center and parameters for the first vertex. An empty regular polygon is returned if \a numberSides < 3 or \a ConstructionOption isn't valid. * \param center The center of the regular polygon. * \param radius Distance from the center and the first vertex or sides (see \a ConstructionOption). * \param azimuth Angle in degrees started from the North to the first vertex. @@ -65,7 +67,8 @@ class CORE_EXPORT QgsRegularPolygon */ QgsRegularPolygon( const QgsPoint ¢er, const double radius, const double azimuth, const unsigned int numberSides, const ConstructionOption circle ); - /** Constructs a regular polygon by \a center and another point. + /** + * Constructs a regular polygon by \a center and another point. * \param center The center of the regular polygon. * \param pt1 The first vertex if the polygon is inscribed in circle or the midpoint of a side if the polygon is circumscribed about circle. * \param numberSides Number of sides of the regular polygon. @@ -73,7 +76,8 @@ class CORE_EXPORT QgsRegularPolygon */ QgsRegularPolygon( const QgsPoint ¢er, const QgsPoint &pt1, const unsigned int numberSides, const ConstructionOption circle ); - /** Constructs a regular polygon by two points of the first side. + /** + * Constructs a regular polygon by two points of the first side. * \param pt1 The first vertex of the first side, also first vertex of the regular polygon. * \param pt2 The second vertex of the first side. * \param numberSides Number of sides of the regular polygon. @@ -86,85 +90,101 @@ class CORE_EXPORT QgsRegularPolygon //! A regular polygon is empty if radius equal to 0 or number of sides < 3 bool isEmpty() const; - /** Returns the center point of the regular polygon. + /** + * Returns the center point of the regular polygon. * \see setCenter() */ QgsPoint center() const { return mCenter; } - /** Returns the radius. + /** + * Returns the radius. * This is also the radius of the circumscribing circle. * \see apothem() * \see setRadius() */ double radius() const { return mRadius; } - /** Returns the first vertex (corner) of the regular polygon. + /** + * Returns the first vertex (corner) of the regular polygon. * \see setFirstVertex() */ QgsPoint firstVertex() const { return mFirstVertex; } - /** Returns the apothem of the regular polygon. + /** + * Returns the apothem of the regular polygon. * The apothem is the radius of the inscribed circle. * \see radius() */ double apothem() const { return mRadius * std::cos( M_PI / mNumberSides ); } - /** Returns the number of sides of the regular polygon. + /** + * Returns the number of sides of the regular polygon. * \see setNumberSides() */ unsigned int numberSides() const { return mNumberSides; } - /** Sets the center point. + /** + * Sets the center point. * Radius is unchanged. The first vertex is reprojected from the new center. * \see center() */ void setCenter( const QgsPoint ¢er ); - /** Sets the radius. + /** + * Sets the radius. * Center is unchanged. The first vertex is reprojected from the center with the new radius. * \see radius() */ void setRadius( const double radius ); - /** Sets the first vertex. + /** + * Sets the first vertex. * Radius is unchanged. The center is reprojected from the new first vertex. * \see firstVertex() */ void setFirstVertex( const QgsPoint &firstVertex ); - /** Sets the number of sides. + /** + * Sets the number of sides. * If numberSides < 3, the number of sides is unchanged. * \see numberSides() */ void setNumberSides( const unsigned int numberSides ); - /** Returns a list including the vertices of the regular polygon. + /** + * Returns a list including the vertices of the regular polygon. */ QgsPointSequence points() const; - /** Returns as a polygon. + /** + * Returns as a polygon. */ QgsPolygonV2 *toPolygon() const SIP_FACTORY; - /** Returns as a linestring. + /** + * Returns as a linestring. */ QgsLineString *toLineString() const SIP_FACTORY; - /** Returns as a triangle. + /** + * Returns as a triangle. * An empty triangle is returned if the regular polygon is empty or if the number of sides is different from 3. */ QgsTriangle toTriangle() const; - /** Returns a triangulation (vertices from sides to the center) of the regular polygon. + /** + * Returns a triangulation (vertices from sides to the center) of the regular polygon. * An empty list is returned if the regular polygon is empty. */ QList triangulate() const; - /** Returns the inscribed circle + /** + * Returns the inscribed circle */ QgsCircle inscribedCircle() const; - /** Returns the circumscribed circle + /** + * Returns the circumscribed circle */ QgsCircle circumscribedCircle() const; @@ -174,25 +194,30 @@ class CORE_EXPORT QgsRegularPolygon */ QString toString( int pointPrecision = 17, int radiusPrecision = 17, int anglePrecision = 2 ) const; - /** Returns the measure of the interior angles in degrees. + /** + * Returns the measure of the interior angles in degrees. */ double interiorAngle() const; - /** Returns the measure of the central angle (the angle subtended at the center of the polygon by one of its sides) in degrees. + /** + * Returns the measure of the central angle (the angle subtended at the center of the polygon by one of its sides) in degrees. */ double centralAngle() const; - /** Returns the area. + /** + * Returns the area. * Returns 0 if the regular polygon is empty. */ double area() const; - /** Returns the perimeter. + /** + * Returns the perimeter. * Returns 0 if the regular polygon is empty. */ double perimeter() const; - /** Returns the length of a side. + /** + * Returns the length of a side. * Returns 0 if the regular polygon is empty. */ double length() const; @@ -203,15 +228,18 @@ class CORE_EXPORT QgsRegularPolygon unsigned int mNumberSides = 0; double mRadius = 0.0; - /** Convenient method to convert an apothem to a radius. + /** + * Convenient method to convert an apothem to a radius. */ double apothemToRadius( const double apothem, const unsigned int numberSides ) const; - /** Convenient method for interiorAngle used by constructors. + /** + * Convenient method for interiorAngle used by constructors. */ double interiorAngle( const unsigned int nbSides ) const; - /** Convenient method for centralAngle used by constructors. + /** + * Convenient method for centralAngle used by constructors. */ double centralAngle( const unsigned int nbSides ) const; diff --git a/src/core/geometry/qgssurface.h b/src/core/geometry/qgssurface.h index fcf21894a1fe..387b0269d040 100644 --- a/src/core/geometry/qgssurface.h +++ b/src/core/geometry/qgssurface.h @@ -25,7 +25,8 @@ class QgsPolygonV2; -/** \ingroup core +/** + * \ingroup core * \class QgsSurface */ class CORE_EXPORT QgsSurface: public QgsAbstractGeometry @@ -38,7 +39,8 @@ class CORE_EXPORT QgsSurface: public QgsAbstractGeometry */ virtual QgsPolygonV2 *surfaceToPolygon() const = 0 SIP_FACTORY; - /** Returns the minimal bounding box for the geometry + /** + * Returns the minimal bounding box for the geometry */ virtual QgsRectangle boundingBox() const override { diff --git a/src/core/geometry/qgstriangle.h b/src/core/geometry/qgstriangle.h index 30342cb43f9f..33ebf45d8a1b 100644 --- a/src/core/geometry/qgstriangle.h +++ b/src/core/geometry/qgstriangle.h @@ -24,7 +24,8 @@ #include "qgscircle.h" #include "qgslinestring.h" -/** \ingroup core +/** + * \ingroup core * \class QgsTriangle * \brief Triangle geometry type. * \since QGIS 3.0 @@ -34,7 +35,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 public: QgsTriangle(); - /** Construct a QgsTriangle from three QgsPointV2. + /** + * Construct a QgsTriangle from three QgsPointV2. * An empty triangle is returned if there are identical points or if the points are collinear. * \param p1 first point * \param p2 second point @@ -42,7 +44,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 */ QgsTriangle( const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &p3 ); - /** Construct a QgsTriangle from three QgsPoint. + /** + * Construct a QgsTriangle from three QgsPoint. * An empty triangle is returned if there are identical points or if the points are collinear. * \param p1 first point * \param p2 second point @@ -50,7 +53,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 */ explicit QgsTriangle( const QgsPointXY &p1, const QgsPointXY &p2, const QgsPointXY &p3 ); - /** Construct a QgsTriangle from three QPointF. + /** + * Construct a QgsTriangle from three QPointF. * An empty triangle is returned if there are identical points or if the points are collinear. * \param p1 first point * \param p2 second point @@ -81,7 +85,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 //! Inherited method not used. You cannot add an interior ring into a triangle. void addInteriorRing( QgsCurve *ring SIP_TRANSFER ) override; - /** Inherited method not used. You cannot add an interior ring into a triangle. + /** + * Inherited method not used. You cannot add an interior ring into a triangle. * \note not available in Python bindings */ void setInteriorRings( const QList< QgsCurve *> &rings ) = delete; diff --git a/src/core/geometry/qgswkbptr.h b/src/core/geometry/qgswkbptr.h index 59156e1b7fbe..60d724ae876b 100644 --- a/src/core/geometry/qgswkbptr.h +++ b/src/core/geometry/qgswkbptr.h @@ -22,7 +22,8 @@ #include "qgsexception.h" #include "qpolygon.h" -/** \ingroup core +/** + * \ingroup core * Custom exception class for Wkb related exceptions. * \note not available in Python bindings */ @@ -35,7 +36,8 @@ class CORE_EXPORT QgsWkbException : public QgsException #endif -/** \ingroup core +/** + * \ingroup core * \class QgsWkbPtr */ class CORE_EXPORT QgsWkbPtr @@ -112,7 +114,8 @@ class CORE_EXPORT QgsWkbPtr inline int writtenSize() const { return mP - mStart; } SIP_SKIP }; -/** \ingroup core +/** + * \ingroup core * \class QgsConstWkbPtr */ diff --git a/src/core/geometry/qgswkbtypes.h b/src/core/geometry/qgswkbtypes.h index 953acd830a60..a0b55b6772a2 100644 --- a/src/core/geometry/qgswkbtypes.h +++ b/src/core/geometry/qgswkbtypes.h @@ -30,7 +30,8 @@ * See details in QEP #17 ****************************************************************************/ -/** \ingroup core +/** + * \ingroup core * \class QgsWkbTypes * \brief Handles storage of information regarding WKB types and their properties. * \since QGIS 2.10 @@ -142,7 +143,8 @@ class CORE_EXPORT QgsWkbTypes NullGeometry }; - /** Returns the single type for a WKB type. For example, for MultiPolygon WKB types the single type would be Polygon. + /** + * Returns the single type for a WKB type. For example, for MultiPolygon WKB types the single type would be Polygon. * \see isSingleType() * \see multiType() * \see flatType() @@ -285,7 +287,8 @@ class CORE_EXPORT QgsWkbTypes return Unknown; } - /** Returns the multi type for a WKB type. For example, for Polygon WKB types the multi type would be MultiPolygon. + /** + * Returns the multi type for a WKB type. For example, for Polygon WKB types the multi type would be MultiPolygon. * \see isMultiType() * \see singleType() * \see flatType() @@ -415,7 +418,8 @@ class CORE_EXPORT QgsWkbTypes return Unknown; } - /** Returns the flat type for a WKB type. This is the WKB type minus any Z or M dimensions. + /** + * Returns the flat type for a WKB type. This is the WKB type minus any Z or M dimensions. * For example, for PolygonZM WKB types the single type would be Polygon. * \see singleType() * \see multiType() @@ -529,12 +533,14 @@ class CORE_EXPORT QgsWkbTypes return type; } - /** Attempts to extract the WKB type from a WKT string. + /** + * Attempts to extract the WKB type from a WKT string. * \param wktStr a valid WKT string */ static Type parseType( const QString &wktStr ); - /** Returns true if the WKB type is a single type. + /** + * Returns true if the WKB type is a single type. * \see isMultiType() * \see singleType() */ @@ -543,7 +549,8 @@ class CORE_EXPORT QgsWkbTypes return ( type != Unknown && !isMultiType( type ) ); } - /** Returns true if the WKB type is a multi type. + /** + * Returns true if the WKB type is a multi type. * \see isSingleType() * \see multiType() */ @@ -592,7 +599,8 @@ class CORE_EXPORT QgsWkbTypes } } - /** Returns true if the WKB type is a curved type or can contain curved geometries. + /** + * Returns true if the WKB type is a curved type or can contain curved geometries. * \since QGIS 2.14 */ static bool isCurvedType( Type type ) @@ -611,7 +619,8 @@ class CORE_EXPORT QgsWkbTypes } } - /** Returns the inherent dimension of the geometry type as an integer. Returned value will + /** + * Returns the inherent dimension of the geometry type as an integer. Returned value will * always be less than or equal to the coordinate dimension. * \returns 0 for point geometries, 1 for line geometries, 2 for polygon geometries * Invalid geometry types will return a dimension of 0. @@ -631,7 +640,8 @@ class CORE_EXPORT QgsWkbTypes } } - /** Returns the coordinate dimension of the geometry type as an integer. Returned value will + /** + * Returns the coordinate dimension of the geometry type as an integer. Returned value will * be between 2-4, depending on whether the geometry type contains the Z or M dimensions. * Invalid geometry types will return a dimension of 0. * \since QGIS 2.14 @@ -645,7 +655,8 @@ class CORE_EXPORT QgsWkbTypes return 2 + hasZ( type ) + hasM( type ); } - /** Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a + /** + * Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a * PolygonGeometry geometry type. * GeometryCollections are reported as QgsWkbTypes::UnknownGeometry. */ @@ -727,7 +738,8 @@ class CORE_EXPORT QgsWkbTypes return UnknownGeometry; } - /** Returns a display string type for a WKB type, e.g., the geometry name used in WKT geometry representations. + /** + * Returns a display string type for a WKB type, e.g., the geometry name used in WKT geometry representations. */ static QString displayString( Type type ); @@ -747,7 +759,8 @@ class CORE_EXPORT QgsWkbTypes */ static QString geometryDisplayString( GeometryType type ); - /** Tests whether a WKB type contains the z-dimension. + /** + * Tests whether a WKB type contains the z-dimension. * \returns true if type has z values * \see addZ() * \see hasM() @@ -796,7 +809,8 @@ class CORE_EXPORT QgsWkbTypes } } - /** Tests whether a WKB type contains m values. + /** + * Tests whether a WKB type contains m values. * \returns true if type has m values * \see addM() * \see hasZ() @@ -839,7 +853,8 @@ class CORE_EXPORT QgsWkbTypes } } - /** Adds the z dimension to a WKB type and returns the new type + /** + * Adds the z dimension to a WKB type and returns the new type * \param type original type * \since QGIS 2.12 * \see addM() @@ -863,7 +878,8 @@ class CORE_EXPORT QgsWkbTypes return static_cast< QgsWkbTypes::Type >( flat + 1000 ); } - /** Adds the m dimension to a WKB type and returns the new type + /** + * Adds the m dimension to a WKB type and returns the new type * \param type original type * \since QGIS 2.12 * \see addZ() @@ -894,7 +910,8 @@ class CORE_EXPORT QgsWkbTypes return static_cast< QgsWkbTypes::Type >( flat + 2000 ); } - /** Drops the z dimension (if present) for a WKB type and returns the new type. + /** + * Drops the z dimension (if present) for a WKB type and returns the new type. * \param type original type * \since QGIS 2.14 * \see dropM() @@ -911,7 +928,8 @@ class CORE_EXPORT QgsWkbTypes return returnType; } - /** Drops the m dimension (if present) for a WKB type and returns the new type. + /** + * Drops the m dimension (if present) for a WKB type and returns the new type. * \param type original type * \since QGIS 2.14 * \see dropZ() diff --git a/src/core/gps/qgsgpsconnection.h b/src/core/gps/qgsgpsconnection.h index 7cd8141edeb5..4569c9e829d9 100644 --- a/src/core/gps/qgsgpsconnection.h +++ b/src/core/gps/qgsgpsconnection.h @@ -59,7 +59,8 @@ struct CORE_EXPORT QgsGPSInformation bool satInfoComplete; // based on GPGSV sentences - to be used to determine when to graph signal and satellite position }; -/** \ingroup core +/** + * \ingroup core * Abstract base class for connection to a GPS device*/ class CORE_EXPORT QgsGPSConnection : public QObject { @@ -91,7 +92,8 @@ class CORE_EXPORT QgsGPSConnection : public QObject GPSDataReceived }; - /** Constructor + /** + * Constructor \param dev input device for the connection (e.g. serial device). The class takes ownership of the object */ QgsGPSConnection( QIODevice *dev SIP_TRANSFER ); diff --git a/src/core/gps/qgsgpsconnectionregistry.h b/src/core/gps/qgsgpsconnectionregistry.h index a7913cb8dc33..4f44b518f568 100644 --- a/src/core/gps/qgsgpsconnectionregistry.h +++ b/src/core/gps/qgsgpsconnectionregistry.h @@ -25,7 +25,8 @@ class QgsGPSConnection; -/** \ingroup core +/** + * \ingroup core * A class to register / unregister existing GPS connections such that the information * is available to all classes and plugins. * diff --git a/src/core/gps/qgsgpsdconnection.h b/src/core/gps/qgsgpsdconnection.h index 93f547b9fa6a..d54137a00c7b 100644 --- a/src/core/gps/qgsgpsdconnection.h +++ b/src/core/gps/qgsgpsdconnection.h @@ -23,7 +23,8 @@ #include -/** \ingroup core +/** + * \ingroup core * Evaluates NMEA sentences coming from gpsd*/ class CORE_EXPORT QgsGpsdConnection: public QgsNMEAConnection { diff --git a/src/core/gps/qgsgpsdetector.h b/src/core/gps/qgsgpsdetector.h index e3cfcb11a5e1..a5785d28165a 100644 --- a/src/core/gps/qgsgpsdetector.h +++ b/src/core/gps/qgsgpsdetector.h @@ -28,7 +28,8 @@ class QgsGPSConnection; struct QgsGPSInformation; -/** \ingroup core +/** + * \ingroup core * Class to detect the GPS port */ class CORE_EXPORT QgsGPSDetector : public QObject diff --git a/src/core/gps/qgsnmeaconnection.h b/src/core/gps/qgsnmeaconnection.h index 707709782c29..29f1942c8e84 100644 --- a/src/core/gps/qgsnmeaconnection.h +++ b/src/core/gps/qgsnmeaconnection.h @@ -21,7 +21,8 @@ #include "qgis_core.h" #include "qgsgpsconnection.h" -/** \ingroup core +/** + * \ingroup core * Evaluates NMEA sentences coming from a GPS device */ class CORE_EXPORT QgsNMEAConnection: public QgsGPSConnection diff --git a/src/core/gps/qgsqtlocationconnection.h b/src/core/gps/qgsqtlocationconnection.h index 34ee6c7b5ca0..99a4484afa87 100644 --- a/src/core/gps/qgsqtlocationconnection.h +++ b/src/core/gps/qgsqtlocationconnection.h @@ -60,7 +60,8 @@ class CORE_EXPORT QgsQtLocationConnection: public QgsGPSConnection //! Parse available data source content void parseData(); - /** Called when the position updated. + /** + * Called when the position updated. * \note not available in Python bindings */ void positionUpdated( const QGeoPositionInfo &info ) SIP_SKIP; @@ -69,12 +70,14 @@ class CORE_EXPORT QgsQtLocationConnection: public QgsGPSConnection SIP_IF_FEATURE( !ANDROID ) #endif - /** Called when the number of satellites in view is updated. + /** + * Called when the number of satellites in view is updated. * \note not available in Python bindings on android */ void satellitesInViewUpdated( const QList &satellites ); - /** Called when the number of satellites in use is updated. + /** + * Called when the number of satellites in use is updated. * \note not available in Python bindings on android */ void satellitesInUseUpdated( const QList &satellites ); diff --git a/src/core/layertree/qgslayertree.h b/src/core/layertree/qgslayertree.h index be61615732db..3693924df69d 100644 --- a/src/core/layertree/qgslayertree.h +++ b/src/core/layertree/qgslayertree.h @@ -20,7 +20,8 @@ #include "qgslayertreegroup.h" #include "qgslayertreelayer.h" -/** \ingroup core +/** + * \ingroup core * Namespace with helper functions for layer tree operations. * * Only generally useful routines should be here. Miscellaneous utility functions for work diff --git a/src/core/layertree/qgslayertreegroup.h b/src/core/layertree/qgslayertreegroup.h index 910c7dbfc5e0..7b8bee3fb7c3 100644 --- a/src/core/layertree/qgslayertreegroup.h +++ b/src/core/layertree/qgslayertreegroup.h @@ -23,7 +23,8 @@ class QgsMapLayer; class QgsLayerTreeLayer; -/** \ingroup core +/** + * \ingroup core * Layer tree group node serves as a container for layers and further groups. * * Group names do not need to be unique within one tree nor within one parent. diff --git a/src/core/layertree/qgslayertreelayer.h b/src/core/layertree/qgslayertreelayer.h index 5836a3d7916c..7c55e702bd2b 100644 --- a/src/core/layertree/qgslayertreelayer.h +++ b/src/core/layertree/qgslayertreelayer.h @@ -23,7 +23,8 @@ class QgsMapLayer; -/** \ingroup core +/** + * \ingroup core * Layer tree node points to a map layer. * * The node can exist also without a valid instance of a layer (just ID). That diff --git a/src/core/layertree/qgslayertreemodel.h b/src/core/layertree/qgslayertreemodel.h index 2a3ccfcaeee9..da247f36fd26 100644 --- a/src/core/layertree/qgslayertreemodel.h +++ b/src/core/layertree/qgslayertreemodel.h @@ -37,7 +37,8 @@ class QgsExpression; class QgsRenderContext; class QgsLayerTree; -/** \ingroup core +/** + * \ingroup core * The QgsLayerTreeModel class is model implementation for Qt item views framework. * The model can be used in any QTreeView, it is however recommended to use it * with QgsLayerTreeView which brings additional functionality specific to layer tree handling. @@ -168,7 +169,8 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel */ QgsLayerTreeModelLegendNode *legendNodeEmbeddedInParent( QgsLayerTreeLayer *nodeLayer ) const; - /** Searches through the layer tree to find a legend node with a matching layer ID + /** + * Searches through the layer tree to find a legend node with a matching layer ID * and rule key. * \param layerId map layer ID * \param ruleKey legend node rule key @@ -316,7 +318,8 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel //! emit dataChanged() for layer tree node items void recursivelyEmitDataChanged( const QModelIndex &index = QModelIndex() ); - /** Updates layer data for scale dependent layers, should be called when map scale changes. + /** + * Updates layer data for scale dependent layers, should be called when map scale changes. * Emits dataChanged() for all scale dependent layers. * \since QGIS 2.16 */ @@ -441,7 +444,8 @@ Q_DECLARE_OPERATORS_FOR_FLAGS( QgsLayerTreeModel::Flags ) ///@cond PRIVATE #ifndef SIP_RUN -/** In order to support embedded widgets in layer tree view, the model +/** + * In order to support embedded widgets in layer tree view, the model * generates one placeholder legend node for each embedded widget. * The placeholder will be replaced by an embedded widget in QgsLayerTreeView */ diff --git a/src/core/layertree/qgslayertreemodellegendnode.h b/src/core/layertree/qgslayertreemodellegendnode.h index 4fc8a7863444..63a3eca56c72 100644 --- a/src/core/layertree/qgslayertreemodellegendnode.h +++ b/src/core/layertree/qgslayertreemodellegendnode.h @@ -35,7 +35,8 @@ class QgsMapSettings; class QgsSymbol; class QgsRenderContext; -/** \ingroup core +/** + * \ingroup core * The QgsLegendRendererItem class is abstract interface for legend items * returned from QgsMapLayerLegend implementation. * @@ -78,7 +79,8 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject virtual bool isScaleOK( double scale ) const { Q_UNUSED( scale ); return true; } - /** Notification from model that information from associated map view has changed. + /** + * Notification from model that information from associated map view has changed. * Default implementation does nothing. */ virtual void invalidateMapBasedData() {} @@ -98,7 +100,8 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject QSizeF labelSize; }; - /** Entry point called from QgsLegendRenderer to do the rendering. + /** + * Entry point called from QgsLegendRenderer to do the rendering. * Default implementation calls drawSymbol() and drawSymbolText() methods. * * If ctx is null, this is just first stage when preparing layout - without actual rendering. @@ -142,7 +145,8 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject #include "qgslegendsymbolitem.h" -/** \ingroup core +/** + * \ingroup core * Implementation of legend node interface for displaying preview of vector symbols and their labels * and allowing interaction with the symbol / renderer. * @@ -201,13 +205,15 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode */ QSize minimumIconSize( QgsRenderContext *context ) const; - /** Returns the symbol used by the legend node. + /** + * Returns the symbol used by the legend node. * \see setSymbol() * \since QGIS 2.14 */ const QgsSymbol *symbol() const; - /** Sets the symbol to be used by the legend node. The symbol change is also propagated + /** + * Sets the symbol to be used by the legend node. The symbol change is also propagated * to the associated vector layer's renderer. * \param symbol new symbol for node. Ownership is transferred. * \see symbol() @@ -217,13 +223,15 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode public slots: - /** Checks all items belonging to the same layer as this node. + /** + * Checks all items belonging to the same layer as this node. * \since QGIS 2.14 * \see uncheckAllItems() */ void checkAllItems(); - /** Unchecks all items belonging to the same layer as this node. + /** + * Unchecks all items belonging to the same layer as this node. * \since QGIS 2.14 * \see checkAllItems() */ @@ -242,14 +250,16 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode // ident the symbol icon to make it look like a tree structure static const int INDENT_SIZE = 20; - /** Sets all items belonging to the same layer as this node to the same check state. + /** + * Sets all items belonging to the same layer as this node to the same check state. * \param state check state */ void checkAll( bool state ); }; -/** \ingroup core +/** + * \ingroup core * Implementation of legend node interface for displaying arbitrary label with icon. * * \since QGIS 2.6 @@ -280,7 +290,8 @@ class CORE_EXPORT QgsSimpleLegendNode : public QgsLayerTreeModelLegendNode }; -/** \ingroup core +/** + * \ingroup core * Implementation of legend node interface for displaying arbitrary raster image * * \since QGIS 2.6 @@ -307,7 +318,8 @@ class CORE_EXPORT QgsImageLegendNode : public QgsLayerTreeModelLegendNode QImage mImage; }; -/** \ingroup core +/** + * \ingroup core * Implementation of legend node interface for displaying raster legend entries * * \since QGIS 2.6 @@ -338,7 +350,8 @@ class CORE_EXPORT QgsRasterSymbolLegendNode : public QgsLayerTreeModelLegendNode class QgsImageFetcher; -/** \ingroup core +/** + * \ingroup core * Implementation of legend node interface for displaying WMS legend entries * * \since QGIS 2.8 diff --git a/src/core/layertree/qgslayertreenode.h b/src/core/layertree/qgslayertreenode.h index 13f8c23605e8..7a6667f61a80 100644 --- a/src/core/layertree/qgslayertreenode.h +++ b/src/core/layertree/qgslayertreenode.h @@ -27,7 +27,8 @@ class QDomElement; class QgsProject; class QgsMapLayer; -/** \ingroup core +/** + * \ingroup core * This class is a base class for nodes in a layer tree. * Layer tree is a hierarchical structure consisting of group and layer nodes: * - group nodes are containers and may contain children (layer and group nodes) diff --git a/src/core/layertree/qgslayertreeregistrybridge.h b/src/core/layertree/qgslayertreeregistrybridge.h index 5be34db600ec..5b7d89befc11 100644 --- a/src/core/layertree/qgslayertreeregistrybridge.h +++ b/src/core/layertree/qgslayertreeregistrybridge.h @@ -28,7 +28,8 @@ class QgsMapLayer; class QgsProject; -/** \ingroup core +/** + * \ingroup core * Listens to the updates in map layer registry and does changes in layer tree. * * When connected to a layer tree, any layers added to the map layer registry diff --git a/src/core/layertree/qgslayertreeutils.h b/src/core/layertree/qgslayertreeutils.h index 70db8603b028..898081e05716 100644 --- a/src/core/layertree/qgslayertreeutils.h +++ b/src/core/layertree/qgslayertreeutils.h @@ -31,7 +31,8 @@ class QgsLayerTreeLayer; class QgsMapLayer; class QgsProject; -/** \ingroup core +/** + * \ingroup core * Assorted functions for dealing with layer trees. * * \since QGIS 2.4 diff --git a/src/core/layout/qgslayoutitem.h b/src/core/layout/qgslayoutitem.h index 478d9df053d6..14b563f2dda8 100644 --- a/src/core/layout/qgslayoutitem.h +++ b/src/core/layout/qgslayoutitem.h @@ -267,7 +267,8 @@ class CORE_EXPORT QgsLayoutItem : public QgsLayoutObject, public QGraphicsRectIt protected: - /** Draws a debugging rectangle of the item's current bounds within the specified + /** + * Draws a debugging rectangle of the item's current bounds within the specified * painter. * @param painter destination QPainter */ diff --git a/src/core/layout/qgslayoutobject.h b/src/core/layout/qgslayoutobject.h index 064a2b73d9c3..99b8bdf618bd 100644 --- a/src/core/layout/qgslayoutobject.h +++ b/src/core/layout/qgslayoutobject.h @@ -40,7 +40,8 @@ class CORE_EXPORT QgsLayoutObject: public QObject, public QgsExpressionContextGe Q_OBJECT public: - /** Data defined properties for different item types + /** + * Data defined properties for different item types */ enum DataDefinedProperty { diff --git a/src/core/pal/costcalculator.h b/src/core/pal/costcalculator.h index 2109a6fb6ac8..68756354645c 100644 --- a/src/core/pal/costcalculator.h +++ b/src/core/pal/costcalculator.h @@ -29,7 +29,8 @@ namespace pal { class Feats; - /** \ingroup core + /** + * \ingroup core */ class CostCalculator { @@ -45,11 +46,13 @@ namespace pal //! Sort candidates by costs, skip the worse ones, evaluate polygon candidates static int finalizeCandidatesCosts( Feats *feat, int max_p, RTree *obstacles, double bbx[4], double bby[4] ); - /** Sorts label candidates in ascending order of cost + /** + * Sorts label candidates in ascending order of cost */ static bool candidateSortGrow( const LabelPosition *c1, const LabelPosition *c2 ); - /** Sorts label candidates in descending order of cost + /** + * Sorts label candidates in descending order of cost */ static bool candidateSortShrink( const LabelPosition *c1, const LabelPosition *c2 ); }; diff --git a/src/core/pal/feature.h b/src/core/pal/feature.h index 52faea6ee718..9101adec0842 100644 --- a/src/core/pal/feature.h +++ b/src/core/pal/feature.h @@ -43,7 +43,8 @@ #include #include -/** \ingroup core +/** + * \ingroup core * \class pal::LabelInfo * \note not available in Python bindings */ @@ -97,7 +98,8 @@ namespace pal public: - /** Creates a new generic feature. + /** + * Creates a new generic feature. * \param lf a pointer for a feature which contains the spatial entites * \param geom a pointer to a GEOS geometry */ @@ -105,23 +107,28 @@ namespace pal FeaturePart( const FeaturePart &other ); - /** Delete the feature + /** + * Delete the feature */ virtual ~FeaturePart(); - /** Returns the parent feature. + /** + * Returns the parent feature. */ QgsLabelFeature *feature() { return mLF; } - /** Returns the layer that feature belongs to. + /** + * Returns the layer that feature belongs to. */ Layer *layer(); - /** Returns the unique ID of the feature. + /** + * Returns the unique ID of the feature. */ QgsFeatureId featureId() const; - /** Generic method to generate label candidates for the feature. + /** + * Generic method to generate label candidates for the feature. * \param lPos pointer to an array of candidates, will be filled by generated candidates * \param bboxMin min values of the map extent * \param bboxMax max values of the map extent @@ -131,7 +138,8 @@ namespace pal */ int createCandidates( QList &lPos, double bboxMin[2], double bboxMax[2], PointSet *mapShape, RTree *candidates ); - /** Generate candidates for point feature, located around a specified point. + /** + * Generate candidates for point feature, located around a specified point. * \param x x coordinate of the point * \param y y coordinate of the point * \param lPos pointer to an array of candidates, will be filled by generated candidates @@ -140,7 +148,8 @@ namespace pal */ int createCandidatesAroundPoint( double x, double y, QList &lPos, double angle ); - /** Generate one candidate over or offset the specified point. + /** + * Generate one candidate over or offset the specified point. * \param x x coordinate of the point * \param y y coordinate of the point * \param lPos pointer to an array of candidates, will be filled by generated candidate @@ -149,7 +158,8 @@ namespace pal */ int createCandidatesOverPoint( double x, double y, QList &lPos, double angle ); - /** Generates candidates following a prioritized list of predefined positions around a point. + /** + * Generates candidates following a prioritized list of predefined positions around a point. * \param x x coordinate of the point * \param y y coordinate of the point * \param lPos pointer to an array of candidates, will be filled by generated candidate @@ -158,14 +168,16 @@ namespace pal */ int createCandidatesAtOrderedPositionsOverPoint( double x, double y, QList &lPos, double angle ); - /** Generate candidates for line feature. + /** + * Generate candidates for line feature. * \param lPos pointer to an array of candidates, will be filled by generated candidates * \param mapShape a pointer to the line * \returns the number of generated candidates */ int createCandidatesAlongLine( QList &lPos, PointSet *mapShape ); - /** Generate candidates for line feature, by trying to place candidates towards the middle of the longest + /** + * Generate candidates for line feature, by trying to place candidates towards the middle of the longest * straightish segments of the line. Segments closer to horizontal are preferred over vertical segments. * \param lPos pointer to an array of candidates, will be filled by generated candidates * \param mapShape a pointer to the line @@ -173,7 +185,8 @@ namespace pal */ int createCandidatesAlongLineNearStraightSegments( QList &lPos, PointSet *mapShape ); - /** Generate candidates for line feature, by trying to place candidates as close as possible to the line's midpoint. + /** + * Generate candidates for line feature, by trying to place candidates as close as possible to the line's midpoint. * Candidates can "cut corners" if it helps them place near this mid point. * \param lPos pointer to an array of candidates, will be filled by generated candidates * \param mapShape a pointer to the line @@ -183,7 +196,8 @@ namespace pal */ int createCandidatesAlongLineNearMidpoint( QList &lPos, PointSet *mapShape, double initialCost = 0.0 ); - /** Returns the label position for a curved label at a specific offset along a path. + /** + * Returns the label position for a curved label at a specific offset along a path. * \param path_positions line path to place label on * \param path_distances array of distances to each segment on path * \param orientation can be 0 for automatic calculation of orientation, or -1/+1 for a specific label orientation @@ -196,21 +210,24 @@ namespace pal LabelPosition *curvedPlacementAtOffset( PointSet *path_positions, double *path_distances, int &orientation, int index, double distance, bool &reversed, bool &flip ); - /** Generate curved candidates for line features. + /** + * Generate curved candidates for line features. * \param lPos pointer to an array of candidates, will be filled by generated candidates * \param mapShape a pointer to the line * \returns the number of generated candidates */ int createCurvedCandidatesAlongLine( QList &lPos, PointSet *mapShape ); - /** Generate candidates for polygon features. + /** + * Generate candidates for polygon features. * \param lPos pointer to an array of candidates, will be filled by generated candidates * \param mapShape a pointer to the polygon * \returns the number of generated candidates */ int createCandidatesForPolygon( QList &lPos, PointSet *mapShape ); - /** Tests whether this feature part belongs to the same QgsLabelFeature as another + /** + * Tests whether this feature part belongs to the same QgsLabelFeature as another * feature part. * \param part part to compare to * \returns true if both parts belong to same QgsLabelFeature @@ -265,13 +282,15 @@ namespace pal //! Check whether this part is connected with some other part bool isConnected( FeaturePart *p2 ); - /** Merge other (connected) part with this one and save the result in this part (other is unchanged). + /** + * Merge other (connected) part with this one and save the result in this part (other is unchanged). * Return true on success, false if the feature wasn't modified */ bool mergeWithFeaturePart( FeaturePart *other ); void addSizePenalty( int nbp, QList &lPos, double bbx[4], double bby[4] ); - /** Calculates the priority for the feature. This will be the feature's priority if set, + /** + * Calculates the priority for the feature. This will be the feature's priority if set, * otherwise the layer's default priority. * \see Feature::setPriority * \see Feature::priority diff --git a/src/core/pal/geomfunction.h b/src/core/pal/geomfunction.h index a24d016bc68d..2c3fc28f5375 100644 --- a/src/core/pal/geomfunction.h +++ b/src/core/pal/geomfunction.h @@ -105,7 +105,8 @@ namespace pal //! Reorder points to have cross prod ((x,y)[i], (x,y)[i+1), point) > 0 when point is outside static int reorderPolygon( int nbPoints, double *x, double *y ); - /** Returns true if a GEOS prepared geometry totally contains a label candidate. + /** + * Returns true if a GEOS prepared geometry totally contains a label candidate. * \param geom GEOS prepared geometry * \param x candidate x * \param y candidate y diff --git a/src/core/pal/internalexception.h b/src/core/pal/internalexception.h index 50c163d085c2..ca1ef79c92ea 100644 --- a/src/core/pal/internalexception.h +++ b/src/core/pal/internalexception.h @@ -35,14 +35,16 @@ namespace pal { - /** \brief Various Exceptions + /** + * \brief Various Exceptions * \ingroup core */ class InternalException { public: - /** \brief Thrown when something is added in a Full set + /** + * \brief Thrown when something is added in a Full set * \ingroup core */ class Full : public std::exception @@ -53,7 +55,8 @@ namespace pal } }; - /** \brief Thrown when trying to access an empty data set + /** + * \brief Thrown when trying to access an empty data set * \ingroup core */ class Empty : public std::exception @@ -64,7 +67,8 @@ namespace pal } }; - /** \brief Thrown when a geometry type is not like expected + /** + * \brief Thrown when a geometry type is not like expected * \ingroup core */ class WrongGeometry : public std::exception @@ -75,7 +79,8 @@ namespace pal } }; - /** \brief Thrown when a geometry type is not like expected + /** + * \brief Thrown when a geometry type is not like expected * \ingroup core */ class UnknownGeometry : public std::exception @@ -87,7 +92,8 @@ namespace pal }; - /** \brief Throw an exception when it's impossible to compute labelPosition + /** + * \brief Throw an exception when it's impossible to compute labelPosition * \ingroup core */ class NoLabelPosition : public std::exception diff --git a/src/core/pal/labelposition.h b/src/core/pal/labelposition.h index 70bea52d6ba0..9beb4193407a 100644 --- a/src/core/pal/labelposition.h +++ b/src/core/pal/labelposition.h @@ -140,25 +140,29 @@ namespace pal //! Returns true if this label crosses the boundary of the specified polygon bool crossesBoundary( PointSet *polygon ) const; - /** Returns cost of position intersection with polygon (testing area of intersection and center). + /** + * Returns cost of position intersection with polygon (testing area of intersection and center). * Cost ranges between 0 and 12, with extra cost if center of label position is covered. */ int polygonIntersectionCost( PointSet *polygon ) const; - /** Returns true if if any intersection between polygon and position exists. + /** + * Returns true if if any intersection between polygon and position exists. */ bool intersectsWithPolygon( PointSet *polygon ) const; //! Shift the label by specified offset void offsetPosition( double xOffset, double yOffset ); - /** \brief return id + /** + * \brief return id * \returns id */ int getId() const; - /** \brief return the feature corresponding to this labelposition + /** + * \brief return the feature corresponding to this labelposition * \returns the feature */ FeaturePart *getFeaturePart(); @@ -168,7 +172,8 @@ namespace pal int getProblemFeatureId() const { return probFeat; } - /** Set problem feature ID and assigned label candidate ID. + /** + * Set problem feature ID and assigned label candidate ID. * called from pal.cpp during extraction */ void setProblemIds( int probFid, int lpId ) { @@ -177,25 +182,29 @@ namespace pal if ( nextPart ) nextPart->setProblemIds( probFid, lpId ); } - /** Returns the candidate label position's geographical cost. + /** + * Returns the candidate label position's geographical cost. * \see setCost */ double cost() const { return mCost; } - /** Sets the candidate label position's geographical cost. + /** + * Sets the candidate label position's geographical cost. * \param newCost new cost for position * \see cost */ void setCost( double newCost ) { mCost = newCost; } - /** Sets whether the position is marked as conflicting with an obstacle feature. + /** + * Sets whether the position is marked as conflicting with an obstacle feature. * \param conflicts set to true to mark candidate as being in conflict * \note This method applies to all label parts for the candidate position. * \see conflictsWithObstacle */ void setConflictsWithObstacle( bool conflicts ); - /** Returns whether the position is marked as conflicting with an obstacle feature. + /** + * Returns whether the position is marked as conflicting with an obstacle feature. * \see setConflictsWithObstacle */ bool conflictsWithObstacle() const { return mHasObstacleConflict; } @@ -309,11 +318,13 @@ namespace pal bool mHasObstacleConflict; int mUpsideDownCharCount; - /** Calculates the total number of parts for this label position + /** + * Calculates the total number of parts for this label position */ int partCount() const; - /** Calculates the polygon intersection cost for a single label position part + /** + * Calculates the polygon intersection cost for a single label position part * \returns double between 0 - 12 */ double polygonIntersectionCostForParts( PointSet *polygon ) const; diff --git a/src/core/pal/layer.h b/src/core/pal/layer.h index b2b513c5ab96..33856ce9499f 100644 --- a/src/core/pal/layer.h +++ b/src/core/pal/layer.h @@ -82,38 +82,45 @@ namespace pal bool displayAll() const { return mDisplayAll; } - /** Returns the number of features in layer. + /** + * Returns the number of features in layer. */ int featureCount() { return mHashtable.size(); } //! Returns pointer to the associated provider QgsAbstractLabelProvider *provider() const { return mProvider; } - /** Returns the layer's name. + /** + * Returns the layer's name. */ QString name() const { return mName; } - /** Returns the layer's arrangement policy. + /** + * Returns the layer's arrangement policy. * \see setArrangement */ QgsPalLayerSettings::Placement arrangement() const { return mArrangement; } - /** Returns true if the layer has curved labels + /** + * Returns true if the layer has curved labels */ bool isCurved() const { return mArrangement == QgsPalLayerSettings::Curved || mArrangement == QgsPalLayerSettings::PerimeterCurved; } - /** Sets the layer's arrangement policy. + /** + * Sets the layer's arrangement policy. * \param arrangement arrangement policy * \see arrangement */ void setArrangement( QgsPalLayerSettings::Placement arrangement ) { mArrangement = arrangement; } - /** Returns the layer's arrangement flags. + /** + * Returns the layer's arrangement flags. * \see setArrangementFlags */ LineArrangementFlags arrangementFlags() const { return mArrangementFlags; } - /** Sets the layer's arrangement flags. + /** + * Sets the layer's arrangement flags. * \param flags arrangement flags * \see arrangementFlags */ @@ -131,12 +138,14 @@ namespace pal */ void setActive( bool active ) { mActive = active; } - /** Returns whether the layer is currently active. + /** + * Returns whether the layer is currently active. * \see setActive */ bool active() const { return mActive; } - /** Sets whether the layer will be labeled. + /** + * Sets whether the layer will be labeled. * \note Layers are labelled if and only if labelLayer and active are true * \param toLabel set to false disable labeling this layer * \see labelLayer @@ -144,71 +153,83 @@ namespace pal */ void setLabelLayer( bool toLabel ) { mLabelLayer = toLabel; } - /** Returns whether the layer will be labeled or not. + /** + * Returns whether the layer will be labeled or not. * \see setLabelLayer */ bool labelLayer() const { return mLabelLayer; } - /** Returns the obstacle type, which controls how features within the layer + /** + * Returns the obstacle type, which controls how features within the layer * act as obstacles for labels. * \see setObstacleType */ QgsPalLayerSettings::ObstacleType obstacleType() const { return mObstacleType; } - /** Sets the obstacle type, which controls how features within the layer + /** + * Sets the obstacle type, which controls how features within the layer * act as obstacles for labels. * \param obstacleType new obstacle type * \see obstacleType */ void setObstacleType( QgsPalLayerSettings::ObstacleType obstacleType ) { mObstacleType = obstacleType; } - /** Sets the layer's priority. + /** + * Sets the layer's priority. * \param priority layer priority, between 0 and 1. 0 corresponds to highest priority, * 1 to lowest priority. * \see priority */ void setPriority( double priority ); - /** Returns the layer's priority, between 0 and 1. 0 corresponds to highest priority, + /** + * Returns the layer's priority, between 0 and 1. 0 corresponds to highest priority, * 1 to lowest priority. * \see setPriority */ double priority() const { return mDefaultPriority; } - /** Sets the layer's labeling mode. + /** + * Sets the layer's labeling mode. * \param mode label mode * \see labelMode */ void setLabelMode( LabelMode mode ) { mMode = mode; } - /** Returns the layer's labeling mode. + /** + * Returns the layer's labeling mode. * \see setLabelMode */ LabelMode labelMode() const { return mMode; } - /** Sets whether connected lines should be merged before labeling + /** + * Sets whether connected lines should be merged before labeling * \param merge set to true to merge connected lines * \see mergeConnectedLines */ void setMergeConnectedLines( bool merge ) { mMergeLines = merge; } - /** Returns whether connected lines will be merged before labeling. + /** + * Returns whether connected lines will be merged before labeling. * \see setMergeConnectedLines */ bool mergeConnectedLines() const { return mMergeLines; } - /** Sets how upside down labels will be handled within the layer. + /** + * Sets how upside down labels will be handled within the layer. * \param ud upside down label handling mode * \see upsideDownLabels */ void setUpsidedownLabels( UpsideDownLabels ud ) { mUpsidedownLabels = ud; } - /** Returns how upside down labels are handled within the layer. + /** + * Returns how upside down labels are handled within the layer. * \see setUpsidedownLabels */ UpsideDownLabels upsidedownLabels() const { return mUpsidedownLabels; } - /** Sets whether labels placed at the centroid of features within the layer + /** + * Sets whether labels placed at the centroid of features within the layer * are forced to be placed inside the feature's geometry. * \param forceInside set to true to force centroid labels to be within the * feature. If set to false then the centroid may fall outside the feature. @@ -216,13 +237,15 @@ namespace pal */ void setCentroidInside( bool forceInside ) { mCentroidInside = forceInside; } - /** Returns whether labels placed at the centroid of features within the layer + /** + * Returns whether labels placed at the centroid of features within the layer * are forced to be placed inside the feature's geometry. * \see setCentroidInside */ bool centroidInside() const { return mCentroidInside; } - /** Register a feature in the layer. + /** + * Register a feature in the layer. * * Does not take ownership of the label feature (it is owned by its provider). * @@ -235,7 +258,8 @@ namespace pal //! Join connected features with the same label text void joinConnectedFeatures(); - /** Returns the connected feature ID for a label feature ID, which is unique for all features + /** + * Returns the connected feature ID for a label feature ID, which is unique for all features * which have been joined as a result of joinConnectedFeatures() * \returns connected feature ID, or -1 if feature was not joined */ diff --git a/src/core/pal/pal.h b/src/core/pal/pal.h index e5fdb1db4d08..7dbfcacfc9e0 100644 --- a/src/core/pal/pal.h +++ b/src/core/pal/pal.h @@ -77,7 +77,8 @@ namespace pal }; Q_DECLARE_FLAGS( LineArrangementFlags, LineArrangementFlag ) - /** \ingroup core + /** + * \ingroup core * \brief Main Pal labeling class * * A pal object will contains layers and global information such as which search method diff --git a/src/core/pal/palexception.h b/src/core/pal/palexception.h index 8e0ba8f87540..f029f7966f10 100644 --- a/src/core/pal/palexception.h +++ b/src/core/pal/palexception.h @@ -36,14 +36,16 @@ namespace pal { - /** \brief Various Exceptions + /** + * \brief Various Exceptions * \ingroup core */ class PalException { public: - /** \brief Thrown when a feature is not yet implemented + /** + * \brief Thrown when a feature is not yet implemented * \ingroup core */ class NotImplemented : public std::exception @@ -54,7 +56,8 @@ namespace pal } }; - /** \brief Try to access an unknown feature + /** + * \brief Try to access an unknown feature * \ingroup core */ class UnknownFeature : public std::exception @@ -65,7 +68,8 @@ namespace pal } }; - /** \brief Try to access an unknown layer + /** + * \brief Try to access an unknown layer * \ingroup core */ class UnknownLayer : public std::exception @@ -76,7 +80,8 @@ namespace pal } }; - /** \brief layer already exists + /** + * \brief layer already exists * \ingroup core */ class LayerExists : public std::exception @@ -87,7 +92,8 @@ namespace pal } }; - /** \brief features already exists + /** + * \brief features already exists * \ingroup core */ class FeatureExists : public std::exception @@ -98,7 +104,8 @@ namespace pal } }; - /** \brief thrown when a value is not in the valid scale range\ + /** + * \brief thrown when a value is not in the valid scale range\ * \ingroup core * * It can be thrown by : diff --git a/src/core/pal/palstat.h b/src/core/pal/palstat.h index 231275ae4270..ee7cb68accf8 100644 --- a/src/core/pal/palstat.h +++ b/src/core/pal/palstat.h @@ -38,7 +38,8 @@ namespace pal { - /** \ingroup core + /** + * \ingroup core * \brief Summary statistics of labeling problem. * \class pal::PalStat * \note not available in Python bindings diff --git a/src/core/pal/pointset.h b/src/core/pal/pointset.h index de81a51678b6..902b6803a85d 100644 --- a/src/core/pal/pointset.h +++ b/src/core/pal/pointset.h @@ -80,14 +80,16 @@ namespace pal PointSet *extractShape( int nbPtSh, int imin, int imax, int fps, int fpe, double fptx, double fpty ); - /** Tests whether point set contains a specified point. + /** + * Tests whether point set contains a specified point. * \param x x-coordinate of point * \param y y-coordinate of point * \returns true if point set contains a specified point */ bool containsPoint( double x, double y ) const; - /** Tests whether a possible label candidate will fit completely within the shape. + /** + * Tests whether a possible label candidate will fit completely within the shape. * \param x x-coordinate of label candidate * \param y y-coordinate of label candidate * \param width label width @@ -99,13 +101,15 @@ namespace pal CHullBox *compute_chull_bbox(); - /** Split a concave shape into several convex shapes. + /** + * Split a concave shape into several convex shapes. */ static void splitPolygons( QLinkedList &shapes_toProcess, QLinkedList &shapes_final, double xrm, double yrm ); - /** Returns the squared minimum distance between the point set geometry and the point (px,py) + /** + * Returns the squared minimum distance between the point set geometry and the point (px,py) * Optionally, the nearest point is stored in (rx,ry). * \param px x coordinate of the point * \param py y coordinate of the points @@ -132,7 +136,8 @@ namespace pal int getNumPoints() const { return nbPoints; } - /** Get a point a set distance along a line geometry. + /** + * Get a point a set distance along a line geometry. * \param d array of distances between points * \param ad cumulative total distance from pt0 to each point (ad0 = pt0->pt0) * \param dl distance to traverse along line @@ -141,11 +146,13 @@ namespace pal */ void getPointByDistance( double *d, double *ad, double dl, double *px, double *py ); - /** Returns the point set's GEOS geometry. + /** + * Returns the point set's GEOS geometry. */ const GEOSGeometry *geos() const; - /** Returns length of line geometry. + /** + * Returns length of line geometry. */ double length() const; diff --git a/src/core/pal/priorityqueue.h b/src/core/pal/priorityqueue.h index f5cf92f3949f..e88bf0e20ffe 100644 --- a/src/core/pal/priorityqueue.h +++ b/src/core/pal/priorityqueue.h @@ -53,7 +53,8 @@ namespace pal public: - /** \brief Create a priority queue of max size n + /** + * \brief Create a priority queue of max size n * \\param n max size of the queuet * \\param p external vector representing the priority * \\param min best element has the smalest p when min is True ans has the biggest when min is false diff --git a/src/core/pal/problem.h b/src/core/pal/problem.h index 44f841188d0e..1451a02750b8 100644 --- a/src/core/pal/problem.h +++ b/src/core/pal/problem.h @@ -121,7 +121,8 @@ namespace pal //! Problem cannot be copied Problem &operator=( const Problem &other ) = delete; - /** Adds a candidate label position to the problem. + /** + * Adds a candidate label position to the problem. * \param position label candidate position. Ownership is transferred to Problem. * \since QGIS 2.12 */ diff --git a/src/core/pal/rtree.hpp b/src/core/pal/rtree.hpp index b003bf6f9c64..fc469846b446 100644 --- a/src/core/pal/rtree.hpp +++ b/src/core/pal/rtree.hpp @@ -44,7 +44,8 @@ namespace pal class RTFileStream; // File I/O helper class, look below for implementation and notes. - /** \ingroup core + /** + * \ingroup core Implementation of RTree, a multidimensional bounding rectangle tree. Example usage: For a 3-dimensional tree use RTree myTree; @@ -123,7 +124,8 @@ namespace pal /// Save tree contents to stream bool Save( RTFileStream &a_stream ); - /** \ingroup core + /** + * \ingroup core * Iterator is not remove safe. */ class Iterator @@ -361,7 +363,8 @@ namespace pal // Because there is not stream support, this is a quick and dirty file I/O helper. // Users will likely replace its usage with a Stream implementation from their favorite API. - /** \ingroup core + /** + * \ingroup core */ class RTFileStream { diff --git a/src/core/qgis.h b/src/core/qgis.h index 6be2a4c73e95..6b3e607eff73 100644 --- a/src/core/qgis.h +++ b/src/core/qgis.h @@ -48,7 +48,8 @@ int QgisEvent = QEvent::User + 1; #endif -/** \ingroup core +/** + * \ingroup core * The Qgis class provides global constants for use throughout the application. */ class CORE_EXPORT Qgis @@ -68,7 +69,8 @@ class CORE_EXPORT Qgis // Enumerations // - /** Raster data types. + /** + * Raster data types. * This is modified and extended copy of GDALDataType. */ enum DataType @@ -89,33 +91,39 @@ class CORE_EXPORT Qgis ARGB32_Premultiplied = 13 //!< Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32_Premultiplied }; - /** Identify search radius in mm + /** + * Identify search radius in mm * \since QGIS 2.3 */ static const double DEFAULT_SEARCH_RADIUS_MM; //! Default threshold between map coordinates and device coordinates for map2pixel simplification static const float DEFAULT_MAPTOPIXEL_THRESHOLD; - /** Default highlight color. The transparency is expected to only be applied to polygon + /** + * Default highlight color. The transparency is expected to only be applied to polygon * fill. Lines and outlines are rendered opaque. * \since QGIS 2.3 */ static const QColor DEFAULT_HIGHLIGHT_COLOR; - /** Default highlight buffer in mm. + /** + * Default highlight buffer in mm. * \since QGIS 2.3 */ static const double DEFAULT_HIGHLIGHT_BUFFER_MM; - /** Default highlight line/stroke minimum width in mm. + /** + * Default highlight line/stroke minimum width in mm. * \since QGIS 2.3 */ static const double DEFAULT_HIGHLIGHT_MIN_WIDTH_MM; - /** Fudge factor used to compare two scales. The code is often going from scale to scale + /** + * Fudge factor used to compare two scales. The code is often going from scale to scale * denominator. So it looses precision and, when a limit is inclusive, can lead to errors. * To avoid that, use this factor instead of using <= or >=. * \since QGIS 2.15*/ static const double SCALE_PRECISION; - /** Default Z coordinate value for 2.5d geometry + /** + * Default Z coordinate value for 2.5d geometry * This value have to be assigned to the Z coordinate for the new 2.5d geometry vertex. * \since QGIS 3.0 */ static const double DEFAULT_Z_COORDINATE; @@ -136,7 +144,8 @@ class CORE_EXPORT Qgis #define cast_to_fptr(f) f -/** \ingroup core +/** + * \ingroup core * RAII signal blocking class. Used for temporarily blocking signals from a QObject * for the lifetime of QgsSignalBlocker object. * \see whileBlocking() @@ -148,7 +157,8 @@ template class QgsSignalBlocker SIP_SKIP SIP_SKIP // clazy:exclude { public: - /** Constructor for QgsSignalBlocker + /** + * Constructor for QgsSignalBlocker * \param object QObject to block signals from */ explicit QgsSignalBlocker( Object *object ) @@ -171,7 +181,8 @@ template class QgsSignalBlocker SIP_SKIP SIP_SKIP // clazy:exclude }; -/** Temporarily blocks signals from a QObject while calling a single method from the object. +/** + * Temporarily blocks signals from a QObject while calling a single method from the object. * * Usage: * whileBlocking( checkBox )->setChecked( true ); @@ -281,7 +292,8 @@ void qgsAsConst( const T && ) = delete; ///@endcond #endif -/** Converts a string to a double in a permissive way, e.g., allowing for incorrect +/** + * Converts a string to a double in a permissive way, e.g., allowing for incorrect * numbers of digits between thousand separators * \param string string to convert * \param ok will be set to true if conversion was successful @@ -291,7 +303,8 @@ void qgsAsConst( const T && ) = delete; */ CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok ); -/** Converts a string to an integer in a permissive way, e.g., allowing for incorrect +/** + * Converts a string to an integer in a permissive way, e.g., allowing for incorrect * numbers of digits between thousand separators * \param string string to convert * \param ok will be set to true if conversion was successful @@ -319,13 +332,15 @@ CORE_EXPORT bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs CORE_EXPORT QString qgsVsiPrefix( const QString &path ); -/** Allocates size bytes and returns a pointer to the allocated memory. +/** + * Allocates size bytes and returns a pointer to the allocated memory. Works like C malloc() but prints debug message by QgsLogger if allocation fails. \param size size in bytes */ void CORE_EXPORT *qgsMalloc( size_t size ) SIP_SKIP; -/** Allocates memory for an array of nmemb elements of size bytes each and returns +/** + * Allocates memory for an array of nmemb elements of size bytes each and returns a pointer to the allocated memory. Works like C calloc() but prints debug message by QgsLogger if allocation fails. \param nmemb number of elements @@ -333,12 +348,14 @@ void CORE_EXPORT *qgsMalloc( size_t size ) SIP_SKIP; */ void CORE_EXPORT *qgsCalloc( size_t nmemb, size_t size ) SIP_SKIP; -/** Frees the memory space pointed to by ptr. Works like C free(). +/** + * Frees the memory space pointed to by ptr. Works like C free(). \param ptr pointer to memory space */ void CORE_EXPORT qgsFree( void *ptr ) SIP_SKIP; -/** Wkt string that represents a geographic coord sys +/** + * Wkt string that represents a geographic coord sys * \since QGIS GEOWkt */ extern CORE_EXPORT const QString GEOWKT; @@ -355,7 +372,8 @@ const long GEO_EPSG_CRS_ID = 4326; //! Geographic coord sys from EPSG authority extern CORE_EXPORT const QString GEO_EPSG_CRS_AUTHID; -/** Magick number that determines whether a projection crsid is a system (srs.db) +/** + * Magick number that determines whether a projection crsid is a system (srs.db) * or user (~/.qgis.qgis.db) defined projection. */ const int USER_CRS_START_ID = 100000; @@ -375,7 +393,8 @@ const double DEFAULT_SEGMENT_EPSILON = 1e-8; typedef QMap QgsStringMap SIP_SKIP; -/** Qgssize is used instead of size_t, because size_t is stdlib type, unknown +/** + * Qgssize is used instead of size_t, because size_t is stdlib type, unknown * by SIP, and it would be hard to define size_t correctly in SIP. * Currently used "unsigned long long" was introduced in C++11 (2011) * but it was supported already before C++11 on common platforms. diff --git a/src/core/qgsaction.h b/src/core/qgsaction.h index 020cd7e3bcd9..27eaec689d61 100644 --- a/src/core/qgsaction.h +++ b/src/core/qgsaction.h @@ -28,7 +28,8 @@ class QgsExpressionContextScope; -/** \ingroup core +/** + * \ingroup core * Utility class that encapsulates an action based on vector attributes. */ class CORE_EXPORT QgsAction diff --git a/src/core/qgsactionmanager.h b/src/core/qgsactionmanager.h index 7cf036db5cd5..966cf2ae6176 100644 --- a/src/core/qgsactionmanager.h +++ b/src/core/qgsactionmanager.h @@ -39,7 +39,8 @@ class QgsVectorLayer; class QgsExpressionContextScope; class QgsExpressionContext; -/** \ingroup core +/** + * \ingroup core * \class QgsActionManager * Storage and management of actions associated with a layer. * @@ -57,7 +58,8 @@ class CORE_EXPORT QgsActionManager: public QObject : mLayer( layer ) {} - /** Add an action with the given name and action details. + /** + * Add an action with the given name and action details. * Will happily have duplicate names and actions. If * capture is true, when running the action using doAction(), * any stdout from the process will be captured and displayed in a @@ -65,7 +67,8 @@ class CORE_EXPORT QgsActionManager: public QObject */ QUuid addAction( QgsAction::ActionType type, const QString &name, const QString &command, bool capture = false ); - /** Add an action with the given name and action details. + /** + * Add an action with the given name and action details. * Will happily have duplicate names and actions. If * capture is true, when running the action using doAction(), * any stdout from the process will be captured and displayed in a @@ -85,13 +88,15 @@ class CORE_EXPORT QgsActionManager: public QObject */ void removeAction( const QUuid &actionId ); - /** Does the given action. defaultValueIndex is the index of the + /** + * Does the given action. defaultValueIndex is the index of the * field to be used if the action has a $currfield placeholder. * \note available in Python bindings as doActionFeature */ void doAction( const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex = 0 ) SIP_PYNAME( doActionFeature ); - /** Does the action using the expression engine to replace any embedded expressions + /** + * Does the action using the expression engine to replace any embedded expressions * in the action definition. * \param actionId action id * \param feature feature to run action for diff --git a/src/core/qgsactionscope.h b/src/core/qgsactionscope.h index a04f1c9cac3c..473741ef877d 100644 --- a/src/core/qgsactionscope.h +++ b/src/core/qgsactionscope.h @@ -20,7 +20,8 @@ #include #include "qgsexpressioncontext.h" -/** \ingroup core +/** + * \ingroup core * An action scope defines a "place" for an action to be shown and may add * additional expression variables. * Each QgsAction can be available in one or several action scopes. diff --git a/src/core/qgsactionscoperegistry.h b/src/core/qgsactionscoperegistry.h index 09cf85c3c95a..e7448765c15a 100644 --- a/src/core/qgsactionscoperegistry.h +++ b/src/core/qgsactionscoperegistry.h @@ -21,7 +21,8 @@ #include #include "qgsactionscope.h" -/** \ingroup core +/** + * \ingroup core * The action scope registry is an application wide registry that * contains a list of available action scopes. * Some scopes are available by default, additional ones can be registered diff --git a/src/core/qgsaggregatecalculator.h b/src/core/qgsaggregatecalculator.h index 73eebbbd722d..ddb2f9d48937 100644 --- a/src/core/qgsaggregatecalculator.h +++ b/src/core/qgsaggregatecalculator.h @@ -30,7 +30,8 @@ class QgsExpression; class QgsVectorLayer; class QgsExpressionContext; -/** \ingroup core +/** + * \ingroup core * \class QgsAggregateCalculator * \brief Utility class for calculating aggregates for a field (or expression) over the features * from a vector layer. It is recommended that QgsVectorLayer::aggregate() is used rather then @@ -75,57 +76,67 @@ class CORE_EXPORT QgsAggregateCalculator struct AggregateParameters { - /** Optional filter for calculating aggregate over a subset of features, or an + /** + * Optional filter for calculating aggregate over a subset of features, or an * empty string to use all features. * \see QgsAggregateCalculator::setFilter() * \see QgsAggregateCalculator::filter() */ QString filter; - /** Delimiter to use for joining values with the StringConcatenate aggregate. + /** + * Delimiter to use for joining values with the StringConcatenate aggregate. * \see QgsAggregateCalculator::setDelimiter() * \see QgsAggregateCalculator::delimiter() */ QString delimiter; }; - /** Constructor for QgsAggregateCalculator. + /** + * Constructor for QgsAggregateCalculator. * \param layer vector layer to calculate aggregate from */ QgsAggregateCalculator( const QgsVectorLayer *layer ); - /** Returns the associated vector layer. + /** + * Returns the associated vector layer. */ const QgsVectorLayer *layer() const; - /** Sets all aggregate parameters from a parameter bundle. + /** + * Sets all aggregate parameters from a parameter bundle. * \param parameters aggregate parameters */ void setParameters( const AggregateParameters ¶meters ); - /** Sets a filter to limit the features used during the aggregate calculation. + /** + * Sets a filter to limit the features used during the aggregate calculation. * \param filterExpression expression for filtering features, or empty string to remove filter * \see filter() */ void setFilter( const QString &filterExpression ) { mFilterExpression = filterExpression; } - /** Returns the filter which limits the features used during the aggregate calculation. + /** + * Returns the filter which limits the features used during the aggregate calculation. * \see setFilter() */ QString filter() const { return mFilterExpression; } - /** Sets the delimiter to use for joining values with the StringConcatenate aggregate. + /** + * Sets the delimiter to use for joining values with the StringConcatenate aggregate. * \param delimiter string delimiter * \see delimiter() */ void setDelimiter( const QString &delimiter ) { mDelimiter = delimiter; } - /** Returns the delimiter used for joining values with the StringConcatenate aggregate. + /** + * Returns the delimiter used for joining values with the StringConcatenate aggregate. * \see setDelimiter() */ QString delimiter() const { return mDelimiter; } - /** Calculates the value of an aggregate. + /** + * Calculates the value of an aggregate. * \param aggregate aggregate to calculate * \param fieldOrExpression source field or expression to use as basis for aggregated values. * If an expression is used, then the context parameter must be set. @@ -136,7 +147,8 @@ class CORE_EXPORT QgsAggregateCalculator QVariant calculate( Aggregate aggregate, const QString &fieldOrExpression, QgsExpressionContext *context = nullptr, bool *ok = nullptr ) const; - /** Converts a string to a aggregate type. + /** + * Converts a string to a aggregate type. * \param string string to convert * \param ok if specified, will be set to true if conversion was successful * \returns aggregate type diff --git a/src/core/qgsanimatedicon.h b/src/core/qgsanimatedicon.h index dc283ed2e831..8c21adde4355 100644 --- a/src/core/qgsanimatedicon.h +++ b/src/core/qgsanimatedicon.h @@ -23,7 +23,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * Animated icon is keeping an animation running if there are listeners connected to frameChanged */ class CORE_EXPORT QgsAnimatedIcon : public QObject diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h index 1ffa4b558f15..9907128d7b4f 100644 --- a/src/core/qgsapplication.h +++ b/src/core/qgsapplication.h @@ -45,7 +45,8 @@ class QgsUserProfileManager; class QgsPageSizeRegistry; class QgsLayoutItemRegistry; -/** \ingroup core +/** + * \ingroup core * Extends QApplication to provide access to QGIS specific resources such * as theme paths, database paths etc. * @@ -152,7 +153,8 @@ class CORE_EXPORT QgsApplication : public QApplication */ static QgsApplication *instance(); - /** This method initializes paths etc for QGIS. Called by the ctor or call it manually + /** + * This method initializes paths etc for QGIS. Called by the ctor or call it manually when your app does not extend the QApplication class. \note you will probably want to call initQgis too to load the providers in the above case. @@ -169,7 +171,8 @@ class CORE_EXPORT QgsApplication : public QApplication //! Set the FileOpen event receiver static void setFileOpenEventReceiver( QObject *receiver ); - /** Set the active theme to the specified theme. + /** + * Set the active theme to the specified theme. * The theme name should be a single word e.g. 'default','classic'. * The theme search path usually will be pkgDataPath + "/themes/" + themName + "/" * but plugin writers etc can use themeName() as a basis for searching @@ -180,7 +183,8 @@ class CORE_EXPORT QgsApplication : public QApplication */ static void setThemeName( const QString &themeName ); - /** Set the active theme to the specified theme. + /** + * Set the active theme to the specified theme. * The theme name should be a single word e.g. 'default','classic'. * The theme search path usually will be pkgDataPath + "/themes/" + themName + "/" * but plugin writers etc can use this method as a basis for searching @@ -208,12 +212,14 @@ class CORE_EXPORT QgsApplication : public QApplication //! Returns the path to the authors file. static QString authorsFilePath(); - /** Returns the path to the contributors file. + /** + * Returns the path to the contributors file. * Contributors are people who have submitted patches * but don't have commit access. */ static QString contributorsFilePath(); - /** Returns the path to the developers map file. + /** + * Returns the path to the developers map file. * The developers map was created by using leaflet framework, * it shows the doc/contributors.json file. * \since QGIS 2.7 */ @@ -238,7 +244,8 @@ class CORE_EXPORT QgsApplication : public QApplication //! Returns the path to the translation directory. static QString i18nPath(); - /** Returns the path to the metadata directory. + /** + * Returns the path to the metadata directory. * \since QGIS 3.0 */ static QString metadataPath(); @@ -312,31 +319,36 @@ class CORE_EXPORT QgsApplication : public QApplication //! Returns the short name regular expression for line edit validator static QRegExp shortNameRegExp(); - /** Returns the user's operating system login account name. + /** + * Returns the user's operating system login account name. * \since QGIS 2.14 * \see userFullName() */ static QString userLoginName(); - /** Returns the user's operating system login account full display name. + /** + * Returns the user's operating system login account full display name. * \since QGIS 2.14 * \see userLoginName() */ static QString userFullName(); - /** Returns a string name of the operating system QGIS is running on. + /** + * Returns a string name of the operating system QGIS is running on. * \since QGIS 2.14 * \see platform() */ static QString osName(); - /** Returns the QGIS platform name, e.g., "desktop" or "server". + /** + * Returns the QGIS platform name, e.g., "desktop" or "server". * \since QGIS 2.14 * \see osName() */ static QString platform(); - /** Returns the QGIS locale. + /** + * Returns the QGIS locale. * \since QGIS 3.0 */ static QString locale(); @@ -396,7 +408,8 @@ class CORE_EXPORT QgsApplication : public QApplication //! Returns whether this machine uses big or little endian static endian_t endian(); - /** Swap the endianness of the specified value. + /** + * Swap the endianness of the specified value. * \note not available in Python bindings */ #ifndef SIP_RUN @@ -412,7 +425,8 @@ class CORE_EXPORT QgsApplication : public QApplication } #endif - /** \brief get a standard css style sheet for reports. + /** + * \brief get a standard css style sheet for reports. * Typically you will use this method by doing: * QString myStyle = QgsApplication::reportStyleSheet(); * textBrowserReport->document()->setDefaultStyleSheet(myStyle); @@ -422,11 +436,13 @@ class CORE_EXPORT QgsApplication : public QApplication */ static QString reportStyleSheet(); - /** Convenience function to get a summary of the paths used in this + /** + * Convenience function to get a summary of the paths used in this * application instance useful for debugging mainly.*/ static QString showSettings(); - /** Register OGR drivers ensuring this only happens once. + /** + * Register OGR drivers ensuring this only happens once. * This is a workaround for an issue with older gdal versions that * caused duplicate driver name entries to appear in the list * of registered drivers when QgsApplication::registerOgrDrivers was called multiple @@ -449,34 +465,40 @@ class CORE_EXPORT QgsApplication : public QApplication //! Returns path to the build output directory. Valid only when running from build directory static QString buildOutputPath() { return ABISYM( mBuildOutputPath ); } - /** Sets the GDAL_SKIP environment variable to include the specified driver + /** + * Sets the GDAL_SKIP environment variable to include the specified driver * and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. The * driver name should be the short format of the Gdal driver name e.g. GTIFF. */ static void skipGdalDriver( const QString &driver ); - /** Sets the GDAL_SKIP environment variable to exclude the specified driver + /** + * Sets the GDAL_SKIP environment variable to exclude the specified driver * and then calls GDALDriverManager::AutoSkipDrivers() to unregister it. The * driver name should be the short format of the Gdal driver name e.g. GTIFF. */ static void restoreGdalDriver( const QString &driver ); - /** Returns the list of gdal drivers that should be skipped (based on + /** + * Returns the list of gdal drivers that should be skipped (based on * GDAL_SKIP environment variable) */ static QStringList skippedGdalDrivers() { return ABISYM( mGdalSkipList ); } - /** Apply the skipped drivers list to gdal + /** + * Apply the skipped drivers list to gdal * \see skipGdalDriver * \see restoreGdalDriver * \see skippedGdalDrivers */ static void applyGdalSkippedDrivers(); - /** Get maximum concurrent thread count + /** + * Get maximum concurrent thread count * \since QGIS 2.4 */ static int maxThreads() { return ABISYM( mMaxThreads ); } - /** Set maximum concurrent thread count + /** + * Set maximum concurrent thread count * \note must be between 1 and \#cores, -1 means use all available cores * \since QGIS 2.4 */ static void setMaxThreads( int maxThreads ); @@ -695,7 +717,8 @@ class CORE_EXPORT QgsApplication : public QApplication //! Path to the output directory of the build. valid only when running from build directory static QString ABISYM( mBuildOutputPath ); - /** List of gdal drivers to be skipped. Uses GDAL_SKIP to exclude them. + /** + * List of gdal drivers to be skipped. Uses GDAL_SKIP to exclude them. * \see skipGdalDriver, restoreGdalDriver */ static QStringList ABISYM( mGdalSkipList ); diff --git a/src/core/qgsattributeeditorelement.h b/src/core/qgsattributeeditorelement.h index 4b68cb6c8e90..2849341b8934 100644 --- a/src/core/qgsattributeeditorelement.h +++ b/src/core/qgsattributeeditorelement.h @@ -22,7 +22,8 @@ class QgsRelationManager; -/** \ingroup core +/** + * \ingroup core * This is an abstract base class for any elements of a drag and drop form. * * This can either be a container which will be represented on the screen @@ -157,7 +158,8 @@ class CORE_EXPORT QgsAttributeEditorElement SIP_ABSTRACT }; -/** \ingroup core +/** + * \ingroup core * This is a container for attribute editors, used to group them visually in the * attribute form if it is set to the drag and drop designer. */ @@ -272,7 +274,8 @@ class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement QgsOptionalExpression mVisibilityExpression; }; -/** \ingroup core +/** + * \ingroup core * This element will load a field's widget onto the form. */ class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement @@ -305,7 +308,8 @@ class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement int mIdx; }; -/** \ingroup core +/** + * \ingroup core * This element will load a relation editor onto the form. */ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement diff --git a/src/core/qgsattributes.h b/src/core/qgsattributes.h index 5d9e548ce0ca..f7ccb9bcb428 100644 --- a/src/core/qgsattributes.h +++ b/src/core/qgsattributes.h @@ -49,7 +49,8 @@ typedef QMap QgsFieldMap; #endif -/** \ingroup core +/** + * \ingroup core * A vector of attributes. Mostly equal to QVector. \note QgsAttributes is implemented as a Python list of Python objects. */ diff --git a/src/core/qgsattributetableconfig.h b/src/core/qgsattributetableconfig.h index 57843b868550..6e1e14cc281e 100644 --- a/src/core/qgsattributetableconfig.h +++ b/src/core/qgsattributetableconfig.h @@ -26,7 +26,8 @@ class QgsFields; -/** \ingroup core +/** + * \ingroup core * This is a container for configuration of the attribute table. * The configuration is specific for one vector layer. * \since QGIS 2.16 @@ -82,11 +83,13 @@ class CORE_EXPORT QgsAttributeTableConfig */ QVector columns() const; - /** Returns true if the configuration is empty, ie it contains no columns. + /** + * Returns true if the configuration is empty, ie it contains no columns. */ bool isEmpty() const; - /** Maps a visible column index to its original column index. + /** + * Maps a visible column index to its original column index. * \param visibleColumn index of visible column * \returns corresponding index when hidden columns are considered */ @@ -146,26 +149,30 @@ class CORE_EXPORT QgsAttributeTableConfig */ void setSortExpression( const QString &sortExpression ); - /** Returns the width of a column, or -1 if column should use default width. + /** + * Returns the width of a column, or -1 if column should use default width. * \param column column index * \see setColumnWidth() */ int columnWidth( int column ) const; - /** Sets the width of a column. + /** + * Sets the width of a column. * \param column column index * \param width column width in pixels, or -1 if column should use default width * \see columnWidth() */ void setColumnWidth( int column, int width ); - /** Returns true if the specified column is hidden. + /** + * Returns true if the specified column is hidden. * \param column column index * \see setColumnHidden() */ bool columnHidden( int column ) const; - /** Sets whether the specified column should be hidden. + /** + * Sets whether the specified column should be hidden. * \param column column index * \param hidden set to true to hide column * \see columnHidden() diff --git a/src/core/qgsbrowsermodel.h b/src/core/qgsbrowsermodel.h index 2b19b4eed4db..78e77a982260 100644 --- a/src/core/qgsbrowsermodel.h +++ b/src/core/qgsbrowsermodel.h @@ -25,7 +25,8 @@ #include "qgsdataitem.h" -/** \ingroup core +/** + * \ingroup core * \class QgsBrowserWatcher * \note not available in Python bindings */ @@ -47,7 +48,8 @@ class CORE_EXPORT QgsBrowserWatcher : public QFutureWatcher QgsGradientStopsList; #define DEFAULT_GRADIENT_COLOR1 QColor(0,0,255) #define DEFAULT_GRADIENT_COLOR2 QColor(0,255,0) -/** \ingroup core +/** + * \ingroup core * \class QgsGradientColorRamp * \brief Gradient color ramp, which smoothly interpolates between two colors and also * supports optional extra color stops. @@ -129,7 +140,8 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp { public: - /** Constructor for QgsGradientColorRamp + /** + * Constructor for QgsGradientColorRamp * \param color1 start color, corresponding to a position of 0.0 * \param color2 end color, corresponding to a position of 1.0 * \param discrete set to true for discrete interpolation instead of smoothly @@ -152,39 +164,45 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp virtual QgsGradientColorRamp *clone() const override SIP_FACTORY; virtual QgsStringMap properties() const override; - /** Returns the gradient start color. + /** + * Returns the gradient start color. * \see setColor1() * \see color2() */ QColor color1() const { return mColor1; } - /** Returns the gradient end color. + /** + * Returns the gradient end color. * \see setColor2() * \see color1() */ QColor color2() const { return mColor2; } - /** Sets the gradient start color. + /** + * Sets the gradient start color. * \param color start color * \see color1() * \see setColor2() */ void setColor1( const QColor &color ) { mColor1 = color; } - /** Sets the gradient end color. + /** + * Sets the gradient end color. * \param color end color * \see color2() * \see setColor1() */ void setColor2( const QColor &color ) { mColor2 = color; } - /** Returns true if the gradient is using discrete interpolation, rather than + /** + * Returns true if the gradient is using discrete interpolation, rather than * smoothly interpolating between colors. * \see setDiscrete() */ bool isDiscrete() const { return mDiscrete; } - /** Sets whether the gradient should use discrete interpolation, rather than + /** + * Sets whether the gradient should use discrete interpolation, rather than * smoothly interpolating between colors. * \param discrete set to true to use discrete interpolation * \see convertToDiscrete() @@ -192,7 +210,8 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp */ void setDiscrete( bool discrete ) { mDiscrete = discrete; } - /** Converts a gradient with existing color stops to or from discrete + /** + * Converts a gradient with existing color stops to or from discrete * interpolation. * \param discrete set to true to convert the gradient stops to discrete, * or false to convert them to smooth interpolation @@ -200,7 +219,8 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp */ void convertToDiscrete( bool discrete ); - /** Sets the list of intermediate gradient stops for the ramp. + /** + * Sets the list of intermediate gradient stops for the ramp. * \param stops list of stops. Any existing color stops will be replaced. The stop * list will be automatically reordered so that stops are listed in ascending offset * order. @@ -208,23 +228,27 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp */ void setStops( const QgsGradientStopsList &stops ); - /** Returns the list of intermediate gradient stops for the ramp. + /** + * Returns the list of intermediate gradient stops for the ramp. * \see setStops() */ QgsGradientStopsList stops() const { return mStops; } - /** Returns any additional info attached to the gradient ramp (e.g., authorship notes) + /** + * Returns any additional info attached to the gradient ramp (e.g., authorship notes) * \see setInfo() */ QgsStringMap info() const { return mInfo; } - /** Sets additional info to attach to the gradient ramp (e.g., authorship notes) + /** + * Sets additional info to attach to the gradient ramp (e.g., authorship notes) * \param info map of string info to attach * \see info() */ void setInfo( const QgsStringMap &info ) { mInfo = info; } - /** Copy color ramp stops to a QGradient + /** + * Copy color ramp stops to a QGradient * \param gradient gradient to copy stops into * \param opacity opacity multiplier. Opacity of colors will be multiplied * by this factor before adding to the gradient. @@ -250,7 +274,8 @@ Q_DECLARE_METATYPE( QgsGradientColorRamp ) #define DEFAULT_RANDOM_SAT_MIN 100 #define DEFAULT_RANDOM_SAT_MAX 240 -/** \ingroup core +/** + * \ingroup core * \class QgsLimitedRandomColorRamp * \brief Constrained random color ramp, which returns random colors based on preset parameters. * \since QGIS 3.0 @@ -259,7 +284,8 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp { public: - /** Constructor for QgsLimitedRandomColorRamp + /** + * Constructor for QgsLimitedRandomColorRamp * \param count number of colors in ramp * \param hueMin minimum hue * \param hueMax maximum hue @@ -273,7 +299,8 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp int satMin = DEFAULT_RANDOM_SAT_MIN, int satMax = DEFAULT_RANDOM_SAT_MAX, int valMin = DEFAULT_RANDOM_VAL_MIN, int valMax = DEFAULT_RANDOM_VAL_MAX ); - /** Returns a new QgsLimitedRandomColorRamp color ramp created using the properties encoded in a string + /** + * Returns a new QgsLimitedRandomColorRamp color ramp created using the properties encoded in a string * map. * \param properties color ramp properties * \see properties() @@ -287,7 +314,8 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp virtual QgsStringMap properties() const override; int count() const override { return mCount; } - /** Get a list of random colors + /** + * Get a list of random colors * \since QGIS 2.4 */ static QList randomColors( int count, @@ -295,71 +323,85 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp int satMax = DEFAULT_RANDOM_SAT_MAX, int satMin = DEFAULT_RANDOM_SAT_MIN, int valMax = DEFAULT_RANDOM_VAL_MAX, int valMin = DEFAULT_RANDOM_VAL_MIN ); - /** Must be called after changing the properties of the color ramp + /** + * Must be called after changing the properties of the color ramp * to regenerate the list of random colors. */ void updateColors(); - /** Returns the minimum hue for generated colors + /** + * Returns the minimum hue for generated colors * \see setHueMin() */ int hueMin() const { return mHueMin; } - /** Returns the maximum hue for generated colors + /** + * Returns the maximum hue for generated colors * \see setHueMax() */ int hueMax() const { return mHueMax; } - /** Returns the minimum saturation for generated colors + /** + * Returns the minimum saturation for generated colors * \see setSatMin() */ int satMin() const { return mSatMin; } - /** Returns the maximum saturation for generated colors + /** + * Returns the maximum saturation for generated colors * \see setSatMax() */ int satMax() const { return mSatMax; } - /** Returns the minimum value for generated colors + /** + * Returns the minimum value for generated colors * \see setValMin() */ int valMin() const { return mValMin; } - /** Returns the maximum value for generated colors + /** + * Returns the maximum value for generated colors * \see setValMax() */ int valMax() const { return mValMax; } - /** Sets the number of colors contained in the ramp. + /** + * Sets the number of colors contained in the ramp. */ void setCount( int val ) { mCount = val; } - /** Sets the minimum hue for generated colors + /** + * Sets the minimum hue for generated colors * \see hueMin() */ void setHueMin( int val ) { mHueMin = val; } - /** Sets the maximum hue for generated colors + /** + * Sets the maximum hue for generated colors * \see hueMax() */ void setHueMax( int val ) { mHueMax = val; } - /** Sets the minimum saturation for generated colors + /** + * Sets the minimum saturation for generated colors * \see satMin() */ void setSatMin( int val ) { mSatMin = val; } - /** Sets the maximum saturation for generated colors + /** + * Sets the maximum saturation for generated colors * \see satMax() */ void setSatMax( int val ) { mSatMax = val; } - /** Sets the minimum value for generated colors + /** + * Sets the minimum value for generated colors * \see valMin() */ void setValMin( int val ) { mValMin = val; } - /** Sets the maximum value for generated colors + /** + * Sets the maximum value for generated colors * \see valMax() */ void setValMax( int val ) { mValMax = val; } @@ -375,7 +417,8 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp QList mColors; }; -/** \ingroup core +/** + * \ingroup core * \class QgsRandomColorRamp * \brief Totally random color ramp. Returns colors generated at random, but constrained * to some hardcoded saturation and value ranges to prevent ugly color generation. @@ -396,7 +439,8 @@ class CORE_EXPORT QgsRandomColorRamp: public QgsColorRamp QColor color( double value ) const override; - /** Sets the desired total number of unique colors for the resultant ramp. Calling + /** + * Sets the desired total number of unique colors for the resultant ramp. Calling * this method pregenerates a set of visually distinct colors which are returned * by subsequent calls to color(). * \param colorCount number of unique colors @@ -418,7 +462,8 @@ class CORE_EXPORT QgsRandomColorRamp: public QgsColorRamp }; -/** \ingroup core +/** + * \ingroup core * \class QgsPresetSchemeColorRamp * \brief A scheme based color ramp consisting of a list of predefined colors. * \since QGIS 3.0 @@ -427,31 +472,36 @@ class CORE_EXPORT QgsPresetSchemeColorRamp : public QgsColorRamp, public QgsColo { public: - /** Constructor for QgsPresetSchemeColorRamp. + /** + * Constructor for QgsPresetSchemeColorRamp. * \param colors list of colors in ramp */ QgsPresetSchemeColorRamp( const QList< QColor > &colors = QList< QColor >() ); - /** Constructor for QgsPresetColorRamp. + /** + * Constructor for QgsPresetColorRamp. * \param colors list of named colors in ramp * \note not available in Python bindings - use setColors instead */ QgsPresetSchemeColorRamp( const QgsNamedColorList &colors ); - /** Returns a new QgsPresetSchemeColorRamp color ramp created using the properties encoded in a string + /** + * Returns a new QgsPresetSchemeColorRamp color ramp created using the properties encoded in a string * map. * \param properties color ramp properties * \see properties() */ static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY; - /** Sets the list of colors used by the ramp. + /** + * Sets the list of colors used by the ramp. * \param colors list of colors * \see colors() */ bool setColors( const QgsNamedColorList &colors, const QString & = QString(), const QColor & = QColor() ) override { mColors = colors; return true; } - /** Returns the list of colors used by the ramp. + /** + * Returns the list of colors used by the ramp. * \see setColors() */ QList< QColor > colors() const; @@ -477,7 +527,8 @@ class CORE_EXPORT QgsPresetSchemeColorRamp : public QgsColorRamp, public QgsColo #define DEFAULT_COLORBREWER_SCHEMENAME "Spectral" #define DEFAULT_COLORBREWER_COLORS 5 -/** \ingroup core +/** + * \ingroup core * \class QgsColorBrewerColorRamp * \brief Color ramp utilising "Color Brewer" preset color schemes. * \since QGIS 3.0 @@ -486,7 +537,8 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp { public: - /** Constructor for QgsColorBrewerColorRamp + /** + * Constructor for QgsColorBrewerColorRamp * \param schemeName color brewer scheme name * \param colors number of colors in ramp * \param inverted invert ramp ordering @@ -495,7 +547,8 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp int colors = DEFAULT_COLORBREWER_COLORS, bool inverted = false ); - /** Returns a new QgsColorBrewerColorRamp color ramp created using the properties encoded in a string + /** + * Returns a new QgsColorBrewerColorRamp color ramp created using the properties encoded in a string * map. * \param properties color ramp properties * \see properties() @@ -510,36 +563,42 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp virtual QgsStringMap properties() const override; virtual int count() const override { return mColors; } - /** Returns the name of the color brewer color scheme. + /** + * Returns the name of the color brewer color scheme. * \see setSchemeName() */ QString schemeName() const { return mSchemeName; } - /** Returns the number of colors in the ramp. + /** + * Returns the number of colors in the ramp. * \see setColors() */ int colors() const { return mColors; } - /** Sets the name of the color brewer color scheme. + /** + * Sets the name of the color brewer color scheme. * \param schemeName scheme name, must match a valid color brewer scheme name * \see schemeName() * \see listSchemeNames() */ void setSchemeName( const QString &schemeName ) { mSchemeName = schemeName; loadPalette(); } - /** Sets the number of colors in the ramp. + /** + * Sets the number of colors in the ramp. * \param colors number of colors. Must match a valid value for the scheme, * which can be retrieved using listSchemeVariants() * \see colors() */ void setColors( int colors ) { mColors = colors; loadPalette(); } - /** Returns a list of all valid color brewer scheme names. + /** + * Returns a list of all valid color brewer scheme names. * \see listSchemeVariants() */ static QStringList listSchemeNames(); - /** Returns a list of the valid variants (numbers of colors) for a specified + /** + * Returns a list of the valid variants (numbers of colors) for a specified * color brewer scheme name * \param schemeName color brewer scheme name * \see listSchemeNames() @@ -561,14 +620,16 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp #define DEFAULT_CPTCITY_SCHEMENAME "cb/div/BrBG_" //change this #define DEFAULT_CPTCITY_VARIANTNAME "05" -/** \ingroup core +/** + * \ingroup core * \class QgsCptCityColorRamp */ class CORE_EXPORT QgsCptCityColorRamp : public QgsGradientColorRamp { public: - /** Constructor for QgsCptCityColorRamp + /** + * Constructor for QgsCptCityColorRamp * \param schemeName cpt-city scheme name * \param variantName cpt-city variant name * \param inverted invert ramp ordering @@ -579,7 +640,8 @@ class CORE_EXPORT QgsCptCityColorRamp : public QgsGradientColorRamp bool inverted = false, bool doLoadFile = true ); - /** Constructor for QgsCptCityColorRamp + /** + * Constructor for QgsCptCityColorRamp * \param schemeName cpt-city scheme name * \param variantList cpt-city variant list * \param variantName cpt-city variant name diff --git a/src/core/qgscolorscheme.h b/src/core/qgscolorscheme.h index 2f50564b6b9e..d08211e9d75f 100644 --- a/src/core/qgscolorscheme.h +++ b/src/core/qgscolorscheme.h @@ -26,13 +26,15 @@ #include "qgis_core.h" #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * List of colors paired with a friendly display name identifying the color * \since QGIS 2.5 */ typedef QList< QPair< QColor, QString > > QgsNamedColorList; -/** \ingroup core +/** + * \ingroup core * \class QgsColorScheme * \brief Abstract base class for color schemes * @@ -63,7 +65,8 @@ class CORE_EXPORT QgsColorScheme public: - /** Flags for controlling behavior of color scheme + /** + * Flags for controlling behavior of color scheme */ enum SchemeFlag { @@ -80,17 +83,20 @@ class CORE_EXPORT QgsColorScheme virtual ~QgsColorScheme() = default; - /** Gets the name for the color scheme + /** + * Gets the name for the color scheme * \returns color scheme name */ virtual QString schemeName() const = 0; - /** Returns the current flags for the color scheme. + /** + * Returns the current flags for the color scheme. * \returns current flags */ virtual SchemeFlags flags() const { return ShowInColorDialog; } - /** Gets a list of colors from the scheme. The colors can optionally + /** + * Gets a list of colors from the scheme. The colors can optionally * be generated using the supplied context and base color. * \param context string specifying an optional context for the returned * colors. For instance, a "recent colors" scheme may filter returned colors @@ -103,13 +109,15 @@ class CORE_EXPORT QgsColorScheme virtual QgsNamedColorList fetchColors( const QString &context = QString(), const QColor &baseColor = QColor() ) = 0; - /** Returns whether the color scheme is editable + /** + * Returns whether the color scheme is editable * \returns true if scheme is editable * \see setColors */ virtual bool isEditable() const { return false; } - /** Sets the colors for the scheme. This method is only valid for editable color schemes. + /** + * Sets the colors for the scheme. This method is only valid for editable color schemes. * \param colors list of colors for the scheme * \param context to set colors for * \param baseColor base color to set colors for @@ -118,7 +126,8 @@ class CORE_EXPORT QgsColorScheme */ virtual bool setColors( const QgsNamedColorList &colors, const QString &context = QString(), const QColor &baseColor = QColor() ); - /** Clones a color scheme + /** + * Clones a color scheme * \returns copy of color scheme */ virtual QgsColorScheme *clone() const = 0 SIP_FACTORY; @@ -126,7 +135,8 @@ class CORE_EXPORT QgsColorScheme Q_DECLARE_OPERATORS_FOR_FLAGS( QgsColorScheme::SchemeFlags ) -/** \ingroup core +/** + * \ingroup core * \class QgsGplColorScheme * \brief A color scheme which stores its colors in a gpl palette file. * \since QGIS 2.5 @@ -147,14 +157,16 @@ class CORE_EXPORT QgsGplColorScheme : public QgsColorScheme protected: - /** Returns the file path for the associated gpl palette file + /** + * Returns the file path for the associated gpl palette file * \returns gpl file path */ virtual QString gplFilePath() = 0; }; -/** \ingroup core +/** + * \ingroup core * \class QgsUserColorScheme * \brief A color scheme which stores its colors in a gpl palette file within the "palettes" * subfolder off the user's QGIS settings folder. @@ -164,7 +176,8 @@ class CORE_EXPORT QgsUserColorScheme : public QgsGplColorScheme { public: - /** Constructs a new user color scheme, using a specified gpl palette file + /** + * Constructs a new user color scheme, using a specified gpl palette file * \param filename filename of gpl palette file stored in the users "palettes" folder */ QgsUserColorScheme( const QString &filename ); @@ -177,17 +190,20 @@ class CORE_EXPORT QgsUserColorScheme : public QgsGplColorScheme virtual QgsColorScheme::SchemeFlags flags() const override; - /** Sets the name for the scheme + /** + * Sets the name for the scheme * \param name new name */ void setName( const QString &name ) { mName = name; } - /** Erases the associated gpl palette file from the users "palettes" folder + /** + * Erases the associated gpl palette file from the users "palettes" folder * \returns true if erase was successful */ bool erase(); - /** Sets whether a this scheme should be shown in color button menus. + /** + * Sets whether a this scheme should be shown in color button menus. * \param show set to true to show in color button menus, or false to hide from menus * \since QGIS 3.0 */ @@ -203,7 +219,8 @@ class CORE_EXPORT QgsUserColorScheme : public QgsGplColorScheme }; -/** \ingroup core +/** + * \ingroup core * \class QgsRecentColorScheme * \brief A color scheme which contains the most recently used colors. * \since QGIS 2.5 @@ -226,21 +243,24 @@ class CORE_EXPORT QgsRecentColorScheme : public QgsColorScheme QgsRecentColorScheme *clone() const override SIP_FACTORY; - /** Adds a color to the list of recent colors. + /** + * Adds a color to the list of recent colors. * \param color color to add * \since QGIS 2.14 * \see lastUsedColor() */ static void addRecentColor( const QColor &color ); - /** Returns the most recently used color. + /** + * Returns the most recently used color. * \since QGIS 3.0 * \see addRecentColor() */ static QColor lastUsedColor(); }; -/** \ingroup core +/** + * \ingroup core * \class QgsCustomColorScheme * \brief A color scheme which contains custom colors set through QGIS app options dialog. * \since QGIS 2.5 @@ -268,7 +288,8 @@ class CORE_EXPORT QgsCustomColorScheme : public QgsColorScheme QgsCustomColorScheme *clone() const override SIP_FACTORY; }; -/** \ingroup core +/** + * \ingroup core * \class QgsProjectColorScheme * \brief A color scheme which contains project specific colors set through project properties dialog. * \since QGIS 2.5 diff --git a/src/core/qgscolorschemeregistry.h b/src/core/qgscolorschemeregistry.h index dc5afc68ab57..ccde4bc0aa14 100644 --- a/src/core/qgscolorschemeregistry.h +++ b/src/core/qgscolorschemeregistry.h @@ -22,7 +22,8 @@ #include "qgscolorscheme.h" #include -/** \ingroup core +/** + * \ingroup core * \class QgsColorSchemeRegistry * \brief Registry of color schemes * @@ -35,33 +36,38 @@ class CORE_EXPORT QgsColorSchemeRegistry public: - /** Constructor for an empty color scheme registry + /** + * Constructor for an empty color scheme registry */ QgsColorSchemeRegistry() = default; virtual ~QgsColorSchemeRegistry(); - /** Adds all color schemes from the global instance to this color scheme. + /** + * Adds all color schemes from the global instance to this color scheme. * \see addDefaultSchemes * \see addColorScheme */ void populateFromInstance(); - /** Adds all default color schemes to this color scheme. + /** + * Adds all default color schemes to this color scheme. * \see populateFromInstance * \see addColorScheme * \see addUserSchemes */ void addDefaultSchemes(); - /** Creates schemes for all gpl palettes in the user's palettes folder. + /** + * Creates schemes for all gpl palettes in the user's palettes folder. * \see populateFromInstance * \see addDefaultSchemes * \see addColorScheme */ void addUserSchemes(); - /** Adds a color scheme to the registry. Ownership of the scheme is transferred + /** + * Adds a color scheme to the registry. Ownership of the scheme is transferred * to the registry. * \param scheme color scheme to add * \see populateFromInstance @@ -69,26 +75,30 @@ class CORE_EXPORT QgsColorSchemeRegistry */ void addColorScheme( QgsColorScheme *scheme SIP_TRANSFER ); - /** Removes all matching color schemes from the registry + /** + * Removes all matching color schemes from the registry * \param scheme color scheme to remove * \returns true if scheme was found and removed * \see addColorScheme */ bool removeColorScheme( QgsColorScheme *scheme ); - /** Returns all color schemes in the registry + /** + * Returns all color schemes in the registry * \returns list of color schemes */ QList schemes() const; - /** Returns all color schemes in the registry which have a specified flag set + /** + * Returns all color schemes in the registry which have a specified flag set * \param flag flag to match * \returns list of color schemes with flag set */ QList schemes( const QgsColorScheme::SchemeFlag flag ) const; - /** Return color schemes of a specific type + /** + * Return color schemes of a specific type * \param schemeList destination list for matching schemes * \note not available in Python bindings */ diff --git a/src/core/qgsconditionalstyle.h b/src/core/qgsconditionalstyle.h index d5c6d34e233d..c92f2f408caf 100644 --- a/src/core/qgsconditionalstyle.h +++ b/src/core/qgsconditionalstyle.h @@ -16,7 +16,8 @@ class QgsReadWriteContext; typedef QList QgsConditionalStyles; -/** \ingroup core +/** + * \ingroup core * \brief The QgsConditionalLayerStyles class holds conditional style information * for a layer. This includes field styles and full row styles. */ @@ -48,11 +49,13 @@ class CORE_EXPORT QgsConditionalLayerStyles */ QList fieldStyles( const QString &fieldName ); - /** Reads field ui properties specific state from Dom node. + /** + * Reads field ui properties specific state from Dom node. */ bool readXml( const QDomNode &node, const QgsReadWriteContext &context ); - /** Write field ui properties specific state from Dom node. + /** + * Write field ui properties specific state from Dom node. */ bool writeXml( QDomNode &node, QDomDocument &doc, const QgsReadWriteContext &context ) const; @@ -61,7 +64,8 @@ class CORE_EXPORT QgsConditionalLayerStyles QList mRowStyles; }; -/** \class QgsConditionalStyle +/** + * \class QgsConditionalStyle * \ingroup core * Conditional styling for a rule. */ @@ -221,11 +225,13 @@ class CORE_EXPORT QgsConditionalStyle */ static QgsConditionalStyle compressStyles( const QList &styles ); - /** Reads vector conditional style specific state from layer Dom node. + /** + * Reads vector conditional style specific state from layer Dom node. */ bool readXml( const QDomNode &node, const QgsReadWriteContext &context ); - /** Write vector conditional style specific state from layer Dom node. + /** + * Write vector conditional style specific state from layer Dom node. */ bool writeXml( QDomNode &node, QDomDocument &doc, const QgsReadWriteContext &context ) const; diff --git a/src/core/qgsconnectionpool.h b/src/core/qgsconnectionpool.h index 1290b3f58243..5cc3c4e47a2d 100644 --- a/src/core/qgsconnectionpool.h +++ b/src/core/qgsconnectionpool.h @@ -32,7 +32,8 @@ #define CONN_POOL_EXPIRATION_TIME 60 // in seconds -/** \ingroup core +/** + * \ingroup core * Template that stores data related to one server. * * It is assumed that following functions exist: @@ -223,7 +224,8 @@ class QgsConnectionPoolGroup }; -/** \ingroup core +/** + * \ingroup core * Template class responsible for keeping a pool of open connections. * This is desired to avoid the overhead of creation of new connection every time. * diff --git a/src/core/qgscoordinatereferencesystem.h b/src/core/qgscoordinatereferencesystem.h index 4b4a6217c43b..4e1fa5df00d2 100644 --- a/src/core/qgscoordinatereferencesystem.h +++ b/src/core/qgscoordinatereferencesystem.h @@ -48,7 +48,8 @@ typedef void *OGRSpatialReferenceH SIP_SKIP; class QgsCoordinateReferenceSystem; typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem & ) SIP_SKIP; -/** \ingroup core +/** + * \ingroup core * This class represents a coordinate reference system (CRS). * * Coordinate reference system object defines a specific map projection, as well as transformations @@ -220,7 +221,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ // TODO QGIS 3: remove "POSTGIS" and "INTERNAL", allow PROJ4 without the prefix explicit QgsCoordinateReferenceSystem( const QString &definition ); - /** Constructor a CRS object using a PostGIS SRID, an EPSG code or an internal QGIS CRS ID. + /** + * Constructor a CRS object using a PostGIS SRID, an EPSG code or an internal QGIS CRS ID. * \note We encourage you to use EPSG code, WKT or Proj4 to describe CRS's in your code * wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile. * \param id The ID valid for the chosen CRS ID type @@ -251,7 +253,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem // static creators - /** Creates a CRS from a given OGC WMS-format Coordinate Reference System string. + /** + * Creates a CRS from a given OGC WMS-format Coordinate Reference System string. * \param ogcCrs OGR compliant CRS definition, e.g., "EPSG:4326" * \returns matching CRS, or an invalid CRS if string could not be matched * \since QGIS 3.0 @@ -259,14 +262,16 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ static QgsCoordinateReferenceSystem fromOgcWmsCrs( const QString &ogcCrs ); - /** Creates a CRS from a given EPSG ID. + /** + * Creates a CRS from a given EPSG ID. * \param epsg epsg CRS ID * \returns matching CRS, or an invalid CRS if string could not be matched * \since QGIS 3.0 */ Q_INVOKABLE static QgsCoordinateReferenceSystem fromEpsgId( long epsg ); - /** Creates a CRS from a proj4 style formatted string. + /** + * Creates a CRS from a proj4 style formatted string. * \param proj4 proj4 format string * \returns matching CRS, or an invalid CRS if string could not be matched * \since QGIS 3.0 @@ -274,7 +279,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ static QgsCoordinateReferenceSystem fromProj4( const QString &proj4 ); - /** Creates a CRS from a WKT spatial ref sys definition string. + /** + * Creates a CRS from a WKT spatial ref sys definition string. * \param wkt WKT for the desired spatial reference system. * \returns matching CRS, or an invalid CRS if string could not be matched * \since QGIS 3.0 @@ -282,7 +288,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ static QgsCoordinateReferenceSystem fromWkt( const QString &wkt ); - /** Creates a CRS from a specified QGIS SRS ID. + /** + * Creates a CRS from a specified QGIS SRS ID. * \param srsId internal QGIS SRS ID * \returns matching CRS, or an invalid CRS if ID could not be found * \since QGIS 3.0 @@ -313,13 +320,15 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ // TODO QGIS 3: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid()) bool createFromOgcWmsCrs( const QString &crs ); - /** Sets this CRS by lookup of the given PostGIS SRID in the CRS database. + /** + * Sets this CRS by lookup of the given PostGIS SRID in the CRS database. * \param srid The PostGIS SRID for the desired spatial reference system. * \returns True on success else false */ // TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead bool createFromSrid( const long srid ); - /** Sets this CRS using a WKT definition. + /** + * Sets this CRS using a WKT definition. * * If EPSG code of the WKT definition can be determined, it is extracted * and createFromOgcWmsCrs() is used to initialize the object. @@ -333,7 +342,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ bool createFromWkt( const QString &wkt ); - /** Sets this CRS by lookup of internal QGIS CRS ID in the CRS database. + /** + * Sets this CRS by lookup of internal QGIS CRS ID in the CRS database. * * If the srsid is < USER_CRS_START_ID, system CRS database is used, otherwise * user's local CRS database from home directory is used. @@ -344,7 +354,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ bool createFromSrsId( const long srsId ); - /** Sets this CRS by passing it a PROJ.4 style formatted string. + /** + * Sets this CRS by passing it a PROJ.4 style formatted string. * * The string will be parsed and the projection and ellipsoid * members set and the remainder of the proj4 string will be stored @@ -368,7 +379,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ bool createFromProj4( const QString &projString ); - /** Set up this CRS from a string definition. + /** + * Set up this CRS from a string definition. * * It supports the following formats: * - "EPSG:" - handled with createFromOgcWms() @@ -383,7 +395,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ bool createFromString( const QString &definition ); - /** Set up this CRS from various text formats. + /** + * Set up this CRS from various text formats. * * Valid formats: WKT string, "EPSG:n", "EPSGA:n", "AUTO:proj_id,unit_id,lon0,lat0", * "urn:ogc:def:crs:EPSG::n", PROJ.4 string, filename (with WKT, XML or PROJ.4 string), @@ -399,7 +412,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ // TODO QGIS3: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend bool createFromUserInput( const QString &definition ); - /** Make sure that ESRI WKT import is done properly. + /** + * Make sure that ESRI WKT import is done properly. * This is required for proper shapefile CRS import when using gdal>= 1.9. * \note This function is called by createFromUserInput() and QgsOgrProvider::crs(), there is usually * no need to call it from elsewhere. @@ -412,7 +426,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem //! Returns whether this CRS is correctly initialized and usable bool isValid() const; - /** Perform some validation on this CRS. If the CRS doesn't validate the + /** + * Perform some validation on this CRS. If the CRS doesn't validate the * default behavior settings for layers with unknown CRS will be * consulted and acted on accordingly. By hell or high water this * method will do its best to make sure that this CRS is valid - even @@ -424,7 +439,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ void validate(); - /** Walks the CRS databases (both system and user database) trying to match + /** + * Walks the CRS databases (both system and user database) trying to match * stored PROJ.4 string to a database entry in order to fill in further * pieces of information about CRS. * \note The ellipsoid and projection acronyms must be set as well as the proj4string! @@ -432,25 +448,29 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ // TODO QGIS 3: seems completely obsolete now (only compares proj4 - already done in createFromProj4) long findMatchingProj(); - /** Overloaded == operator used to compare to CRS's. + /** + * Overloaded == operator used to compare to CRS's. * * Internally it will use authid() for comparison. */ bool operator==( const QgsCoordinateReferenceSystem &srs ) const; - /** Overloaded != operator used to compare to CRS's. + /** + * Overloaded != operator used to compare to CRS's. * * Returns opposite bool value to operator == */ bool operator!=( const QgsCoordinateReferenceSystem &srs ) const; - /** Restores state from the given DOM node. + /** + * Restores state from the given DOM node. * \param node The node from which state will be restored * \returns bool True on success, False on failure */ bool readXml( const QDomNode &node ); - /** Stores state to the given Dom node in the given document. + /** + * Stores state to the given Dom node in the given document. * \param node The node in which state will be restored * \param doc The document in which state will be stored * \returns bool True on success, False on failure @@ -458,29 +478,34 @@ class CORE_EXPORT QgsCoordinateReferenceSystem bool writeXml( QDomNode &node, QDomDocument &doc ) const; - /** Sets custom function to force valid CRS + /** + * Sets custom function to force valid CRS * \note not available in Python bindings */ static void setCustomCrsValidation( CUSTOM_CRS_VALIDATION f ) SIP_SKIP; - /** Gets custom function + /** + * Gets custom function * \note not available in Python bindings */ static CUSTOM_CRS_VALIDATION customCrsValidation() SIP_SKIP; // Accessors ----------------------------------- - /** Returns the internal CRS ID, if available. + /** + * Returns the internal CRS ID, if available. * \returns the internal sqlite3 srs.db primary key for this CRS */ long srsid() const; - /** Returns PostGIS SRID for the CRS. + /** + * Returns PostGIS SRID for the CRS. * \returns the PostGIS spatial_ref_sys identifier for this CRS (defaults to 0) */ // TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead long postgisSrid() const; - /** Returns the authority identifier for the CRS. + /** + * Returns the authority identifier for the CRS. * * The identifier includes both the authority (e.g., EPSG) and the CRS number (e.g., 4326). * This is the best method to use when showing a very short CRS identifier to a user, @@ -493,7 +518,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ QString authid() const; - /** Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94". In most + /** + * Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94". In most * cases this is the best method to use when showing a friendly identifier for the CRS to a * user. * \returns descriptive name of the CRS @@ -502,27 +528,31 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ QString description() const; - /** Returns the projection acronym for the projection used by the CRS. + /** + * Returns the projection acronym for the projection used by the CRS. * \returns the official proj4 acronym for the projection family * \note an empty string will be returned if the projectionAcronym is not available for the CRS * \see ellipsoidAcronym() */ QString projectionAcronym() const; - /** Returns the ellipsoid acronym for the ellipsoid used by the CRS. + /** + * Returns the ellipsoid acronym for the ellipsoid used by the CRS. * \returns the official proj4 acronym for the ellipoid * \note an empty string will be returned if the ellipsoidAcronym is not available for the CRS * \see projectionAcronym() */ QString ellipsoidAcronym() const; - /** Returns a WKT representation of this CRS. + /** + * Returns a WKT representation of this CRS. * \returns string containing WKT of the CRS * \see toProj4() */ QString toWkt() const; - /** Returns a Proj4 string representation of this CRS. + /** + * Returns a Proj4 string representation of this CRS. * * If proj and ellps keys are found in the parameters, * they will be stripped out and the projection and ellipsoid acronyms will be @@ -533,31 +563,37 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ QString toProj4() const; - /** Returns whether the CRS is a geographic CRS (using lat/lon coordinates) + /** + * Returns whether the CRS is a geographic CRS (using lat/lon coordinates) * \returns true if CRS is geographic, or false if it is a projected CRS */ bool isGeographic() const; - /** Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS. + /** + * Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS. * \returns true if CRS axis is inverted */ bool hasAxisInverted() const; - /** Returns the units for the projection used by the CRS. + /** + * Returns the units for the projection used by the CRS. */ QgsUnitTypes::DistanceUnit mapUnits() const; // Mutators ----------------------------------- - /** Set user hint for validation + /** + * Set user hint for validation */ void setValidationHint( const QString &html ); - /** Get user hint for validation + /** + * Get user hint for validation */ QString validationHint(); - /** Update proj.4 parameters in our database from proj.4 + /** + * Update proj.4 parameters in our database from proj.4 * \returns number of updated CRS on success and * negative number of failed updates in case of errors. * \note This is used internally and should not be necessary to call in client code @@ -565,7 +601,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem static int syncDatabase(); - /** Save the proj4-string as a custom CRS + /** + * Save the proj4-string as a custom CRS * \returns bool true if success else false */ bool saveAsUserCrs( const QString &name ); @@ -573,13 +610,15 @@ class CORE_EXPORT QgsCoordinateReferenceSystem //! Returns auth id of related geographic CRS QString geographicCrsAuthId() const; - /** Returns a list of recently used projections + /** + * Returns a list of recently used projections * \returns list of srsid for recently used projections * \since QGIS 2.7 */ static QStringList recentProjections(); - /** Clears the internal cache used to initialize QgsCoordinateReferenceSystem objects. + /** + * Clears the internal cache used to initialize QgsCoordinateReferenceSystem objects. * This should be called whenever the srs database has been modified in order to ensure * that outdated CRS objects are not created. * \since QGIS 3.0 @@ -591,28 +630,33 @@ class CORE_EXPORT QgsCoordinateReferenceSystem // a fully valid crs. Programmers should use the createFrom* methods rather private: - /** A static helper function to find out the proj4 string for a srsid + /** + * A static helper function to find out the proj4 string for a srsid * \param srsId The srsid used for the lookup * \returns QString The proj4 string */ static QString proj4FromSrsId( const int srsId ); - /** Set the QGIS SrsId + /** + * Set the QGIS SrsId * \param srsId The internal sqlite3 srs.db primary key for this CRS */ void setInternalId( long srsId ); - /** Set the PostGIS srid + /** + * Set the PostGIS srid * \param srid The PostGIS spatial_ref_sys key for this CRS */ void setSrid( long srid ); - /** Set the Description + /** + * Set the Description * \param description A textual description of the CRS. */ void setDescription( const QString &description ); - /** Set the Proj Proj4String. + /** + * Set the Proj Proj4String. * \param proj4String Proj4 format specifies * (excluding proj and ellips) that define this CRS. * \note some content of the PROJ4 string may be stripped off by this @@ -624,39 +668,46 @@ class CORE_EXPORT QgsCoordinateReferenceSystem */ void setProj4String( const QString &proj4String ); - /** Set this Geographic? flag + /** + * Set this Geographic? flag * \param geoFlag Whether this is a geographic or projected coordinate system */ void setGeographicFlag( bool geoFlag ); - /** Set the EpsgCrsId identifier for this CRS + /** + * Set the EpsgCrsId identifier for this CRS * \param epsg the ESPG identifier for this CRS (defaults to 0) */ void setEpsg( long epsg ); - /** Set the authority identifier for this CRS + /** + * Set the authority identifier for this CRS * \param theID the authority identifier for this CRS (defaults to 0) */ void setAuthId( const QString &theID ); - /** Set the projection acronym + /** + * Set the projection acronym * \param projectionAcronym the acronym (must be a valid proj4 projection acronym) */ void setProjectionAcronym( const QString &projectionAcronym ); - /** Set the ellipsoid acronym + /** + * Set the ellipsoid acronym * \param ellipsoidAcronym the acronym (must be a valid proj4 ellipsoid acronym) */ void setEllipsoidAcronym( const QString &ellipsoidAcronym ); - /** Print the description if debugging + /** + * Print the description if debugging */ void debugPrint(); //! A string based associative array used for passing records around typedef QMap RecordMap; - /** Get a record from the srs.db or qgis.db backends, given an sql statement. + /** + * Get a record from the srs.db or qgis.db backends, given an sql statement. * \note only handles queries that return a single record. * \note it will first try the system srs.db then the users qgis.db! * \param sql The sql query to execute diff --git a/src/core/qgscoordinatetransform.h b/src/core/qgscoordinatetransform.h index 719663c4e9dc..7daf24034277 100644 --- a/src/core/qgscoordinatetransform.h +++ b/src/core/qgscoordinatetransform.h @@ -28,7 +28,8 @@ class QgsPointXY; class QgsRectangle; class QPolygonF; -/** \ingroup core +/** + * \ingroup core * Class for doing transforms between two map coordinate systems. * * This class can convert map coordinates to a different coordinate reference system. @@ -57,7 +58,8 @@ class CORE_EXPORT QgsCoordinateTransform //! Default constructor, creates an invalid QgsCoordinateTransform. QgsCoordinateTransform(); - /** Constructs a QgsCoordinateTransform using QgsCoordinateReferenceSystem objects. + /** + * Constructs a QgsCoordinateTransform using QgsCoordinateReferenceSystem objects. * \param source source CRS, typically of the layer's coordinate system * \param destination CRS, typically of the map canvas coordinate system */ @@ -99,21 +101,24 @@ class CORE_EXPORT QgsCoordinateTransform */ void setDestinationCrs( const QgsCoordinateReferenceSystem &crs ); - /** Returns the source coordinate reference system, which the transform will + /** + * Returns the source coordinate reference system, which the transform will * transform coordinates from. * \see setSourceCrs() * \see destinationCrs() */ QgsCoordinateReferenceSystem sourceCrs() const; - /** Returns the destination coordinate reference system, which the transform will + /** + * Returns the destination coordinate reference system, which the transform will * transform coordinates to. * \see setDestinationCrs() * \see sourceCrs() */ QgsCoordinateReferenceSystem destinationCrs() const; - /** Transform the point from the source CRS to the destination CRS. + /** + * Transform the point from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param point point to transform @@ -122,7 +127,8 @@ class CORE_EXPORT QgsCoordinateTransform */ QgsPointXY transform( const QgsPointXY &point, TransformDirection direction = ForwardTransform ) const; - /** Transform the point specified by x,y from the source CRS to the destination CRS. + /** + * Transform the point specified by x,y from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param x x coordinate of point to transform @@ -132,7 +138,8 @@ class CORE_EXPORT QgsCoordinateTransform */ QgsPointXY transform( const double x, const double y, TransformDirection direction = ForwardTransform ) const; - /** Transforms a rectangle from the source CRS to the destination CRS. + /** + * Transforms a rectangle from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * This method assumes that the rectangle is a bounding box, and creates a bounding box @@ -146,7 +153,8 @@ class CORE_EXPORT QgsCoordinateTransform */ QgsRectangle transformBoundingBox( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform, const bool handle180Crossover = false ) const; - /** Transforms an array of x, y and z double coordinates in place, from the source CRS to the destination CRS. + /** + * Transforms an array of x, y and z double coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param x array of x coordinates of points to transform @@ -158,7 +166,8 @@ class CORE_EXPORT QgsCoordinateTransform */ void transformInPlace( double &x, double &y, double &z, TransformDirection direction = ForwardTransform ) const; - /** Transforms an array of x, y and z float coordinates in place, from the source CRS to the destination CRS. + /** + * Transforms an array of x, y and z float coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param x array of x coordinates of points to transform @@ -171,7 +180,8 @@ class CORE_EXPORT QgsCoordinateTransform */ void transformInPlace( float &x, float &y, double &z, TransformDirection direction = ForwardTransform ) const SIP_SKIP; - /** Transforms an array of x, y and z float coordinates in place, from the source CRS to the destination CRS. + /** + * Transforms an array of x, y and z float coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param x array of x coordinates of points to transform @@ -184,7 +194,8 @@ class CORE_EXPORT QgsCoordinateTransform */ void transformInPlace( float &x, float &y, float &z, TransformDirection direction = ForwardTransform ) const SIP_SKIP; - /** Transforms a vector of x, y and z float coordinates in place, from the source CRS to the destination CRS. + /** + * Transforms a vector of x, y and z float coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param x vector of x coordinates of points to transform @@ -198,7 +209,8 @@ class CORE_EXPORT QgsCoordinateTransform void transformInPlace( QVector &x, QVector &y, QVector &z, TransformDirection direction = ForwardTransform ) const SIP_SKIP; - /** Transforms a vector of x, y and z double coordinates in place, from the source CRS to the destination CRS. + /** + * Transforms a vector of x, y and z double coordinates in place, from the source CRS to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param x vector of x coordinates of points to transform @@ -212,13 +224,15 @@ class CORE_EXPORT QgsCoordinateTransform void transformInPlace( QVector &x, QVector &y, QVector &z, TransformDirection direction = ForwardTransform ) const SIP_SKIP; - /** Transforms a polygon to the destination coordinate system. + /** + * Transforms a polygon to the destination coordinate system. * \param polygon polygon to transform (occurs in place) * \param direction transform direction (defaults to forward transformation) */ void transformPolygon( QPolygonF &polygon, TransformDirection direction = ForwardTransform ) const; - /** Transforms a rectangle to the destination CRS. + /** + * Transforms a rectangle to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param rectangle rectangle to transform @@ -227,7 +241,8 @@ class CORE_EXPORT QgsCoordinateTransform */ QgsRectangle transform( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform ) const SIP_SKIP; - /** Transform an array of coordinates to the destination CRS. + /** + * Transform an array of coordinates to the destination CRS. * If the direction is ForwardTransform then coordinates are transformed from source to destination, * otherwise points are transformed from destination to source CRS. * \param numPoint number of coordinates in arrays @@ -238,18 +253,21 @@ class CORE_EXPORT QgsCoordinateTransform */ void transformCoords( int numPoint, double *x, double *y, double *z, TransformDirection direction = ForwardTransform ) const; - /** Returns true if the transform short circuits because the source and destination are equivalent. + /** + * Returns true if the transform short circuits because the source and destination are equivalent. */ bool isShortCircuited() const; - /** Returns list of datum transformations for the given src and dest CRS + /** + * Returns list of datum transformations for the given src and dest CRS * \note not available in Python bindings */ static QList< QList< int > > datumTransformations( const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destinationCrs ) SIP_SKIP; static QString datumTransformString( int datumTransform ); - /** Gets name of source and dest geographical CRS (to show in a tooltip) + /** + * Gets name of source and dest geographical CRS (to show in a tooltip) \returns epsgNr epsg code of the transformation (or 0 if not in epsg db)*/ static bool datumTransformCrsInfo( int datumTransform, int &epsgNr, QString &srcProjection, QString &dstProjection, QString &remarks, QString &scope, bool &preferred, bool &deprecated ); @@ -261,14 +279,16 @@ class CORE_EXPORT QgsCoordinateTransform //!initialize is used to actually create the Transformer instance void initialize(); - /** Restores state from the given Dom node. + /** + * Restores state from the given Dom node. * \param node The node from which state will be restored * \returns bool True on success, False on failure * \see writeXml() */ bool readXml( const QDomNode &node ); - /** Stores state to the given Dom node in the given document + /** + * Stores state to the given Dom node in the given document * \param node The node in which state will be restored * \param document The document in which state will be stored * \returns bool True on success, False on failure diff --git a/src/core/qgscoordinateutils.h b/src/core/qgscoordinateutils.h index 04203ff887da..feeadbff14de 100644 --- a/src/core/qgscoordinateutils.h +++ b/src/core/qgscoordinateutils.h @@ -30,7 +30,8 @@ class QgsCoordinateReferenceSystem; //not stable api - I plan on reworking this when QgsCoordinateFormatter lands in 2.16 ///@cond NOT_STABLE_API -/** \ingroup core +/** + * \ingroup core * \class QgsCoordinateUtils * \brief Utilities for handling and formatting coordinates * \since QGIS 2.14 @@ -39,7 +40,8 @@ class CORE_EXPORT QgsCoordinateUtils { public: - /** Returns the precision to use for displaying coordinates to the user, respecting + /** + * Returns the precision to use for displaying coordinates to the user, respecting * the user's project settings. If the user has set the project to use "automatic" * precision, this function tries to calculate an optimal coordinate precision for a given * map units per pixel by calculating the number of decimal places for the coordinates diff --git a/src/core/qgscredentials.h b/src/core/qgscredentials.h index 4f6f7269fb31..5ca32887efb7 100644 --- a/src/core/qgscredentials.h +++ b/src/core/qgscredentials.h @@ -26,7 +26,8 @@ #include "qgis_core.h" #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * Interface for requesting credentials in QGIS in GUI independent way. * This class provides abstraction of a dialog for requesting credentials to the user. * By default QgsCredentials will be used if not overridden with other @@ -107,7 +108,8 @@ class CORE_EXPORT QgsCredentials }; -/** \ingroup core +/** + * \ingroup core \brief Default implementation of credentials interface This class doesn't prompt or return credentials @@ -129,7 +131,8 @@ class CORE_EXPORT QgsCredentialsNone : public QObject, public QgsCredentials }; -/** \ingroup core +/** + * \ingroup core \brief Implementation of credentials interface for the console This class outputs message to the standard output and retrieves input from diff --git a/src/core/qgscrscache.h b/src/core/qgscrscache.h index 0c04df6e9678..d7fbe4624536 100644 --- a/src/core/qgscrscache.h +++ b/src/core/qgscrscache.h @@ -25,7 +25,8 @@ class QgsCoordinateTransform; -/** \ingroup core +/** + * \ingroup core * Cache coordinate transform by authid of source/dest transformation to avoid the overhead of initialization for each redraw*/ class CORE_EXPORT QgsCoordinateTransformCache @@ -38,7 +39,8 @@ class CORE_EXPORT QgsCoordinateTransformCache //! QgsCoordinateTransformCache cannot be copied QgsCoordinateTransformCache &operator=( const QgsCoordinateTransformCache &rh ) = delete; - /** Returns coordinate transformation. Cache keeps ownership + /** + * Returns coordinate transformation. Cache keeps ownership \param srcAuthId auth id string of source crs \param destAuthId auth id string of dest crs \param srcDatumTransform id of source's datum transform diff --git a/src/core/qgsdartmeasurement.h b/src/core/qgsdartmeasurement.h index 04b1e81d7db2..7528bd51e2e2 100644 --- a/src/core/qgsdartmeasurement.h +++ b/src/core/qgsdartmeasurement.h @@ -20,7 +20,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * \class QgsDartMeasurement */ class CORE_EXPORT QgsDartMeasurement diff --git a/src/core/qgsdatadefinedsizelegend.h b/src/core/qgsdatadefinedsizelegend.h index 72296c926843..1e4e5ff1ce5d 100644 --- a/src/core/qgsdatadefinedsizelegend.h +++ b/src/core/qgsdatadefinedsizelegend.h @@ -29,7 +29,8 @@ class QgsRenderContext; class QgsSizeScaleTransformer; -/** \ingroup core +/** + * \ingroup core * Object that keeps configuration of appearance of marker symbol's data-defined size in legend. * For example: the list of classes (size values), whether the classes should appear in separate * legend nodes or whether to collapse them into one legend node. diff --git a/src/core/qgsdataitem.h b/src/core/qgsdataitem.h index 4195b99b9b14..0e9405d14674 100644 --- a/src/core/qgsdataitem.h +++ b/src/core/qgsdataitem.h @@ -41,7 +41,8 @@ class QgsAnimatedIcon; typedef QgsDataItem *dataItem_t( QString, QgsDataItem * ) SIP_SKIP; -/** \ingroup core +/** + * \ingroup core * Base class for all items in the model. * Parent/children hierarchy is not based on QObject. */ @@ -93,7 +94,8 @@ class CORE_EXPORT QgsDataItem : public QObject int rowCount(); - /** Create children. Children are not expected to have parent set. + /** + * Create children. Children are not expected to have parent set. * This method MUST BE THREAD SAFE. */ virtual QVector createChildren() SIP_FACTORY; @@ -108,32 +110,37 @@ class CORE_EXPORT QgsDataItem : public QObject //! \since QGIS 2.8 State state() const; - /** Set item state. It also take care about starting/stopping loading icon animation. + /** + * Set item state. It also take care about starting/stopping loading icon animation. * \param state * \since QGIS 2.8 */ virtual void setState( State state ); - /** Inserts a new child item. The child will be inserted at a position using an alphabetical order based on mName. + /** + * Inserts a new child item. The child will be inserted at a position using an alphabetical order based on mName. * \param child child item to insert. Ownership is transferred, and item parent will be set and relevant connections made. * \param refresh - set to true to refresh populated item, emitting relevant signals to the model * \see deleteChildItem() */ virtual void addChildItem( QgsDataItem *child SIP_TRANSFER, bool refresh = false ); - /** Removes and deletes a child item, emitting relevant signals to the model. + /** + * Removes and deletes a child item, emitting relevant signals to the model. * \param child child to remove. Item must exist as a current child. * \see addChildItem() */ virtual void deleteChildItem( QgsDataItem *child ); - /** Removes a child item and returns it without deleting it. Emits relevant signals to model as required. + /** + * Removes a child item and returns it without deleting it. Emits relevant signals to model as required. * \param child child to remove * \returns pointer to the removed item or null if no such item was found */ virtual QgsDataItem *removeChildItem( QgsDataItem *child ) SIP_TRANSFERBACK; - /** Returns true if this item is equal to another item (by testing item type and path). + /** + * Returns true if this item is equal to another item (by testing item type and path). */ virtual bool equal( const QgsDataItem *other ); @@ -148,7 +155,8 @@ class CORE_EXPORT QgsDataItem : public QObject */ virtual QList actions( QWidget *parent ); - /** Returns the list of menus available for this item. This is usually used for the popup menu on right-clicking + /** + * Returns the list of menus available for this item. This is usually used for the popup menu on right-clicking * the item. Subclasses should override this to provide actions. Subclasses should ensure that ownership of * created menus is correctly handled by parenting them to the specified parent widget. * \param parent a parent widget of the menu @@ -157,13 +165,15 @@ class CORE_EXPORT QgsDataItem : public QObject */ virtual QList menus( QWidget *parent ); - /** Returns whether the item accepts drag and dropped layers - e.g. for importing a dataset to a provider. + /** + * Returns whether the item accepts drag and dropped layers - e.g. for importing a dataset to a provider. * Subclasses should override this and handleDrop() to accept dropped layers. * \see handleDrop() */ virtual bool acceptDrop() { return false; } - /** Attempts to process the mime data dropped on this item. Subclasses must override this and acceptDrop() if they + /** + * Attempts to process the mime data dropped on this item. Subclasses must override this and acceptDrop() if they * accept dropped layers. * \see acceptDrop() */ @@ -177,7 +187,8 @@ class CORE_EXPORT QgsDataItem : public QObject */ virtual bool handleDoubleClick(); - /** Returns true if the item may be dragged. + /** + * Returns true if the item may be dragged. * Default implementation returns false. * A draggable item has to implement mimeUri() that will be used to pass data. * \see mimeUri() @@ -185,7 +196,8 @@ class CORE_EXPORT QgsDataItem : public QObject */ virtual bool hasDragEnabled() const { return false; } - /** Return mime URI for the data item. + /** + * Return mime URI for the data item. * Items that return valid URI will be returned in mime data when dragging a selection from browser model. * \see hasDragEnabled() * \since QGIS 3.0 @@ -225,11 +237,13 @@ class CORE_EXPORT QgsDataItem : public QObject Type type() const { return mType; } - /** Get item parent. QgsDataItem maintains its own items hierarchy, it does not use + /** + * Get item parent. QgsDataItem maintains its own items hierarchy, it does not use * QObject hierarchy. */ QgsDataItem *parent() const { return mParent; } - /** Set item parent and connect / disconnect parent to / from item signals. + /** + * Set item parent and connect / disconnect parent to / from item signals. * It does not add itself to parents children (mChildren) */ void setParent( QgsDataItem *parent ); QVector children() const { return mChildren; } @@ -264,7 +278,8 @@ class CORE_EXPORT QgsDataItem : public QObject */ virtual void refresh( const QVector &children ); - /** The item is scheduled to be deleted. E.g. if deleteLater() is called when + /** + * 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. * Items with slow reateChildren() (for example network or database based) may @@ -290,7 +305,8 @@ class CORE_EXPORT QgsDataItem : public QObject public slots: - /** Safely delete the item: + /** + * Safely delete the item: * - disconnects parent * - unsets parent (but does not remove itself) * - deletes all its descendants recursively @@ -350,7 +366,8 @@ class CORE_EXPORT QgsDataItem : public QObject Q_DECLARE_OPERATORS_FOR_FLAGS( QgsDataItem::Capabilities ) -/** \ingroup core +/** + * \ingroup core * Item that represents a layer that can be opened with one of the providers */ class CORE_EXPORT QgsLayerItem : public QgsDataItem @@ -395,27 +412,32 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem //! Returns provider key QString providerKey() const { return mProviderKey; } - /** Returns the supported CRS + /** + * Returns the supported CRS * \since QGIS 2.8 */ QStringList supportedCrs() const { return mSupportedCRS; } - /** Returns the supported formats + /** + * Returns the supported formats * \since QGIS 2.8 */ QStringList supportedFormats() const { return mSupportFormats; } - /** Returns comments of the layer + /** + * Returns comments of the layer * \since QGIS 2.12 */ virtual QString comments() const { return QString(); } - /** Returns the string representation of the given \a layerType + /** + * Returns the string representation of the given \a layerType * \since QGIS 3 */ static QString layerTypeAsString( const LayerType &layerType ); - /** Returns the icon name of the given \a layerType + /** + * Returns the icon name of the given \a layerType * \since QGIS 3 */ static QString iconName( const LayerType &layerType ); @@ -446,7 +468,8 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem }; -/** \ingroup core +/** + * \ingroup core * A Collection: logical collection of layers or subcollections, e.g. GRASS location/mapset, database? wms source? */ class CORE_EXPORT QgsDataCollectionItem : public QgsDataItem @@ -462,7 +485,8 @@ class CORE_EXPORT QgsDataCollectionItem : public QgsDataItem static QIcon iconDataCollection(); // default icon for data collection }; -/** \ingroup core +/** + * \ingroup core * A directory: contains subdirectories and layers */ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem @@ -482,7 +506,8 @@ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem QgsDirectoryItem( QgsDataItem *parent, const QString &name, const QString &path ); - /** Constructor. + /** + * Constructor. * \param parent * \param name directory name * \param dirPath path to directory in file system @@ -518,7 +543,8 @@ class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem QDateTime mLastScan; }; -/** \ingroup core +/** + * \ingroup core Data item that can be used to represent QGIS projects. */ class CORE_EXPORT QgsProjectItem : public QgsDataItem @@ -538,7 +564,8 @@ class CORE_EXPORT QgsProjectItem : public QgsDataItem }; -/** \ingroup core +/** + * \ingroup core Data item that can be used to report problems (e.g. network error) */ class CORE_EXPORT QgsErrorItem : public QgsDataItem @@ -553,7 +580,8 @@ class CORE_EXPORT QgsErrorItem : public QgsDataItem // --------- -/** \ingroup core +/** + * \ingroup core * \class QgsDirectoryParamWidget */ class CORE_EXPORT QgsDirectoryParamWidget : public QTreeWidget @@ -570,7 +598,8 @@ class CORE_EXPORT QgsDirectoryParamWidget : public QTreeWidget void showHideColumn(); }; -/** \ingroup core +/** + * \ingroup core * Contains various Favorites directories * \since QGIS 3.0 */ @@ -606,7 +635,8 @@ class CORE_EXPORT QgsFavoritesItem : public QgsDataCollectionItem QVector createChildren( const QString &favDir ); }; -/** \ingroup core +/** + * \ingroup core * A zip file: contains layers, using GDAL/OGR VSIFILE mechanism */ class CORE_EXPORT QgsZipItem : public QgsDataCollectionItem diff --git a/src/core/qgsdataitemprovider.h b/src/core/qgsdataitemprovider.h index dbdaed331094..40231f0b1177 100644 --- a/src/core/qgsdataitemprovider.h +++ b/src/core/qgsdataitemprovider.h @@ -28,7 +28,8 @@ class QString; typedef bool handlesDirectoryPath_t( const QString &path ) SIP_SKIP; -/** \ingroup core +/** + * \ingroup core * This is the interface for those who want to add custom data items to the browser tree. * * The method createDataItem() is ever called only if capabilities() return non-zero value. diff --git a/src/core/qgsdataitemproviderregistry.h b/src/core/qgsdataitemproviderregistry.h index 92869409c785..77168aeef630 100644 --- a/src/core/qgsdataitemproviderregistry.h +++ b/src/core/qgsdataitemproviderregistry.h @@ -23,7 +23,8 @@ class QgsDataItemProvider; -/** \ingroup core +/** + * \ingroup core * This class keeps a list of data item providers that may add items to the browser tree. * When created, it automatically adds providers from provider plugins (e.g. PostGIS, WMS, ...) * diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h index ac6a993f6bda..3f175ade5f06 100644 --- a/src/core/qgsdataprovider.h +++ b/src/core/qgsdataprovider.h @@ -32,7 +32,8 @@ class QgsRectangle; class QgsCoordinateReferenceSystem; -/** \ingroup core +/** + * \ingroup core * Abstract base class for spatial data provider implementations. * * This object needs to inherit from QObject to enable event @@ -97,7 +98,8 @@ class CORE_EXPORT QgsDataProvider : public QObject : mDataSourceURI( uri ) {} - /** Returns the coordinate system for the data source. + /** + * Returns the coordinate system for the data source. * If the provider isn't capable of returning its projection then an invalid * QgsCoordinateReferenceSystem will be returned. */ @@ -194,7 +196,8 @@ class CORE_EXPORT QgsDataProvider : public QObject } - /** Returns true if the provider supports setting of subset strings. + /** + * Returns true if the provider supports setting of subset strings. */ virtual bool supportsSubsetString() const { return false; } @@ -274,7 +277,8 @@ class CORE_EXPORT QgsDataProvider : public QObject } - /** Return a provider name + /** + * Return a provider name * * Essentially just returns the provider key. Should be used to build file * dialogs so that providers can be shown with their supported types. Thus @@ -291,7 +295,8 @@ class CORE_EXPORT QgsDataProvider : public QObject virtual QString name() const = 0; - /** Return description + /** + * Return description * * Return a terse string describing what the provider is. * @@ -305,7 +310,8 @@ class CORE_EXPORT QgsDataProvider : public QObject virtual QString description() const = 0; - /** Return vector file filter string + /** + * Return vector file filter string * * Returns a string suitable for a QFileDialog of vector file formats * supported by the data provider. Naturally this will be an empty string @@ -320,7 +326,8 @@ class CORE_EXPORT QgsDataProvider : public QObject } - /** Return raster file filter string + /** + * Return raster file filter string * * Returns a string suitable for a QFileDialog of raster file formats * supported by the data provider. Naturally this will be an empty string @@ -334,7 +341,8 @@ class CORE_EXPORT QgsDataProvider : public QObject return QLatin1String( "" ); } - /** Reloads the data from the source. Needs to be implemented by providers with data caches to + /** + * Reloads the data from the source. Needs to be implemented by providers with data caches to * synchronize with changes in the data source */ virtual void reloadData() {} @@ -345,18 +353,21 @@ class CORE_EXPORT QgsDataProvider : public QObject //! Current time stamp of data source virtual QDateTime dataTimestamp() const { return QDateTime(); } - /** Get current status error. This error describes some principal problem + /** + * Get current status error. This error describes some principal problem * for which provider cannot work and thus is not valid. It is not last error * after accessing data by block(), identify() etc. */ virtual QgsError error() const { return mError; } - /** Invalidate connections corresponding to specified name + /** + * Invalidate connections corresponding to specified name * \since QGIS 2.16 */ virtual void invalidateConnections( const QString &connection ) { Q_UNUSED( connection ); } - /** Enter update mode. + /** + * Enter update mode. * * This is aimed at providers that can open differently the connection to * the datasource, according it to be in update mode or in read-only mode. @@ -379,7 +390,8 @@ class CORE_EXPORT QgsDataProvider : public QObject */ virtual bool enterUpdateMode() { return true; } - /** Leave update mode. + /** + * Leave update mode. * * This is aimed at providers that can open differently the connection to * the datasource, according it to be in update mode or in read-only mode. diff --git a/src/core/qgsdatasourceuri.h b/src/core/qgsdatasourceuri.h index 2497ebdb804f..758a9c961457 100644 --- a/src/core/qgsdatasourceuri.h +++ b/src/core/qgsdatasourceuri.h @@ -24,7 +24,8 @@ #include -/** \ingroup core +/** + * \ingroup core * Class for storing the component parts of a PostgreSQL/RDBMS datasource URI. * This structure stores the database connection information, including host, database, * user name, password, schema, password, and sql where clause @@ -205,7 +206,8 @@ class CORE_EXPORT QgsDataSourceUri //! Sets the name of the (primary) key column void setKeyColumn( const QString &column ); - /** The wkb type. + /** + * The wkb type. */ QgsWkbTypes::Type wkbType() const; diff --git a/src/core/qgsdatetimestatisticalsummary.h b/src/core/qgsdatetimestatisticalsummary.h index 1ecb14f503ed..a517f0516e3b 100644 --- a/src/core/qgsdatetimestatisticalsummary.h +++ b/src/core/qgsdatetimestatisticalsummary.h @@ -29,7 +29,8 @@ * See details in QEP #17 ****************************************************************************/ -/** \ingroup core +/** + * \ingroup core * \class QgsDateTimeStatisticalSummary * \brief Calculator for summary statistics and aggregates for a list of datetimes. * @@ -58,36 +59,42 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary }; Q_DECLARE_FLAGS( Statistics, Statistic ) - /** Constructor for QgsDateTimeStatisticalSummary + /** + * Constructor for QgsDateTimeStatisticalSummary * \param stats flags for statistics to calculate */ QgsDateTimeStatisticalSummary( QgsDateTimeStatisticalSummary::Statistics stats = All ); - /** Returns flags which specify which statistics will be calculated. Some statistics + /** + * Returns flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., count). * \see setStatistics */ Statistics statistics() const { return mStatistics; } - /** Sets flags which specify which statistics will be calculated. Some statistics + /** + * Sets flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., count). * \param stats flags for statistics to calculate * \see statistics */ void setStatistics( Statistics stats ) { mStatistics = stats; } - /** Resets the calculated values + /** + * Resets the calculated values */ void reset(); - /** Calculates summary statistics for a list of variants. Any non-datetime variants will be + /** + * Calculates summary statistics for a list of variants. Any non-datetime variants will be * ignored. * \param values list of variants * \see addValue() */ void calculate( const QVariantList &values ); - /** Adds a single datetime to the statistics calculation. Calling this method + /** + * Adds a single datetime to the statistics calculation. Calling this method * allows datetimes to be added to the calculation one at a time. For large * quantities of dates this may be more efficient then first adding all the * variants to a list and calling calculate(). @@ -101,47 +108,57 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary */ void addValue( const QVariant &value ); - /** Must be called after adding all datetimes with addValue() and before retrieving + /** + * Must be called after adding all datetimes with addValue() and before retrieving * any calculated datetime statistics. * \see addValue() */ void finalize(); - /** Returns the value of a specified statistic + /** + * Returns the value of a specified statistic * \param stat statistic to return * \returns calculated value of statistic */ QVariant statistic( QgsDateTimeStatisticalSummary::Statistic stat ) const; - /** Returns the calculated count of values. + /** + * Returns the calculated count of values. */ int count() const { return mCount; } - /** Returns the number of distinct datetime values. + /** + * Returns the number of distinct datetime values. */ int countDistinct() const { return mValues.count(); } - /** Returns the set of distinct datetime values. + /** + * Returns the set of distinct datetime values. */ QSet< QDateTime > distinctValues() const { return mValues; } - /** Returns the number of missing (null) datetime values. + /** + * Returns the number of missing (null) datetime values. */ int countMissing() const { return mCountMissing; } - /** Returns the minimum (earliest) non-null datetime value. + /** + * Returns the minimum (earliest) non-null datetime value. */ QDateTime min() const { return mMin; } - /** Returns the maximum (latest) non-null datetime value. + /** + * Returns the maximum (latest) non-null datetime value. */ QDateTime max() const { return mMax; } - /** Returns the range (interval between earliest and latest non-null datetime values). + /** + * Returns the range (interval between earliest and latest non-null datetime values). */ QgsInterval range() const { return mMax - mMin; } - /** Returns the friendly display name for a statistic + /** + * Returns the friendly display name for a statistic * \param statistic statistic to return name for */ static QString displayName( QgsDateTimeStatisticalSummary::Statistic statistic ); diff --git a/src/core/qgsdatumtransformstore.h b/src/core/qgsdatumtransformstore.h index d1f8f923a294..df357177ceb7 100644 --- a/src/core/qgsdatumtransformstore.h +++ b/src/core/qgsdatumtransformstore.h @@ -24,7 +24,8 @@ class QgsMapLayer; class QDomElement; -/** \ingroup core +/** + * \ingroup core * \brief The QgsDatumTransformStore class keeps track of datum transformations * as chosen by the user. * diff --git a/src/core/qgsdiagramrenderer.h b/src/core/qgsdiagramrenderer.h index cef6cf22cca0..c806168303e6 100644 --- a/src/core/qgsdiagramrenderer.h +++ b/src/core/qgsdiagramrenderer.h @@ -46,7 +46,8 @@ class QgsLayerTreeLayer; namespace pal { class Layer; } SIP_SKIP -/** \ingroup core +/** + * \ingroup core * \class QgsDiagramLayerSettings * \brief Stores the settings for rendering of all diagrams for a layer. * @@ -79,7 +80,8 @@ class CORE_EXPORT QgsDiagramLayerSettings }; Q_DECLARE_FLAGS( LinePlacementFlags, LinePlacementFlag ) - /** Data definable properties. + /** + * Data definable properties. * \since QGIS 3.0 */ enum Property @@ -123,21 +125,24 @@ class CORE_EXPORT QgsDiagramLayerSettings */ Placement placement() const { return mPlacement; } - /** Sets the diagram placement. + /** + * Sets the diagram placement. * \param value placement value * \see placement() * \since QGIS 2.16 */ void setPlacement( Placement value ) { mPlacement = value; } - /** Returns the diagram placement flags. These are only used if the diagram placement + /** + * Returns the diagram placement flags. These are only used if the diagram placement * is set to a line type. * \see setLinePlacementFlags() * \since QGIS 2.16 */ LinePlacementFlags linePlacementFlags() const { return mPlacementFlags; } - /** Sets the the diagram placement flags. These are only used if the diagram placement + /** + * Sets the the diagram placement flags. These are only used if the diagram placement * is set to a line type. * \param flags placement value * \see getPlacement() @@ -145,7 +150,8 @@ class CORE_EXPORT QgsDiagramLayerSettings */ void setLinePlacementFlags( LinePlacementFlags flags ) { mPlacementFlags = flags; } - /** Returns the diagram priority. + /** + * Returns the diagram priority. * \returns diagram priority, where 0 = low and 10 = high * \note placement priority is shared with labeling, so diagrams with a high priority may displace labels * and vice-versa @@ -154,14 +160,16 @@ class CORE_EXPORT QgsDiagramLayerSettings */ int priority() const { return mPriority; } - /** Sets the diagram priority. + /** + * Sets the diagram priority. * \param value priority, where 0 = low and 10 = high * \see priority() * \since QGIS 2.16 */ void setPriority( int value ) { mPriority = value; } - /** Returns the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams + /** + * Returns the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams * with a lower z-index. * \note z-index ordering is shared with labeling, so diagrams with a high z-index may be drawn over labels * with a low z-index and vice-versa @@ -170,7 +178,8 @@ class CORE_EXPORT QgsDiagramLayerSettings */ double zIndex() const { return mZIndex; } - /** Sets the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams + /** + * Sets the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams * with a lower z-index. * \param index diagram z-index * \see zIndex() @@ -178,73 +187,84 @@ class CORE_EXPORT QgsDiagramLayerSettings */ void setZIndex( double index ) { mZIndex = index; } - /** Returns whether the feature associated with a diagram acts as an obstacle for other labels or diagrams. + /** + * Returns whether the feature associated with a diagram acts as an obstacle for other labels or diagrams. * \see setIsObstacle() * \since QGIS 2.16 */ bool isObstacle() const { return mObstacle; } - /** Sets whether the feature associated with a diagram acts as an obstacle for other labels or diagrams. + /** + * Sets whether the feature associated with a diagram acts as an obstacle for other labels or diagrams. * \param isObstacle set to true for feature to act as obstacle * \see isObstacle() * \since QGIS 2.16 */ void setIsObstacle( bool isObstacle ) { mObstacle = isObstacle; } - /** Returns the distance between the diagram and the feature (in mm). + /** + * Returns the distance between the diagram and the feature (in mm). * \see setDistance() * \since QGIS 2.16 */ double distance() const { return mDistance; } - /** Sets the distance between the diagram and the feature. + /** + * Sets the distance between the diagram and the feature. * \param distance distance in mm * \see distance() * \since QGIS 2.16 */ void setDistance( double distance ) { mDistance = distance; } - /** Returns the diagram renderer associated with the layer. + /** + * Returns the diagram renderer associated with the layer. * \see setRenderer() * \since QGIS 2.16 */ QgsDiagramRenderer *renderer() { return mRenderer; } - /** Returns the diagram renderer associated with the layer. + /** + * Returns the diagram renderer associated with the layer. * \see setRenderer() * \since QGIS 2.16 * \note not available in Python bindings */ const QgsDiagramRenderer *renderer() const { return mRenderer; } SIP_SKIP - /** Sets the diagram renderer associated with the layer. + /** + * Sets the diagram renderer associated with the layer. * \param diagramRenderer diagram renderer. Ownership is transferred to the object. * \see renderer() * \since QGIS 2.16 */ void setRenderer( QgsDiagramRenderer *diagramRenderer SIP_TRANSFER ); - /** Returns the coordinate transform associated with the layer, or an + /** + * Returns the coordinate transform associated with the layer, or an * invalid transform if no transformation is required. * \see setCoordinateTransform() * \since QGIS 2.16 */ QgsCoordinateTransform coordinateTransform() const { return mCt; } - /** Sets the coordinate transform associated with the layer. + /** + * Sets the coordinate transform associated with the layer. * \param transform coordinate transform. Ownership is transferred to the object. * \see coordinateTransform() * \since QGIS 2.16 */ void setCoordinateTransform( const QgsCoordinateTransform &transform ); - /** Returns whether the layer should show all diagrams, including overlapping diagrams + /** + * Returns whether the layer should show all diagrams, including overlapping diagrams * \see setShowAllDiagrams() * \since QGIS 2.16 */ bool showAllDiagrams() const { return mShowAll; } - /** Sets whether the layer should show all diagrams, including overlapping diagrams + /** + * Sets whether the layer should show all diagrams, including overlapping diagrams * \param showAllDiagrams set to true to show all diagrams * \see showAllDiagrams() * \since QGIS 2.16 @@ -271,26 +291,30 @@ class CORE_EXPORT QgsDiagramLayerSettings */ bool prepare( const QgsExpressionContext &context = QgsExpressionContext() ) const; - /** Returns the set of any fields referenced by the layer's diagrams. + /** + * Returns the set of any fields referenced by the layer's diagrams. * \param context expression context the diagrams will be drawn using * \since QGIS 2.16 */ QSet< QString > referencedFields( const QgsExpressionContext &context = QgsExpressionContext() ) const; - /** Returns a reference to the diagram's property collection, used for data defined overrides. + /** + * Returns a reference to the diagram's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } - /** Returns a reference to the diagram's property collection, used for data defined overrides. + /** + * Returns a reference to the diagram's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setProperties() * \note not available in Python bindings */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP - /** Sets the diagram's property collection, used for data defined overrides. + /** + * Sets the diagram's property collection, used for data defined overrides. * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 * \see dataDefinedProperties() @@ -340,7 +364,8 @@ class CORE_EXPORT QgsDiagramLayerSettings }; -/** \ingroup core +/** + * \ingroup core * \class QgsDiagramSettings * \brief Stores the settings for rendering a single diagram. * @@ -378,21 +403,25 @@ class CORE_EXPORT QgsDiagramSettings QList< QString > categoryLabels; QSizeF size; //size - /** Diagram size unit + /** + * Diagram size unit */ QgsUnitTypes::RenderUnit sizeType = QgsUnitTypes::RenderMillimeters; - /** Diagram size unit scale + /** + * Diagram size unit scale * \since QGIS 2.16 */ QgsMapUnitScale sizeScale; - /** Line unit index + /** + * Line unit index * \since QGIS 2.16 */ QgsUnitTypes::RenderUnit lineSizeUnit = QgsUnitTypes::RenderMillimeters; - /** Line unit scale + /** + * Line unit scale * \since QGIS 2.16 */ QgsMapUnitScale lineSizeScale; @@ -441,7 +470,8 @@ class CORE_EXPORT QgsDiagramSettings //! Writes diagram settings to XML void writeXml( QDomElement &rendererElem, QDomDocument &doc ) const; - /** Returns list of legend nodes for the diagram + /** + * Returns list of legend nodes for the diagram * \note caller is responsible for deletion of QgsLayerTreeModelLegendNodes * \since QGIS 2.10 */ @@ -449,7 +479,8 @@ class CORE_EXPORT QgsDiagramSettings }; -/** \ingroup core +/** + * \ingroup core * \class QgsDiagramInterpolationSettings * Additional diagram settings for interpolated size rendering. */ @@ -469,7 +500,8 @@ class CORE_EXPORT QgsDiagramInterpolationSettings }; -/** \ingroup core +/** + * \ingroup core * \class QgsDiagramRenderer * \brief Evaluates and returns the diagram settings relating to a diagram for a specific feature. */ @@ -496,7 +528,8 @@ class CORE_EXPORT QgsDiagramRenderer QgsDiagramRenderer() = default; virtual ~QgsDiagramRenderer() = default; - /** Returns new instance that is equivalent to this one + /** + * Returns new instance that is equivalent to this one * \since QGIS 2.4 */ virtual QgsDiagramRenderer *clone() const = 0 SIP_FACTORY; @@ -508,7 +541,8 @@ class CORE_EXPORT QgsDiagramRenderer //! Returns attribute indices needed for diagram rendering virtual QList diagramAttributes() const = 0; - /** Returns the set of any fields required for diagram rendering + /** + * Returns the set of any fields required for diagram rendering * \param context expression context the diagrams will be drawn using * \since QGIS 2.16 */ @@ -539,20 +573,23 @@ class CORE_EXPORT QgsDiagramRenderer */ virtual void writeXml( QDomElement &layerElem, QDomDocument &doc, const QgsReadWriteContext &context ) const = 0; - /** Returns list of legend nodes for the diagram + /** + * Returns list of legend nodes for the diagram * \note caller is responsible for deletion of QgsLayerTreeModelLegendNodes * \since QGIS 2.10 */ virtual QList< QgsLayerTreeModelLegendNode * > legendItems( QgsLayerTreeLayer *nodeLayer ) const SIP_FACTORY; - /** Returns true if renderer will show legend items for diagram attributes. + /** + * Returns true if renderer will show legend items for diagram attributes. * \since QGIS 2.16 * \see setAttributeLegend() * \see sizeLegend() */ bool attributeLegend() const { return mShowAttributeLegend; } - /** Sets whether the renderer will show legend items for diagram attributes. + /** + * Sets whether the renderer will show legend items for diagram attributes. * \param enabled set to true to show diagram attribute legend * \since QGIS 2.16 * \see attributeLegend() @@ -564,7 +601,8 @@ class CORE_EXPORT QgsDiagramRenderer QgsDiagramRenderer( const QgsDiagramRenderer &other ); QgsDiagramRenderer &operator=( const QgsDiagramRenderer &other ); - /** Returns diagram settings for a feature (or false if the diagram for the feature is not to be rendered). Used internally within renderDiagram() + /** + * Returns diagram settings for a feature (or false if the diagram for the feature is not to be rendered). Used internally within renderDiagram() * \param feature the feature * \param c render context * \param s out: diagram settings for the feature @@ -601,7 +639,8 @@ class CORE_EXPORT QgsDiagramRenderer bool mShowAttributeLegend = true; }; -/** \ingroup core +/** + * \ingroup core * Renders the diagrams for all features with the same settings */ class CORE_EXPORT QgsSingleCategoryDiagramRenderer : public QgsDiagramRenderer @@ -633,7 +672,8 @@ class CORE_EXPORT QgsSingleCategoryDiagramRenderer : public QgsDiagramRenderer QgsDiagramSettings mSettings; }; -/** \ingroup core +/** + * \ingroup core * \class QgsLinearlyInterpolatedDiagramRenderer */ class CORE_EXPORT QgsLinearlyInterpolatedDiagramRenderer : public QgsDiagramRenderer diff --git a/src/core/qgsdistancearea.h b/src/core/qgsdistancearea.h index 6cfdb973b4c7..05ee7cbbe543 100644 --- a/src/core/qgsdistancearea.h +++ b/src/core/qgsdistancearea.h @@ -93,7 +93,8 @@ class CORE_EXPORT QgsDistanceArea */ bool setEllipsoid( double semiMajor, double semiMinor ); - /** Returns ellipsoid's acronym. Calculations will only use the + /** + * Returns ellipsoid's acronym. Calculations will only use the * ellipsoid if a valid ellipsoid has been set. * \see setEllipsoid() * \see willUseEllipsoid() diff --git a/src/core/qgseditformconfig.h b/src/core/qgseditformconfig.h index 2eb289ddddd3..7e3bd1a96101 100644 --- a/src/core/qgseditformconfig.h +++ b/src/core/qgseditformconfig.h @@ -30,7 +30,8 @@ class QgsReadWriteContext; class QgsRelationManager; class QgsEditFormConfigPrivate; -/** \ingroup core +/** + * \ingroup core * \class QgsEditFormConfig */ class CORE_EXPORT QgsEditFormConfig @@ -249,7 +250,8 @@ class CORE_EXPORT QgsEditFormConfig */ void setInitFilePath( const QString &filePath ); - /** Return Python code source for edit form initialization + /** + * Return Python code source for edit form initialization * (if it shall be loaded from a file, read from the * provided dialog editor or inherited from the environment) */ diff --git a/src/core/qgseditorwidgetsetup.h b/src/core/qgseditorwidgetsetup.h index 4c00be808e10..f3924fae27b9 100644 --- a/src/core/qgseditorwidgetsetup.h +++ b/src/core/qgseditorwidgetsetup.h @@ -19,7 +19,8 @@ #include "qgis_core.h" #include -/** \ingroup core +/** + * \ingroup core * Holder for the widget type and its configuration for a field. * * \since QGIS 3.0 diff --git a/src/core/qgserror.h b/src/core/qgserror.h index 08999776119a..d83891701f4c 100644 --- a/src/core/qgserror.h +++ b/src/core/qgserror.h @@ -25,7 +25,8 @@ // Macro to create Error message including info about where it was created. #define QGS_ERROR_MESSAGE(message, tag) QgsErrorMessage(QString(message),QString(tag), QString(__FILE__), QString(__FUNCTION__), __LINE__) -/** \ingroup core +/** + * \ingroup core * QgsErrorMessage represents single error message. */ class CORE_EXPORT QgsErrorMessage @@ -41,7 +42,8 @@ class CORE_EXPORT QgsErrorMessage QgsErrorMessage() {} - /** Constructor. + /** + * Constructor. * \param message error message string * \param tag error label, for example GDAL, GDAL Provider, Raster layer * \param file the file where error was created @@ -72,7 +74,8 @@ class CORE_EXPORT QgsErrorMessage Format mFormat = Text; }; -/** \ingroup core +/** + * \ingroup core * QgsError is container for error messages (report). It may contain chain * (sort of traceback) of error messages (e.g. GDAL - provider - layer). * Higher level messages are appended at the end. @@ -83,35 +86,41 @@ class CORE_EXPORT QgsError QgsError() {} - /** Constructor with single message. + /** + * Constructor with single message. * \param message error message * \param tag short description, e.g. GDAL, Provider, Layer */ QgsError( const QString &message, const QString &tag ); - /** Append new error message. + /** + * Append new error message. * \param message error message string * \param tag error label, for example GDAL, GDAL Provider, Raster layer */ void append( const QString &message, const QString &tag ); - /** Append new error message. + /** + * Append new error message. * \param message error message */ void append( const QgsErrorMessage &message ); - /** Test if any error is set. + /** + * Test if any error is set. * \returns true if contains error */ bool isEmpty() const { return mMessageList.isEmpty(); } - /** Full error messages description + /** + * Full error messages description * \param format output format * \returns error report */ QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const; - /** Short error description, usually the first error in chain, the real error. + /** + * Short error description, usually the first error in chain, the real error. * \returns error description */ QString summary() const; diff --git a/src/core/qgsexception.h b/src/core/qgsexception.h index 03b8ed506c48..41bea719ae95 100644 --- a/src/core/qgsexception.h +++ b/src/core/qgsexception.h @@ -27,7 +27,8 @@ -/** \ingroup core +/** + * \ingroup core * Defines a QGIS exception class. */ class CORE_EXPORT QgsException @@ -58,7 +59,8 @@ class CORE_EXPORT QgsException }; -/** \ingroup core +/** + * \ingroup core * Custom exception class for Coordinate Reference System related exceptions. */ class CORE_EXPORT QgsCsException : public QgsException diff --git a/src/core/qgsexpressioncontext.h b/src/core/qgsexpressioncontext.h index 7c1f9d3880ae..2ae63d0c3f1a 100644 --- a/src/core/qgsexpressioncontext.h +++ b/src/core/qgsexpressioncontext.h @@ -41,7 +41,8 @@ class QgsSymbol; class QgsProcessingAlgorithm; class QgsProcessingContext; -/** \ingroup core +/** + * \ingroup core * \class QgsScopedExpressionFunction * \brief Expression function for use within a QgsExpressionContextScope. This differs from a * standard QgsExpression::Function in that it requires an implemented @@ -93,7 +94,8 @@ class CORE_EXPORT QgsScopedExpressionFunction : public QgsExpressionFunction virtual QVariant func( const QVariantList &values, const QgsExpressionContext *context, QgsExpression *parent, const QgsExpressionNodeFunction *node ) override = 0; - /** Returns a clone of the function. + /** + * Returns a clone of the function. */ virtual QgsScopedExpressionFunction *clone() const = 0 SIP_FACTORY; @@ -109,7 +111,8 @@ class CORE_EXPORT QgsScopedExpressionFunction : public QgsExpressionFunction }; -/** \ingroup core +/** + * \ingroup core * \class QgsExpressionContextScope * \brief Single scope for storing variables and functions for use within a QgsExpressionContext. * Examples include a project's scope, which could contain information about the current project such as @@ -125,12 +128,14 @@ class CORE_EXPORT QgsExpressionContextScope { public: - /** Single variable definition for use within a QgsExpressionContextScope. + /** + * Single variable definition for use within a QgsExpressionContextScope. */ struct StaticVariable { - /** Constructor for StaticVariable. + /** + * Constructor for StaticVariable. * \param name variable name (should be unique within the QgsExpressionContextScope) * \param value initial variable value * \param readOnly true if variable should not be editable by users @@ -161,12 +166,14 @@ class CORE_EXPORT QgsExpressionContextScope QString description; }; - /** Constructor for QgsExpressionContextScope + /** + * Constructor for QgsExpressionContextScope * \param name friendly display name for the context scope */ QgsExpressionContextScope( const QString &name = QString() ); - /** Copy constructor + /** + * Copy constructor */ QgsExpressionContextScope( const QgsExpressionContextScope &other ); @@ -174,11 +181,13 @@ class CORE_EXPORT QgsExpressionContextScope ~QgsExpressionContextScope(); - /** Returns the friendly display name of the context scope. + /** + * Returns the friendly display name of the context scope. */ QString name() const { return mName; } - /** Convenience method for setting a variable in the context scope by \a name name and \a value. If a variable + /** + * Convenience method for setting a variable in the context scope by \a name name and \a value. If a variable * with the same name is already set then its value is overwritten, otherwise a new variable is added to the scope. * If the \a isStatic parameter is set to true, this variable can be cached during the execution * of QgsExpression::prepare(). @@ -186,7 +195,8 @@ class CORE_EXPORT QgsExpressionContextScope */ void setVariable( const QString &name, const QVariant &value, bool isStatic = false ); - /** Adds a variable into the context scope. If a variable with the same name is already set then its + /** + * Adds a variable into the context scope. If a variable with the same name is already set then its * value is overwritten, otherwise a new variable is added to the scope. * \param variable definition of variable to insert * \see setVariable() @@ -194,14 +204,16 @@ class CORE_EXPORT QgsExpressionContextScope */ void addVariable( const QgsExpressionContextScope::StaticVariable &variable ); - /** Removes a variable from the context scope, if found. + /** + * Removes a variable from the context scope, if found. * \param name name of variable to remove * \returns true if variable was removed from the scope, false if matching variable was not * found within the scope */ bool removeVariable( const QString &name ); - /** Tests whether a variable with the specified name exists in the scope. + /** + * Tests whether a variable with the specified name exists in the scope. * \param name variable name * \returns true if matching variable was found in the scope * \see variable() @@ -209,7 +221,8 @@ class CORE_EXPORT QgsExpressionContextScope */ bool hasVariable( const QString &name ) const; - /** Retrieves a variable's value from the scope. + /** + * Retrieves a variable's value from the scope. * \param name variable name * \returns variable value, or invalid QVariant if matching variable could not be found * \see hasVariable() @@ -217,20 +230,23 @@ class CORE_EXPORT QgsExpressionContextScope */ QVariant variable( const QString &name ) const; - /** Returns a list of variable names contained within the scope. + /** + * Returns a list of variable names contained within the scope. * \see functionNames() * \see filteredVariableNames() */ QStringList variableNames() const; - /** Returns a filtered and sorted list of variable names contained within the scope. + /** + * Returns a filtered and sorted list of variable names contained within the scope. * Hidden variable names will be excluded, and the list will be sorted so that * read only variables are listed first. * \see variableNames() */ QStringList filteredVariableNames() const; - /** Tests whether the specified variable is read only and should not be editable + /** + * Tests whether the specified variable is read only and should not be editable * by users. * \param name variable name * \returns true if variable is read only @@ -253,11 +269,13 @@ class CORE_EXPORT QgsExpressionContextScope */ QString description( const QString &name ) const; - /** Returns the count of variables contained within the scope. + /** + * Returns the count of variables contained within the scope. */ int variableCount() const { return mVariables.count(); } - /** Tests whether a function with the specified name exists in the scope. + /** + * Tests whether a function with the specified name exists in the scope. * \param name function name * \returns true if matching function was found in the scope * \see function() @@ -265,7 +283,8 @@ class CORE_EXPORT QgsExpressionContextScope */ bool hasFunction( const QString &name ) const; - /** Retrieves a function from the scope. + /** + * Retrieves a function from the scope. * \param name function name * \returns function, or null if matching function could not be found * \see hasFunction() @@ -274,13 +293,15 @@ class CORE_EXPORT QgsExpressionContextScope */ QgsExpressionFunction *function( const QString &name ) const; - /** Retrieves a list of names of functions contained in the scope. + /** + * Retrieves a list of names of functions contained in the scope. * \see function() * \see variableNames() */ QStringList functionNames() const; - /** Adds a function to the scope. + /** + * Adds a function to the scope. * \param name function name * \param function function to insert. Ownership is transferred to the scope. * \see addVariable() @@ -302,7 +323,8 @@ class CORE_EXPORT QgsExpressionContextScope */ QgsFeature feature() const { return mFeature; } - /** Convenience function for setting a feature for the scope. Any existing + /** + * Convenience function for setting a feature for the scope. Any existing * feature set by the scope will be overwritten. * \param feature feature for scope * \see removeFeature() @@ -318,7 +340,8 @@ class CORE_EXPORT QgsExpressionContextScope */ void removeFeature() { mHasFeature = false; mFeature = QgsFeature(); } - /** Convenience function for setting a fields for the scope. Any existing + /** + * Convenience function for setting a fields for the scope. Any existing * fields set by the scope will be overwritten. * \param fields fields for scope */ @@ -334,7 +357,8 @@ class CORE_EXPORT QgsExpressionContextScope bool variableNameSort( const QString &a, const QString &b ); }; -/** \ingroup core +/** + * \ingroup core * \class QgsExpressionContext * \brief Expression contexts are used to encapsulate the parameters around which a QgsExpression should * be evaluated. QgsExpressions can then utilize the information stored within a context to contextualise @@ -352,13 +376,15 @@ class CORE_EXPORT QgsExpressionContext QgsExpressionContext() {} - /** Initializes the context with given list of scopes. + /** + * Initializes the context with given list of scopes. * Ownership of the scopes is transferred to the stack. * \since QGIS 3.0 */ explicit QgsExpressionContext( const QList &scopes SIP_TRANSFER ); - /** Copy constructor + /** + * Copy constructor */ QgsExpressionContext( const QgsExpressionContext &other ); @@ -368,7 +394,8 @@ class CORE_EXPORT QgsExpressionContext ~QgsExpressionContext(); - /** Check whether a variable is specified by any scope within the context. + /** + * Check whether a variable is specified by any scope within the context. * \param name variable name * \returns true if variable is set * \see variable() @@ -376,7 +403,8 @@ class CORE_EXPORT QgsExpressionContext */ bool hasVariable( const QString &name ) const; - /** Fetches a matching variable from the context. The variable will be fetched + /** + * Fetches a matching variable from the context. The variable will be fetched * from the last scope contained within the context which has a matching * variable set. * \param name variable name @@ -393,7 +421,8 @@ class CORE_EXPORT QgsExpressionContext */ QVariantMap variablesToMap() const; - /** Returns true if the specified variable name is intended to be highlighted to the + /** + * Returns true if the specified variable name is intended to be highlighted to the * user. This is used by the expression builder to more prominently display the * variable. * \param name variable name @@ -401,14 +430,16 @@ class CORE_EXPORT QgsExpressionContext */ bool isHighlightedVariable( const QString &name ) const; - /** Sets the list of variable names within the context intended to be highlighted to the user. This + /** + * Sets the list of variable names within the context intended to be highlighted to the user. This * is used by the expression builder to more prominently display these variables. * \param variableNames variable names to highlight * \see isHighlightedVariable() */ void setHighlightedVariables( const QStringList &variableNames ); - /** Returns the currently active scope from the context for a specified variable name. + /** + * Returns the currently active scope from the context for a specified variable name. * As scopes later in the stack override earlier contexts, this will be the last matching * scope which contains a matching variable. * \param name variable name @@ -416,7 +447,8 @@ class CORE_EXPORT QgsExpressionContext */ QgsExpressionContextScope *activeScopeForVariable( const QString &name ); - /** Returns the currently active scope from the context for a specified variable name. + /** + * Returns the currently active scope from the context for a specified variable name. * As scopes later in the stack override earlier contexts, this will be the last matching * scope which contains a matching variable. * \param name variable name @@ -425,37 +457,43 @@ class CORE_EXPORT QgsExpressionContext */ const QgsExpressionContextScope *activeScopeForVariable( const QString &name ) const SIP_SKIP; - /** Returns the scope at the specified index within the context. + /** + * Returns the scope at the specified index within the context. * \param index index of scope * \returns matching scope, or null if none found * \see lastScope() */ QgsExpressionContextScope *scope( int index ); - /** Returns the last scope added to the context. + /** + * Returns the last scope added to the context. * \see scope() */ QgsExpressionContextScope *lastScope(); - /** Returns a list of scopes contained within the stack. + /** + * Returns a list of scopes contained within the stack. * \returns list of pointers to scopes */ QList< QgsExpressionContextScope * > scopes() { return mStack; } - /** Returns the index of the specified scope if it exists within the context. + /** + * Returns the index of the specified scope if it exists within the context. * \param scope scope to find * \returns index of scope, or -1 if scope was not found within the context. */ int indexOfScope( QgsExpressionContextScope *scope ) const; - /** Returns the index of the first scope with a matching name within the context. + /** + * Returns the index of the first scope with a matching name within the context. * \param scopeName name of scope to find * \returns index of scope, or -1 if scope was not found within the context. * \since QGIS 3.0 */ int indexOfScope( const QString &scopeName ) const; - /** Returns a list of variables names set by all scopes in the context. + /** + * Returns a list of variables names set by all scopes in the context. * \returns list of unique variable names * \see filteredVariableNames * \see functionNames @@ -464,14 +502,16 @@ class CORE_EXPORT QgsExpressionContext */ QStringList variableNames() const; - /** Returns a filtered list of variables names set by all scopes in the context. The included + /** + * Returns a filtered list of variables names set by all scopes in the context. The included * variables are those which should be seen by users. * \returns filtered list of unique variable names * \see variableNames */ QStringList filteredVariableNames() const; - /** Returns whether a variable is read only, and should not be modifiable by users. + /** + * Returns whether a variable is read only, and should not be modifiable by users. * \param name variable name * \returns true if variable is read only. Read only status will be taken from last * matching scope which contains a matching variable. @@ -488,20 +528,23 @@ class CORE_EXPORT QgsExpressionContext */ QString description( const QString &name ) const; - /** Checks whether a specified function is contained in the context. + /** + * Checks whether a specified function is contained in the context. * \param name function name * \returns true if context provides a matching function * \see function */ bool hasFunction( const QString &name ) const; - /** Retrieves a list of function names contained in the context. + /** + * Retrieves a list of function names contained in the context. * \see function() * \see variableNames() */ QStringList functionNames() const; - /** Fetches a matching function from the context. The function will be fetched + /** + * Fetches a matching function from the context. The function will be fetched * from the last scope contained within the context which has a matching * function set. * \param name function name @@ -510,18 +553,21 @@ class CORE_EXPORT QgsExpressionContext */ QgsExpressionFunction *function( const QString &name ) const; - /** Returns the number of scopes contained in the context. + /** + * Returns the number of scopes contained in the context. */ int scopeCount() const; - /** Appends a scope to the end of the context. This scope will override + /** + * Appends a scope to the end of the context. This scope will override * any matching variables or functions provided by existing scopes within the * context. Ownership of the scope is transferred to the stack. * \param scope expression context to append to context */ void appendScope( QgsExpressionContextScope *scope SIP_TRANSFER ); - /** Appends a list of scopes to the end of the context. This scopes will override + /** + * Appends a list of scopes to the end of the context. This scopes will override * any matching variables or functions provided by existing scopes within the * context. Ownership of the scopes is transferred to the stack. * \param scopes scopes to append to context @@ -534,13 +580,15 @@ class CORE_EXPORT QgsExpressionContext */ QgsExpressionContextScope *popScope(); - /** Appends a scope to the end of the context. This scope will override + /** + * Appends a scope to the end of the context. This scope will override * any matching variables or functions provided by existing scopes within the * context. Ownership of the scope is transferred to the stack. */ QgsExpressionContext &operator<< ( QgsExpressionContextScope *scope SIP_TRANSFER ); - /** Convenience function for setting a feature for the context. The feature + /** + * Convenience function for setting a feature for the context. The feature * will be set within the last scope of the context, so will override any * existing features within the context. * \param feature feature for context @@ -555,12 +603,14 @@ class CORE_EXPORT QgsExpressionContext */ bool hasFeature() const; - /** Convenience function for retrieving the feature for the context, if set. + /** + * Convenience function for retrieving the feature for the context, if set. * \see setFeature */ QgsFeature feature() const; - /** Convenience function for setting a fields for the context. The fields + /** + * Convenience function for setting a fields for the context. The fields * will be set within the last scope of the context, so will override any * existing fields within the context. * \param fields fields for context @@ -568,19 +618,22 @@ class CORE_EXPORT QgsExpressionContext */ void setFields( const QgsFields &fields ); - /** Convenience function for retrieving the fields for the context, if set. + /** + * Convenience function for retrieving the fields for the context, if set. * \see setFields */ QgsFields fields() const; - /** Sets the original value variable value for the context. + /** + * Sets the original value variable value for the context. * \param value value for original value variable. This usually represents the an original widget * value before any data defined overrides have been applied. * \since QGIS 2.12 */ void setOriginalValueVariable( const QVariant &value ); - /** Sets a value to cache within the expression context. This can be used to cache the results + /** + * Sets a value to cache within the expression context. This can be used to cache the results * of expensive expression sub-calculations, to speed up future evaluations using the same * expression context. * \param key unique key for retrieving cached value @@ -592,7 +645,8 @@ class CORE_EXPORT QgsExpressionContext */ void setCachedValue( const QString &key, const QVariant &value ) const; - /** Returns true if the expression context contains a cached value with a matching key. + /** + * Returns true if the expression context contains a cached value with a matching key. * \param key unique key used to store cached value * \see setCachedValue() * \see cachedValue() @@ -601,7 +655,8 @@ class CORE_EXPORT QgsExpressionContext */ bool hasCachedValue( const QString &key ) const; - /** Returns the matching cached value, if set. This can be used to retrieve the previously stored results + /** + * Returns the matching cached value, if set. This can be used to retrieve the previously stored results * of an expensive expression sub-calculation. * \param key unique key used to store cached value * \returns matching cached value, or invalid QVariant if not set @@ -612,7 +667,8 @@ class CORE_EXPORT QgsExpressionContext */ QVariant cachedValue( const QString &key ) const; - /** Clears all cached values from the context. + /** + * Clears all cached values from the context. * \see setCachedValue() * \see hasCachedValue() * \see cachedValue() @@ -651,7 +707,8 @@ class CORE_EXPORT QgsExpressionContext }; -/** \ingroup core +/** + * \ingroup core * \class QgsExpressionContextUtils * \brief Contains utilities for working with QgsExpressionContext objects, including methods * for creating scopes for specific uses (e.g., project scopes, layer scopes). @@ -662,13 +719,15 @@ class CORE_EXPORT QgsExpressionContextUtils { public: - /** Creates a new scope which contains variables and functions relating to the global QGIS context. + /** + * Creates a new scope which contains variables and functions relating to the global QGIS context. * For instance, QGIS version numbers and variables specified through QGIS options. * \see setGlobalVariable() */ static QgsExpressionContextScope *globalScope() SIP_FACTORY; - /** Sets a global context variable. This variable will be contained within scopes retrieved via + /** + * Sets a global context variable. This variable will be contained within scopes retrieved via * globalScope(). * \param name variable name * \param value variable value @@ -677,7 +736,8 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setGlobalVariable( const QString &name, const QVariant &value ); - /** Sets all global context variables. Existing global variables will be removed and replaced + /** + * Sets all global context variables. Existing global variables will be removed and replaced * with the variables specified. * \param variables new set of global variables * \see setGlobalVariable() @@ -685,14 +745,16 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setGlobalVariables( const QVariantMap &variables ); - /** Creates a new scope which contains variables and functions relating to a QGIS project. + /** + * Creates a new scope which contains variables and functions relating to a QGIS project. * For instance, project path and title, and variables specified through the project properties. * \param project What project to use * \see setProjectVariable() */ static QgsExpressionContextScope *projectScope( const QgsProject *project ) SIP_FACTORY; - /** Sets a project context variable. This variable will be contained within scopes retrieved via + /** + * Sets a project context variable. This variable will be contained within scopes retrieved via * projectScope(). * \param project Project to apply changes to * \param name variable name @@ -702,7 +764,8 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setProjectVariable( QgsProject *project, const QString &name, const QVariant &value ); - /** Sets all project context variables. Existing project variables will be removed and replaced + /** + * Sets all project context variables. Existing project variables will be removed and replaced * with the variables specified. * \param project Project to apply changes to * \param variables new set of project variables @@ -711,17 +774,20 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setProjectVariables( QgsProject *project, const QVariantMap &variables ); - /** Creates a new scope which contains variables and functions relating to a QgsMapLayer. + /** + * Creates a new scope which contains variables and functions relating to a QgsMapLayer. * For instance, layer name, id and fields. */ static QgsExpressionContextScope *layerScope( const QgsMapLayer *layer ) SIP_FACTORY; - /** Creates a list of three scopes: global, layer's project and layer. + /** + * Creates a list of three scopes: global, layer's project and layer. * \since QGIS 3.0 */ static QList globalProjectLayerScopes( const QgsMapLayer *layer ) SIP_FACTORY; - /** Sets a layer context variable. This variable will be contained within scopes retrieved via + /** + * Sets a layer context variable. This variable will be contained within scopes retrieved via * layerScope(). * \param layer map layer * \param name variable name @@ -731,7 +797,8 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setLayerVariable( QgsMapLayer *layer, const QString &name, const QVariant &value ); - /** Sets all layer context variables. Existing layer variables will be removed and replaced + /** + * Sets all layer context variables. Existing layer variables will be removed and replaced * with the variables specified. * \param layer map layer * \param variables new set of layer variables @@ -740,7 +807,8 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setLayerVariables( QgsMapLayer *layer, const QVariantMap &variables ); - /** Creates a new scope which contains variables and functions relating to a QgsMapSettings object. + /** + * Creates a new scope which contains variables and functions relating to a QgsMapSettings object. * For instance, map scale and rotation. */ static QgsExpressionContextScope *mapSettingsScope( const QgsMapSettings &mapSettings ) SIP_FACTORY; @@ -761,13 +829,15 @@ class CORE_EXPORT QgsExpressionContextUtils */ static QgsExpressionContextScope *updateSymbolScope( const QgsSymbol *symbol, QgsExpressionContextScope *symbolScope = nullptr ); - /** Creates a new scope which contains variables and functions relating to a QgsComposition. + /** + * Creates a new scope which contains variables and functions relating to a QgsComposition. * For instance, number of pages and page sizes. * \param composition source composition */ static QgsExpressionContextScope *compositionScope( const QgsComposition *composition ) SIP_FACTORY; - /** Sets a composition context variable. This variable will be contained within scopes retrieved via + /** + * Sets a composition context variable. This variable will be contained within scopes retrieved via * compositionScope(). * \param composition target composition * \param name variable name @@ -817,19 +887,22 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setLayoutVariables( QgsLayout *layout, const QVariantMap &variables ); - /** Creates a new scope which contains variables and functions relating to a QgsAtlasComposition. + /** + * Creates a new scope which contains variables and functions relating to a QgsAtlasComposition. * For instance, current page name and number. * \param atlas source atlas. If null, a set of default atlas variables will be added to the scope. */ static QgsExpressionContextScope *atlasScope( const QgsAtlasComposition *atlas ) SIP_FACTORY; - /** Creates a new scope which contains variables and functions relating to a QgsComposerItem. + /** + * Creates a new scope which contains variables and functions relating to a QgsComposerItem. * For instance, item size and position. * \param composerItem source composer item */ static QgsExpressionContextScope *composerItemScope( const QgsComposerItem *composerItem ) SIP_FACTORY; - /** Sets a composer item context variable. This variable will be contained within scopes retrieved via + /** + * Sets a composer item context variable. This variable will be contained within scopes retrieved via * composerItemScope(). * \param composerItem target composer item * \param name variable name @@ -839,7 +912,8 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setComposerItemVariable( QgsComposerItem *composerItem, const QString &name, const QVariant &value ); - /** Sets all composition context variables. Existing compositoin variables will be removed and replaced + /** + * Sets all composition context variables. Existing compositoin variables will be removed and replaced * with the variables specified. * \param composerItem target composer item * \param variables new set of layer variables @@ -848,7 +922,8 @@ class CORE_EXPORT QgsExpressionContextUtils */ static void setComposerItemVariables( QgsComposerItem *composerItem, const QVariantMap &variables ); - /** Helper function for creating an expression context which contains just a feature and fields + /** + * Helper function for creating an expression context which contains just a feature and fields * collection. Generally this method should not be used as the created context does not include * standard scopes such as the global and project scopes. */ @@ -867,7 +942,8 @@ class CORE_EXPORT QgsExpressionContextUtils */ static QgsExpressionContextScope *notificationScope( const QString &message = QString() ) SIP_FACTORY; - /** Registers all known core functions provided by QgsExpressionContextScope objects. + /** + * Registers all known core functions provided by QgsExpressionContextScope objects. */ static void registerContextFunctions(); diff --git a/src/core/qgsexpressionfieldbuffer.h b/src/core/qgsexpressionfieldbuffer.h index 3a5c3910c89c..075e3d8dfcae 100644 --- a/src/core/qgsexpressionfieldbuffer.h +++ b/src/core/qgsexpressionfieldbuffer.h @@ -26,7 +26,8 @@ #include "qgsfields.h" #include "qgsexpression.h" -/** \ingroup core +/** + * \ingroup core * Buffers information about expression fields for a vector layer. * * \since QGIS 2.6 diff --git a/src/core/qgsfeature.h b/src/core/qgsfeature.h index 1244bfa5915e..83ded9ec87fc 100644 --- a/src/core/qgsfeature.h +++ b/src/core/qgsfeature.h @@ -53,7 +53,8 @@ typedef qint64 QgsFeatureId SIP_SKIP; #define STRING_TO_FID(str) (str).toLongLong() -/** \ingroup core +/** + * \ingroup core * The feature class encapsulates a single feature including its id, * geometry and a list of field/values attributes. * \note QgsFeature objects are implicitly shared. @@ -176,7 +177,8 @@ class CORE_EXPORT QgsFeature % End #endif - /** Constructor for QgsFeature + /** + * Constructor for QgsFeature * \param id feature id */ #ifndef SIP_RUN @@ -185,7 +187,8 @@ class CORE_EXPORT QgsFeature QgsFeature( qint64 id = 0 ); #endif - /** Constructor for QgsFeature + /** + * Constructor for QgsFeature * \param fields feature's fields * \param id feature id */ @@ -195,11 +198,13 @@ class CORE_EXPORT QgsFeature QgsFeature( const QgsFields &fields, qint64 id = 0 ); #endif - /** Copy constructor + /** + * Copy constructor */ QgsFeature( const QgsFeature &rhs ); - /** Assignment operator + /** + * Assignment operator */ QgsFeature &operator=( const QgsFeature &rhs ) SIP_SKIP; @@ -215,19 +220,22 @@ class CORE_EXPORT QgsFeature virtual ~QgsFeature(); - /** Get the feature ID for this feature. + /** + * Get the feature ID for this feature. * \returns feature ID * \see setId() */ QgsFeatureId id() const; - /** Sets the feature ID for this feature. + /** + * Sets the feature ID for this feature. * \param id feature id * \see id */ void setId( QgsFeatureId id ); - /** Returns the feature's attributes. + /** + * Returns the feature's attributes. * \returns list of feature's attributes * \see setAttributes * \since QGIS 2.9 @@ -235,7 +243,8 @@ class CORE_EXPORT QgsFeature */ QgsAttributes attributes() const; - /** Sets the feature's attributes. + /** + * Sets the feature's attributes. * The feature will be valid after. * \param attrs attribute list * \see setAttribute @@ -243,7 +252,8 @@ class CORE_EXPORT QgsFeature */ void setAttributes( const QgsAttributes &attrs ); - /** Set an attribute's value by field index. + /** + * Set an attribute's value by field index. * The feature will be valid if it was successful. * \param field the index of the field to set * \param attr the value of the attribute @@ -278,12 +288,14 @@ class CORE_EXPORT QgsFeature % End #endif - /** Initialize this feature with the given number of fields. Discard any previously set attribute data. + /** + * Initialize this feature with the given number of fields. Discard any previously set attribute data. * \param fieldCount Number of fields to initialize */ void initAttributes( int fieldCount ); - /** Deletes an attribute and its value. + /** + * Deletes an attribute and its value. * \param field the index of the field * \see setAttribute * \note For Python: raises a KeyError exception if the field is not found @@ -302,47 +314,54 @@ class CORE_EXPORT QgsFeature % End #endif - /** Returns the validity of this feature. This is normally set by + /** + * Returns the validity of this feature. This is normally set by * the provider to indicate some problem that makes the feature * invalid or to indicate a null feature. * \see setValid */ bool isValid() const; - /** Sets the validity of the feature. + /** + * Sets the validity of the feature. * \param validity set to true if feature is valid * \see isValid */ void setValid( bool validity ); - /** Returns true if the feature has an associated geometry. + /** + * Returns true if the feature has an associated geometry. * \see geometry() * \since QGIS 3.0. */ bool hasGeometry() const; - /** Returns the geometry associated with this feature. If the feature has no geometry, + /** + * Returns the geometry associated with this feature. If the feature has no geometry, * an empty QgsGeometry object will be returned. * \see hasGeometry() * \see setGeometry() */ QgsGeometry geometry() const; - /** Set the feature's geometry. The feature will be valid after. + /** + * Set the feature's geometry. The feature will be valid after. * \param geometry new feature geometry * \see geometry() * \see clearGeometry() */ void setGeometry( const QgsGeometry &geometry ); - /** Removes any geometry associated with the feature. + /** + * Removes any geometry associated with the feature. * \see setGeometry() * \see hasGeometry() * \since QGIS 3.0 */ void clearGeometry(); - /** Assign a field map with the feature to allow attribute access by attribute name. + /** + * Assign a field map with the feature to allow attribute access by attribute name. * \param fields The attribute fields which this feature holds * \param initAttributes If true, attributes are initialized. Clears any data previously assigned. * C++: Defaults to false @@ -352,12 +371,14 @@ class CORE_EXPORT QgsFeature */ void setFields( const QgsFields &fields, bool initAttributes = false SIP_PYARGDEFAULT( true ) ); - /** Returns the field map associated with the feature. + /** + * Returns the field map associated with the feature. * \see setFields */ QgsFields fields() const; - /** Insert a value into attribute. Returns false if attribute name could not be converted to index. + /** + * Insert a value into attribute. Returns false if attribute name could not be converted to index. * Field map must be associated using setFields() before this method can be used. * The feature will be valid if it was successful * \param name The name of the field to set @@ -392,7 +413,8 @@ class CORE_EXPORT QgsFeature % End #endif - /** Removes an attribute value by field name. Field map must be associated using setFields() + /** + * Removes an attribute value by field name. Field map must be associated using setFields() * before this method can be used. * \param name The name of the field to delete * \returns false if attribute name could not be converted to index (C++ only) @@ -418,7 +440,8 @@ class CORE_EXPORT QgsFeature % End #endif - /** Lookup attribute value from attribute name. Field map must be associated using setFields() + /** + * Lookup attribute value from attribute name. Field map must be associated using setFields() * before this method can be used. * \param name The name of the attribute to get * \returns The value of the attribute (C++: Invalid variant if no such name exists ) @@ -445,7 +468,8 @@ class CORE_EXPORT QgsFeature % End #endif - /** Lookup attribute value from its index. Field map must be associated using setFields() + /** + * Lookup attribute value from its index. Field map must be associated using setFields() * before this method can be used. * \param fieldIdx The index of the attribute to get * \returns The value of the attribute (C++: Invalid variant if no such index exists ) @@ -473,7 +497,8 @@ class CORE_EXPORT QgsFeature % End #endif - /** Utility method to get attribute index from name. Field map must be associated using setFields() + /** + * Utility method to get attribute index from name. Field map must be associated using setFields() * before this method can be used. * \param fieldName name of field to get attribute index of * \returns -1 if field does not exist or field map is not associated. diff --git a/src/core/qgsfeaturefilterprovider.h b/src/core/qgsfeaturefilterprovider.h index 545a9d8b755e..81b6f9af502f 100644 --- a/src/core/qgsfeaturefilterprovider.h +++ b/src/core/qgsfeaturefilterprovider.h @@ -28,7 +28,8 @@ class QgsVectorLayer; class QgsFeatureRequest; -/** \ingroup core +/** + * \ingroup core * \class QgsFeatureFilterProvider * Abstract interface for use by classes that filter the features of a layer. * A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest in place to apply @@ -49,14 +50,16 @@ class CORE_EXPORT QgsFeatureFilterProvider #endif - /** Add additional filters to the feature request to further restrict the features returned by the request. + /** + * Add additional filters to the feature request to further restrict the features returned by the request. * Derived classes must implement this method. * \param layer the layer to filter * \param featureRequest the feature request to update */ virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0; - /** Create a clone of the feature filter provider + /** + * Create a clone of the feature filter provider * \returns a new clone */ virtual QgsFeatureFilterProvider *clone() const = 0 SIP_FACTORY; diff --git a/src/core/qgsfeatureiterator.h b/src/core/qgsfeatureiterator.h index 383b16b1ac91..f38d2a2204f6 100644 --- a/src/core/qgsfeatureiterator.h +++ b/src/core/qgsfeatureiterator.h @@ -21,7 +21,8 @@ -/** \ingroup core +/** + * \ingroup core * Interface that can be optionally attached to an iterator so its * nextFeature() implementaton can check if it must stop as soon as possible. * \since QGIS 2.16 @@ -34,7 +35,8 @@ class CORE_EXPORT QgsInterruptionChecker SIP_SKIP virtual bool mustStop() const = 0; }; -/** \ingroup core +/** + * \ingroup core * Internal feature iterator to be implemented within data providers */ class CORE_EXPORT QgsAbstractFeatureIterator @@ -63,7 +65,8 @@ class CORE_EXPORT QgsAbstractFeatureIterator //! end of iterating: free the resources / lock virtual bool close() = 0; - /** Attach an object that can be queried regularly by the iterator to check + /** + * Attach an object that can be queried regularly by the iterator to check * if it must stopped. This is mostly useful for iterators where a single * nextFeature()/fetchFeature() iteration might be very long. A typical use case is the * WFS provider. When nextFeature()/fetchFeature() is reasonably fast, it is not necessary @@ -73,7 +76,8 @@ class CORE_EXPORT QgsAbstractFeatureIterator */ virtual void setInterruptionChecker( QgsInterruptionChecker *interruptionChecker ) SIP_SKIP; - /** Returns the status of expression compilation for filter expression requests. + /** + * Returns the status of expression compilation for filter expression requests. * \since QGIS 2.16 */ CompileStatus compileStatus() const { return mCompileStatus; } @@ -199,7 +203,8 @@ class CORE_EXPORT QgsAbstractFeatureIterator }; -/** \ingroup core +/** + * \ingroup core * Helper template that cares of two things: 1. automatic deletion of source if owned by iterator, 2. notification of open/closed iterator. * \note not available in Python bindings (although present in SIP file) */ @@ -277,7 +282,8 @@ class CORE_EXPORT QgsFeatureIterator //! find out whether the iterator is still valid or closed already bool isClosed() const; - /** Attach an object that can be queried regularly by the iterator to check + /** + * Attach an object that can be queried regularly by the iterator to check * if it must stopped. This is mostly useful for iterators where a single * nextFeature()/fetchFeature() iteration might be very long. A typical use case is the * WFS provider. @@ -286,7 +292,8 @@ class CORE_EXPORT QgsFeatureIterator */ void setInterruptionChecker( QgsInterruptionChecker *interruptionChecker ) SIP_SKIP; - /** Returns the status of expression compilation for filter expression requests. + /** + * Returns the status of expression compilation for filter expression requests. * \since QGIS 2.16 */ QgsAbstractFeatureIterator::CompileStatus compileStatus() const { return mIter->compileStatus(); } diff --git a/src/core/qgsfeaturerequest.h b/src/core/qgsfeaturerequest.h index 25a4c039bd5a..043e2f68b3a2 100644 --- a/src/core/qgsfeaturerequest.h +++ b/src/core/qgsfeaturerequest.h @@ -29,7 +29,8 @@ -/** \ingroup core +/** + * \ingroup core * This class wraps a request for features to a vector layer (or directly its vector data provider). * The request may apply a filter to fetch only a particular subset of features. Currently supported filters: * - no filter - all features are returned @@ -94,7 +95,8 @@ class CORE_EXPORT QgsFeatureRequest GeometryAbortOnInvalid = 2, //!< Close iterator on encountering any features with invalid geometry. This requires a slow geometry validity check for every feature. }; - /** \ingroup core + /** + * \ingroup core * The OrderByClause class represents an order by clause for a QgsFeatureRequest. * * It can be a simple field or an expression. Multiple order by clauses can be added to @@ -209,7 +211,8 @@ class CORE_EXPORT QgsFeatureRequest }; - /** \ingroup core + /** + * \ingroup core * Represents a list of OrderByClauses, with the most important first and the least * important last. * @@ -378,34 +381,39 @@ class CORE_EXPORT QgsFeatureRequest */ std::function< void( const QgsFeature & ) > invalidGeometryCallback() const { return mInvalidGeometryCallback; } SIP_SKIP - /** Set the filter expression. {\see QgsExpression} + /** + * Set the filter expression. {\see QgsExpression} * \param expression expression string * \see filterExpression * \see setExpressionContext */ QgsFeatureRequest &setFilterExpression( const QString &expression ); - /** Returns the filter expression if set. + /** + * Returns the filter expression if set. * \see setFilterExpression * \see expressionContext */ QgsExpression *filterExpression() const { return mFilterExpression.get(); } - /** Modifies the existing filter expression to add an additional expression filter. The + /** + * Modifies the existing filter expression to add an additional expression filter. The * filter expressions are combined using AND, so only features matching both * the existing expression and the additional expression will be returned. * \since QGIS 2.14 */ QgsFeatureRequest &combineFilterExpression( const QString &expression ); - /** Returns the expression context used to evaluate filter expressions. + /** + * Returns the expression context used to evaluate filter expressions. * \since QGIS 2.12 * \see setExpressionContext * \see filterExpression */ QgsExpressionContext *expressionContext() { return &mExpressionContext; } - /** Sets the expression context used to evaluate filter expressions. + /** + * Sets the expression context used to evaluate filter expressions. * \since QGIS 2.12 * \see expressionContext * \see setFilterExpression @@ -460,14 +468,16 @@ class CORE_EXPORT QgsFeatureRequest */ QgsFeatureRequest &setOrderBy( const OrderBy &orderBy ); - /** Set the maximum number of features to request. + /** + * Set the maximum number of features to request. * \param limit maximum number of features, or -1 to request all features. * \see limit() * \since QGIS 2.14 */ QgsFeatureRequest &setLimit( long limit ); - /** Returns the maximum number of features to request, or -1 if no limit set. + /** + * Returns the maximum number of features to request, or -1 if no limit set. * \see setLimit * \since QGIS 2.14 */ @@ -615,7 +625,8 @@ Q_DECLARE_OPERATORS_FOR_FLAGS( QgsFeatureRequest::Flags ) class QgsFeatureIterator; class QgsAbstractFeatureIterator; -/** \ingroup core +/** + * \ingroup core * Base class that can be used for any class that is capable of returning features * \since QGIS 2.4 */ diff --git a/src/core/qgsfeaturesource.h b/src/core/qgsfeaturesource.h index da617830621e..c7e36be6b9ee 100644 --- a/src/core/qgsfeaturesource.h +++ b/src/core/qgsfeaturesource.h @@ -94,7 +94,8 @@ class CORE_EXPORT QgsFeatureSource */ virtual QSet uniqueValues( int fieldIndex, int limit = -1 ) const; - /** Returns the minimum value for an attribute column or an invalid variant in case of error. + /** + * Returns the minimum value for an attribute column or an invalid variant in case of error. * The base class implementation uses a non-optimised approach of looping through * all features in the source. * \see maximumValue() @@ -102,7 +103,8 @@ class CORE_EXPORT QgsFeatureSource */ virtual QVariant minimumValue( int fieldIndex ) const; - /** Returns the maximum value for an attribute column or an invalid variant in case of error. + /** + * Returns the maximum value for an attribute column or an invalid variant in case of error. * The base class implementation uses a non-optimised approach of looping through * all features in the source. * \see minimumValue() diff --git a/src/core/qgsfeaturestore.h b/src/core/qgsfeaturestore.h index 177e6862cce1..63a844866dae 100644 --- a/src/core/qgsfeaturestore.h +++ b/src/core/qgsfeaturestore.h @@ -25,7 +25,8 @@ #include #include -/** \ingroup core +/** + * \ingroup core * A container for features with the same fields and crs. */ class CORE_EXPORT QgsFeatureStore : public QgsFeatureSink diff --git a/src/core/qgsfeedback.h b/src/core/qgsfeedback.h index a921b6117157..80778f39eec2 100644 --- a/src/core/qgsfeedback.h +++ b/src/core/qgsfeedback.h @@ -21,7 +21,8 @@ #include "qgis_core.h" #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * Base class for feedback objects to be used for cancelation of something running in a worker thread. * The class may be used as is or it may be subclassed for extended functionality * for a particular operation (e.g. report progress or pass some data for preview). diff --git a/src/core/qgsfield.h b/src/core/qgsfield.h index d5f30a967d4d..6a3868490b0e 100644 --- a/src/core/qgsfield.h +++ b/src/core/qgsfield.h @@ -36,7 +36,8 @@ typedef QList QgsAttributeList SIP_SKIP; #include "qgsfieldconstraints.h" #include "qgsdefaultvalue.h" -/** \class QgsField +/** + * \class QgsField * \ingroup core * Encapsulate a field in an attribute table or data source. * QgsField stores metadata about an attribute field, including name, type @@ -59,7 +60,8 @@ class CORE_EXPORT QgsField public: - /** Constructor. Constructs a new QgsField object. + /** + * Constructor. Constructs a new QgsField object. * \param name Field name * \param type Field variant type, currently supported: String / Int / Double * \param typeName Field type (e.g., char, varchar, text, int, serial, double). @@ -81,11 +83,13 @@ class CORE_EXPORT QgsField const QString &comment = QString(), QVariant::Type subType = QVariant::Invalid ); - /** Copy constructor + /** + * Copy constructor */ QgsField( const QgsField &other ); - /** Assignment operator + /** + * Assignment operator */ QgsField &operator =( const QgsField &other ) SIP_SKIP; @@ -94,13 +98,15 @@ class CORE_EXPORT QgsField bool operator==( const QgsField &other ) const; bool operator!=( const QgsField &other ) const; - /** Returns the name of the field. + /** + * Returns the name of the field. * \see setName() * \see displayName() */ QString name() const; - /** Returns the name to use when displaying this field. This will be the + /** + * Returns the name to use when displaying this field. This will be the * field alias if set, otherwise the field name. * \see name() * \see alias() @@ -194,7 +200,8 @@ class CORE_EXPORT QgsField */ void setComment( const QString &comment ); - /** Returns the expression used when calculating the default value for the field. + /** + * Returns the expression used when calculating the default value for the field. * \returns expression evaluated when calculating default values for field, or an * empty string if no default is set * \since QGIS 3.0 @@ -202,7 +209,8 @@ class CORE_EXPORT QgsField */ QgsDefaultValue defaultValueDefinition() const; - /** Sets an expression to use when calculating the default value for the field. + /** + * Sets an expression to use when calculating the default value for the field. * \param defaultValueDefinition expression to evaluate when calculating default values for field. Pass * a default constructed QgsDefaultValue() to reset. * \since QGIS 3.0 @@ -224,14 +232,16 @@ class CORE_EXPORT QgsField */ void setConstraints( const QgsFieldConstraints &constraints ); - /** Returns the alias for the field (the friendly displayed name of the field ), + /** + * Returns the alias for the field (the friendly displayed name of the field ), * or an empty string if there is no alias. * \see setAlias() * \since QGIS 3.0 */ QString alias() const; - /** Sets the alias for the field (the friendly displayed name of the field ). + /** + * Sets the alias for the field (the friendly displayed name of the field ). * \param alias field alias, or empty string to remove an existing alias * \see alias() * \since QGIS 3.0 diff --git a/src/core/qgsfieldproxymodel.h b/src/core/qgsfieldproxymodel.h index 6f07ca25bd97..c8700b021673 100644 --- a/src/core/qgsfieldproxymodel.h +++ b/src/core/qgsfieldproxymodel.h @@ -24,7 +24,8 @@ class QgsFieldModel; -/** \ingroup core +/** + * \ingroup core * \brief The QgsFieldProxyModel class provides an easy to use model to display the list of fields of a layer. * \since QGIS 2.3 */ @@ -66,7 +67,8 @@ class CORE_EXPORT QgsFieldProxyModel : public QSortFilterProxyModel */ QgsFieldProxyModel *setFilters( QgsFieldProxyModel::Filters filters ); - /** Returns the filters controlling displayed fields. + /** + * Returns the filters controlling displayed fields. * \see setFilters() */ const Filters &filters() const { return mFilters; } diff --git a/src/core/qgsfields.h b/src/core/qgsfields.h index e90a41043ad3..63a6d815e796 100644 --- a/src/core/qgsfields.h +++ b/src/core/qgsfields.h @@ -29,7 +29,8 @@ class QgsFieldsPrivate; * See details in QEP #17 ****************************************************************************/ -/** \class QgsFields +/** + * \class QgsFields * \ingroup core * Container of fields for a vector layer. * @@ -76,15 +77,18 @@ class CORE_EXPORT QgsFields #endif - /** Constructor for an empty field container + /** + * Constructor for an empty field container */ QgsFields(); - /** Copy constructor + /** + * Copy constructor */ QgsFields( const QgsFields &other ); - /** Assignment operator + /** + * Assignment operator */ QgsFields &operator =( const QgsFields &other ) SIP_SKIP; @@ -295,7 +299,8 @@ class CORE_EXPORT QgsFields //! \since QGIS 2.6 bool operator!=( const QgsFields &other ) const { return !( *this == other ); } - /** Returns an icon corresponding to a field index, based on the field's type and source + /** + * Returns an icon corresponding to a field index, based on the field's type and source * \since QGIS 2.14 */ QIcon iconForField( int fieldIdx ) const SIP_FACTORY; diff --git a/src/core/qgsfontutils.h b/src/core/qgsfontutils.h index 9f33638cd7aa..369439009302 100644 --- a/src/core/qgsfontutils.h +++ b/src/core/qgsfontutils.h @@ -25,26 +25,30 @@ class QMimeData; -/** \ingroup core +/** + * \ingroup core * \class QgsFontUtils */ class CORE_EXPORT QgsFontUtils { public: - /** Check whether exact font is on system + /** + * Check whether exact font is on system * \param f The font to test for match */ static bool fontMatchOnSystem( const QFont &f ); - /** Check whether font family is on system in a quick manner, which does not compare [foundry] + /** + * Check whether font family is on system in a quick manner, which does not compare [foundry] * \param family The family to test * \returns Whether family was found on system * \note This is good for use in loops of large lists, e.g. registering many features for labeling */ static bool fontFamilyOnSystem( const QString &family ); - /** Check whether font family on system has specific style + /** + * Check whether font family on system has specific style * \param family The family to test * \param style The style to test for * \returns Whether family has style @@ -52,7 +56,8 @@ class CORE_EXPORT QgsFontUtils */ static bool fontFamilyHasStyle( const QString &family, const QString &style ); - /** Check whether font family is on system + /** + * Check whether font family is on system * \param family The family to test * \param chosen The actual family (possibly from different foundry) returned by system * \param match Whether the family [foundry] returned by system is a match @@ -60,7 +65,8 @@ class CORE_EXPORT QgsFontUtils */ static bool fontFamilyMatchOnSystem( const QString &family, QString *chosen = nullptr, bool *match = nullptr ); - /** Updates font with named style and retain all font properties + /** + * Updates font with named style and retain all font properties * \param f The font to update * \param fontstyle The style to try and switch the font to * \param fallback If no matching fontstyle found for font, assign most similar or first style found to font @@ -69,12 +75,14 @@ class CORE_EXPORT QgsFontUtils */ static bool updateFontViaStyle( QFont &f, const QString &fontstyle, bool fallback = false ); - /** Get standard test font family + /** + * Get standard test font family * \since QGIS 2.1 */ static QString standardTestFontFamily(); - /** Loads standard test fonts from filesystem or qrc resource + /** + * Loads standard test fonts from filesystem or qrc resource * \param loadstyles List of styles to load, e.g. All, Roman, Oblique, Bold, Bold Oblique * \returns Whether any font was loaded * \note Done by default on debug app/server startup to ensure fonts available for unit tests (Roman and Bold) @@ -82,7 +90,8 @@ class CORE_EXPORT QgsFontUtils */ static bool loadStandardTestFonts( const QStringList &loadstyles ); - /** Get standard test font with specific style + /** + * Get standard test font with specific style * \param style Style to load, e.g. Roman, Oblique, Bold, Bold Oblique * \param pointsize Font point size to set * \returns QFont @@ -90,7 +99,8 @@ class CORE_EXPORT QgsFontUtils */ static QFont getStandardTestFont( const QString &style = "Roman", int pointsize = 12 ); - /** Returns a DOM element containing the properties of the font. + /** + * Returns a DOM element containing the properties of the font. * \param font font * \param document DOM document * \param elementName name for DOM element @@ -100,7 +110,8 @@ class CORE_EXPORT QgsFontUtils */ static QDomElement toXmlElement( const QFont &font, QDomDocument &document, const QString &elementName ); - /** Sets the properties of a font to match the properties stored in an XML element. Calling + /** + * Sets the properties of a font to match the properties stored in an XML element. Calling * this will overwrite the current properties of the font. * \param font font to update * \param element DOM element @@ -111,7 +122,8 @@ class CORE_EXPORT QgsFontUtils */ static bool setFromXmlElement( QFont &font, const QDomElement &element ); - /** Sets the properties of a font to match the properties stored in an XML child node. Calling + /** + * Sets the properties of a font to match the properties stored in an XML child node. Calling * this will overwrite the current properties of the font. * \param font font to update * \param element DOM element @@ -139,7 +151,8 @@ class CORE_EXPORT QgsFontUtils */ static QFont fromMimeData( const QMimeData *data, bool *ok SIP_OUT = nullptr ); - /** Returns the localized named style of a font, if such a translation is available. + /** + * Returns the localized named style of a font, if such a translation is available. * \param namedStyle a named style, i.e. "Bold", "Italic", etc * \returns The localized named style * \since QGIS 2.12 @@ -147,7 +160,8 @@ class CORE_EXPORT QgsFontUtils */ static QString translateNamedStyle( const QString &namedStyle ); - /** Returns the english named style of a font, if possible. + /** + * Returns the english named style of a font, if possible. * \param namedStyle a localized named style, i.e. "Fett", "Kursiv", etc * \returns The english named style * \since QGIS 2.12 @@ -155,7 +169,8 @@ class CORE_EXPORT QgsFontUtils */ static QString untranslateNamedStyle( const QString &namedStyle ); - /** Returns a CSS string representing the specified font as closely as possible. + /** + * Returns a CSS string representing the specified font as closely as possible. * \param font QFont to convert * \param pointToPixelMultiplier scaling factor to apply to convert point sizes to pixel font sizes. * The CSS returned by this function will always use pixels for font sizes, so this parameter diff --git a/src/core/qgsgeometrysimplifier.h b/src/core/qgsgeometrysimplifier.h index c4d36737beea..18ab40d36a43 100644 --- a/src/core/qgsgeometrysimplifier.h +++ b/src/core/qgsgeometrysimplifier.h @@ -25,7 +25,8 @@ class QgsRectangle; #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * Abstract base class for simplify geometries using a specific algorithm */ class CORE_EXPORT QgsAbstractGeometrySimplifier @@ -46,7 +47,8 @@ class CORE_EXPORT QgsAbstractGeometrySimplifier /***************************************************************************/ -/** \ingroup core +/** + * \ingroup core * Implementation of GeometrySimplifier using the Douglas-Peucker algorithm * * Simplifies a geometry, ensuring that the result is a valid geometry having the same dimension and number of components as the input. diff --git a/src/core/qgsgeometryvalidator.h b/src/core/qgsgeometryvalidator.h index f929351543d2..5ae65ef7034a 100644 --- a/src/core/qgsgeometryvalidator.h +++ b/src/core/qgsgeometryvalidator.h @@ -21,7 +21,8 @@ email : jef at norbit dot de #include #include "qgsgeometry.h" -/** \ingroup core +/** + * \ingroup core * \class QgsGeometryValidator */ class CORE_EXPORT QgsGeometryValidator : public QThread diff --git a/src/core/qgsgml.h b/src/core/qgsgml.h index 6b4d0821184b..282cc0857db0 100644 --- a/src/core/qgsgml.h +++ b/src/core/qgsgml.h @@ -36,7 +36,8 @@ class QgsCoordinateReferenceSystem; #ifndef SIP_RUN -/** \ingroup core +/** + * \ingroup core * This class builds features from GML data in a streaming way. The caller must call processData() * as soon it has new content from the source. At any point, it can call * getAndStealReadyFeatures() to collect the features that have been completely @@ -50,7 +51,8 @@ class CORE_EXPORT QgsGmlStreamingParser typedef QPair QgsGmlFeaturePtrGmlIdPair; - /** \ingroup core + /** + * \ingroup core * Layer properties */ class LayerProperties @@ -96,15 +98,18 @@ class CORE_EXPORT QgsGmlStreamingParser //! QgsGmlStreamingParser cannot be copied. QgsGmlStreamingParser &operator=( const QgsGmlStreamingParser &other ) = delete; - /** Process a new chunk of data. atEnd must be set to true when this is + /** + * Process a new chunk of data. atEnd must be set to true when this is the last chunk of data. */ bool processData( const QByteArray &data, bool atEnd, QString &errorMsg ); - /** Process a new chunk of data. atEnd must be set to true when this is + /** + * Process a new chunk of data. atEnd must be set to true when this is the last chunk of data. */ bool processData( const QByteArray &data, bool atEnd ); - /** Returns the list of features that have been completely parsed. This + /** + * Returns the list of features that have been completely parsed. This can be called at any point. This will empty the list maintained internally by the parser, so that features already returned will no longer be returned by later calls. */ @@ -184,14 +189,16 @@ class CORE_EXPORT QgsGmlStreamingParser //helper routines - /** Reads attribute srsName="EpsgCrsId:..." + /** + * Reads attribute srsName="EpsgCrsId:..." \param epsgNr result \param attr attribute strings \returns 0 in case of success */ int readEpsgFromAttribute( int &epsgNr, const XML_Char **attr ); - /** Reads attribute as string + /** + * Reads attribute as string \param attributeName \param attr \returns attribute value or an empty string if no such attribute @@ -200,14 +207,16 @@ class CORE_EXPORT QgsGmlStreamingParser //! Creates a rectangle from a coordinate string. bool createBBoxFromCoordinateString( QgsRectangle &bb, const QString &coordString ) const; - /** Creates a set of points from a coordinate string. + /** + * Creates a set of points from a coordinate string. \param points list that will contain the created points \param coordString the text containing the coordinates \returns 0 in case of success */ int pointsFromCoordinateString( QList &points, const QString &coordString ) const; - /** Creates a set of points from a gml:posList or gml:pos coordinate string. + /** + * Creates a set of points from a gml:posList or gml:pos coordinate string. \param points list that will contain the created points \param coordString the text containing the coordinates \param dimension number of dimensions @@ -220,7 +229,8 @@ class CORE_EXPORT QgsGmlStreamingParser int getLineWKB( QgsWkbPtr &wkbPtr, const QList &lineCoordinates ) const; int getRingWKB( QgsWkbPtr &wkbPtr, const QList &ringCoordinates ) const; - /** Creates a multiline from the information in mCurrentWKBFragments and + /** + * Creates a multiline from the information in mCurrentWKBFragments and * mCurrentWKBFragmentSizes. Assign the result. The multiline is in * mCurrentWKB. The function deletes the memory in * mCurrentWKBFragments. Returns 0 in case of success. @@ -287,7 +297,8 @@ class CORE_EXPORT QgsGmlStreamingParser QgsRectangle mCurrentExtent; bool mBoundedByNullFound; - /** WKB intermediate storage during parsing. For points and lines, no + /** + * WKB intermediate storage during parsing. For points and lines, no * intermediate WKB is stored at all. For multipoints and multilines and * polygons, only one nested list is used. For multipolygons, both nested lists * are used*/ @@ -331,7 +342,8 @@ class CORE_EXPORT QgsGmlStreamingParser #endif -/** \ingroup core +/** + * \ingroup core * This class reads data from a WFS server or alternatively from a GML file. It * uses the expat XML parser and an event based model to keep performance high. * The parsing starts when the first data arrives, it does not wait until the @@ -345,7 +357,8 @@ class CORE_EXPORT QgsGml : public QObject const QString &geometryAttribute, const QgsFields &fields ); - /** Does the Http GET request to the wfs server + /** + * Does the Http GET request to the wfs server * Supports only UTF-8, UTF-16, ISO-8859-1, ISO-8859-1 XML encodings. * \param uri GML URL * \param wkbType wkbType to retrieve @@ -363,7 +376,8 @@ class CORE_EXPORT QgsGml : public QObject const QString &password = QString(), const QString &authcfg = QString() ) SIP_PYNAME( getFeaturesUri ); - /** Read from GML data. Constructor uri param is ignored + /** + * Read from GML data. Constructor uri param is ignored * Supports only UTF-8, UTF-16, ISO-8859-1, ISO-8859-1 XML encodings. */ int getFeatures( const QByteArray &data, QgsWkbTypes::Type *wkbType, QgsRectangle *extent = nullptr ); @@ -374,7 +388,8 @@ class CORE_EXPORT QgsGml : public QObject //! Get feature ids map QMap idsMap() const { return mIdMap; } - /** Returns features spatial reference system + /** + * Returns features spatial reference system \since QGIS 2.1 */ QgsCoordinateReferenceSystem crs() const; @@ -393,7 +408,8 @@ class CORE_EXPORT QgsGml : public QObject private: - /** This function evaluates the layer bounding box from the features and + /** + * This function evaluates the layer bounding box from the features and * sets it to mExtent. Less efficient compared to reading the bbox from * the provider, so it is only done if the wfs server does not provider * extent information. diff --git a/src/core/qgsgmlschema.h b/src/core/qgsgmlschema.h index f1d739fbc78f..c9f740ac2a7d 100644 --- a/src/core/qgsgmlschema.h +++ b/src/core/qgsgmlschema.h @@ -33,7 +33,8 @@ class QgsRectangle; class QgsCoordinateReferenceSystem; class QgsFeature; -/** \ingroup core +/** + * \ingroup core * Description of feature class in GML */ class CORE_EXPORT QgsGmlFeatureClass @@ -74,7 +75,8 @@ class CORE_EXPORT QgsGmlFeatureClass QStringList mGeometryAttributes; }; -/** \ingroup core +/** + * \ingroup core * \class QgsGmlSchema */ class CORE_EXPORT QgsGmlSchema : public QObject @@ -86,7 +88,8 @@ class CORE_EXPORT QgsGmlSchema : public QObject //! Get fields info from XSD bool parseXSD( const QByteArray &xml ); - /** Guess GML schema from data if XSD does not exist. + /** + * Guess GML schema from data if XSD does not exist. * Currently only recognizes UMN Mapserver GetFeatureInfo GML response. * Supports only UTF-8, UTF-16, ISO-8859-1, US-ASCII XML encodings. * \param data GML data @@ -139,7 +142,8 @@ class CORE_EXPORT QgsGmlSchema : public QObject //helper routines - /** Reads attribute as string + /** + * Reads attribute as string \returns attribute value or an empty string if no such attribute*/ QString readAttribute( const QString &attributeName, const XML_Char **attr ) const; @@ -161,7 +165,8 @@ class CORE_EXPORT QgsGmlSchema : public QObject //! Strip namespace from element name QString stripNS( const QString &name ); - /** Find GML base type for complex type of given name + /** + * Find GML base type for complex type of given name * \param element input element * \param name complex type name * \returns name of GML base type without NS, e.g. AbstractFeatureType or empty string if not passed on GML type diff --git a/src/core/qgshistogram.h b/src/core/qgshistogram.h index 39918cea76ab..3d24ee1cebe5 100644 --- a/src/core/qgshistogram.h +++ b/src/core/qgshistogram.h @@ -26,7 +26,8 @@ class QgsVectorLayer; -/** \ingroup core +/** + * \ingroup core * \class QgsHistogram * \brief Calculator for a numeric histogram from a list of values. * @@ -44,12 +45,14 @@ class CORE_EXPORT QgsHistogram virtual ~QgsHistogram() = default; - /** Assigns numeric source values for the histogram. + /** + * Assigns numeric source values for the histogram. * \param values list of doubles */ void setValues( const QList &values ); - /** Assigns numeric source values for the histogram from a vector layer's field or as the + /** + * Assigns numeric source values for the histogram from a vector layer's field or as the * result of an expression. * \param layer vector layer * \param fieldOrExpression field name or expression to be evaluated @@ -58,7 +61,8 @@ class CORE_EXPORT QgsHistogram */ bool setValues( const QgsVectorLayer *layer, const QString &fieldOrExpression, QgsFeedback *feedback = nullptr ); - /** Calculates the optimal bin width using the Freedman-Diaconis rule. Bins widths are + /** + * Calculates the optimal bin width using the Freedman-Diaconis rule. Bins widths are * determined by the inter-quartile range of values and the number of values. * \returns optimal width for bins * \see optimalNumberBins @@ -66,7 +70,8 @@ class CORE_EXPORT QgsHistogram */ double optimalBinWidth() const; - /** Returns the optimal number of bins for the source values, calculated using the + /** + * Returns the optimal number of bins for the source values, calculated using the * Freedman-Diaconis rule. The number of bins are determined by the inter-quartile range * of values and the number of values. * \returns optimal number of bins @@ -75,7 +80,8 @@ class CORE_EXPORT QgsHistogram */ int optimalNumberBins() const; - /** Returns a list of edges for the histogram for a specified number of bins. This list + /** + * Returns a list of edges for the histogram for a specified number of bins. This list * will be length bins + 1, as both the first and last value are also included. * \param bins number of bins * \returns list of bin edges @@ -83,7 +89,8 @@ class CORE_EXPORT QgsHistogram */ QList binEdges( int bins ) const; - /** Returns the calculated list of the counts for the histogram bins. + /** + * Returns the calculated list of the counts for the histogram bins. * \param bins number of histogram bins * \returns list of histogram counts * \note values must first be specified using setValues() diff --git a/src/core/qgsindexedfeature.h b/src/core/qgsindexedfeature.h index 1fe61de3e438..35b84fc57b13 100644 --- a/src/core/qgsindexedfeature.h +++ b/src/core/qgsindexedfeature.h @@ -21,7 +21,8 @@ #include #include "qgsfeature.h" -/** \ingroup core +/** + * \ingroup core * Temporarily used structure to cache order by information * \note not available in Python bindings */ diff --git a/src/core/qgsinterval.h b/src/core/qgsinterval.h index 72d2d9893182..79761a0ea32f 100644 --- a/src/core/qgsinterval.h +++ b/src/core/qgsinterval.h @@ -29,7 +29,8 @@ class QString; -/** \ingroup core +/** + * \ingroup core * \class QgsInterval * \brief A representation of the interval between two datetime values. * \since QGIS 2.16 @@ -54,98 +55,116 @@ class CORE_EXPORT QgsInterval //! Seconds per minute static const int MINUTE = 60; - /** Default constructor for QgsInterval. Creates an invalid interval. + /** + * Default constructor for QgsInterval. Creates an invalid interval. */ QgsInterval() = default; - /** Constructor for QgsInterval. + /** + * Constructor for QgsInterval. * \param seconds duration of interval in seconds */ QgsInterval( double seconds ); - /** Returns the interval duration in years (based on an average year length) + /** + * Returns the interval duration in years (based on an average year length) * \see setYears() */ double years() const { return mSeconds / YEARS; } - /** Sets the interval duration in years. + /** + * Sets the interval duration in years. * \param years duration in years (based on average year length) * \see years() */ void setYears( double years ) { mSeconds = years * YEARS; mValid = true; } - /** Returns the interval duration in months (based on a 30 day month). + /** + * Returns the interval duration in months (based on a 30 day month). * \see setMonths() */ double months() const { return mSeconds / MONTHS; } - /** Sets the interval duration in months. + /** + * Sets the interval duration in months. * \param months duration in months (based on a 30 day month) * \see months() */ void setMonths( double months ) { mSeconds = months * MONTHS; mValid = true; } - /** Returns the interval duration in weeks. + /** + * Returns the interval duration in weeks. * \see setWeeks() */ double weeks() const { return mSeconds / WEEKS; } - /** Sets the interval duration in weeks. + /** + * Sets the interval duration in weeks. * \param weeks duration in weeks * \see weeks() */ void setWeeks( double weeks ) { mSeconds = weeks * WEEKS; mValid = true; } - /** Returns the interval duration in days. + /** + * Returns the interval duration in days. * \see setDays() */ double days() const { return mSeconds / DAY; } - /** Sets the interval duration in days. + /** + * Sets the interval duration in days. * \param days duration in days * \see days() */ void setDays( double days ) { mSeconds = days * DAY; mValid = true; } - /** Returns the interval duration in hours. + /** + * Returns the interval duration in hours. * \see setHours() */ double hours() const { return mSeconds / HOUR; } - /** Sets the interval duration in hours. + /** + * Sets the interval duration in hours. * \param hours duration in hours * \see hours() */ void setHours( double hours ) { mSeconds = hours * HOUR; mValid = true; } - /** Returns the interval duration in minutes. + /** + * Returns the interval duration in minutes. * \see setMinutes() */ double minutes() const { return mSeconds / MINUTE; } - /** Sets the interval duration in minutes. + /** + * Sets the interval duration in minutes. * \param minutes duration in minutes * \see minutes() */ void setMinutes( double minutes ) { mSeconds = minutes * MINUTE; mValid = true; } - /** Returns the interval duration in seconds. + /** + * Returns the interval duration in seconds. * \see setSeconds() */ double seconds() const { return mSeconds; } - /** Sets the interval duration in seconds. + /** + * Sets the interval duration in seconds. * \param seconds duration in seconds * \see seconds() */ void setSeconds( double seconds ) { mSeconds = seconds; mValid = true; } - /** Returns true if the interval is valid. + /** + * Returns true if the interval is valid. * \see setValid() */ bool isValid() const { return mValid; } - /** Sets whether the interval is valid. + /** + * Sets whether the interval is valid. * \param valid set to true to set the interval as valid. * \see isValid() */ @@ -153,7 +172,8 @@ class CORE_EXPORT QgsInterval bool operator==( QgsInterval other ) const; - /** Converts a string to an interval + /** + * Converts a string to an interval * \param string string to parse * \returns interval, or invalid interval if string could not be parsed */ @@ -178,7 +198,8 @@ Q_DECLARE_METATYPE( QgsInterval ) #ifndef SIP_RUN -/** Returns the interval between two datetimes. +/** + * Returns the interval between two datetimes. * \param datetime1 start datetime * \param datetime2 datetime to subtract, ie subtract datetime2 from datetime1 * \since QGIS 2.16 @@ -186,7 +207,8 @@ Q_DECLARE_METATYPE( QgsInterval ) */ QgsInterval CORE_EXPORT operator-( const QDateTime &datetime1, const QDateTime &datetime2 ); -/** Returns the interval between two dates. +/** + * Returns the interval between two dates. * \param date1 start date * \param date2 date to subtract, ie subtract date2 from date1 * \since QGIS 2.16 @@ -194,7 +216,8 @@ QgsInterval CORE_EXPORT operator-( const QDateTime &datetime1, const QDateTime & */ QgsInterval CORE_EXPORT operator-( QDate date1, QDate date2 ); -/** Returns the interval between two times. +/** + * Returns the interval between two times. * \param time1 start time * \param time2 time to subtract, ie subtract time2 from time1 * \since QGIS 2.16 @@ -202,7 +225,8 @@ QgsInterval CORE_EXPORT operator-( QDate date1, QDate date2 ); */ QgsInterval CORE_EXPORT operator-( QTime time1, QTime time2 ); -/** Adds an interval to a datetime +/** + * Adds an interval to a datetime * \param start initial datetime * \param interval interval to add * \since QGIS 2.16 diff --git a/src/core/qgsjsonutils.h b/src/core/qgsjsonutils.h index a3afb2aa4419..7e9093d42105 100644 --- a/src/core/qgsjsonutils.h +++ b/src/core/qgsjsonutils.h @@ -25,7 +25,8 @@ class QTextCodec; -/** \ingroup core +/** + * \ingroup core * \class QgsJsonExporter * \brief Handles exporting QgsFeature features to GeoJSON features. * @@ -38,48 +39,56 @@ class CORE_EXPORT QgsJsonExporter { public: - /** Constructor for QgsJsonExporter. + /** + * Constructor for QgsJsonExporter. * \param vectorLayer associated vector layer (required for related attribute export) * \param precision maximum number of decimal places to use for geometry coordinates, * the RFC 7946 GeoJSON specification recommends limiting coordinate precision to 6 */ QgsJsonExporter( QgsVectorLayer *vectorLayer = nullptr, int precision = 6 ); - /** Sets the maximum number of decimal places to use in geometry coordinates. + /** + * Sets the maximum number of decimal places to use in geometry coordinates. * The RFC 7946 GeoJSON specification recommends limiting coordinate precision to 6 * \param precision number of decimal places * \see precision() */ void setPrecision( int precision ) { mPrecision = precision; } - /** Returns the maximum number of decimal places to use in geometry coordinates. + /** + * Returns the maximum number of decimal places to use in geometry coordinates. * \see setPrecision() */ int precision() const { return mPrecision; } - /** Sets whether to include geometry in the JSON exports. + /** + * Sets whether to include geometry in the JSON exports. * \param includeGeometry set to false to prevent geometry inclusion * \see includeGeometry() */ void setIncludeGeometry( bool includeGeometry ) { mIncludeGeometry = includeGeometry; } - /** Returns whether geometry will be included in the JSON exports. + /** + * Returns whether geometry will be included in the JSON exports. * \see setIncludeGeometry() */ bool includeGeometry() const { return mIncludeGeometry; } - /** Sets whether to include attributes in the JSON exports. + /** + * Sets whether to include attributes in the JSON exports. * \param includeAttributes set to false to prevent attribute inclusion * \see includeAttributes() */ void setIncludeAttributes( bool includeAttributes ) { mIncludeAttributes = includeAttributes; } - /** Returns whether attributes will be included in the JSON exports. + /** + * Returns whether attributes will be included in the JSON exports. * \see setIncludeAttributes() */ bool includeAttributes() const { return mIncludeAttributes; } - /** Sets whether to include attributes of features linked via references in the JSON exports. + /** + * Sets whether to include attributes of features linked via references in the JSON exports. * \param includeRelated set to true to include attributes for any related child features * within the exported properties element. * \note associated vector layer must be set with setVectorLayer() @@ -87,24 +96,28 @@ class CORE_EXPORT QgsJsonExporter */ void setIncludeRelated( bool includeRelated ) { mIncludeRelatedAttributes = includeRelated; } - /** Returns whether attributes of related (child) features will be included in the JSON exports. + /** + * Returns whether attributes of related (child) features will be included in the JSON exports. * \see setIncludeRelated() */ bool includeRelated() const { return mIncludeRelatedAttributes; } - /** Sets the associated vector layer (required for related attribute export). This will automatically + /** + * Sets the associated vector layer (required for related attribute export). This will automatically * update the sourceCrs() to match. * \param vectorLayer vector layer * \see vectorLayer() */ void setVectorLayer( QgsVectorLayer *vectorLayer ); - /** Returns the associated vector layer, if set. + /** + * Returns the associated vector layer, if set. * \see setVectorLayer() */ QgsVectorLayer *vectorLayer() const; - /** Sets the source CRS for feature geometries. The source CRS must be set if geometries are to be + /** + * Sets the source CRS for feature geometries. The source CRS must be set if geometries are to be * correctly automatically reprojected to WGS 84, to match GeoJSON specifications. * \param crs source CRS for input feature geometries * \note the source CRS will be overwritten when a vector layer is specified via setVectorLayer() @@ -112,13 +125,15 @@ class CORE_EXPORT QgsJsonExporter */ void setSourceCrs( const QgsCoordinateReferenceSystem &crs ); - /** Returns the source CRS for feature geometries. The source CRS must be set if geometries are to be + /** + * Returns the source CRS for feature geometries. The source CRS must be set if geometries are to be * correctly automatically reprojected to WGS 84, to match GeoJSON specifications. * \see setSourceCrs() */ QgsCoordinateReferenceSystem sourceCrs() const; - /** Sets the list of attributes to include in the JSON exports. + /** + * Sets the list of attributes to include in the JSON exports. * \param attributes list of attribute indexes, or an empty list to include all * attributes * \see attributes() @@ -128,7 +143,8 @@ class CORE_EXPORT QgsJsonExporter */ void setAttributes( const QgsAttributeList &attributes ) { mAttributeIndexes = attributes; } - /** Returns the list of attributes which will be included in the JSON exports, or + /** + * Returns the list of attributes which will be included in the JSON exports, or * an empty list if all attributes will be included. * \see setAttributes() * \see excludedAttributes() @@ -137,7 +153,8 @@ class CORE_EXPORT QgsJsonExporter */ QgsAttributeList attributes() const { return mAttributeIndexes; } - /** Sets a list of attributes to specifically exclude from the JSON exports. Excluded attributes + /** + * Sets a list of attributes to specifically exclude from the JSON exports. Excluded attributes * take precedence over attributes included via setAttributes(). * \param attributes list of attribute indexes to exclude * \see excludedAttributes() @@ -145,14 +162,16 @@ class CORE_EXPORT QgsJsonExporter */ void setExcludedAttributes( const QgsAttributeList &attributes ) { mExcludedAttributeIndexes = attributes; } - /** Returns a list of attributes which will be specifically excluded from the JSON exports. Excluded attributes + /** + * Returns a list of attributes which will be specifically excluded from the JSON exports. Excluded attributes * take precedence over attributes included via attributes(). * \see setExcludedAttributes() * \see attributes() */ QgsAttributeList excludedAttributes() const { return mExcludedAttributeIndexes; } - /** Returns a GeoJSON string representation of a feature. + /** + * Returns a GeoJSON string representation of a feature. * \param feature feature to convert * \param extraProperties map of extra attributes to include in feature's properties * \param id optional ID to use as GeoJSON feature's ID instead of input feature's ID. If omitted, feature's @@ -165,7 +184,8 @@ class CORE_EXPORT QgsJsonExporter const QVariant &id = QVariant() ) const; - /** Returns a GeoJSON string representation of a list of features (feature collection). + /** + * Returns a GeoJSON string representation of a list of features (feature collection). * \param features features to convert * \returns GeoJSON string * \see exportFeature() @@ -204,7 +224,8 @@ class CORE_EXPORT QgsJsonExporter }; -/** \ingroup core +/** + * \ingroup core * \class QgsJsonUtils * \brief Helper utilities for working with JSON and GeoJSON conversions. * \since QGIS 2.16 @@ -214,7 +235,8 @@ class CORE_EXPORT QgsJsonUtils { public: - /** Attempts to parse a GeoJSON string to a collection of features. + /** + * Attempts to parse a GeoJSON string to a collection of features. * \param string GeoJSON string to parse * \param fields fields collection to use for parsed features * \param encoding text encoding @@ -224,7 +246,8 @@ class CORE_EXPORT QgsJsonUtils */ static QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields, QTextCodec *encoding ); - /** Attempts to retrieve the fields from a GeoJSON string representing a collection of features. + /** + * Attempts to retrieve the fields from a GeoJSON string representing a collection of features. * \param string GeoJSON string to parse * \param encoding text encoding * \returns retrieved fields collection, or an empty list if no fields could be determined from the string @@ -233,14 +256,16 @@ class CORE_EXPORT QgsJsonUtils */ static QgsFields stringToFields( const QString &string, QTextCodec *encoding ); - /** Encodes a value to a JSON string representation, adding appropriate quotations and escaping + /** + * Encodes a value to a JSON string representation, adding appropriate quotations and escaping * where required. * \param value value to encode * \returns encoded value */ static QString encodeValue( const QVariant &value ); - /** Exports all attributes from a QgsFeature as a JSON map type. + /** + * Exports all attributes from a QgsFeature as a JSON map type. * \param feature feature to export * \param layer optional associated vector layer. If specified, this allows * richer export utilising settings like the layer's fields widget configuration. @@ -250,7 +275,8 @@ class CORE_EXPORT QgsJsonUtils static QString exportAttributes( const QgsFeature &feature, QgsVectorLayer *layer = nullptr, const QVector &attributeWidgetCaches = QVector() ); - /** Parse a simple array (depth=1). + /** + * Parse a simple array (depth=1). * \param json the JSON to parse * \param type the type of the elements * \since QGIS 3.0 diff --git a/src/core/qgslabelfeature.h b/src/core/qgslabelfeature.h index abd377a2c78a..1de8a1e80eef 100644 --- a/src/core/qgslabelfeature.h +++ b/src/core/qgslabelfeature.h @@ -18,7 +18,8 @@ class QgsRenderContext; class QgsGeometry; -/** \ingroup core +/** + * \ingroup core * \brief The QgsLabelFeature class describes a feature that * should be used within the labeling engine. Those may be the usual textual labels, * diagrams, or any other custom type of map annotations (generated by custom @@ -49,7 +50,8 @@ class CORE_EXPORT QgsLabelFeature //! Get access to the associated geometry GEOSGeometry *geometry() const { return mGeometry; } - /** Sets the label's obstacle geometry, if different to the feature geometry. + /** + * Sets the label's obstacle geometry, if different to the feature geometry. * This can be used to override the shape of the feature for obstacle detection, e.g., to * buffer around a point geometry to prevent labels being placed too close to the * point itself. It not set, the feature's geometry is used for obstacle detection. @@ -59,13 +61,15 @@ class CORE_EXPORT QgsLabelFeature */ void setObstacleGeometry( GEOSGeometry *obstacleGeom ); - /** Returns the label's obstacle geometry, if different to the feature geometry. + /** + * Returns the label's obstacle geometry, if different to the feature geometry. * \since QGIS 2.14 * \see setObstacleGeometry() */ GEOSGeometry *obstacleGeometry() const { return mObstacleGeometry; } - /** Sets the label's permissible zone geometry. If set, the feature's label MUST be fully contained + /** + * Sets the label's permissible zone geometry. If set, the feature's label MUST be fully contained * within this zone, and the feature will not be labeled if no candidates can be generated which * are not contained within the zone. * \param geometry permissible zone geometry. If an invalid QgsGeometry is passed then no zone limit @@ -75,7 +79,8 @@ class CORE_EXPORT QgsLabelFeature */ void setPermissibleZone( const QgsGeometry &geometry ); - /** Returns the label's permissible zone geometry. If a valid geometry is returned, the feature's label + /** + * Returns the label's permissible zone geometry. If a valid geometry is returned, the feature's label * MUST be fully contained within this zone, and the feature will not be labeled if no candidates can be * generated which are not contained within the zone. * \since QGIS 3.0 @@ -84,7 +89,8 @@ class CORE_EXPORT QgsLabelFeature */ QgsGeometry permissibleZone() const { return mPermissibleZone; } - /** Returns a GEOS prepared geometry representing the label's permissibleZone(). + /** + * Returns a GEOS prepared geometry representing the label's permissibleZone(). * \see permissibleZone() * \since QGIS 3.0 */ @@ -94,7 +100,8 @@ class CORE_EXPORT QgsLabelFeature //! Size of the label (in map units) QSizeF size() const { return mSize; } - /** Sets the visual margin for the label feature. The visual margin represents a margin + /** + * Sets the visual margin for the label feature. The visual margin represents a margin * within the label which should not be considered when calculating the positions of candidates * for the label feature. It is used in certain label placement modes to adjust the position * of candidates so that they all appear to be at visually equal distances from a point feature. @@ -105,19 +112,22 @@ class CORE_EXPORT QgsLabelFeature */ void setVisualMargin( const QgsMargins &margin ) { mVisualMargin = margin; } - /** Returns the visual margin for the label feature. + /** + * Returns the visual margin for the label feature. * \see setVisualMargin() for details */ const QgsMargins &visualMargin() const { return mVisualMargin; } - /** Sets the size of the rendered symbol associated with this feature. This size is taken into + /** + * Sets the size of the rendered symbol associated with this feature. This size is taken into * account in certain label placement modes to avoid placing labels over the rendered * symbol for this feature. * \see symbolSize() */ void setSymbolSize( QSizeF size ) { mSymbolSize = size; } - /** Returns the size of the rendered symbol associated with this feature, if applicable. + /** + * Returns the size of the rendered symbol associated with this feature, if applicable. * This size is taken into account in certain label placement modes to avoid placing labels over * the rendered symbol for this feature. The size will only be set for labels associated * with a point feature. @@ -125,14 +135,16 @@ class CORE_EXPORT QgsLabelFeature */ const QSizeF &symbolSize() const { return mSymbolSize; } - /** Returns the feature's labeling priority. + /** + * Returns the feature's labeling priority. * \returns feature's priority, as a value between 0 (highest priority) * and 1 (lowest priority). Returns -1.0 if feature will use the layer's default priority. * \see setPriority */ double priority() const { return mPriority; } - /** Sets the priority for labeling the feature. + /** + * Sets the priority for labeling the feature. * \param priority feature's priority, as a value between 0 (highest priority) * and 1 (lowest priority). Set to -1.0 to use the layer's default priority * for this feature. @@ -140,14 +152,16 @@ class CORE_EXPORT QgsLabelFeature */ void setPriority( double priority ) { mPriority = priority; } - /** Returns the label's z-index. Higher z-index labels are rendered on top of lower + /** + * Returns the label's z-index. Higher z-index labels are rendered on top of lower * z-index labels. * \see setZIndex() * \since QGIS 2.14 */ double zIndex() const { return mZIndex; } - /** Sets the label's z-index. Higher z-index labels are rendered on top of lower + /** + * Sets the label's z-index. Higher z-index labels are rendered on top of lower * z-index labels. * \param zIndex z-index for label * \see zIndex() @@ -173,14 +187,16 @@ class CORE_EXPORT QgsLabelFeature //! Set angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true) void setFixedAngle( double angle ) { mFixedAngle = angle; } - /** Returns whether the quadrant for the label is fixed. + /** + * Returns whether the quadrant for the label is fixed. * Applies to "around point" placement strategy. * \see setFixedQuadrant * \see quadOffset */ bool hasFixedQuadrant() const { return mHasFixedQuadrant; } - /** Sets whether the quadrant for the label must be respected. This can be used + /** + * Sets whether the quadrant for the label must be respected. This can be used * to fix the quadrant for specific features when using an "around point" placement. * \see fixedQuadrant * \see quadOffset @@ -213,14 +229,16 @@ class CORE_EXPORT QgsLabelFeature */ void setPositionOffset( const QgsPointXY &offset ) { mPositionOffset = offset; } - /** Returns the offset type, which determines how offsets and distance to label + /** + * Returns the offset type, which determines how offsets and distance to label * behaves. Support depends on which placement mode is used for generating * label candidates. * \see setOffsetType() */ QgsPalLayerSettings::OffsetType offsetType() const { return mOffsetType; } - /** Sets the offset type, which determines how offsets and distance to label + /** + * Sets the offset type, which determines how offsets and distance to label * behaves. Support depends on which placement mode is used for generating * label candidates. * \see offsetType() @@ -239,13 +257,15 @@ class CORE_EXPORT QgsLabelFeature */ void setDistLabel( double dist ) { mDistLabel = dist; } - /** Returns the priority ordered list of predefined positions for label candidates. This property + /** + * Returns the priority ordered list of predefined positions for label candidates. This property * is only used for OrderedPositionsAroundPoint placements. * \see setPredefinedPositionOrder() */ QVector< QgsPalLayerSettings::PredefinedPointPosition > predefinedPositionOrder() const { return mPredefinedPositionOrder; } - /** Sets the priority ordered list of predefined positions for label candidates. This property + /** + * Sets the priority ordered list of predefined positions for label candidates. This property * is only used for OrderedPositionsAroundPoint placements. * \see predefinedPositionOrder() */ @@ -268,25 +288,29 @@ class CORE_EXPORT QgsLabelFeature //! Set whether label should be always shown (sets very high label priority) void setAlwaysShow( bool enabled ) { mAlwaysShow = enabled; } - /** Returns whether the feature will act as an obstacle for labels. + /** + * Returns whether the feature will act as an obstacle for labels. * \returns true if feature is an obstacle * \see setIsObstacle */ bool isObstacle() const { return mIsObstacle; } - /** Sets whether the feature will act as an obstacle for labels. + /** + * Sets whether the feature will act as an obstacle for labels. * \param enabled whether feature will act as an obstacle * \see isObstacle */ void setIsObstacle( bool enabled ) { mIsObstacle = enabled; } - /** Returns the obstacle factor for the feature. The factor controls the penalty + /** + * Returns the obstacle factor for the feature. The factor controls the penalty * for labels overlapping this feature. * \see setObstacleFactor */ double obstacleFactor() const { return mObstacleFactor; } - /** Sets the obstacle factor for the feature. The factor controls the penalty + /** + * Sets the obstacle factor for the feature. The factor controls the penalty * for labels overlapping this feature. * \param factor larger factors ( > 1.0 ) will result in labels * which are less likely to cover this feature, smaller factors ( < 1.0 ) mean labels @@ -295,7 +319,8 @@ class CORE_EXPORT QgsLabelFeature */ void setObstacleFactor( double factor ) { mObstacleFactor = factor; } - /** Text of the label + /** + * Text of the label * * Used also if "merge connected lines to avoid duplicate labels" is enabled * to identify which features may be merged. diff --git a/src/core/qgslabelingengine.cpp b/src/core/qgslabelingengine.cpp index 02f9fc6e7746..f13da5c4b563 100644 --- a/src/core/qgslabelingengine.cpp +++ b/src/core/qgslabelingengine.cpp @@ -33,7 +33,8 @@ static bool _palIsCanceled( void *ctx ) return ( reinterpret_cast< QgsRenderContext * >( ctx ) )->renderingStopped(); } -/** \ingroup core +/** + * \ingroup core * \class QgsLabelSorter * Helper class for sorting labels into correct draw order */ diff --git a/src/core/qgslabelingengine.h b/src/core/qgslabelingengine.h index df96bbdcc051..4b7541392375 100644 --- a/src/core/qgslabelingengine.h +++ b/src/core/qgslabelingengine.h @@ -28,7 +28,8 @@ class QgsLabelingEngine; -/** \ingroup core +/** + * \ingroup core * \brief The QgsAbstractLabelProvider class is an interface class. Implementations * return list of labels and their associated geometries - these are used by * QgsLabelingEngine to compute the final layout of labels. @@ -133,7 +134,8 @@ class CORE_EXPORT QgsAbstractLabelProvider Q_DECLARE_OPERATORS_FOR_FLAGS( QgsAbstractLabelProvider::Flags ) -/** \ingroup core +/** + * \ingroup core * \brief The QgsLabelingEngine class provides map labeling functionality. * The input for the engine is a list of label provider objects and map settings. * Based on the input, the engine computes layout of labels for the given map view @@ -224,7 +226,8 @@ class CORE_EXPORT QgsLabelingEngine }; -/** \ingroup core +/** + * \ingroup core * \class QgsLabelingUtils * \brief Contains helper utilities for working with QGIS' labeling engine. * \note this class is not a part of public API yet. See notes in QgsLabelingEngine @@ -236,14 +239,16 @@ class CORE_EXPORT QgsLabelingUtils { public: - /** Encodes an ordered list of predefined point label positions to a string. + /** + * Encodes an ordered list of predefined point label positions to a string. * \param positions order list of positions * \returns list encoded to string * \see decodePredefinedPositionOrder() */ static QString encodePredefinedPositionOrder( const QVector< QgsPalLayerSettings::PredefinedPointPosition > &positions ); - /** Decodes a string to an ordered list of predefined point label positions. + /** + * Decodes a string to an ordered list of predefined point label positions. * \param positionString encoded string of positions * \returns decoded list * \see encodePredefinedPositionOrder() diff --git a/src/core/qgslabelingenginesettings.h b/src/core/qgslabelingenginesettings.h index 7658c553c0ba..039bc0765925 100644 --- a/src/core/qgslabelingenginesettings.h +++ b/src/core/qgslabelingenginesettings.h @@ -7,7 +7,8 @@ class QgsProject; -/** \ingroup core +/** + * \ingroup core * Stores global configuration for labeling engine * \since QGIS 3.0 */ diff --git a/src/core/qgslabelsearchtree.h b/src/core/qgslabelsearchtree.h index c692817daab6..01ca70f58650 100644 --- a/src/core/qgslabelsearchtree.h +++ b/src/core/qgslabelsearchtree.h @@ -30,7 +30,8 @@ class QgsPointXY; -/** \ingroup core +/** + * \ingroup core * A class to query the labeling structure at a given point (small wraper around pal RTree class) */ class CORE_EXPORT QgsLabelSearchTree @@ -51,19 +52,22 @@ class CORE_EXPORT QgsLabelSearchTree //! Removes and deletes all the entries void clear(); - /** Returns label position(s) at a given point. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions + /** + * Returns label position(s) at a given point. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions * \note not available in Python bindings * TODO: why does this break bindings with QList? */ void label( const QgsPointXY &p, QList &posList ) const SIP_SKIP; - /** Returns label position(s) in given rectangle. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions + /** + * Returns label position(s) in given rectangle. QgsLabelSearchTree keeps ownership, don't delete the LabelPositions * \note not available in Python bindings * TODO: why does this break bindings with QList? */ void labelsInRect( const QgsRectangle &r, QList &posList ) const SIP_SKIP; - /** Inserts label position. Does not take ownership of labelPos + /** + * Inserts label position. Does not take ownership of labelPos * \returns true in case of success * \note not available in Python bindings */ diff --git a/src/core/qgslayerdefinition.h b/src/core/qgslayerdefinition.h index 067cab85709e..ff931888669f 100644 --- a/src/core/qgslayerdefinition.h +++ b/src/core/qgslayerdefinition.h @@ -31,7 +31,8 @@ class QgsMapLayer; class QgsReadWriteContext; class QgsProject; -/** \ingroup core +/** + * \ingroup core * \brief The QgsLayerDefinition class holds generic methods for loading/exporting QLR files. * * QLR files are an export of the layer xml including the style and datasource location. There is no link @@ -50,7 +51,8 @@ class CORE_EXPORT QgsLayerDefinition //! Export the selected layer tree nodes to a QLR-XML document static bool exportLayerDefinition( QDomDocument doc, const QList &selectedTreeNodes, QString &errorMessage SIP_OUT, const QgsReadWriteContext &context ); - /** Returns the given layer as a layer definition document + /** + * Returns the given layer as a layer definition document * Layer definitions store the data source as well as styling and custom properties. * * Layer definitions can be used to load a layer and styling all from a single file. @@ -82,12 +84,14 @@ class CORE_EXPORT QgsLayerDefinition { public: - /** Constructor + /** + * Constructor * \param doc The XML document containing maplayer elements */ DependencySorter( const QDomDocument &doc ); - /** Constructor + /** + * Constructor * \param fileName The filename where the XML document is stored */ DependencySorter( const QString &fileName ); diff --git a/src/core/qgslegendrenderer.h b/src/core/qgslegendrenderer.h index 971e6f9b8e4c..b17bafd420c8 100644 --- a/src/core/qgslegendrenderer.h +++ b/src/core/qgslegendrenderer.h @@ -31,7 +31,8 @@ class QgsSymbol; #include "qgslegendsettings.h" -/** \ingroup core +/** + * \ingroup core * \brief The QgsLegendRenderer class handles automatic layout and rendering of legend. * The content is given by QgsLayerTreeModel instance. Various layout properties can be configured * within QgsLegendRenderer. @@ -55,7 +56,8 @@ class CORE_EXPORT QgsLegendRenderer //! Find out preferred legend size set by the client. If null, the legend will be drawn with the minimum size QSizeF legendSize() const { return mLegendSize; } - /** Draw the legend with given painter. It will occupy the area reported in legendSize(). + /** + * Draw the legend with given painter. It will occupy the area reported in legendSize(). * Painter should be scaled beforehand so that units correspond to millimeters. */ void drawLegend( QPainter *painter ); @@ -68,7 +70,8 @@ class CORE_EXPORT QgsLegendRenderer #ifndef SIP_RUN - /** Nucleon is either group title, layer title or layer child item. + /** + * Nucleon is either group title, layer title or layer child item. * E.g. layer title nucleon is just title, it does not * include all layer subitems, the same with groups. */ @@ -89,7 +92,8 @@ class CORE_EXPORT QgsLegendRenderer double labelXOffset = 0.0; }; - /** Atom is indivisible set (indivisible into more columns). It may consists + /** + * Atom is indivisible set (indivisible into more columns). It may consists * of one or more Nucleon, depending on layer splitting mode: * 1) no layer split: [group_title ...] layer_title layer_item [layer_item ...] * 2) layer split: [group_title ...] layer_title layer_item @@ -116,14 +120,16 @@ class CORE_EXPORT QgsLegendRenderer //! Divide atoms to columns and set columns on atoms void setColumns( QList &atomList ); - /** Draws title in the legend using the title font and the specified alignment + /** + * Draws title in the legend using the title font and the specified alignment * If no painter is specified, function returns the required width/height to draw the title. */ QSizeF drawTitle( QPainter *painter = nullptr, QPointF point = QPointF(), Qt::AlignmentFlag halignment = Qt::AlignLeft, double legendWidth = 0 ); double spaceAboveAtom( const Atom &atom ); - /** Draw atom and return its actual size, the atom is drawn with the space above it + /** + * Draw atom and return its actual size, the atom is drawn with the space above it * so that first atoms in column are all aligned to the same line regardles their * style top space */ QSizeF drawAtom( const Atom &atom, QPainter *painter = nullptr, QPointF point = QPointF() ); @@ -133,7 +139,8 @@ class CORE_EXPORT QgsLegendRenderer //! Draws a layer item QSizeF drawLayerTitle( QgsLayerTreeLayer *nodeLayer, QPainter *painter = nullptr, QPointF point = QPointF() ); - /** Draws a group item. + /** + * Draws a group item. * Returns list of sizes of layers and groups including this group. */ QSizeF drawGroupTitle( QgsLayerTreeGroup *nodeGroup, QPainter *painter = nullptr, QPointF point = QPointF() ); diff --git a/src/core/qgslegendsettings.h b/src/core/qgslegendsettings.h index 34def1798bed..a41f69e918c3 100644 --- a/src/core/qgslegendsettings.h +++ b/src/core/qgslegendsettings.h @@ -26,7 +26,8 @@ class QRectF; #include "qgslegendstyle.h" -/** \ingroup core +/** + * \ingroup core * \brief The QgsLegendSettings class stores the appearance and layout settings * for legend drawing with QgsLegendRenderer. The content of the legend is given * in QgsLegendModel class. @@ -41,13 +42,15 @@ class CORE_EXPORT QgsLegendSettings void setTitle( const QString &t ) { mTitle = t; } QString title() const { return mTitle; } - /** Returns the alignment of the legend title + /** + * Returns the alignment of the legend title * \returns Qt::AlignmentFlag for the legend title * \see setTitleAlignment */ Qt::AlignmentFlag titleAlignment() const { return mTitleAlignment; } - /** Sets the alignment of the legend title + /** + * Sets the alignment of the legend title * \param alignment Text alignment for drawing the legend title * \see titleAlignment */ @@ -87,7 +90,8 @@ class CORE_EXPORT QgsLegendSettings QSizeF symbolSize() const {return mSymbolSize;} void setSymbolSize( QSizeF s ) {mSymbolSize = s;} - /** Returns whether a stroke will be drawn around raster symbol items. + /** + * Returns whether a stroke will be drawn around raster symbol items. * \see setDrawRasterStroke() * \see rasterStrokeColor() * \see rasterStrokeWidth() @@ -95,7 +99,8 @@ class CORE_EXPORT QgsLegendSettings */ bool drawRasterStroke() const { return mRasterSymbolStroke; } - /** Sets whether a stroke will be drawn around raster symbol items. + /** + * Sets whether a stroke will be drawn around raster symbol items. * \param enabled set to true to draw borders * \see drawRasterStroke() * \see setRasterStrokeColor() @@ -104,7 +109,8 @@ class CORE_EXPORT QgsLegendSettings */ void setDrawRasterStroke( bool enabled ) { mRasterSymbolStroke = enabled; } - /** Returns the stroke color for the stroke drawn around raster symbol items. The stroke is + /** + * Returns the stroke color for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. * \see setRasterStrokeColor() * \see drawRasterStroke() @@ -113,7 +119,8 @@ class CORE_EXPORT QgsLegendSettings */ QColor rasterStrokeColor() const { return mRasterStrokeColor; } - /** Sets the stroke color for the stroke drawn around raster symbol items. The stroke is + /** + * Sets the stroke color for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. * \param color stroke color * \see rasterStrokeColor() @@ -123,7 +130,8 @@ class CORE_EXPORT QgsLegendSettings */ void setRasterStrokeColor( const QColor &color ) { mRasterStrokeColor = color; } - /** Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items. The stroke is + /** + * Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. * \see setRasterStrokeWidth() * \see drawRasterStroke() @@ -132,7 +140,8 @@ class CORE_EXPORT QgsLegendSettings */ double rasterStrokeWidth() const { return mRasterStrokeWidth; } - /** Sets the stroke width for the stroke drawn around raster symbol items. The stroke is + /** + * Sets the stroke width for the stroke drawn around raster symbol items. The stroke is * only drawn if drawRasterStroke() is true. * \param width stroke width in millimeters * \see rasterStrokeWidth() @@ -173,17 +182,20 @@ class CORE_EXPORT QgsLegendSettings // utility functions - /** Splits a string using the wrap char taking into account handling empty + /** + * Splits a string using the wrap char taking into account handling empty * wrap char which means no wrapping */ QStringList splitStringForWrapping( const QString &stringToSplt ) const; - /** Draws Text. Takes care about all the composer specific issues (calculation to + /** + * Draws Text. Takes care about all the composer specific issues (calculation to * pixel, scaling of font and painter to work around the Qt font bug) */ void drawText( QPainter *p, double x, double y, const QString &text, const QFont &font ) const; - /** Like the above, but with a rectangle for multiline text + /** + * Like the above, but with a rectangle for multiline text * \param p painter to use * \param rect rectangle to draw into * \param text text to draw diff --git a/src/core/qgslegendstyle.h b/src/core/qgslegendstyle.h index e083a9a2f58f..fd9a3185b294 100644 --- a/src/core/qgslegendstyle.h +++ b/src/core/qgslegendstyle.h @@ -27,7 +27,8 @@ #include "qgis_core.h" #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * Composer legend components style */ class CORE_EXPORT QgsLegendStyle diff --git a/src/core/qgslocalec.h b/src/core/qgslocalec.h index 7f69ed50d989..6528a84f67d8 100644 --- a/src/core/qgslocalec.h +++ b/src/core/qgslocalec.h @@ -24,7 +24,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsLocaleNumC { diff --git a/src/core/qgslogger.h b/src/core/qgslogger.h index cf2c22802e94..46ed0b6199da 100644 --- a/src/core/qgslogger.h +++ b/src/core/qgslogger.h @@ -38,7 +38,8 @@ class QFile; #define QgsDebugMsgLevel(str, level) #endif -/** \ingroup core +/** + * \ingroup core * QgsLogger is a class to print debug/warning/error messages to the console. * The advantage of this class over iostream & co. is that the * output can be controlled with environment variables: @@ -58,7 +59,8 @@ class CORE_EXPORT QgsLogger { public: - /** Goes to qDebug. + /** + * Goes to qDebug. \param msg the message to be printed \param debuglevel \param file file name where the message comes from @@ -96,14 +98,16 @@ class CORE_EXPORT QgsLogger //! Goes to qFatal static void fatal( const QString &msg ); - /** Reads the environment variable QGIS_DEBUG and converts it to int. If QGIS_DEBUG is not set, + /** + * Reads the environment variable QGIS_DEBUG and converts it to int. If QGIS_DEBUG is not set, the function returns 1 if QGISDEBUG is defined and 0 if not*/ static int debugLevel() { init(); return sDebugLevel; } //! Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any. * static void logMessageToFile( const QString &message ); - /** Reads the environment variable QGIS_LOG_FILE. Returns NULL if the variable is not set, + /** + * Reads the environment variable QGIS_LOG_FILE. Returns NULL if the variable is not set, * otherwise returns a file name for writing log messages to.*/ static const QString logFile() { init(); return sLogFile; } @@ -118,7 +122,8 @@ class CORE_EXPORT QgsLogger static QTime sTime; }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsScopeLogger // clazy:exclude=rule-of-three { diff --git a/src/core/qgsmaphittest.h b/src/core/qgsmaphittest.h index a39ed26939f0..ee6e59c51cb6 100644 --- a/src/core/qgsmaphittest.h +++ b/src/core/qgsmaphittest.h @@ -27,7 +27,8 @@ class QgsSymbol; class QgsVectorLayer; class QgsExpression; -/** \ingroup core +/** + * \ingroup core * Class that runs a hit test with given map settings. Based on the hit test it returns which symbols * will be visible on the map - this is useful for content based legend. * @@ -52,7 +53,8 @@ class CORE_EXPORT QgsMapHitTest //! Runs the map hit test void run(); - /** Tests whether a symbol is visible for a specified layer. + /** + * Tests whether a symbol is visible for a specified layer. * \param symbol symbol to find * \param layer vector layer * \since QGIS 2.12 @@ -60,7 +62,8 @@ class CORE_EXPORT QgsMapHitTest */ bool symbolVisible( QgsSymbol *symbol, QgsVectorLayer *layer ) const; - /** Tests whether a given legend key is visible for a specified layer. + /** + * Tests whether a given legend key is visible for a specified layer. * \param ruleKey legend rule key * \param layer vector layer * \since QGIS 2.14 @@ -76,7 +79,8 @@ class CORE_EXPORT QgsMapHitTest //! \note not available in Python bindings typedef QMap HitTest; - /** Runs test for visible symbols within a layer + /** + * Runs test for visible symbols within a layer * \param vl vector layer * \param usedSymbols set for storage of visible symbols * \param usedSymbolsRuleKey set of storage of visible legend rule keys diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h index 572eb546c501..32f8cf322308 100644 --- a/src/core/qgsmaplayer.h +++ b/src/core/qgsmaplayer.h @@ -48,7 +48,8 @@ class QDomDocument; class QKeyEvent; class QPainter; -/** \ingroup core +/** + * \ingroup core * Base class for all map layer types. * This is the base class for all map layer types (vector, raster). */ @@ -97,7 +98,8 @@ class CORE_EXPORT QgsMapLayer : public QObject PluginLayer }; - /** Constructor for QgsMapLayer + /** + * Constructor for QgsMapLayer * \param type layer type * \param name display name for the layer * \param source datasource of layer @@ -111,14 +113,16 @@ class CORE_EXPORT QgsMapLayer : public QObject //! QgsMapLayer cannot be copied QgsMapLayer &operator=( QgsMapLayer const & ) = delete; - /** Returns a new instance equivalent to this one except for the id which + /** + * Returns a new instance equivalent to this one except for the id which * is still unique. * \returns a new layer instance * \since QGIS 3.0 */ virtual QgsMapLayer *clone() const = 0; - /** Returns the type of the layer. + /** + * Returns the type of the layer. */ QgsMapLayer::LayerType type() const; @@ -132,7 +136,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setName( const QString &name ); - /** Returns the display name of the layer. + /** + * Returns the display name of the layer. * \returns the layer name * \see setName() */ @@ -149,58 +154,67 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual const QgsDataProvider *dataProvider() const SIP_SKIP; - /** Returns the original name of the layer. + /** + * Returns the original name of the layer. */ QString originalName() const; - /** Sets the short name of the layer + /** + * Sets the short name of the layer * used by QGIS Server to identify the layer. * \returns the layer short name * \see shortName() */ void setShortName( const QString &shortName ) { mShortName = shortName; } - /** Returns the short name of the layer + /** + * Returns the short name of the layer * used by QGIS Server to identify the layer. * \see setShortName() */ QString shortName() const { return mShortName; } - /** Sets the title of the layer + /** + * Sets the title of the layer * used by QGIS Server in GetCapabilities request. * \see title() */ void setTitle( const QString &title ) { mTitle = title; } - /** Returns the title of the layer + /** + * Returns the title of the layer * used by QGIS Server in GetCapabilities request. * \returns the layer title * \see setTitle() */ QString title() const { return mTitle; } - /** Sets the abstract of the layer + /** + * Sets the abstract of the layer * used by QGIS Server in GetCapabilities request. * \returns the layer abstract * \see abstract() */ void setAbstract( const QString &abstract ) { mAbstract = abstract; } - /** Returns the abstract of the layer + /** + * Returns the abstract of the layer * used by QGIS Server in GetCapabilities request. * \returns the layer abstract * \see setAbstract() */ QString abstract() const { return mAbstract; } - /** Sets the keyword list of the layer + /** + * Sets the keyword list of the layer * used by QGIS Server in GetCapabilities request. * \returns the layer keyword list * \see keywordList() */ void setKeywordList( const QString &keywords ) { mKeywordList = keywords; } - /** Returns the keyword list of the layer + /** + * Returns the keyword list of the layer * used by QGIS Server in GetCapabilities request. * \returns the layer keyword list * \see setKeywordList() @@ -209,7 +223,8 @@ class CORE_EXPORT QgsMapLayer : public QObject /* Layer dataUrl information */ - /** Sets the DataUrl of the layer + /** + * Sets the DataUrl of the layer * used by QGIS Server in GetCapabilities request. * DataUrl is a a link to the underlying data represented by a particular layer. * \returns the layer DataUrl @@ -217,7 +232,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setDataUrl( const QString &dataUrl ) { mDataUrl = dataUrl; } - /** Returns the DataUrl of the layer + /** + * Returns the DataUrl of the layer * used by QGIS Server in GetCapabilities request. * DataUrl is a a link to the underlying data represented by a particular layer. * \returns the layer DataUrl @@ -225,7 +241,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QString dataUrl() const { return mDataUrl; } - /** Sets the DataUrl format of the layer + /** + * Sets the DataUrl format of the layer * used by QGIS Server in GetCapabilities request. * DataUrl is a a link to the underlying data represented by a particular layer. * \returns the layer DataUrl format @@ -233,7 +250,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setDataUrlFormat( const QString &dataUrlFormat ) { mDataUrlFormat = dataUrlFormat; } - /** Returns the DataUrl format of the layer + /** + * Returns the DataUrl format of the layer * used by QGIS Server in GetCapabilities request. * DataUrl is a a link to the underlying data represented by a particular layer. * \returns the layer DataUrl format @@ -243,7 +261,8 @@ class CORE_EXPORT QgsMapLayer : public QObject /* Layer attribution information */ - /** Sets the attribution of the layer + /** + * Sets the attribution of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. * \returns the layer attribution @@ -251,7 +270,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setAttribution( const QString &attrib ) { mAttribution = attrib; } - /** Returns the attribution of the layer + /** + * Returns the attribution of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. * \returns the layer attribution @@ -259,7 +279,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QString attribution() const { return mAttribution; } - /** Sets the attribution URL of the layer + /** + * Sets the attribution URL of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. * \returns the layer attribution URL @@ -267,7 +288,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setAttributionUrl( const QString &attribUrl ) { mAttributionUrl = attribUrl; } - /** Returns the attribution URL of the layer + /** + * Returns the attribution URL of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. * \returns the layer attribution URL @@ -277,7 +299,8 @@ class CORE_EXPORT QgsMapLayer : public QObject /* Layer metadataUrl information */ - /** Sets the metadata URL of the layer + /** + * Sets the metadata URL of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrl is a a link to the detailed, standardized metadata about the data. * \returns the layer metadata URL @@ -285,7 +308,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setMetadataUrl( const QString &metaUrl ) { mMetadataUrl = metaUrl; } - /** Returns the metadata URL of the layer + /** + * Returns the metadata URL of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrl is a a link to the detailed, standardized metadata about the data. * \returns the layer metadata URL @@ -293,7 +317,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QString metadataUrl() const { return mMetadataUrl; } - /** Set the metadata type of the layer + /** + * Set the metadata type of the layer * used by QGIS Server in GetCapabilities request * MetadataUrlType indicates the standard to which the metadata complies. * \returns the layer metadata type @@ -301,7 +326,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setMetadataUrlType( const QString &metaUrlType ) { mMetadataUrlType = metaUrlType; } - /** Returns the metadata type of the layer + /** + * Returns the metadata type of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates the standard to which the metadata complies. * \returns the layer metadata type @@ -309,7 +335,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QString metadataUrlType() const { return mMetadataUrlType; } - /** Sets the metadata format of the layer + /** + * Sets the metadata format of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates how the metadata is structured. * \returns the layer metadata format @@ -317,7 +344,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setMetadataUrlFormat( const QString &metaUrlFormat ) { mMetadataUrlFormat = metaUrlFormat; } - /** Returns the metadata format of the layer + /** + * Returns the metadata format of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates how the metadata is structured. * \returns the layer metadata format @@ -325,13 +353,15 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QString metadataUrlFormat() const { return mMetadataUrlFormat; } - /** Set the blending mode used for rendering a layer. + /** + * Set the blending mode used for rendering a layer. * \param blendMode new blending mode * \see blendMode() */ void setBlendMode( QPainter::CompositionMode blendMode ); - /** Returns the current blending mode for a layer. + /** + * Returns the current blending mode for a layer. * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; @@ -339,11 +369,13 @@ class CORE_EXPORT QgsMapLayer : public QObject //! Returns if this layer is read only. bool readOnly() const { return isReadOnly(); } - /** Synchronises with changes in the datasource + /** + * Synchronises with changes in the datasource */ virtual void reload() {} - /** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context + /** + * Return new instance of QgsMapLayerRenderer that will be used for rendering of given context * \since QGIS 2.4 */ virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) = 0 SIP_FACTORY; @@ -351,20 +383,23 @@ class CORE_EXPORT QgsMapLayer : public QObject //! Returns the extent of the layer. virtual QgsRectangle extent() const; - /** Return the status of the layer. An invalid layer is one which has a bad datasource + /** + * Return the status of the layer. An invalid layer is one which has a bad datasource * or other problem. Child classes set this flag when initialized. * \returns true if the layer is valid and can be accessed */ bool isValid() const; - /** Gets a version of the internal layer definition that has sensitive + /** + * Gets a version of the internal layer definition that has sensitive * bits removed (for example, the password). This function should * be used when displaying the source name for general viewing. * \see source() */ QString publicSource() const; - /** Returns the source for the layer. This source may contain usernames, passwords + /** + * Returns the source for the layer. This source may contain usernames, passwords * and other sensitive information. * \see publicSource() */ @@ -382,7 +417,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual void setLayerOrder( const QStringList &layers ); - /** Set the visibility of the given sublayer name. + /** + * Set the visibility of the given sublayer name. * \param name sublayer name * \param visible sublayer visibility */ @@ -391,12 +427,14 @@ class CORE_EXPORT QgsMapLayer : public QObject //! Returns true if the layer can be edited. virtual bool isEditable() const; - /** Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. + /** + * Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it. * \since QGIS 2.16 */ virtual bool isSpatial() const; - /** Sets state from Dom document + /** + * Sets state from Dom document \param layerElement The Dom element corresponding to ``maplayer'' tag \param context writing context (e.g. for conversion between relative and absolute paths) \note @@ -413,7 +451,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ bool readLayerXml( const QDomElement &layerElement, const QgsReadWriteContext &context ); - /** Stores state in Dom node + /** + * Stores state in Dom node * \param layerElement is a Dom element corresponding to ``maplayer'' tag * \param document is a the dom document being written * \param context reading context (e.g. for conversion between relative and absolute paths) @@ -431,45 +470,53 @@ class CORE_EXPORT QgsMapLayer : public QObject */ bool writeLayerXml( QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context ) const; - /** Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. + /** + * Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. * \since QGIS 3.0 */ virtual void resolveReferences( QgsProject *project ); - /** Returns list of all keys within custom properties. Properties are stored in a map and saved in project file. + /** + * Returns list of all keys within custom properties. Properties are stored in a map and saved in project file. * \see customProperty() * \since QGIS 3.0 */ QStringList customPropertyKeys() const; - /** Set a custom property for layer. Properties are stored in a map and saved in project file. + /** + * Set a custom property for layer. Properties are stored in a map and saved in project file. * \see customProperty() * \see removeCustomProperty() */ void setCustomProperty( const QString &key, const QVariant &value ); - /** Read a custom property from layer. Properties are stored in a map and saved in project file. + /** + * Read a custom property from layer. Properties are stored in a map and saved in project file. * \see setCustomProperty() */ QVariant customProperty( const QString &value, const QVariant &defaultValue = QVariant() ) const; - /** Set custom properties for layer. Current properties are dropped. + /** + * Set custom properties for layer. Current properties are dropped. * \since QGIS 3.0 */ void setCustomProperties( const QgsObjectCustomProperties &properties ); - /** Remove a custom property from layer. Properties are stored in a map and saved in project file. + /** + * Remove a custom property from layer. Properties are stored in a map and saved in project file. * \see setCustomProperty() */ void removeCustomProperty( const QString &key ); - /** Get current status error. This error describes some principal problem + /** + * Get current status error. This error describes some principal problem * for which layer cannot work and thus is not valid. It is not last error * after accessing data by draw() etc. */ virtual QgsError error() const; - /** Returns the layer's spatial reference system. + /** + * Returns the layer's spatial reference system. \since QGIS 1.4 */ QgsCoordinateReferenceSystem crs() const; @@ -480,7 +527,8 @@ class CORE_EXPORT QgsMapLayer : public QObject //! A convenience function to (un)capitalize the layer name static QString capitalizeLayerName( const QString &name ); - /** Retrieve the style URI for this layer + /** + * Retrieve the style URI for this layer * (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) * \returns a QString with the style file name @@ -488,7 +536,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual QString styleURI() const; - /** Retrieve the default style for this layer if one + /** + * Retrieve the default style for this layer if one * exists (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) * \param resultFlag a reference to a flag that will be set to false if @@ -498,7 +547,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual QString loadDefaultStyle( bool &resultFlag SIP_OUT ); - /** Retrieve a named style for this layer if one + /** + * Retrieve a named style for this layer if one * exists (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) * \param uri - the file name or other URI for the @@ -513,7 +563,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual QString loadNamedStyle( const QString &uri, bool &resultFlag SIP_OUT ); - /** Retrieve a named style for this layer from a sqlite database. + /** + * Retrieve a named style for this layer from a sqlite database. * \param db path to sqlite database * \param uri uri for table * \param qml will be set to QML style content from database @@ -548,7 +599,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual void exportSldStyle( QDomDocument &doc, QString &errorMsg ) const; - /** Save the properties of this layer as the default style + /** + * Save the properties of this layer as the default style * (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) * \param resultFlag a reference to a flag that will be set to false if @@ -558,7 +610,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual QString saveDefaultStyle( bool &resultFlag SIP_OUT ); - /** Save the properties of this layer as a named style + /** + * Save the properties of this layer as a named style * (either as a .qml file on disk or as a * record in the users style table in their personal qgis.db) * \param uri the file name or other URI for the @@ -573,7 +626,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual QString saveNamedStyle( const QString &uri, bool &resultFlag SIP_OUT ); - /** Saves the properties of this layer to an SLD format file. + /** + * Saves the properties of this layer to an SLD format file. * \param uri uri of destination for exported SLD file. * \param resultFlag a reference to a flag that will be set to false if * the SLD file could not be generated @@ -582,7 +636,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual QString saveSldStyle( const QString &uri, bool &resultFlag ) const; - /** Attempts to style the layer using the formatting from an SLD type file. + /** + * Attempts to style the layer using the formatting from an SLD type file. * \param uri uri of source SLD file * \param resultFlag a reference to a flag that will be set to false if * the SLD file could not be loaded @@ -596,7 +651,8 @@ class CORE_EXPORT QgsMapLayer : public QObject - /** Read the symbology for the current layer from the Dom node supplied. + /** + * Read the symbology for the current layer from the Dom node supplied. * \param node node that will contain the symbology definition for this layer. * \param errorMessage reference to string that will be updated with any error messages * \param context reading context (used for transform from relative to absolute paths) @@ -604,7 +660,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual bool readSymbology( const QDomNode &node, QString &errorMessage, const QgsReadWriteContext &context ) = 0; - /** Read the style for the current layer from the Dom node supplied. + /** + * Read the style for the current layer from the Dom node supplied. * \param node node that will contain the style definition for this layer. * \param errorMessage reference to string that will be updated with any error messages * \param context reading context (used for transform from relative to absolute paths) @@ -614,7 +671,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual bool readStyle( const QDomNode &node, QString &errorMessage, const QgsReadWriteContext &context ); - /** Write the symbology for the layer into the docment provided. + /** + * Write the symbology for the layer into the docment provided. * \param node the node that will have the style element added to it. * \param doc the document that will have the QDomNode added. * \param errorMessage reference to string that will be updated with any error messages @@ -623,7 +681,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context ) const = 0; - /** Write just the style information for the layer into the document + /** + * Write just the style information for the layer into the document * \param node the node that will have the style element added to it. * \param doc the document that will have the QDomNode added. * \param errorMessage reference to string that will be updated with any error messages @@ -637,7 +696,8 @@ class CORE_EXPORT QgsMapLayer : public QObject //! Return pointer to layer's undo stack QUndoStack *undoStack(); - /** Return pointer to layer's style undo stack + /** + * Return pointer to layer's style undo stack * \since QGIS 2.16 */ QUndoStack *undoStackStyles(); @@ -693,7 +753,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ QgsAbstract3DRenderer *renderer3D() const; - /** Tests whether the layer should be visible at the specified \a scale. + /** + * Tests whether the layer should be visible at the specified \a scale. * The \a scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. * \returns true if the layer is visible at the given scale. * \since QGIS 2.16 @@ -727,7 +788,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ double maximumScale() const; - /** Returns whether scale based visibility is enabled for the layer. + /** + * Returns whether scale based visibility is enabled for the layer. * \returns true if scale based visibility is enabled * \see minimumScale() * \see maximumScale() @@ -832,7 +894,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void setMaximumScale( double scale ); - /** Sets whether scale based visibility is enabled for the layer. + /** + * Sets whether scale based visibility is enabled for the layer. * \param enabled set to true to enable scale based visibility * \see setMinimumScale * \see setMaximumScale @@ -850,7 +913,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ void triggerRepaint( bool deferredUpdate = false ); - /** Triggers an emission of the styleChanged() signal. + /** + * Triggers an emission of the styleChanged() signal. * \since QGIS 2.16 */ void emitStyleChanged(); @@ -911,7 +975,8 @@ class CORE_EXPORT QgsMapLayer : public QObject //! Emit a signal that layer's CRS has been reset void crsChanged(); - /** By emitting this signal the layer tells that either appearance or content have been changed + /** + * By emitting this signal the layer tells that either appearance or content have been changed * and any view showing the rendered layer should refresh itself. * If \a deferredUpdate is true then the layer will only be repainted when the canvas is next * re-rendered, and will not trigger any canvas redraws itself. @@ -927,12 +992,14 @@ class CORE_EXPORT QgsMapLayer : public QObject //! Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode() void blendModeChanged( QPainter::CompositionMode blendMode ); - /** Signal emitted when renderer is changed. + /** + * Signal emitted when renderer is changed. * \see styleChanged() */ void rendererChanged(); - /** Signal emitted whenever a change affects the layer's style. Ie this may be triggered + /** + * Signal emitted whenever a change affects the layer's style. Ie this may be triggered * by renderer changes, label style changes, or other style changes such as blend * mode or layer opacity changes. * \since QGIS 2.16 @@ -992,7 +1059,8 @@ class CORE_EXPORT QgsMapLayer : public QObject protected: - /** Copies attributes like name, short name, ... into another layer. + /** + * Copies attributes like name, short name, ... into another layer. * \param layer The copy recipient * \since QGIS 3.0 */ @@ -1004,17 +1072,20 @@ class CORE_EXPORT QgsMapLayer : public QObject //! Set whether layer is valid or not - should be used in constructor. void setValid( bool valid ); - /** Called by readLayerXML(), used by children to read state specific to them from + /** + * Called by readLayerXML(), used by children to read state specific to them from * project files. */ virtual bool readXml( const QDomNode &layer_node, const QgsReadWriteContext &context ); - /** Called by writeLayerXML(), used by children to write state specific to them to + /** + * Called by writeLayerXML(), used by children to write state specific to them to * project files. */ virtual bool writeXml( QDomNode &layer_node, QDomDocument &document, const QgsReadWriteContext &context ) const; - /** Read custom properties from project file. + /** + * Read custom properties from project file. \param layerNode note to read from \param keyStartsWith reads only properties starting with the specified string (or all if the string is empty)*/ void readCustomProperties( const QDomNode &layerNode, const QString &keyStartsWith = QString() ); @@ -1051,7 +1122,8 @@ class CORE_EXPORT QgsMapLayer : public QObject //! Name of the layer - used for display QString mLayerName; - /** Original name of the layer + /** + * Original name of the layer */ QString mLayerOrigName; @@ -1099,7 +1171,8 @@ class CORE_EXPORT QgsMapLayer : public QObject */ virtual bool isReadOnly() const; - /** Layer's spatial reference system. + /** + * Layer's spatial reference system. private to make sure setCrs must be used and crsChanged() is emitted */ QgsCoordinateReferenceSystem mCRS; diff --git a/src/core/qgsmaplayerdependency.h b/src/core/qgsmaplayerdependency.h index f0f72fa308a6..84e6712eadef 100644 --- a/src/core/qgsmaplayerdependency.h +++ b/src/core/qgsmaplayerdependency.h @@ -22,7 +22,8 @@ #include "qgis_core.h" #include -/** \ingroup core +/** + * \ingroup core * This class models dependencies with or between map layers. * A dependency is defined by a layer ID, a type and an origin. * The two combinations of type/origin that are currently supported are: diff --git a/src/core/qgsmaplayerlegend.h b/src/core/qgsmaplayerlegend.h index c89d2b6430e2..820e6add2d67 100644 --- a/src/core/qgsmaplayerlegend.h +++ b/src/core/qgsmaplayerlegend.h @@ -28,7 +28,8 @@ class QgsVectorLayer; #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * The QgsMapLayerLegend class is abstract interface for implementations * of legends for one map layer. * @@ -62,7 +63,8 @@ class CORE_EXPORT QgsMapLayerLegend : public QObject }; -/** \ingroup core +/** + * \ingroup core * Miscellaneous utility functions for handling of map layer legend * * \since QGIS 2.6 @@ -85,7 +87,8 @@ class CORE_EXPORT QgsMapLayerLegendUtils #include -/** \ingroup core +/** + * \ingroup core * Default legend implementation for vector layers * \since QGIS 2.6 */ @@ -103,7 +106,8 @@ class CORE_EXPORT QgsDefaultVectorLayerLegend : public QgsMapLayerLegend }; -/** \ingroup core +/** + * \ingroup core * Default legend implementation for raster layers * \since QGIS 2.6 */ diff --git a/src/core/qgsmaplayermodel.h b/src/core/qgsmaplayermodel.h index 8e7431aa83ef..4b263150d2ea 100644 --- a/src/core/qgsmaplayermodel.h +++ b/src/core/qgsmaplayermodel.h @@ -26,7 +26,8 @@ class QgsMapLayer; -/** \ingroup core +/** + * \ingroup core * \brief The QgsMapLayerModel class is a model to display layers in widgets. * \see QgsMapLayerProxyModel to sort and/filter the layers * \see QgsFieldModel to combine in with a field selector. diff --git a/src/core/qgsmaplayerproxymodel.h b/src/core/qgsmaplayerproxymodel.h index 71b5ef31ad4d..264b965a1136 100644 --- a/src/core/qgsmaplayerproxymodel.h +++ b/src/core/qgsmaplayerproxymodel.h @@ -25,7 +25,8 @@ class QgsMapLayerModel; class QgsMapLayer; -/** \ingroup core +/** + * \ingroup core * \brief The QgsMapLayerProxyModel class provides an easy to use model to display the list of layers in widgets. * \since QGIS 2.3 */ diff --git a/src/core/qgsmaplayerref.h b/src/core/qgsmaplayerref.h index 747e7579ead8..0a9fb699e5ea 100644 --- a/src/core/qgsmaplayerref.h +++ b/src/core/qgsmaplayerref.h @@ -24,7 +24,8 @@ #include "qgsdataprovider.h" #include "qgsproject.h" -/** Internal structure to keep weak pointer to QgsMapLayer or layerId +/** + * Internal structure to keep weak pointer to QgsMapLayer or layerId * if the layer is not available yet. * \note not available in Python bindings */ diff --git a/src/core/qgsmaplayerrenderer.h b/src/core/qgsmaplayerrenderer.h index bf59452ab0c6..390e847bddae 100644 --- a/src/core/qgsmaplayerrenderer.h +++ b/src/core/qgsmaplayerrenderer.h @@ -22,7 +22,8 @@ class QgsFeedback; -/** \ingroup core +/** + * \ingroup core * Base class for utility classes that encapsulate information necessary * for rendering of map layers. The rendering is typically done in a background * thread, so it is necessary to keep all structures required for rendering away diff --git a/src/core/qgsmaplayerstylemanager.h b/src/core/qgsmaplayerstylemanager.h index 4095718dbf1c..4b926e204a78 100644 --- a/src/core/qgsmaplayerstylemanager.h +++ b/src/core/qgsmaplayerstylemanager.h @@ -28,7 +28,8 @@ class QgsMapLayer; class QDomElement; -/** \ingroup core +/** + * \ingroup core * Stores style information (renderer, opacity, labeling, diagrams etc.) applicable to a map layer. * * Stored data are considered as opaque - it is not possible to access them directly or modify them - it is @@ -69,7 +70,8 @@ class CORE_EXPORT QgsMapLayerStyle }; -/** \ingroup core +/** + * \ingroup core * Management of styles for use with one map layer. Stored styles are identified by their names. The manager * always keep track of which style of the stored ones is currently active. When the current style is changed, * the new style is applied to the associated layer. @@ -111,7 +113,8 @@ class CORE_EXPORT QgsMapLayerStyleManager : public QObject //! Return list of all defined style names QStringList styles() const; - /** Gets available styles for the associated map layer. + /** + * Gets available styles for the associated map layer. * \returns A map of map layer style by style name * \since QGIS 3.0 */ diff --git a/src/core/qgsmaprenderercache.h b/src/core/qgsmaprenderercache.h index a446b96846d8..c9dbbf9dba58 100644 --- a/src/core/qgsmaprenderercache.h +++ b/src/core/qgsmaprenderercache.h @@ -25,7 +25,8 @@ #include "qgsmaplayer.h" -/** \ingroup core +/** + * \ingroup core * This class is responsible for keeping cache of rendered images resulting from * a map rendering job. * diff --git a/src/core/qgsmaprenderercustompainterjob.h b/src/core/qgsmaprenderercustompainterjob.h index bf7647a98690..099ba54a6028 100644 --- a/src/core/qgsmaprenderercustompainterjob.h +++ b/src/core/qgsmaprenderercustompainterjob.h @@ -22,7 +22,8 @@ #include -/** \ingroup core +/** + * \ingroup core * Job implementation that renders everything sequentially using a custom painter. * * Also supports synchronous rendering in main thread for cases when rendering in background diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h index 9e7e7a5c02b0..6a0030bacd90 100644 --- a/src/core/qgsmaprendererjob.h +++ b/src/core/qgsmaprendererjob.h @@ -39,7 +39,8 @@ class QgsFeatureFilterProvider; #ifndef SIP_RUN /// @cond PRIVATE -/** \ingroup core +/** + * \ingroup core * Structure keeping low-level rendering job information. */ struct LayerRenderJob @@ -58,7 +59,8 @@ struct LayerRenderJob typedef QList LayerRenderJobs; -/** \ingroup core +/** + * \ingroup core * Structure keeping low-level label rendering job information. */ struct LabelRenderJob @@ -85,7 +87,8 @@ struct LabelRenderJob ///@endcond PRIVATE #endif -/** \ingroup core +/** + * \ingroup core * Abstract base class for map rendering implementations. * * The API is designed in a way that rendering is done asynchronously, therefore @@ -275,7 +278,8 @@ class CORE_EXPORT QgsMapRendererJob : public QObject private: - /** Convenience function to project an extent into the layer source + /** + * Convenience function to project an extent into the layer source * CRS, but also split it into two extents if it crosses * the +/- 180 degree line. Modifies the given extent to be in the * source CRS coordinates, and if it was split, returns true, and @@ -289,7 +293,8 @@ class CORE_EXPORT QgsMapRendererJob : public QObject }; -/** \ingroup core +/** + * \ingroup core * Intermediate base class adding functionality that allows client to query the rendered image. * The image can be queried even while the rendering is still in progress to get intermediate result * diff --git a/src/core/qgsmaprendererparalleljob.h b/src/core/qgsmaprendererparalleljob.h index 9c53fc091bf1..be4ef510480a 100644 --- a/src/core/qgsmaprendererparalleljob.h +++ b/src/core/qgsmaprendererparalleljob.h @@ -20,7 +20,8 @@ #include "qgis_sip.h" #include "qgsmaprendererjob.h" -/** \ingroup core +/** + * \ingroup core * Job implementation that renders all layers in parallel. * * The resulting map image can be retrieved with renderedImage() function. diff --git a/src/core/qgsmaprenderersequentialjob.h b/src/core/qgsmaprenderersequentialjob.h index 758138bd57bd..87d01af8f2de 100644 --- a/src/core/qgsmaprenderersequentialjob.h +++ b/src/core/qgsmaprenderersequentialjob.h @@ -21,7 +21,8 @@ class QgsMapRendererCustomPainterJob; -/** \ingroup core +/** + * \ingroup core * Job implementation that renders everything sequentially in one thread. * * The resulting map image can be retrieved with renderedImage() function. diff --git a/src/core/qgsmapsettings.h b/src/core/qgsmapsettings.h index 233524f8deeb..f2f887b3c532 100644 --- a/src/core/qgsmapsettings.h +++ b/src/core/qgsmapsettings.h @@ -41,7 +41,8 @@ class QgsScaleCalculator; class QgsMapRendererJob; -/** \ingroup core +/** + * \ingroup core * The QgsMapSettings class contains configuration for rendering of the map. * The rendering itself is done by QgsMapRendererJob subclasses. * @@ -148,14 +149,16 @@ class CORE_EXPORT QgsMapSettings */ void setLayerStyleOverrides( const QMap &overrides ); - /** Get custom rendering flags. Layers might honour these to alter their rendering. + /** + * Get custom rendering flags. Layers might honour these to alter their rendering. * \returns custom flags strings, separated by ';' * \since QGIS 2.16 * \see setCustomRenderFlags() */ QString customRenderFlags() const { return mCustomRenderFlags; } - /** Sets the custom rendering flags. Layers might honour these to alter their rendering. + /** + * Sets the custom rendering flags. Layers might honour these to alter their rendering. * \param customRenderFlags custom flags strings, separated by ';' * \since QGIS 2.16 * \see customRenderFlags() @@ -180,7 +183,8 @@ class CORE_EXPORT QgsMapSettings */ bool setEllipsoid( const QString &ellipsoid ); - /** Returns ellipsoid's acronym. Calculations will only use the + /** + * Returns ellipsoid's acronym. Calculations will only use the * ellipsoid if a valid ellipsoid has been set. * \since QGIS 3.0 * \see setEllipsoid() @@ -247,14 +251,16 @@ class CORE_EXPORT QgsMapSettings */ double scale() const; - /** Sets the expression context. This context is used for all expression evaluation + /** + * Sets the expression context. This context is used for all expression evaluation * associated with this map settings. * \see expressionContext() * \since QGIS 2.12 */ void setExpressionContext( const QgsExpressionContext &context ) { mExpressionContext = context; } - /** Gets the expression context. This context should be used for all expression evaluation + /** + * Gets the expression context. This context should be used for all expression evaluation * associated with this map settings. * \see setExpressionContext() * \since QGIS 2.12 @@ -269,7 +275,8 @@ class CORE_EXPORT QgsMapSettings const QgsMapToPixel &mapToPixel() const { return mMapToPixel; } - /** Computes an *estimated* conversion factor between layer and map units: layerUnits * layerToMapUnits = mapUnits + /** + * Computes an *estimated* conversion factor between layer and map units: layerUnits * layerToMapUnits = mapUnits * \param layer The layer * \param referenceExtent A reference extent based on which to perform the computation. If not specified, the layer extent is used * \since QGIS 2.12 @@ -332,13 +339,15 @@ class CORE_EXPORT QgsMapSettings void writeXml( QDomNode &node, QDomDocument &doc ); - /** Sets the segmentation tolerance applied when rendering curved geometries + /** + * Sets the segmentation tolerance applied when rendering curved geometries \param tolerance the segmentation tolerance*/ void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; } //! Gets the segmentation tolerance applied when rendering curved geometries double segmentationTolerance() const { return mSegmentationTolerance; } - /** Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) + /** + * Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) \param type the segmentation tolerance typename*/ void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; } //! Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) diff --git a/src/core/qgsmapsettingsutils.h b/src/core/qgsmapsettingsutils.h index ac326ca59363..ed5d5f9ea450 100644 --- a/src/core/qgsmapsettingsutils.h +++ b/src/core/qgsmapsettingsutils.h @@ -23,7 +23,8 @@ #include -/** \ingroup core +/** + * \ingroup core * Utilities for map settings. * \since QGIS 3.0 */ @@ -32,12 +33,14 @@ class CORE_EXPORT QgsMapSettingsUtils public: - /** Checks whether any of the layers attached to a map settings object contain advanced effects + /** + * Checks whether any of the layers attached to a map settings object contain advanced effects * \param mapSettings map settings */ static const QStringList containsAdvancedEffects( const QgsMapSettings &mapSettings ); - /** Creates the content of a world file. + /** + * Creates the content of a world file. * \param mapSettings map settings * \note Uses 17 places of precision for all numbers output */ diff --git a/src/core/qgsmapthemecollection.h b/src/core/qgsmapthemecollection.h index 351b125da472..dfd84225657a 100644 --- a/src/core/qgsmapthemecollection.h +++ b/src/core/qgsmapthemecollection.h @@ -212,7 +212,8 @@ class CORE_EXPORT QgsMapThemeCollection : public QObject */ void readXml( const QDomDocument &doc ); - /** Writes the map theme collection state to XML. + /** + * Writes the map theme collection state to XML. * \param doc DOM document * \see readXml */ diff --git a/src/core/qgsmaptopixel.h b/src/core/qgsmaptopixel.h index bda2536dd94d..0ae227bac804 100644 --- a/src/core/qgsmaptopixel.h +++ b/src/core/qgsmaptopixel.h @@ -27,7 +27,8 @@ class QgsPointXY; class QPoint; -/** \ingroup core +/** + * \ingroup core * Perform transforms between map coordinates and device coordinates. * * This class can convert device coordinates to map coordinates and vice versa. @@ -54,7 +55,8 @@ class CORE_EXPORT QgsMapToPixel */ QgsMapToPixel( double mapUnitsPerPixel ); - /** Returns a new QgsMapToPixel created using a specified \a scale and distance unit. + /** + * Returns a new QgsMapToPixel created using a specified \a scale and distance unit. * \param scale map scale denominator, e.g. 1000.0 for a 1:1000 map. * \param dpi screen DPI * \param mapUnits map units @@ -183,13 +185,15 @@ class CORE_EXPORT QgsMapToPixel QTransform transform() const; - /** Returns the center x-coordinate for the transform. + /** + * Returns the center x-coordinate for the transform. * \see yCenter() * \since QGIS 3.0 */ double xCenter() const { return mXCenter; } - /** Returns the center y-coordinate for the transform. + /** + * Returns the center y-coordinate for the transform. * \see xCenter() * \since QGIS 3.0 */ diff --git a/src/core/qgsmaptopixelgeometrysimplifier.h b/src/core/qgsmaptopixelgeometrysimplifier.h index c7dddf2560c6..8b47a2ed83df 100644 --- a/src/core/qgsmaptopixelgeometrysimplifier.h +++ b/src/core/qgsmaptopixelgeometrysimplifier.h @@ -27,7 +27,8 @@ class QgsWkbPtr; class QgsConstWkbPtr; -/** \ingroup core +/** + * \ingroup core * Implementation of GeometrySimplifier using the "MapToPixel" algorithm * * Simplifies a geometry removing points within of the maximum distance difference that defines the MapToPixel info of a RenderContext request. diff --git a/src/core/qgsmapunitscale.h b/src/core/qgsmapunitscale.h index 510f540a6698..f12712e8bd84 100644 --- a/src/core/qgsmapunitscale.h +++ b/src/core/qgsmapunitscale.h @@ -24,7 +24,8 @@ class QgsRenderContext; -/** \ingroup core +/** + * \ingroup core * \class QgsMapUnitScale * \brief Struct for storing maximum and minimum scales for measurements in map units * @@ -69,7 +70,8 @@ class CORE_EXPORT QgsMapUnitScale //! The maximum size in millimeters, or 0.0 if unset double maxSizeMM = 0.0; - /** Computes a map units per pixel scaling factor, respecting the minimum and maximum scales + /** + * Computes a map units per pixel scaling factor, respecting the minimum and maximum scales * set for the object. * \param c render context * \returns map units per pixel, limited between minimum and maximum scales diff --git a/src/core/qgsmessagelog.h b/src/core/qgsmessagelog.h index 76746b620494..c7d2e4f67f46 100644 --- a/src/core/qgsmessagelog.h +++ b/src/core/qgsmessagelog.h @@ -21,7 +21,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * Interface for logging messages from QGIS in GUI independent way. * This class provides abstraction of a tabbed window for showing messages to the user. * By default QgsMessageLogOutput will be used if not overridden with another @@ -68,7 +69,8 @@ class CORE_EXPORT QgsMessageLog : public QObject }; -/** \ingroup core +/** + * \ingroup core \brief Default implementation of message logging interface This class outputs log messages to the standard output. Therefore it might diff --git a/src/core/qgsmessageoutput.h b/src/core/qgsmessageoutput.h index 7a557259a949..b864ec4a9677 100644 --- a/src/core/qgsmessageoutput.h +++ b/src/core/qgsmessageoutput.h @@ -27,7 +27,8 @@ class QgsMessageOutput; typedef QgsMessageOutput *( *MESSAGE_OUTPUT_CREATOR )() SIP_SKIP; -/** \ingroup core +/** + * \ingroup core * Interface for showing messages from QGIS in GUI independent way. * This class provides abstraction of a dialog for showing output to the user. * By default QgsMessageConsoleOutput will be used if not overridden with other @@ -59,7 +60,8 @@ class CORE_EXPORT QgsMessageOutput //! display the message to the user and deletes itself virtual void showMessage( bool blocking = true ) = 0; - /** Display the blocking message to the user. + /** + * Display the blocking message to the user. * \since QGIS 2.10 */ static void showMessage( const QString &title, const QString &message, MessageType msgType ); @@ -84,7 +86,8 @@ class CORE_EXPORT QgsMessageOutput }; -/** \ingroup core +/** + * \ingroup core \brief Default implementation of message output interface This class outputs messages to the standard output. Therefore it might diff --git a/src/core/qgsmimedatautils.h b/src/core/qgsmimedatautils.h index 06f031dac82d..14ba3f81ebf7 100644 --- a/src/core/qgsmimedatautils.h +++ b/src/core/qgsmimedatautils.h @@ -25,7 +25,8 @@ class QgsLayerTreeNode; class QgsVectorLayer; class QgsRasterLayer; -/** \ingroup core +/** + * \ingroup core * \class QgsMimeDataUtils */ class CORE_EXPORT QgsMimeDataUtils @@ -48,13 +49,15 @@ class CORE_EXPORT QgsMimeDataUtils //! Returns encoded representation of the object QString data() const; - /** Get vector layer from uri if possible, otherwise returns 0 and error is set + /** + * Get vector layer from uri if possible, otherwise returns 0 and error is set * \param owner set to true if caller becomes owner * \param error set to error message if cannot get vector */ QgsVectorLayer *vectorLayer( bool &owner, QString &error ) const; - /** Get raster layer from uri if possible, otherwise returns 0 and error is set + /** + * Get raster layer from uri if possible, otherwise returns 0 and error is set * \param owner set to true if caller becomes owner * \param error set to error message if cannot get raster */ diff --git a/src/core/qgsmultirenderchecker.h b/src/core/qgsmultirenderchecker.h index 8b5bffe8aa10..fe74188dcac7 100644 --- a/src/core/qgsmultirenderchecker.h +++ b/src/core/qgsmultirenderchecker.h @@ -19,7 +19,8 @@ #include "qgis_core.h" #include "qgsrenderchecker.h" -/** \ingroup core +/** + * \ingroup core * This class allows checking rendered images against comparison images. * Its main purpose is for the unit testing framework. * @@ -121,7 +122,8 @@ class CORE_EXPORT QgsMultiRenderChecker */ QString controlImagePath() const; - /** Draws a checkboard pattern for image backgrounds, so that opacity is visible + /** + * Draws a checkboard pattern for image backgrounds, so that opacity is visible * without requiring a transparent background for the image */ static void drawBackground( QImage *image ) { QgsRenderChecker::drawBackground( image ); } @@ -141,7 +143,8 @@ SIP_IF_FEATURE( TESTS ) ///@cond PRIVATE -/** \ingroup core +/** + * \ingroup core * \class QgsCompositionChecker * Renders a composition to an image and compares with an expected output */ diff --git a/src/core/qgsnetworkcontentfetcher.h b/src/core/qgsnetworkcontentfetcher.h index 782a2fa473f3..0f9c7d00065d 100644 --- a/src/core/qgsnetworkcontentfetcher.h +++ b/src/core/qgsnetworkcontentfetcher.h @@ -47,25 +47,29 @@ class CORE_EXPORT QgsNetworkContentFetcher : public QObject virtual ~QgsNetworkContentFetcher(); - /** Fetches content from a remote URL and handles redirects. The finished() + /** + * Fetches content from a remote URL and handles redirects. The finished() * signal will be emitted when content has been fetched. * \param url URL to fetch */ void fetchContent( const QUrl &url ); - /** Returns a reference to the network reply + /** + * Returns a reference to the network reply * \returns QNetworkReply for fetched URL content */ QNetworkReply *reply(); - /** Returns the fetched content as a string + /** + * Returns the fetched content as a string * \returns string containing network content */ QString contentAsString() const; signals: - /** Emitted when content has loaded + /** + * Emitted when content has loaded */ void finished(); @@ -75,7 +79,8 @@ class CORE_EXPORT QgsNetworkContentFetcher : public QObject bool mContentLoaded = false; - /** Tries to create a text codec for decoding html content. Works around bugs in Qt's built in method. + /** + * Tries to create a text codec for decoding html content. Works around bugs in Qt's built in method. * \param array input html byte array * \returns QTextCodec for html content, if detected */ @@ -83,7 +88,8 @@ class CORE_EXPORT QgsNetworkContentFetcher : public QObject private slots: - /** Called when fetchUrlContent has finished loading a url. If + /** + * Called when fetchUrlContent has finished loading a url. If * result is a redirect then the redirect is fetched automatically. */ void contentLoaded( bool ok = true ); diff --git a/src/core/qgsnetworkdiskcache.h b/src/core/qgsnetworkdiskcache.h index 3f55398c79cc..095a602130c2 100644 --- a/src/core/qgsnetworkdiskcache.h +++ b/src/core/qgsnetworkdiskcache.h @@ -38,7 +38,8 @@ class ExpirableNetworkDiskCache : public QNetworkDiskCache ///@endcond -/** \ingroup core +/** + * \ingroup core * Wrapper implementation of QNetworkDiskCache with all methods guarded by a * mutex soly for internal use of QgsNetworkAccessManagers * diff --git a/src/core/qgsnetworkreplyparser.h b/src/core/qgsnetworkreplyparser.h index 53fb5d6d73af..74787233cac1 100644 --- a/src/core/qgsnetworkreplyparser.h +++ b/src/core/qgsnetworkreplyparser.h @@ -25,7 +25,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core \brief Multipart QNetworkReply parser. It seams that Qt does not have currently support for multipart reply @@ -42,19 +43,23 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject public: typedef QMap RawHeaderMap; - /** Constructor + /** + * Constructor * \param reply */ QgsNetworkReplyParser( QNetworkReply *reply ); - /** Indicates if successfully parsed + /** + * Indicates if successfully parsed * \returns true if successfully parsed */ bool isValid() const { return mValid; } - /** Get number of parts + /** + * Get number of parts * \returns number of parts */ int parts() const { return mHeaders.size(); } - /** Get part header + /** + * Get part header * \param part part index * \param headerName header name * \returns raw header */ @@ -63,7 +68,8 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject //! Get headers QList< RawHeaderMap > headers() const { return mHeaders; } - /** Get part part body + /** + * Get part part body * \param part part index * \returns part body */ QByteArray body( int part ) const { return mBodies.value( part ); } @@ -74,7 +80,8 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject //! Parsing error QString error() const { return mError; } - /** Test if reply is multipart. + /** + * Test if reply is multipart. * \returns true if reply is multipart */ static bool isMultipart( QNetworkReply *reply ); diff --git a/src/core/qgsobjectcustomproperties.h b/src/core/qgsobjectcustomproperties.h index d3670c7b3ac4..f44dfd0e93e4 100644 --- a/src/core/qgsobjectcustomproperties.h +++ b/src/core/qgsobjectcustomproperties.h @@ -25,7 +25,8 @@ class QDomDocument; class QDomNode; -/** \ingroup core +/** + * \ingroup core * Simple key-value store (keys = strings, values = variants) that supports loading/saving to/from XML * in \verbatim \endverbatim element. * @@ -53,7 +54,8 @@ class CORE_EXPORT QgsObjectCustomProperties void remove( const QString &key ); - /** Read store contents from XML + /** + * Read store contents from XML \param parentNode node to read from \param keyStartsWith reads only properties starting with the specified string (or all if the string is empty) */ diff --git a/src/core/qgsofflineediting.h b/src/core/qgsofflineediting.h index 1ac346c3ca3c..5ac8178f4b6c 100644 --- a/src/core/qgsofflineediting.h +++ b/src/core/qgsofflineediting.h @@ -30,7 +30,8 @@ class QgsMapLayer; class QgsVectorLayer; struct sqlite3; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsOfflineEditing : public QObject { @@ -50,7 +51,8 @@ class CORE_EXPORT QgsOfflineEditing : public QObject QgsOfflineEditing(); - /** Convert current project for offline editing + /** + * Convert current project for offline editing * \param offlineDataPath Path to offline db file * \param offlineDbFile Offline db file name * \param layerIds List of layer names to convert @@ -87,7 +89,8 @@ class CORE_EXPORT QgsOfflineEditing : public QObject */ void progressModeSet( QgsOfflineEditing::ProgressMode mode, int maximum ); - /** Emitted with the progress of the current mode + /** + * Emitted with the progress of the current mode * \param progress current index of processed entities */ void progressUpdated( int progress ); diff --git a/src/core/qgsogcutils.h b/src/core/qgsogcutils.h index 23cf3ea8ff56..86fb1d36fc90 100644 --- a/src/core/qgsogcutils.h +++ b/src/core/qgsogcutils.h @@ -38,7 +38,8 @@ class QgsRectangle; #include "qgsexpressionnodeimpl.h" #include "qgssqlstatement.h" -/** \ingroup core +/** + * \ingroup core * \brief The QgsOgcUtils class provides various utility functions for conversion between * OGC (Open Geospatial Consortium) standards and QGIS internal representations. * @@ -59,14 +60,16 @@ class CORE_EXPORT QgsOgcUtils GML_3_2_1, }; - /** Static method that creates geometry from GML + /** + * Static method that creates geometry from GML \param xmlString xml representation of the geometry. GML elements are expected to be in default namespace (\verbatim {... \endverbatim) or in "gml" namespace (\verbatim ... \endverbatim) */ static QgsGeometry geometryFromGML( const QString &xmlString ); - /** Static method that creates geometry from GML + /** + * Static method that creates geometry from GML */ static QgsGeometry geometryFromGML( const QDomNode &geometryNode ); @@ -76,7 +79,8 @@ class CORE_EXPORT QgsOgcUtils //! Read rectangle from GML3 Envelope static QgsRectangle rectangleFromGMLEnvelope( const QDomNode &envelopeNode ); - /** Exports the geometry to GML + /** + * Exports the geometry to GML \returns QDomElement \since QGIS 2.16 */ @@ -87,22 +91,26 @@ class CORE_EXPORT QgsOgcUtils const QString &gmlIdBase, int precision = 17 ); - /** Exports the geometry to GML2 or GML3 + /** + * Exports the geometry to GML2 or GML3 \returns QDomElement */ static QDomElement geometryToGML( const QgsGeometry &geometry, QDomDocument &doc, const QString &format, int precision = 17 ); - /** Exports the geometry to GML2 + /** + * Exports the geometry to GML2 \returns QDomElement */ static QDomElement geometryToGML( const QgsGeometry &geometry, QDomDocument &doc, int precision = 17 ); - /** Exports the rectangle to GML2 Box + /** + * Exports the rectangle to GML2 Box \returns QDomElement */ static QDomElement rectangleToGMLBox( QgsRectangle *box, QDomDocument &doc, int precision = 17 ); - /** Exports the rectangle to GML2 Box + /** + * Exports the rectangle to GML2 Box \returns QDomElement \since QGIS 2.16 */ @@ -111,12 +119,14 @@ class CORE_EXPORT QgsOgcUtils bool invertAxisOrientation, int precision = 17 ); - /** Exports the rectangle to GML3 Envelope + /** + * Exports the rectangle to GML3 Envelope \returns QDomElement */ static QDomElement rectangleToGMLEnvelope( QgsRectangle *env, QDomDocument &doc, int precision = 17 ); - /** Exports the rectangle to GML3 Envelope + /** + * Exports the rectangle to GML3 Envelope \returns QDomElement \since QGIS 2.16 */ @@ -132,14 +142,16 @@ class CORE_EXPORT QgsOgcUtils //! Parse XML with OGC filter into QGIS expression static QgsExpression *expressionFromOgcFilter( const QDomElement &element ) SIP_FACTORY; - /** Creates OGC filter XML element. Supports minimum standard filter + /** + * Creates OGC filter XML element. Supports minimum standard filter * according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT) * \returns valid \verbatim \endverbatim QDomElement on success, * otherwise null QDomElement */ static QDomElement expressionToOgcFilter( const QgsExpression &exp, QDomDocument &doc, QString *errorMessage = nullptr ); - /** OGC filter version + /** + * OGC filter version */ enum FilterVersion { @@ -148,7 +160,8 @@ class CORE_EXPORT QgsOgcUtils FILTER_FES_2_0 }; - /** Creates OGC filter XML element. Supports minimum standard filter + /** + * Creates OGC filter XML element. Supports minimum standard filter * according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT) * \returns valid \verbatim \endverbatim QDomElement on success, * otherwise null QDomElement @@ -165,13 +178,15 @@ class CORE_EXPORT QgsOgcUtils bool invertAxisOrientation, QString *errorMessage = nullptr ) SIP_SKIP; - /** Creates an OGC expression XML element. + /** + * Creates an OGC expression XML element. * \returns valid OGC expression QDomElement on success, * otherwise null QDomElement */ static QDomElement expressionToOgcExpression( const QgsExpression &exp, QDomDocument &doc, QString *errorMessage = nullptr ); - /** Creates an OGC expression XML element. + /** + * Creates an OGC expression XML element. * \returns valid OGC expression QDomElement on success, * otherwise null QDomElement */ @@ -187,7 +202,8 @@ class CORE_EXPORT QgsOgcUtils #ifndef SIP_RUN - /** \ingroup core + /** + * \ingroup core * Layer properties. Used by SQLStatementToOgcFilter(). * \since QGIS 2.16 * \note not available in Python bindings @@ -207,7 +223,8 @@ class CORE_EXPORT QgsOgcUtils }; #endif - /** Creates OGC filter XML element from the WHERE and JOIN clauses of a SQL + /** + * Creates OGC filter XML element from the WHERE and JOIN clauses of a SQL * statement. Supports minimum standard filter * according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT,LIKE,BETWEEN,IN) * Supports layer joins. @@ -249,13 +266,15 @@ class CORE_EXPORT QgsOgcUtils //! Static method that creates geometry from GML MultiPolygon static QgsGeometry geometryFromGMLMultiPolygon( const QDomElement &geometryElement ); - /** Reads the \verbatim \endverbatim element and extracts the coordinates as points + /** + * Reads the \verbatim \endverbatim element and extracts the coordinates as points \param coords list where the found coordinates are appended \param elem the \verbatim \endverbatim element \returns boolean for success*/ static bool readGMLCoordinates( QgsPolyline &coords, const QDomElement &elem ); - /** Reads the \verbatim \endverbatim or \verbatim \endverbatim + /** + * Reads the \verbatim \endverbatim or \verbatim \endverbatim and extracts the coordinates as points \param coords list where the found coordinates are appended \param elem the \verbatim \endverbatim or @@ -264,13 +283,15 @@ class CORE_EXPORT QgsOgcUtils static bool readGMLPositions( QgsPolyline &coords, const QDomElement &elem ); - /** Create a GML coordinates element from a point list. + /** + * Create a GML coordinates element from a point list. \param points list of data points \param doc the GML document \returns QDomElement */ static QDomElement createGMLCoordinates( const QgsPolyline &points, QDomDocument &doc ); - /** Create a GML pos or posList element from a point list. + /** + * Create a GML pos or posList element from a point list. \param points list of data points \param doc the GML document \returns QDomElement */ @@ -298,7 +319,8 @@ class CORE_EXPORT QgsOgcUtils #ifndef SIP_RUN -/** \ingroup core +/** + * \ingroup core * Internal use by QgsOgcUtils * \note not available in Python bindings */ @@ -344,7 +366,8 @@ class QgsOgcUtilsExprToFilter QDomElement expressionFunctionToOgcFilter( const QgsExpressionNodeFunction *node ); }; -/** \ingroup core +/** + * \ingroup core * Internal use by QgsOgcUtils * \note not available in Python bindings */ diff --git a/src/core/qgsogrutils.h b/src/core/qgsogrutils.h index 33aabe8963e4..d90646e63f0a 100644 --- a/src/core/qgsogrutils.h +++ b/src/core/qgsogrutils.h @@ -25,7 +25,8 @@ #include "cpl_conv.h" #include "cpl_string.h" -/** \ingroup core +/** + * \ingroup core * \class QgsOgrUtils * \brief Utilities for working with OGR features and layers * @@ -37,7 +38,8 @@ class CORE_EXPORT QgsOgrUtils { public: - /** Reads an OGR feature and converts it to a QgsFeature. + /** + * Reads an OGR feature and converts it to a QgsFeature. * \param ogrFet OGR feature handle * \param fields fields collection corresponding to feature * \param encoding text encoding @@ -45,14 +47,16 @@ class CORE_EXPORT QgsOgrUtils */ static QgsFeature readOgrFeature( OGRFeatureH ogrFet, const QgsFields &fields, QTextCodec *encoding ); - /** Reads an OGR feature and returns a corresponding fields collection. + /** + * Reads an OGR feature and returns a corresponding fields collection. * \param ogrFet OGR feature handle * \param encoding text encoding * \returns fields collection if read was successful */ static QgsFields readOgrFields( OGRFeatureH ogrFet, QTextCodec *encoding ); - /** Retrieves an attribute value from an OGR feature. + /** + * Retrieves an attribute value from an OGR feature. * \param ogrFet OGR feature handle * \param fields fields collection corresponding to feature * \param attIndex index of attribute to retrieve @@ -63,7 +67,8 @@ class CORE_EXPORT QgsOgrUtils */ static QVariant getOgrFeatureAttribute( OGRFeatureH ogrFet, const QgsFields &fields, int attIndex, QTextCodec *encoding, bool *ok = 0 ); - /** Reads all attributes from an OGR feature into a QgsFeature. + /** + * Reads all attributes from an OGR feature into a QgsFeature. * \param ogrFet OGR feature handle * \param fields fields collection corresponding to feature * \param feature QgsFeature to store attributes in @@ -73,7 +78,8 @@ class CORE_EXPORT QgsOgrUtils */ static bool readOgrFeatureAttributes( OGRFeatureH ogrFet, const QgsFields &fields, QgsFeature &feature, QTextCodec *encoding ); - /** Reads the geometry from an OGR feature into a QgsFeature. + /** + * Reads the geometry from an OGR feature into a QgsFeature. * \param ogrFet OGR feature handle * \param feature QgsFeature to store geometry in * \returns true if geometry read was successful @@ -82,7 +88,8 @@ class CORE_EXPORT QgsOgrUtils */ static bool readOgrFeatureGeometry( OGRFeatureH ogrFet, QgsFeature &feature ); - /** Converts an OGR geometry representation to a QgsGeometry object + /** + * Converts an OGR geometry representation to a QgsGeometry object * \param geom OGR geometry handle * \returns QgsGeometry object. If conversion was not successful the geometry * will be empty. @@ -90,7 +97,8 @@ class CORE_EXPORT QgsOgrUtils */ static QgsGeometry ogrGeometryToQgsGeometry( OGRGeometryH geom ); - /** Attempts to parse a string representing a collection of features using OGR. For example, this method can be + /** + * Attempts to parse a string representing a collection of features using OGR. For example, this method can be * used to convert a GeoJSON encoded collection to a list of QgsFeatures. * \param string string to parse * \param fields fields collection to use for parsed features (\see stringToFields()) @@ -100,7 +108,8 @@ class CORE_EXPORT QgsOgrUtils */ static QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields, QTextCodec *encoding ); - /** Attempts to retrieve the fields from a string representing a collection of features using OGR. + /** + * Attempts to retrieve the fields from a string representing a collection of features using OGR. * \param string string to parse * \param encoding text encoding * \returns retrieved fields collection, or an empty list if no fields could be determined from the string diff --git a/src/core/qgsowsconnection.h b/src/core/qgsowsconnection.h index d9ec6692c59c..d086734cfb23 100644 --- a/src/core/qgsowsconnection.h +++ b/src/core/qgsowsconnection.h @@ -28,7 +28,8 @@ #include #include -/** \ingroup core +/** + * \ingroup core * \brief Connections management */ class CORE_EXPORT QgsOwsConnection : public QObject diff --git a/src/core/qgspaintenginehack.h b/src/core/qgspaintenginehack.h index 82d156872586..6e4e719e5061 100644 --- a/src/core/qgspaintenginehack.h +++ b/src/core/qgspaintenginehack.h @@ -18,7 +18,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * Hack to workaround Qt #5114 by disabling PatternTransform */ class CORE_EXPORT QgsPaintEngineHack : public QPaintEngine diff --git a/src/core/qgspainting.h b/src/core/qgspainting.h index 8d42e0b3d3e6..d8bf2920eb3d 100644 --- a/src/core/qgspainting.h +++ b/src/core/qgspainting.h @@ -15,7 +15,8 @@ class CORE_EXPORT QgsPainting { public: - /** Blending modes enum defining the available composition modes that can + /** + * Blending modes enum defining the available composition modes that can * be used when rendering a layer */ enum BlendMode diff --git a/src/core/qgspalgeometry.h b/src/core/qgspalgeometry.h index a7c8e7d962b6..56f091da3e22 100644 --- a/src/core/qgspalgeometry.h +++ b/src/core/qgspalgeometry.h @@ -44,7 +44,8 @@ class QgsTextLabelFeature : public QgsLabelFeature delete mFontMetrics; } - /** Returns the text component corresponding to a specified label part + /** + * Returns the text component corresponding to a specified label part * \param partId Set to -1 for labels which are not broken into parts (e.g., non-curved labels), or the required * part index for labels which are broken into parts (curved labels) * \since QGIS 2.10 diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h index ce3ae2904112..8f029165925a 100644 --- a/src/core/qgspallabeling.h +++ b/src/core/qgspallabeling.h @@ -73,7 +73,8 @@ class QgsVectorLayerDiagramProvider; class QgsExpressionContext; -/** \ingroup core +/** + * \ingroup core * \class QgsLabelPosition */ class CORE_EXPORT QgsLabelPosition @@ -114,7 +115,8 @@ class CORE_EXPORT QgsLabelPosition }; -/** \ingroup core +/** + * \ingroup core * \class QgsPalLayerSettings */ class CORE_EXPORT QgsPalLayerSettings @@ -127,7 +129,8 @@ class CORE_EXPORT QgsPalLayerSettings //! copy operator - only copies the permanent members QgsPalLayerSettings &operator=( const QgsPalLayerSettings &s ); - /** Placement modes which determine how label candidates are generated for a feature. + /** + * Placement modes which determine how label candidates are generated for a feature. */ //TODO QGIS 3.0 - move to QgsLabelingEngine enum Placement @@ -171,7 +174,8 @@ class CORE_EXPORT QgsPalLayerSettings FromSymbolBounds, //!< Offset distance applies from rendered symbol bounds }; - /** Line placement flags, which control how candidates are generated for a linear feature. + /** + * Line placement flags, which control how candidates are generated for a linear feature. */ //TODO QGIS 3.0 - move to QgsLabelingEngine, rename to LinePlacementFlag, use Q_DECLARE_FLAGS to make //LinePlacementFlags type, and replace use of pal::LineArrangementFlag @@ -225,7 +229,8 @@ class CORE_EXPORT QgsPalLayerSettings will be drawn with right alignment*/ }; - /** Valid obstacle types, which affect how features within the layer will act as obstacles + /** + * Valid obstacle types, which affect how features within the layer will act as obstacles * for labels. */ //TODO QGIS 3.0 - Move to QgsLabelingEngine @@ -366,7 +371,8 @@ class CORE_EXPORT QgsPalLayerSettings */ static const QgsPropertiesDefinition &propertyDefinitions(); - /** Whether to draw labels for this layer. For some layers it may be desirable + /** + * Whether to draw labels for this layer. For some layers it may be desirable * to register their features as obstacles for other labels without requiring * labels to be drawn for the layer itself. In this case drawLabels can be set * to false and obstacle set to true, which will result in the layer acting @@ -725,7 +731,8 @@ class CORE_EXPORT QgsPalLayerSettings // called from register feature hook void calculateLabelSize( const QFontMetricsF *fm, QString text, double &labelX, double &labelY, QgsFeature *f = nullptr, QgsRenderContext *context = nullptr ); - /** Register a feature for labeling. + /** + * Register a feature for labeling. * \param f feature to label * \param context render context. The QgsExpressionContext contained within the render context * must have already had the feature and fields sets prior to calling this method. @@ -741,43 +748,50 @@ class CORE_EXPORT QgsPalLayerSettings QgsLabelFeature **labelFeature SIP_PYARGREMOVE = nullptr, QgsGeometry obstacleGeometry SIP_PYARGREMOVE = QgsGeometry() ); - /** Read settings from a DOM element + /** + * Read settings from a DOM element * \since QGIS 2.12 */ void readXml( QDomElement &elem, const QgsReadWriteContext &context ); - /** Write settings into a DOM element + /** + * Write settings into a DOM element * \since QGIS 2.12 */ QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ); - /** Returns a reference to the label's property collection, used for data defined overrides. + /** + * Returns a reference to the label's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } - /** Returns a reference to the label's property collection, used for data defined overrides. + /** + * Returns a reference to the label's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() * \note not available in Python bindings */ const QgsPropertyCollection &dataDefinedProperties() const SIP_SKIP { return mDataDefinedProperties; } - /** Sets the label's property collection, used for data defined overrides. + /** + * Sets the label's property collection, used for data defined overrides. * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 * \see dataDefinedProperties() */ void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; } - /** Returns the label text formatting settings, e.g., font settings, buffer settings, etc. + /** + * Returns the label text formatting settings, e.g., font settings, buffer settings, etc. * \see setFormat() * \since QGIS 3.0 */ const QgsTextFormat &format() const { return mFormat; } - /** Sets the label text formatting settings, e.g., font settings, buffer settings, etc. + /** + * Sets the label text formatting settings, e.g., font settings, buffer settings, etc. * \param format label text format * \see format() * \since QGIS 3.0 @@ -802,7 +816,8 @@ class CORE_EXPORT QgsPalLayerSettings friend class QgsVectorLayer; // to allow calling readFromLayerCustomProperties() - /** Reads labeling configuration from layer's custom properties to support loading of simple labeling from QGIS 2.x projects. + /** + * Reads labeling configuration from layer's custom properties to support loading of simple labeling from QGIS 2.x projects. * \since QGIS 3.0 */ void readFromLayerCustomProperties( QgsVectorLayer *layer ); @@ -851,11 +866,13 @@ class CORE_EXPORT QgsPalLayerSettings void parseDropShadow( QgsRenderContext &context ); - /** Checks if a feature is larger than a minimum size (in mm) + /** + * Checks if a feature is larger than a minimum size (in mm) \returns true if above size, false if below*/ bool checkMinimumSizeMM( const QgsRenderContext &ct, const QgsGeometry &geom, double minSize ) const; - /** Registers a feature as an obstacle only (no label rendered) + /** + * Registers a feature as an obstacle only (no label rendered) */ void registerObstacleFeature( QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **obstacleFeature, const QgsGeometry &obstacleGeometry = QgsGeometry() ); @@ -879,7 +896,8 @@ class CORE_EXPORT QgsPalLayerSettings }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsLabelCandidate { @@ -893,7 +911,8 @@ class CORE_EXPORT QgsLabelCandidate -/** \ingroup core +/** + * \ingroup core * Class that stores computed placement from labeling engine. * \since QGIS 2.4 */ @@ -925,7 +944,8 @@ class CORE_EXPORT QgsLabelingResults friend class QgsVectorLayerDiagramProvider; }; -/** \ingroup core +/** + * \ingroup core * \class QgsPalLabeling */ class CORE_EXPORT QgsPalLabeling @@ -941,7 +961,8 @@ class CORE_EXPORT QgsPalLabeling //! \note not available in Python bindings static void drawLabelCandidateRect( pal::LabelPosition *lp, QPainter *painter, const QgsMapToPixel *xform, QList *candidates = nullptr ) SIP_SKIP; - /** Prepares a geometry for registration with PAL. Handles reprojection, rotation, clipping, etc. + /** + * Prepares a geometry for registration with PAL. Handles reprojection, rotation, clipping, etc. * \param geometry geometry to prepare * \param context render context * \param ct coordinate transform, or invalid transform if no transformation required @@ -951,7 +972,8 @@ class CORE_EXPORT QgsPalLabeling */ static QgsGeometry prepareGeometry( const QgsGeometry &geometry, QgsRenderContext &context, const QgsCoordinateTransform &ct, const QgsGeometry &clipGeometry = QgsGeometry() ) SIP_FACTORY; - /** Checks whether a geometry requires preparation before registration with PAL + /** + * Checks whether a geometry requires preparation before registration with PAL * \param geometry geometry to prepare * \param context render context * \param ct coordinate transform, or invalid transform if no transformation required @@ -961,7 +983,8 @@ class CORE_EXPORT QgsPalLabeling */ static bool geometryRequiresPreparation( const QgsGeometry &geometry, QgsRenderContext &context, const QgsCoordinateTransform &ct, const QgsGeometry &clipGeometry = QgsGeometry() ); - /** Splits a text string to a list of separate lines, using a specified wrap character. + /** + * Splits a text string to a list of separate lines, using a specified wrap character. * The text string will be split on either newline characters or the wrap character. * \param text text string to split * \param wrapCharacter additional character to wrap on @@ -970,7 +993,8 @@ class CORE_EXPORT QgsPalLabeling */ static QStringList splitToLines( const QString &text, const QString &wrapCharacter ); - /** Splits a text string to a list of graphemes, which are the smallest allowable character + /** + * Splits a text string to a list of graphemes, which are the smallest allowable character * divisions in the string. This accounts for scripts were individual characters are not * allowed to be split apart (e.g., Arabic and Indic based scripts) * \param text string to split @@ -1003,7 +1027,8 @@ class CORE_EXPORT QgsPalLabeling friend class QgsVectorLayerLabelProvider; // to allow calling the static methods above friend class QgsDxfExport; // to allow calling the static methods above - /** Checks whether a geometry exceeds the minimum required size for a geometry to be labeled. + /** + * Checks whether a geometry exceeds the minimum required size for a geometry to be labeled. * \param context render context * \param geom geometry * \param minSize minimum size for geometry diff --git a/src/core/qgspathresolver.h b/src/core/qgspathresolver.h index 18a8597844ac..34b009f80707 100644 --- a/src/core/qgspathresolver.h +++ b/src/core/qgspathresolver.h @@ -21,7 +21,8 @@ #include -/** \ingroup core +/** + * \ingroup core * Resolves relative paths into absolute paths and vice versa. Used for writing * * \since QGIS 3.0 diff --git a/src/core/qgspluginlayer.h b/src/core/qgspluginlayer.h index daca7b9efbb2..e3cc65f67920 100644 --- a/src/core/qgspluginlayer.h +++ b/src/core/qgspluginlayer.h @@ -19,7 +19,8 @@ #include "qgsmaplayer.h" -/** \ingroup core +/** + * \ingroup core Base class for plugin layers. These can be implemented by plugins and registered in QgsPluginLayerRegistry. @@ -35,7 +36,8 @@ class CORE_EXPORT QgsPluginLayer : public QgsMapLayer QgsPluginLayer( const QString &layerType, const QString &layerName = QString() ); ~QgsPluginLayer(); - /** Returns a new instance equivalent to this one. + /** + * Returns a new instance equivalent to this one. * \returns a new layer instance * \since QGIS 3.0 */ @@ -47,7 +49,8 @@ class CORE_EXPORT QgsPluginLayer : public QgsMapLayer //! Set extent of the layer void setExtent( const QgsRectangle &extent ) override; - /** Set source string. This is used for example in layer tree to show tooltip. + /** + * Set source string. This is used for example in layer tree to show tooltip. * \since QGIS 2.16 */ void setSource( const QString &source ); diff --git a/src/core/qgspluginlayerregistry.h b/src/core/qgspluginlayerregistry.h index 9740b68c6312..c8050edb77a9 100644 --- a/src/core/qgspluginlayerregistry.h +++ b/src/core/qgspluginlayerregistry.h @@ -27,7 +27,8 @@ class QgsPluginLayer; -/** \ingroup core +/** + * \ingroup core class for creating plugin specific layers */ class CORE_EXPORT QgsPluginLayerType @@ -42,7 +43,8 @@ class CORE_EXPORT QgsPluginLayerType //! Return new layer of this type. Return NULL on error virtual QgsPluginLayer *createLayer() SIP_FACTORY; - /** Return new layer of this type, using layer URI (specific to this plugin layer type). Return NULL on error. + /** + * Return new layer of this type, using layer URI (specific to this plugin layer type). Return NULL on error. * \since QGIS 2.10 */ virtual QgsPluginLayer *createLayer( const QString &uri ) SIP_FACTORY; @@ -56,7 +58,8 @@ class CORE_EXPORT QgsPluginLayerType //============================================================================= -/** \ingroup core +/** + * \ingroup core * A registry of plugin layers types. * * QgsPluginLayerRegistry is not usually directly created, but rather accessed through @@ -77,7 +80,8 @@ class CORE_EXPORT QgsPluginLayerRegistry //! QgsPluginLayerRegistry cannot be copied. QgsPluginLayerRegistry &operator=( const QgsPluginLayerRegistry &rh ) = delete; - /** List all known layer types + /** + * List all known layer types * \since QGIS */ QStringList pluginLayerTypes(); @@ -90,7 +94,8 @@ class CORE_EXPORT QgsPluginLayerRegistry //! Return plugin layer type metadata or NULL if doesn't exist QgsPluginLayerType *pluginLayerType( const QString &typeName ); - /** Returns new layer if corresponding plugin has been found else returns a nullptr. + /** + * Returns new layer if corresponding plugin has been found else returns a nullptr. * \note parameter uri has been added in QGIS 2.10 */ QgsPluginLayer *createLayer( const QString &typeName, const QString &uri = QString() ) SIP_FACTORY; diff --git a/src/core/qgspointlocator.cpp b/src/core/qgspointlocator.cpp index 9e3863a07a8f..aace5da33925 100644 --- a/src/core/qgspointlocator.cpp +++ b/src/core/qgspointlocator.cpp @@ -54,7 +54,8 @@ static const double POINT_LOC_EPSILON = 1e-12; //////////////////////////////////////////////////////////////////////////// -/** \ingroup core +/** + * \ingroup core * Helper class for bulk loading of R-trees. * \note not available in Python bindings */ @@ -81,7 +82,8 @@ class QgsPointLocator_Stream : public IDataStream //////////////////////////////////////////////////////////////////////////// -/** \ingroup core +/** + * \ingroup core * Helper class used when traversing the index looking for vertices - builds a list of matches. * \note not available in Python bindings */ @@ -129,7 +131,8 @@ class QgsPointLocator_VisitorNearestVertex : public IVisitor //////////////////////////////////////////////////////////////////////////// -/** \ingroup core +/** + * \ingroup core * Helper class used when traversing the index looking for edges - builds a list of matches. * \note not available in Python bindings */ @@ -179,7 +182,8 @@ class QgsPointLocator_VisitorNearestEdge : public IVisitor //////////////////////////////////////////////////////////////////////////// -/** \ingroup core +/** + * \ingroup core * Helper class used when traversing the index with areas - builds a list of matches. * \note not available in Python bindings */ @@ -520,7 +524,8 @@ static QgsPointLocator::MatchList _geometrySegmentsInRect( QgsGeometry *geom, co return lst; } -/** \ingroup core +/** + * \ingroup core * Helper class used when traversing the index looking for edges - builds a list of matches. * \note not available in Python bindings */ @@ -564,7 +569,8 @@ class QgsPointLocator_VisitorEdgesInRect : public IVisitor //////////////////////////////////////////////////////////////////////////// #include -/** \ingroup core +/** + * \ingroup core * Helper class to dump the R-index nodes and their content * \note not available in Python bindings */ diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h index 909489890576..dae55e2df357 100644 --- a/src/core/qgspointlocator.h +++ b/src/core/qgspointlocator.h @@ -36,7 +36,8 @@ namespace SpatialIndex SIP_SKIP class ISpatialIndex; } -/** \ingroup core +/** + * \ingroup core * \brief The class defines interface for querying point location: * - query nearest vertices / edges to a point * - query vertices / edges in rectangle @@ -51,7 +52,8 @@ class CORE_EXPORT QgsPointLocator : public QObject Q_OBJECT public: - /** Construct point locator for a \a layer. + /** + * Construct point locator for a \a layer. * * If a valid QgsCoordinateReferenceSystem is passed for \a destinationCrs then the locator will * do the searches on data reprojected to the given CRS. @@ -101,7 +103,8 @@ class CORE_EXPORT QgsPointLocator : public QObject Q_DECLARE_FLAGS( Types, Type ) - /** Prepare the index for queries. Does nothing if the index already exists. + /** + * Prepare the index for queries. Does nothing if the index already exists. * If the number of features is greater than the value of maxFeaturesToIndex, creation of index is stopped * to make sure we do not run out of memory. If maxFeaturesToIndex is -1, no limits are used. Returns * false if the creation of index has been prematurely stopped due to the limit of features, otherwise true */ diff --git a/src/core/qgspointxy.h b/src/core/qgspointxy.h index cb8d90c40b4f..e1d73c33eb69 100644 --- a/src/core/qgspointxy.h +++ b/src/core/qgspointxy.h @@ -30,7 +30,8 @@ class QgsPoint; -/** \ingroup core +/** + * \ingroup core * A class to represent a 2D point. * * A QgsPointXY represents a position with X and Y coordinates. @@ -54,7 +55,8 @@ class CORE_EXPORT QgsPointXY //! Create a point from another point QgsPointXY( const QgsPointXY &p ); - /** Create a point from x,y coordinates + /** + * Create a point from x,y coordinates * \param x x coordinate * \param y y coordinate */ @@ -63,7 +65,8 @@ class CORE_EXPORT QgsPointXY , mY( y ) {} - /** Create a point from a QPointF + /** + * Create a point from a QPointF * \param point QPointF source * \since QGIS 2.7 */ @@ -72,7 +75,8 @@ class CORE_EXPORT QgsPointXY , mY( point.y() ) {} - /** Create a point from a QPoint + /** + * Create a point from a QPoint * \param point QPoint source * \since QGIS 2.7 */ @@ -94,7 +98,8 @@ class CORE_EXPORT QgsPointXY // see https://github.com/qgis/QGIS/pull/4720#issuecomment-308652392 ~QgsPointXY() = default; - /** Sets the x value of the point + /** + * Sets the x value of the point * \param x x coordinate */ void setX( double x ) @@ -102,7 +107,8 @@ class CORE_EXPORT QgsPointXY mX = x; } - /** Sets the y value of the point + /** + * Sets the y value of the point * \param y y coordinate */ void setY( double y ) @@ -117,7 +123,8 @@ class CORE_EXPORT QgsPointXY mY = y; } - /** Get the x value of the point + /** + * Get the x value of the point * \returns x coordinate */ double x() const @@ -125,7 +132,8 @@ class CORE_EXPORT QgsPointXY return mX; } - /** Get the y value of the point + /** + * Get the y value of the point * \returns y coordinate */ double y() const @@ -133,7 +141,8 @@ class CORE_EXPORT QgsPointXY return mY; } - /** Converts a point to a QPointF + /** + * Converts a point to a QPointF * \returns QPointF with same x and y values * \since QGIS 2.7 */ @@ -145,7 +154,8 @@ class CORE_EXPORT QgsPointXY //! As above but with precision for string representation of a point QString toString( int precision ) const; - /** Return a string representation as degrees minutes seconds. + /** + * Return a string representation as degrees minutes seconds. * Its up to the calling function to ensure that this point can * be meaningfully represented in this form. * \param precision number of decimal points to use for seconds @@ -156,7 +166,8 @@ class CORE_EXPORT QgsPointXY */ QString toDegreesMinutesSeconds( int precision, const bool useSuffix = true, const bool padded = false ) const; - /** Return a string representation as degrees minutes. + /** + * Return a string representation as degrees minutes. * Its up to the calling function to ensure that this point can * be meaningfully represented in this form. * \param precision number of decimal points to use for minutes @@ -168,23 +179,27 @@ class CORE_EXPORT QgsPointXY QString toDegreesMinutes( int precision, const bool useSuffix = true, const bool padded = false ) const; - /** Return the well known text representation for the point. + /** + * Return the well known text representation for the point. * The wkt is created without an SRID. * \returns Well known text in the form POINT(x y) */ QString wellKnownText() const; - /** Returns the squared distance between this point a specified x, y coordinate. + /** + * Returns the squared distance between this point a specified x, y coordinate. * \see distance() */ double sqrDist( double x, double y ) const; - /** Returns the squared distance between this point another point. + /** + * Returns the squared distance between this point another point. * \see distance() */ double sqrDist( const QgsPointXY &other ) const; - /** Returns the distance between this point and a specified x, y coordinate. + /** + * Returns the distance between this point and a specified x, y coordinate. * \param x x-coordniate * \param y y-coordinate * \see sqrDist() @@ -192,7 +207,8 @@ class CORE_EXPORT QgsPointXY */ double distance( double x, double y ) const; - /** Returns the distance between this point and another point. + /** + * Returns the distance between this point and another point. * \param other other point * \see sqrDist() * \since QGIS 2.16 @@ -205,7 +221,8 @@ class CORE_EXPORT QgsPointXY //! Calculates azimuth between this point and other one (clockwise in degree, starting from north) double azimuth( const QgsPointXY &other ) const; - /** Returns a new point which corresponds to this point projected by a specified distance + /** + * Returns a new point which corresponds to this point projected by a specified distance * in a specified bearing. * \param distance distance to project * \param bearing angle to project in, clockwise in degrees starting from north @@ -213,7 +230,8 @@ class CORE_EXPORT QgsPointXY */ QgsPointXY project( double distance, double bearing ) const; - /** Compares this point with another point with a fuzzy tolerance + /** + * Compares this point with another point with a fuzzy tolerance * \param other point to compare with * \param epsilon maximum difference for coordinates between the points * \returns true if points are equal within specified tolerance diff --git a/src/core/qgsproject.cpp b/src/core/qgsproject.cpp index b33494b90ca7..02a73ed25b34 100644 --- a/src/core/qgsproject.cpp +++ b/src/core/qgsproject.cpp @@ -186,7 +186,8 @@ QgsProjectProperty *findKey_( const QString &scope, -/** Add the given key and value +/** + * Add the given key and value @param scope scope of key @param key key name diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h index a644353fbcd0..7b6cb23d41f9 100644 --- a/src/core/qgsproject.h +++ b/src/core/qgsproject.h @@ -62,7 +62,8 @@ class QgsLayoutManager; class QgsLayerTree; class QgsLabelingEngineSettings; -/** \ingroup core +/** + * \ingroup core * Reads and writes project states. * \note @@ -102,14 +103,16 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera ~QgsProject(); - /** Sets the project's title. + /** + * Sets the project's title. * \param title new title * \since QGIS 2.4 * \see title() */ void setTitle( const QString &title ); - /** Returns the project's title. + /** + * Returns the project's title. * \see setTitle() */ QString title() const; @@ -119,21 +122,24 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ bool isDirty() const; - /** Sets the file name associated with the project. This is the file which contains the project's XML + /** + * Sets the file name associated with the project. This is the file which contains the project's XML * representation. * \param name project file name * \see fileName() */ void setFileName( const QString &name ); - /** Returns the project's file name. This is the file which contains the project's XML + /** + * Returns the project's file name. This is the file which contains the project's XML * representation. * \see setFileName() * \see fileInfo() */ QString fileName() const; - /** Returns QFileInfo object for the project's associated file. + /** + * Returns QFileInfo object for the project's associated file. * \see fileName() * \since QGIS 2.9 */ @@ -171,23 +177,27 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ void setEllipsoid( const QString &ellipsoid ); - /** Clear the project - removes all settings and resets it back to an empty, default state. + /** + * Clear the project - removes all settings and resets it back to an empty, default state. * \since QGIS 2.4 */ void clear(); - /** Reads given project file from the given file. + /** + * Reads given project file from the given file. * \param filename name of project file to read * \returns true if project file has been read successfully */ bool read( const QString &filename ); - /** Reads the project from its currently associated file (see fileName() ). + /** + * Reads the project from its currently associated file (see fileName() ). * \returns true if project file has been read successfully */ bool read(); - /** Reads the layer described in the associated DOM node. + /** + * Reads the layer described in the associated DOM node. * * \note This method is mainly for use by QgsProjectBadLayerHandler subclasses * that may fix definition of bad layers with the user's help in GUI. Calling @@ -208,7 +218,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ bool write( const QString &filename ); - /** Writes the project to its current associated file (see fileName() ). + /** + * Writes the project to its current associated file (see fileName() ). * \note isDirty() will be set to false if project is successfully written * \returns true if project was written successfully */ @@ -284,26 +295,30 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera bool removeEntry( const QString &scope, const QString &key ); - /** Return keys with values -- do not return keys that contain other keys + /** + * Return keys with values -- do not return keys that contain other keys * * \note equivalent to QgsSettings entryList() */ QStringList entryList( const QString &scope, const QString &key ) const; - /** Return keys with keys -- do not return keys that contain only values + /** + * Return keys with keys -- do not return keys that contain only values * * \note equivalent to QgsSettings subkeyList() */ QStringList subkeyList( const QString &scope, const QString &key ) const; - /** Dump out current project properties to stderr + /** + * Dump out current project properties to stderr */ // TODO Now slightly broken since re-factoring. Won't print out top-level key // and redundantly prints sub-keys. void dumpProperties() const; - /** Return path resolver object with considering whether the project uses absolute + /** + * Return path resolver object with considering whether the project uses absolute * or relative paths and using current project's path. * \since QGIS 3.0 */ @@ -322,7 +337,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera //! Return error message from previous read/write QString error() const; - /** Change handler for missing layers. + /** + * Change handler for missing layers. * Deletes old handler and takes ownership of the new one. */ void setBadLayerHandler( QgsProjectBadLayerHandler *handler SIP_TRANSFER ); @@ -330,14 +346,16 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera //! Returns project file path if layer is embedded from other project file. Returns empty string if layer is not embedded QString layerIsEmbedded( const QString &id ) const; - /** Creates a maplayer instance defined in an arbitrary project file. Caller takes ownership + /** + * Creates a maplayer instance defined in an arbitrary project file. Caller takes ownership * \returns the layer or 0 in case of error * \note not available in Python bindings */ bool createEmbeddedLayer( const QString &layerId, const QString &projectFilePath, QList &brokenNodes, bool saveFlag = true ) SIP_SKIP; - /** Create layer group instance defined in an arbitrary project file. + /** + * Create layer group instance defined in an arbitrary project file. * \since QGIS 2.4 */ QgsLayerTreeGroup *createEmbeddedGroup( const QString &groupName, const QString &projectFilePath, const QStringList &invisibleLayers ); @@ -348,7 +366,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera //! Convenience function to query topological editing status bool topologicalEditing() const; - /** Convenience function to query default distance measurement units for project. + /** + * Convenience function to query default distance measurement units for project. * \since QGIS 2.14 * \see setDistanceUnits() * \see areaUnits() @@ -363,7 +382,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ void setDistanceUnits( QgsUnitTypes::DistanceUnit unit ); - /** Convenience function to query default area measurement units for project. + /** + * Convenience function to query default area measurement units for project. * \since QGIS 2.14 * \see distanceUnits() */ @@ -377,7 +397,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ void setAreaUnits( QgsUnitTypes::AreaUnit unit ); - /** Return project's home path + /** + * Return project's home path \returns home path of project (or null QString if not set) */ QString homePath() const; @@ -398,17 +419,20 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ QgsLayoutManager *layoutManager(); - /** Return pointer to the root (invisible) node of the project's layer tree + /** + * Return pointer to the root (invisible) node of the project's layer tree * \since QGIS 2.4 */ QgsLayerTree *layerTreeRoot() const; - /** Return pointer to the helper class that synchronizes map layer registry with layer tree + /** + * Return pointer to the helper class that synchronizes map layer registry with layer tree * \since QGIS 2.4 */ QgsLayerTreeRegistryBridge *layerTreeRegistryBridge() const { return mLayerTreeRegistryBridge; } - /** Returns pointer to the project's map theme collection. + /** + * Returns pointer to the project's map theme collection. * \since QGIS 2.12 * \note renamed in QGIS 3.0, formerly QgsVisibilityPresetCollection */ @@ -553,7 +577,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera //! Returns the number of registered layers. int count() const; - /** Retrieve a pointer to a registered layer by layer ID. + /** + * Retrieve a pointer to a registered layer by layer ID. * \param layerId ID of layer to retrieve * \returns matching layer, or nullptr if no matching layer found * \see mapLayersByName() @@ -561,7 +586,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ QgsMapLayer *mapLayer( const QString &layerId ) const; - /** Retrieve a list of matching registered layers by layer name. + /** + * Retrieve a list of matching registered layers by layer name. * \param layerName name of layers to match * \returns list of matching layers * \see mapLayer() @@ -569,7 +595,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ QList mapLayersByName( const QString &layerName ) const; - /** Returns a map of all registered layers by layer ID. + /** + * Returns a map of all registered layers by layer ID. * \see mapLayer() * \see mapLayersByName() * \see layers() @@ -583,7 +610,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera #ifndef SIP_RUN - /** Returns a list of registered map layers with a specified layer type. + /** + * Returns a list of registered map layers with a specified layer type. * * Example: * @@ -750,7 +778,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ void reloadAllLayers(); - /** Returns the default CRS for new layers based on the settings and + /** + * Returns the default CRS for new layers based on the settings and * the current project CRS */ QgsCoordinateReferenceSystem defaultCrsForNewLayers() const; @@ -834,7 +863,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera //! emitted whenever the configuration for snapping has changed void snappingConfigChanged( const QgsSnappingConfig &config ); - /** Emitted whenever the expression variables stored in the project have been changed. + /** + * Emitted whenever the expression variables stored in the project have been changed. * \since QGIS 3.0 */ void customVariablesChanged(); @@ -1026,7 +1056,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera static QgsProject *sProject; - /** Read map layers from project file. + /** + * Read map layers from project file. * \param doc DOM document to parse * \param brokenNodes a list of DOM nodes corresponding to layers that we were unable to load; this could be * because the layers were removed or re-located after the project was last saved @@ -1034,12 +1065,14 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera */ bool _getMapLayers( const QDomDocument &doc, QList &brokenNodes ); - /** Set error message from read/write operation + /** + * Set error message from read/write operation * \note not available in Python bindings */ void setError( const QString &errorMessage ) SIP_SKIP; - /** Clear error message + /** + * Clear error message * \note not available in Python bindings */ void clearError() SIP_SKIP; @@ -1074,7 +1107,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera QgsProjectBadLayerHandler *mBadLayerHandler = nullptr; - /** Embedded layers which are defined in other projects. Key: layer id, + /** + * Embedded layers which are defined in other projects. Key: layer id, * value: pair< project file path, save layer yes / no (e.g. if the layer is part of an embedded group, loading/saving is done by the legend) * If the project file path is empty, QgsProject is going to ignore the layer for saving (e.g. because it is part and managed by an embedded group) */ @@ -1112,7 +1146,8 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera bool mTrustLayerMetadata = false; }; -/** Return the version string found in the given DOM document +/** + * Return the version string found in the given DOM document \returns the version string or an empty string if none found \note not available in Python bindings. */ diff --git a/src/core/qgsprojectbadlayerhandler.h b/src/core/qgsprojectbadlayerhandler.h index 7eb31f58fd5a..3bbdf2636041 100644 --- a/src/core/qgsprojectbadlayerhandler.h +++ b/src/core/qgsprojectbadlayerhandler.h @@ -20,7 +20,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * Interface for classes that handle missing layer files when reading project file. */ class CORE_EXPORT QgsProjectBadLayerHandler diff --git a/src/core/qgsprojectfiletransform.h b/src/core/qgsprojectfiletransform.h index 4ec9af363776..7faf09f60450 100644 --- a/src/core/qgsprojectfiletransform.h +++ b/src/core/qgsprojectfiletransform.h @@ -15,7 +15,8 @@ * * ***************************************************************************/ -/** \ingroup core +/** + * \ingroup core * Class to convert from older project file versions to newer. * This class provides possibility to store a project file as a QDomDocument, * and provides the ability to specify version of the project file, and @@ -34,7 +35,8 @@ class QgsRasterLayer; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsProjectFileTransform { @@ -42,7 +44,8 @@ class CORE_EXPORT QgsProjectFileTransform //Default constructor //QgsProjectfiletransform() {} - /** Create an instance from a Dom and a supplied version + /** + * Create an instance from a Dom and a supplied version * \param domDocument The Dom document to use as content * \param version Version number */ @@ -56,7 +59,8 @@ class CORE_EXPORT QgsProjectFileTransform bool updateRevision( const QgsProjectVersion &version ); - /** Prints the contents via QgsDebugMsg() + /** + * Prints the contents via QgsDebugMsg() */ void dump(); diff --git a/src/core/qgsprojectproperty.h b/src/core/qgsprojectproperty.h index 0a09d4648f45..0743d1c566b8 100644 --- a/src/core/qgsprojectproperty.h +++ b/src/core/qgsprojectproperty.h @@ -248,7 +248,8 @@ class CORE_EXPORT QgsProjectPropertyKey : public QgsProjectProperty return p; } - /** Set the value associated with this key + /** + * Set the value associated with this key * * \note that the single value node associated with each key is always * stored keyed by the current key name diff --git a/src/core/qgsprojectversion.h b/src/core/qgsprojectversion.h index 17bef070f609..e52e0e209e65 100644 --- a/src/core/qgsprojectversion.h +++ b/src/core/qgsprojectversion.h @@ -22,7 +22,8 @@ #include #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * A class to describe the version of a project. * Used in places where you need to check if the current version * of QGIS is greater than the one used to create a project file. @@ -51,19 +52,23 @@ class CORE_EXPORT QgsProjectVersion */ bool isNull() const; - /** Boolean equal operator + /** + * Boolean equal operator */ bool operator==( const QgsProjectVersion &other ) const; - /** Boolean not equal operator + /** + * Boolean not equal operator */ bool operator!=( const QgsProjectVersion &other ) const; - /** Boolean >= operator + /** + * Boolean >= operator */ bool operator>=( const QgsProjectVersion &other ) const; - /** Boolean > operator + /** + * Boolean > operator */ bool operator>( const QgsProjectVersion &other ) const; diff --git a/src/core/qgsprovidermetadata.h b/src/core/qgsprovidermetadata.h index f871192ddacd..dcb85d242f8d 100644 --- a/src/core/qgsprovidermetadata.h +++ b/src/core/qgsprovidermetadata.h @@ -27,7 +27,8 @@ class QgsDataProvider; -/** \ingroup core +/** + * \ingroup core * Holds data provider key, description, and associated shared library file or function pointer information. * * Provider metadata refers either to providers which are loaded via libraries or @@ -63,19 +64,22 @@ class CORE_EXPORT QgsProviderMetadata */ SIP_SKIP QgsProviderMetadata( const QString &key, const QString &description, const QgsProviderMetadata::CreateDataProviderFunction &createFunc ); - /** This returns the unique key associated with the provider + /** + * This returns the unique key associated with the provider This key string is used for the associative container in QgsProviderRegistry */ QString key() const; - /** This returns descriptive text for the provider + /** + * This returns descriptive text for the provider This is used to provide a descriptive list of available data providers. */ QString description() const; - /** This returns the library file name + /** + * This returns the library file name This is used to QLibrary calls to load the data provider. */ diff --git a/src/core/qgsproviderregistry.cpp b/src/core/qgsproviderregistry.cpp index aea595b23883..c3e08d662a9f 100644 --- a/src/core/qgsproviderregistry.cpp +++ b/src/core/qgsproviderregistry.cpp @@ -259,7 +259,8 @@ QgsProviderRegistry::~QgsProviderRegistry() } -/** Convenience function for finding any existing data providers that match "providerKey" +/** + * Convenience function for finding any existing data providers that match "providerKey" Necessary because [] map operator will create a QgsProviderMetadata instance. Also you cannot use the map [] operator in const members for that diff --git a/src/core/qgsproviderregistry.h b/src/core/qgsproviderregistry.h index 6b396fc9f14d..b38c41ca12fd 100644 --- a/src/core/qgsproviderregistry.h +++ b/src/core/qgsproviderregistry.h @@ -35,7 +35,8 @@ class QgsVectorLayer; class QgsCoordinateReferenceSystem; -/** \ingroup core +/** + * \ingroup core * A registry / canonical manager of data providers. * * This is a Singleton class that manages data provider access. @@ -97,7 +98,8 @@ class CORE_EXPORT QgsProviderRegistry QgsDataProvider *createProvider( const QString &providerKey, const QString &dataSource ) SIP_FACTORY; - /** Return the provider capabilities + /** + * Return the provider capabilities \param providerKey identificator of the provider \since QGIS 2.6 */ @@ -138,7 +140,8 @@ class CORE_EXPORT QgsProviderRegistry //! Return metadata of the provider or NULL if not found const QgsProviderMetadata *providerMetadata( const QString &providerKey ) const; - /** Return vector file filter string + /** + * Return vector file filter string Returns a string suitable for a QFileDialog of vector file formats supported by all data providers. @@ -152,7 +155,8 @@ class CORE_EXPORT QgsProviderRegistry */ virtual QString fileVectorFilters() const; - /** Return raster file filter string + /** + * Return raster file filter string Returns a string suitable for a QFileDialog of raster file formats supported by all data providers. @@ -172,7 +176,8 @@ class CORE_EXPORT QgsProviderRegistry void registerGuis( QWidget *widget ); - /** Open the given vector data source + /** + * Open the given vector data source * * Similar to open(QString const &), except that the user specifies a data provider * with which to open the data source instead of using the default data provider @@ -215,7 +220,8 @@ class CORE_EXPORT QgsProviderRegistry //! Directory in which provider plugins are installed QDir mLibraryDirectory; - /** File filter string for vector files + /** + * File filter string for vector files * * Built once when registry is constructed by appending strings returned * from iteratively calling vectorFileFilter() for each visited data @@ -225,24 +231,28 @@ class CORE_EXPORT QgsProviderRegistry */ QString mVectorFileFilters; - /** File filter string for raster files + /** + * File filter string for raster files */ QString mRasterFileFilters; - /** Available database drivers string for vector databases + /** + * Available database drivers string for vector databases * * This is a string of form: * DriverNameToShow,DriverName;DriverNameToShow,DriverName;... */ QString mDatabaseDrivers; - /** Available directory drivers string for vector databases + /** + * Available directory drivers string for vector databases * This is a string of form: * DriverNameToShow,DriverName;DriverNameToShow,DriverName;... */ QString mDirectoryDrivers; - /** Available protocol drivers string for vector databases + /** + * Available protocol drivers string for vector databases * * This is a string of form: * DriverNameToShow,DriverName;DriverNameToShow,DriverName;... diff --git a/src/core/qgspythonrunner.h b/src/core/qgspythonrunner.h index 5d7658cc65d7..2e71fb82ee35 100644 --- a/src/core/qgspythonrunner.h +++ b/src/core/qgspythonrunner.h @@ -20,7 +20,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core Utility class for running Python commands from various parts of QGIS. There is no direct Python support in the core library, so it is expected that application with Python support creates a subclass that implements @@ -33,7 +34,8 @@ class CORE_EXPORT QgsPythonRunner { public: - /** Returns true if the runner has an instance + /** + * Returns true if the runner has an instance (and thus is able to run commands) */ static bool isValid(); @@ -43,7 +45,8 @@ class CORE_EXPORT QgsPythonRunner //! Eval a Python statement static bool eval( const QString &command, QString &result SIP_OUT ); - /** Assign an instance of Python runner so that run() can be used. + /** + * Assign an instance of Python runner so that run() can be used. This method should be called during app initialization. Takes ownership of the object, deletes previous instance. */ static void setInstance( QgsPythonRunner *runner SIP_TRANSFER ); diff --git a/src/core/qgsrelation.h b/src/core/qgsrelation.h index 8b37ce98b038..7a53745c9093 100644 --- a/src/core/qgsrelation.h +++ b/src/core/qgsrelation.h @@ -31,7 +31,8 @@ class QgsFeature; class QgsFeatureRequest; class QgsAttributes; -/** \ingroup core +/** + * \ingroup core * \class QgsRelation */ class CORE_EXPORT QgsRelation @@ -162,7 +163,8 @@ class CORE_EXPORT QgsRelation */ QgsFeatureRequest getRelatedFeaturesRequest( const QgsFeature &feature ) const; - /** Returns a filter expression which returns all the features on the referencing (child) layer + /** + * Returns a filter expression which returns all the features on the referencing (child) layer * which have a foreign key pointing to the provided feature. * \param feature A feature from the referenced (parent) layer * \returns expression filter string for all the referencing features @@ -343,7 +345,8 @@ class CORE_EXPORT QgsRelation //! The parent layer QgsVectorLayer *mReferencedLayer = nullptr; - /** A list of fields which define the relation. + /** + * A list of fields which define the relation. * In most cases there will be only one value, but multiple values * are supported for composited foreign keys. * The first field is on the referencing layer, the second on the referenced */ diff --git a/src/core/qgsrelationmanager.h b/src/core/qgsrelationmanager.h index 2097050ef231..3e153aed47c8 100644 --- a/src/core/qgsrelationmanager.h +++ b/src/core/qgsrelationmanager.h @@ -27,7 +27,8 @@ class QgsProject; class QgsVectorLayer; -/** \ingroup core +/** + * \ingroup core * This class manages a set of relations between layers. */ class CORE_EXPORT QgsRelationManager : public QObject @@ -36,7 +37,8 @@ class CORE_EXPORT QgsRelationManager : public QObject public: - /** Constructor for QgsRelationManager. + /** + * Constructor for QgsRelationManager. * \param project associated project (used to notify project of changes) */ explicit QgsRelationManager( QgsProject *project = nullptr ); @@ -86,7 +88,8 @@ class CORE_EXPORT QgsRelationManager : public QObject */ Q_INVOKABLE QgsRelation relation( const QString &id ) const; - /** Returns a list of relations with matching names. + /** + * Returns a list of relations with matching names. * \param name relation name to search for. Searching is case insensitive. * \returns a list of matching relations * \since QGIS 2.16 diff --git a/src/core/qgsrenderchecker.h b/src/core/qgsrenderchecker.h index 32f9665cd15d..74ce598cf38d 100644 --- a/src/core/qgsrenderchecker.h +++ b/src/core/qgsrenderchecker.h @@ -29,7 +29,8 @@ class QImage; -/** \ingroup core +/** + * \ingroup core * This is a helper class for unit tests that need to * write an image and compare it to an expected result * or render time. @@ -58,13 +59,15 @@ class CORE_EXPORT QgsRenderChecker int elapsedTime() { return mElapsedTime; } void setElapsedTimeTarget( int target ) { mElapsedTimeTarget = target; } - /** Base directory name for the control image (with control image path + /** + * Base directory name for the control image (with control image path * suffixed) the path to the image will be constructed like this: * controlImagePath + '/' + mControlName + '/' + mControlName + '.png' */ void setControlName( const QString &name ); - /** Prefix where the control images are kept. + /** + * Prefix where the control images are kept. * This will be appended to controlImagePath */ void setControlPathPrefix( const QString &name ) { mControlPathPrefix = name + '/'; } @@ -87,7 +90,8 @@ class CORE_EXPORT QgsRenderChecker //! \since QGIS 2.4 void setMapSettings( const QgsMapSettings &mapSettings ); - /** Set tolerance for color components used by runTest() and compareImages(). + /** + * Set tolerance for color components used by runTest() and compareImages(). * Default value is 0. * \param colorTolerance is maximum difference for each color component * including alpha to be considered correct. @@ -95,7 +99,8 @@ class CORE_EXPORT QgsRenderChecker */ void setColorTolerance( unsigned int colorTolerance ) { mColorTolerance = colorTolerance; } - /** Sets the largest allowable difference in size between the rendered and the expected image. + /** + * Sets the largest allowable difference in size between the rendered and the expected image. * \param xTolerance x tolerance in pixels * \param yTolerance y tolerance in pixels * \since QGIS 2.12 @@ -127,7 +132,8 @@ class CORE_EXPORT QgsRenderChecker */ bool compareImages( const QString &testName, unsigned int mismatchCount = 0, const QString &renderedImageFile = QString() ); - /** Get a list of all the anomalies. An anomaly is a rendered difference + /** + * Get a list of all the anomalies. An anomaly is a rendered difference * file where there is some red pixel content (indicating a render check * mismatch), but where the output was still acceptable. If the render * diff matches one of these anomalies we will still consider it to be @@ -136,7 +142,8 @@ class CORE_EXPORT QgsRenderChecker */ bool isKnownAnomaly( const QString &diffImageFile ); - /** Draws a checkboard pattern for image backgrounds, so that opacity is visible + /** + * Draws a checkboard pattern for image backgrounds, so that opacity is visible * without requiring a transparent background for the image */ static void drawBackground( QImage *image ); @@ -191,7 +198,8 @@ class CORE_EXPORT QgsRenderChecker }; // class QgsRenderChecker -/** Compare two WKT strings with some tolerance +/** + * Compare two WKT strings with some tolerance * \param a first WKT string * \param b second WKT string * \param tolerance tolerance to use (optional, defaults to 0.000001) diff --git a/src/core/qgsrendercontext.h b/src/core/qgsrendercontext.h index ee98d27463ac..153ca36d946a 100644 --- a/src/core/qgsrendercontext.h +++ b/src/core/qgsrendercontext.h @@ -39,7 +39,8 @@ class QgsLabelingEngine; class QgsMapSettings; -/** \ingroup core +/** + * \ingroup core * Contains information about the context of a rendering operation. * The context of a rendering operation defines properties such as * the conversion ratio between screen and map units, the extents @@ -53,7 +54,8 @@ class CORE_EXPORT QgsRenderContext QgsRenderContext( const QgsRenderContext &rh ); QgsRenderContext &operator=( const QgsRenderContext &rh ); - /** Enumeration of flags that affect rendering operations. + /** + * Enumeration of flags that affect rendering operations. * \since QGIS 2.14 */ enum Flag @@ -70,22 +72,26 @@ class CORE_EXPORT QgsRenderContext }; Q_DECLARE_FLAGS( Flags, Flag ) - /** Set combination of flags that will be used for rendering. + /** + * Set combination of flags that will be used for rendering. * \since QGIS 2.14 */ void setFlags( QgsRenderContext::Flags flags ); - /** Enable or disable a particular flag (other flags are not affected) + /** + * Enable or disable a particular flag (other flags are not affected) * \since QGIS 2.14 */ void setFlag( Flag flag, bool on = true ); - /** Return combination of flags used for rendering. + /** + * Return combination of flags used for rendering. * \since QGIS 2.14 */ Flags flags() const; - /** Check whether a particular flag is enabled. + /** + * Check whether a particular flag is enabled. * \since QGIS 2.14 */ bool testFlag( Flag flag ) const; @@ -112,7 +118,8 @@ class CORE_EXPORT QgsRenderContext */ QPainter *painter() {return mPainter;} - /** Returns the current coordinate transform for the context, or an invalid + /** + * Returns the current coordinate transform for the context, or an invalid * transform is no coordinate transformation is required. */ QgsCoordinateTransform coordinateTransform() const {return mCoordTransform;} @@ -139,11 +146,13 @@ class CORE_EXPORT QgsRenderContext bool forceVectorOutput() const; - /** Returns true if advanced effects such as blend modes such be used + /** + * Returns true if advanced effects such as blend modes such be used */ bool useAdvancedEffects() const; - /** Used to enable or disable advanced effects such as blend modes + /** + * Used to enable or disable advanced effects such as blend modes */ void setUseAdvancedEffects( bool enabled ); @@ -164,7 +173,8 @@ class CORE_EXPORT QgsRenderContext QColor selectionColor() const { return mSelectionColor; } - /** Returns true if vector selections should be shown in the rendered map + /** + * Returns true if vector selections should be shown in the rendered map * \returns true if selections should be shown * \see setShowSelection * \see selectionColor @@ -222,7 +232,8 @@ class CORE_EXPORT QgsRenderContext void setLabelingEngine( QgsLabelingEngine *engine2 ) { mLabelingEngine = engine2; } SIP_SKIP void setSelectionColor( const QColor &color ) { mSelectionColor = color; } - /** Sets whether vector selections should be shown in the rendered map + /** + * Sets whether vector selections should be shown in the rendered map * \param showSelection set to true if selections should be shown * \see showSelection * \see setSelectionColor @@ -230,7 +241,8 @@ class CORE_EXPORT QgsRenderContext */ void setShowSelection( const bool showSelection ); - /** Returns true if the rendering optimization (geometry simplification) can be executed + /** + * Returns true if the rendering optimization (geometry simplification) can be executed */ bool useRenderingOptimization() const; @@ -240,21 +252,24 @@ class CORE_EXPORT QgsRenderContext const QgsVectorSimplifyMethod &vectorSimplifyMethod() const { return mVectorSimplifyMethod; } void setVectorSimplifyMethod( const QgsVectorSimplifyMethod &simplifyMethod ) { mVectorSimplifyMethod = simplifyMethod; } - /** Sets the expression context. This context is used for all expression evaluation + /** + * Sets the expression context. This context is used for all expression evaluation * associated with this render context. * \see expressionContext() * \since QGIS 2.12 */ void setExpressionContext( const QgsExpressionContext &context ) { mExpressionContext = context; } - /** Gets the expression context. This context should be used for all expression evaluation + /** + * Gets the expression context. This context should be used for all expression evaluation * associated with this render context. * \see setExpressionContext() * \since QGIS 2.12 */ QgsExpressionContext &expressionContext() { return mExpressionContext; } - /** Gets the expression context (const version). This context should be used for all expression evaluation + /** + * Gets the expression context (const version). This context should be used for all expression evaluation * associated with this render context. * \see setExpressionContext() * \since QGIS 2.12 @@ -267,27 +282,31 @@ class CORE_EXPORT QgsRenderContext //! Sets pointer to original (unsegmentized) geometry void setGeometry( const QgsAbstractGeometry *geometry ) { mGeometry = geometry; } - /** Set a filter feature provider used for additional filtering of rendered features. + /** + * Set a filter feature provider used for additional filtering of rendered features. * \param ffp the filter feature provider * \since QGIS 2.14 * \see featureFilterProvider() */ void setFeatureFilterProvider( const QgsFeatureFilterProvider *ffp ); - /** Get the filter feature provider used for additional filtering of rendered features. + /** + * Get the filter feature provider used for additional filtering of rendered features. * \returns the filter feature provider * \since QGIS 2.14 * \see setFeatureFilterProvider() */ const QgsFeatureFilterProvider *featureFilterProvider() const; - /** Sets the segmentation tolerance applied when rendering curved geometries + /** + * Sets the segmentation tolerance applied when rendering curved geometries \param tolerance the segmentation tolerance*/ void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; } //! Gets the segmentation tolerance applied when rendering curved geometries double segmentationTolerance() const { return mSegmentationTolerance; } - /** Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) + /** + * Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) \param type the segmentation tolerance typename*/ void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; } //! Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) diff --git a/src/core/qgsrulebasedlabeling.h b/src/core/qgsrulebasedlabeling.h index acee4f76302f..345b11fbc05c 100644 --- a/src/core/qgsrulebasedlabeling.h +++ b/src/core/qgsrulebasedlabeling.h @@ -32,7 +32,8 @@ class QgsRenderContext; class QgsGeometry; class QgsRuleBasedLabelProvider; -/** \ingroup core +/** + * \ingroup core * \class QgsRuleBasedLabeling * \since QGIS 3.0 */ @@ -357,7 +358,8 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling #ifndef SIP_RUN -/** \ingroup core +/** + * \ingroup core * \class QgsRuleBasedLabelProvider * \note not available in Python bindings * \note this class is not a part of public API yet. See notes in QgsLabelingEngine diff --git a/src/core/qgsrunprocess.h b/src/core/qgsrunprocess.h index 8849a8a56eb7..eae3dac17067 100644 --- a/src/core/qgsrunprocess.h +++ b/src/core/qgsrunprocess.h @@ -29,7 +29,8 @@ class QgsMessageOutput; -/** \ingroup core +/** + * \ingroup core * A class that executes an external program/script. * It can optionally capture the standard output and error from the * process and displays them in a dialog box. diff --git a/src/core/qgsruntimeprofiler.h b/src/core/qgsruntimeprofiler.h index 55d12f0d837d..674304a71aba 100644 --- a/src/core/qgsruntimeprofiler.h +++ b/src/core/qgsruntimeprofiler.h @@ -8,7 +8,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * \class QgsRuntimeProfiler */ class CORE_EXPORT QgsRuntimeProfiler diff --git a/src/core/qgsscalecalculator.h b/src/core/qgsscalecalculator.h index 3896fa35efe5..557405abac7b 100644 --- a/src/core/qgsscalecalculator.h +++ b/src/core/qgsscalecalculator.h @@ -26,7 +26,8 @@ class QString; class QgsRectangle; -/** \ingroup core +/** + * \ingroup core * Calculates scale for a given combination of canvas size, map extent, * and monitor dpi. */ diff --git a/src/core/qgsscaleutils.h b/src/core/qgsscaleutils.h index 39155873e334..3d69089219c9 100644 --- a/src/core/qgsscaleutils.h +++ b/src/core/qgsscaleutils.h @@ -21,13 +21,15 @@ #ifndef QGSSCALEUTILS_H #define QGSSCALEUTILS_H -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsScaleUtils { public: - /** Save scales to the given file + /** + * Save scales to the given file * \param fileName the name of the output file * \param scales the list of scales to save * \param errorMessage it will contain the error message if something @@ -36,7 +38,8 @@ class CORE_EXPORT QgsScaleUtils */ static bool saveScaleList( const QString &fileName, const QStringList &scales, QString &errorMessage ); - /** Load scales from the given file + /** + * Load scales from the given file * \param fileName the name of the file to process * \param scales it will contain loaded scales * \param errorMessage it will contain the error message if something diff --git a/src/core/qgssettings.h b/src/core/qgssettings.h index 443d3bc0eaf1..af79dad53710 100644 --- a/src/core/qgssettings.h +++ b/src/core/qgssettings.h @@ -21,7 +21,8 @@ #include "qgis_core.h" #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * \class QgsSettings * * This class is a composition of two QSettings instances: @@ -70,13 +71,15 @@ class CORE_EXPORT QgsSettings : public QObject Misc }; - /** Construct a QgsSettings object for accessing settings of the application + /** + * Construct a QgsSettings object for accessing settings of the application * called application from the organization called organization, and with parent parent. */ explicit QgsSettings( const QString &organization, const QString &application = QString(), QObject *parent = nullptr ); - /** Construct a QgsSettings object for accessing settings of the application called application + /** + * Construct a QgsSettings object for accessing settings of the application called application * from the organization called organization, and with parent parent. * If scope is QSettings::UserScope, the QSettings object searches user-specific settings first, * before it searches system-wide settings as a fallback. If scope is QSettings::SystemScope, @@ -91,7 +94,8 @@ class CORE_EXPORT QgsSettings : public QObject QgsSettings( QSettings::Scope scope, const QString &organization, const QString &application = QString(), QObject *parent = nullptr ); - /** Construct a QgsSettings object for accessing settings of the application called application + /** + * Construct a QgsSettings object for accessing settings of the application called application * from the organization called organization, and with parent parent. * If scope is QSettings::UserScope, the QSettings object searches user-specific settings first, * before it searches system-wide settings as a fallback. If scope is QSettings::SystemScope, @@ -105,7 +109,8 @@ class CORE_EXPORT QgsSettings : public QObject QgsSettings( QSettings::Format format, QSettings::Scope scope, const QString &organization, const QString &application = QString(), QObject *parent = nullptr ); - /** Construct a QgsSettings object for accessing the settings stored in the file called fileName, + /** + * Construct a QgsSettings object for accessing the settings stored in the file called fileName, * with parent parent. If the file doesn't already exist, it is created. * * If format is QSettings::NativeFormat, the meaning of fileName depends on the platform. On Unix, @@ -125,7 +130,8 @@ class CORE_EXPORT QgsSettings : public QObject */ QgsSettings( const QString &fileName, QSettings::Format format, QObject *parent = nullptr ); - /** Constructs a QgsSettings object for accessing settings of the application and organization + /** + * Constructs a QgsSettings object for accessing settings of the application and organization * set previously with a call to QCoreApplication::setOrganizationName(), * QCoreApplication::setOrganizationDomain(), and QCoreApplication::setApplicationName(). * @@ -136,7 +142,8 @@ class CORE_EXPORT QgsSettings : public QObject explicit QgsSettings( QObject *parent = 0 ); ~QgsSettings(); - /** Appends prefix to the current group. + /** + * Appends prefix to the current group. * The current group is automatically prepended to all keys specified to QSettings. * In addition, query functions such as childGroups(), childKeys(), and allKeys() * are based on the group. By default, no group is set. @@ -159,7 +166,8 @@ class CORE_EXPORT QgsSettings : public QObject //! Adds prefix to the current group and starts reading from an array. Returns the size of the array. int beginReadArray( const QString &prefix ); - /** Adds prefix to the current group and starts writing an array of size size. + /** + * Adds prefix to the current group and starts writing an array of size size. * If size is -1 (the default), it is automatically determined based on the indexes of the entries written. * \note This will completely shadow any existing array with the same name in the global settings */ @@ -167,17 +175,20 @@ class CORE_EXPORT QgsSettings : public QObject //! Closes the array that was started using beginReadArray() or beginWriteArray(). void endArray(); - /** Sets the current array index to i. Calls to functions such as setValue(), value(), + /** + * Sets the current array index to i. Calls to functions such as setValue(), value(), * remove(), and contains() will operate on the array entry at that index. */ void setArrayIndex( int i ); - /** Sets the value of setting key to value. If the key already exists, the previous value is overwritten. + /** + * Sets the value of setting key to value. If the key already exists, the previous value is overwritten. * An optional Section argument can be used to set a value to a specific Section. */ void setValue( const QString &key, const QVariant &value, const QgsSettings::Section section = QgsSettings::NoSection ); - /** Returns the value for setting key. If the setting doesn't exist, it will be + /** + * Returns the value for setting key. If the setting doesn't exist, it will be * searched in the Global Settings and if not found, returns defaultValue. * If no default value is specified, a default QVariant is returned. * An optional Section argument can be used to get a value from a specific Section. @@ -205,14 +216,16 @@ class CORE_EXPORT QgsSettings : public QObject % End #endif - /** Returns true if there exists a setting called key; returns false otherwise. + /** + * Returns true if there exists a setting called key; returns false otherwise. * If a group is set using beginGroup(), key is taken to be relative to that group. */ bool contains( const QString &key, const QgsSettings::Section section = QgsSettings::NoSection ) const; //! Returns the path where settings written using this QSettings object are stored. QString fileName() const; - /** Writes any unsaved changes to permanent storage, and reloads any settings that have been + /** + * Writes any unsaved changes to permanent storage, and reloads any settings that have been * changed in the meantime by another application. * This function is called automatically from QSettings's destructor and by the event * loop at regular intervals, so you normally don't need to call it yourself. diff --git a/src/core/qgssimplifymethod.h b/src/core/qgssimplifymethod.h index f04dcb2bde84..80f8e02dfa3b 100644 --- a/src/core/qgssimplifymethod.h +++ b/src/core/qgssimplifymethod.h @@ -20,7 +20,8 @@ class QgsAbstractGeometrySimplifier; -/** \ingroup core +/** + * \ingroup core * This class contains information about how to simplify geometries fetched from a QgsFeatureIterator * \since QGIS 2.2 */ diff --git a/src/core/qgsslconnect.h b/src/core/qgsslconnect.h index c8e217e44f7f..811aba7dc3b8 100644 --- a/src/core/qgsslconnect.h +++ b/src/core/qgsslconnect.h @@ -24,7 +24,8 @@ struct sqlite3; -/** \ingroup core +/** + * \ingroup core * \class QgsSLConnect * \note not available in Python bindings */ diff --git a/src/core/qgssnappingconfig.h b/src/core/qgssnappingconfig.h index 0dc279a01baf..d443dd71914e 100644 --- a/src/core/qgssnappingconfig.h +++ b/src/core/qgssnappingconfig.h @@ -24,7 +24,8 @@ class QgsProject; class QgsVectorLayer; -/** \ingroup core +/** + * \ingroup core * This is a container for configuration of the snapping of the project * \since QGIS 3.0 */ @@ -56,7 +57,8 @@ class CORE_EXPORT QgsSnappingConfig Segment = 3, //!< On segments only }; - /** \ingroup core + /** + * \ingroup core * This is a container of advanced configuration (per layer) of the snapping of the project * \since QGIS 3.0 */ diff --git a/src/core/qgssnappingutils.h b/src/core/qgssnappingutils.h index f0364986a5a5..2c09445d429f 100644 --- a/src/core/qgssnappingutils.h +++ b/src/core/qgssnappingutils.h @@ -26,7 +26,8 @@ class QgsSnappingConfig; -/** \ingroup core +/** + * \ingroup core * This class has all the configuration of snapping and can return answers to snapping queries. * Internally, it keeps a cache of QgsPointLocator instances for multiple layers. * @@ -143,7 +144,8 @@ class CORE_EXPORT QgsSnappingUtils : public QObject //! Query layers used for snapping QList layers() const { return mLayers; } - /** Get extra information about the instance + /** + * Get extra information about the instance * \since QGIS 2.14 */ QString dump(); diff --git a/src/core/qgsspatialindex.cpp b/src/core/qgsspatialindex.cpp index 83c9eef1e982..fdbad9337f25 100644 --- a/src/core/qgsspatialindex.cpp +++ b/src/core/qgsspatialindex.cpp @@ -29,7 +29,8 @@ using namespace SpatialIndex; -/** \ingroup core +/** + * \ingroup core * \class QgisVisitor * \brief Custom visitor that adds found features to list. * \note not available in Python bindings @@ -55,7 +56,8 @@ class QgisVisitor : public SpatialIndex::IVisitor QList &mList; }; -/** \ingroup core +/** + * \ingroup core * \class QgsSpatialIndexCopyVisitor * \note not available in Python bindings */ @@ -84,7 +86,8 @@ class QgsSpatialIndexCopyVisitor : public SpatialIndex::IVisitor }; -/** \ingroup core +/** + * \ingroup core * \class QgsFeatureIteratorDataStream * \brief Utility class for bulk loading of R-trees. Not a part of public API. * \note not available in Python bindings @@ -149,7 +152,8 @@ class QgsFeatureIteratorDataStream : public IDataStream }; -/** \ingroup core +/** + * \ingroup core * \class QgsSpatialIndexData * \brief Data of spatial index that may be implicitly shared * \note not available in Python bindings diff --git a/src/core/qgsspatialindex.h b/src/core/qgsspatialindex.h index f3be66ff2c9e..7b3e8c618b36 100644 --- a/src/core/qgsspatialindex.h +++ b/src/core/qgsspatialindex.h @@ -49,7 +49,8 @@ class QgsSpatialIndexData; class QgsFeatureIterator; class QgsFeatureSource; -/** \ingroup core +/** + * \ingroup core * \class QgsSpatialIndex */ class CORE_EXPORT QgsSpatialIndex @@ -62,7 +63,8 @@ class CORE_EXPORT QgsSpatialIndex //! Constructor - creates R-tree QgsSpatialIndex(); - /** Constructor - creates R-tree and bulk loads it with features from the iterator. + /** + * Constructor - creates R-tree and bulk loads it with features from the iterator. * This is much faster approach than creating an empty index and then inserting features one by one. * * The optional \a feedback object can be used to allow cancelation of bulk feature loading. Ownership @@ -128,7 +130,8 @@ class CORE_EXPORT QgsSpatialIndex static SpatialIndex::Region rectToRegion( const QgsRectangle &rect ); - /** Calculates feature info to insert into index. + /** + * Calculates feature info to insert into index. * \param f input feature * \param r will be set to spatial index region * \param id will be set to feature's ID @@ -137,7 +140,8 @@ class CORE_EXPORT QgsSpatialIndex */ static bool featureInfo( const QgsFeature &f, SpatialIndex::Region &r, QgsFeatureId &id ) SIP_SKIP; - /** Calculates feature info to insert into index. + /** + * Calculates feature info to insert into index. * \param f input feature * \param rect will be set to feature's geometry bounding box * \param id will be set to feature's ID diff --git a/src/core/qgssqlexpressioncompiler.h b/src/core/qgssqlexpressioncompiler.h index 0a590600f729..918e1a03e8ea 100644 --- a/src/core/qgssqlexpressioncompiler.h +++ b/src/core/qgssqlexpressioncompiler.h @@ -24,7 +24,8 @@ class QgsExpression; class QgsExpressionNode; -/** \ingroup core +/** + * \ingroup core * \class QgsSqlExpressionCompiler * \brief Generic expression compiler for translation to provider specific SQL WHERE clauses. * @@ -48,7 +49,8 @@ class CORE_EXPORT QgsSqlExpressionCompiler Fail //!< Provider cannot handle expression }; - /** Enumeration of flags for how provider handles SQL clauses + /** + * Enumeration of flags for how provider handles SQL clauses */ enum Flag { @@ -60,31 +62,36 @@ class CORE_EXPORT QgsSqlExpressionCompiler }; Q_DECLARE_FLAGS( Flags, Flag ) - /** Constructor for expression compiler. + /** + * Constructor for expression compiler. * \param fields fields from provider * \param flags flags which control how expression is compiled */ explicit QgsSqlExpressionCompiler( const QgsFields &fields, QgsSqlExpressionCompiler::Flags flags = Flags() ); virtual ~QgsSqlExpressionCompiler() = default; - /** Compiles an expression and returns the result of the compilation. + /** + * Compiles an expression and returns the result of the compilation. */ virtual Result compile( const QgsExpression *exp ); - /** Returns the compiled expression string for use by the provider. + /** + * Returns the compiled expression string for use by the provider. */ virtual QString result(); protected: - /** Returns a quoted column identifier, in the format expected by the provider. + /** + * Returns a quoted column identifier, in the format expected by the provider. * Derived classes should override this if special handling of column identifiers * is required. * \see quotedValue() */ virtual QString quotedIdentifier( const QString &identifier ); - /** Returns a quoted attribute value, in the format expected by the provider. + /** + * Returns a quoted attribute value, in the format expected by the provider. * Derived classes should override this if special handling of attribute values is required. * \param value value to quote * \param ok wil be set to true if value can be compiled @@ -92,21 +99,24 @@ class CORE_EXPORT QgsSqlExpressionCompiler */ virtual QString quotedValue( const QVariant &value, bool &ok ); - /** Compiles an expression node and returns the result of the compilation. + /** + * Compiles an expression node and returns the result of the compilation. * \param node expression node to compile * \param str string representing compiled node should be stored in this parameter * \returns result of node compilation */ virtual Result compileNode( const QgsExpressionNode *node, QString &str ); - /** Return the SQL function for the expression function. + /** + * Return the SQL function for the expression function. * Derived classes should override this to help compile functions * \param fnName expression function name * \returns the SQL function name */ virtual QString sqlFunctionFromFunctionName( const QString &fnName ) const; - /** Return the Arguments for SQL function for the expression function. + /** + * Return the Arguments for SQL function for the expression function. * Derived classes should override this to help compile functions * \param fnName expression function name * \param fnArgs arguments from expression diff --git a/src/core/qgssqliteexpressioncompiler.h b/src/core/qgssqliteexpressioncompiler.h index 805091e8b911..d1c8b02f7f96 100644 --- a/src/core/qgssqliteexpressioncompiler.h +++ b/src/core/qgssqliteexpressioncompiler.h @@ -23,7 +23,8 @@ #include "qgis_core.h" #include "qgssqlexpressioncompiler.h" -/** \ingroup core +/** + * \ingroup core * \class QgsSQLiteExpressionCompiler * \brief Expression compiler for translation to SQlite SQL WHERE clauses. * @@ -37,7 +38,8 @@ class CORE_EXPORT QgsSQLiteExpressionCompiler : public QgsSqlExpressionCompiler { public: - /** Constructor for expression compiler. + /** + * Constructor for expression compiler. * \param fields fields from provider */ explicit QgsSQLiteExpressionCompiler( const QgsFields &fields ); diff --git a/src/core/qgssqlstatement.cpp b/src/core/qgssqlstatement.cpp index bbbe2eb4c45a..5621d12a9463 100644 --- a/src/core/qgssqlstatement.cpp +++ b/src/core/qgssqlstatement.cpp @@ -189,7 +189,8 @@ void QgsSQLStatement::RecursiveVisitor::visit( const QgsSQLStatement::NodeJoin & expr->accept( *this ); } -/** \ingroup core +/** + * \ingroup core * Internal use. * \note not available in Python bindings */ diff --git a/src/core/qgssqlstatement.h b/src/core/qgssqlstatement.h index c2d8f0a49430..7784a209c000 100644 --- a/src/core/qgssqlstatement.h +++ b/src/core/qgssqlstatement.h @@ -28,7 +28,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core Class for parsing SQL statements. * \since QGIS 2.16 */ @@ -59,7 +60,8 @@ class CORE_EXPORT QgsSQLStatement //! Returns parser error QString parserErrorString() const; - /** Performs basic validity checks. Basically checking that columns referencing + /** + * Performs basic validity checks. Basically checking that columns referencing * a table, references a specified table. Returns true if the validation is * successful */ bool doBasicValidationChecks( QString &errorMsgOut SIP_OUT ) const; @@ -84,23 +86,27 @@ class CORE_EXPORT QgsSQLStatement */ QString dump() const; - /** Returns a quoted column reference (in double quotes) + /** + * Returns a quoted column reference (in double quotes) * \see quotedString(), quotedIdentifierIfNeeded() */ static QString quotedIdentifier( QString name ); - /** Returns a quoted column reference (in double quotes) if needed, or + /** + * Returns a quoted column reference (in double quotes) if needed, or * otherwise the original string. * \see quotedString(), quotedIdentifier() */ static QString quotedIdentifierIfNeeded( const QString &name ); - /** Remove double quotes from an identifier. + /** + * Remove double quotes from an identifier. * \see quotedIdentifier() */ static QString stripQuotedIdentifier( QString text ); - /** Returns a quoted version of a string (in single quotes) + /** + * Returns a quoted version of a string (in single quotes) * \see quotedIdentifier(), quotedIdentifierIfNeeded() */ static QString quotedString( QString text ); @@ -199,7 +205,8 @@ class CORE_EXPORT QgsSQLStatement ntCast }; - /** \ingroup core + /** + * \ingroup core * Abstract node class */ class CORE_EXPORT Node { @@ -271,7 +278,8 @@ class CORE_EXPORT QgsSQLStatement virtual void accept( QgsSQLStatement::Visitor &v ) const = 0; }; - /** \ingroup core + /** + * \ingroup core * List of nodes */ class CORE_EXPORT NodeList { @@ -286,7 +294,8 @@ class CORE_EXPORT QgsSQLStatement //! Return list QList list() { return mList; } - /** Returns the number of nodes in the list. + /** + * Returns the number of nodes in the list. */ int count() const { return mList.count(); } @@ -303,7 +312,8 @@ class CORE_EXPORT QgsSQLStatement QList mList; }; - /** \ingroup core + /** + * \ingroup core * Unary logicial/arithmetical operator ( NOT, - ) */ class CORE_EXPORT NodeUnaryOperator : public QgsSQLStatement::Node { @@ -329,7 +339,8 @@ class CORE_EXPORT QgsSQLStatement Node *mOperand = nullptr; }; - /** \ingroup core + /** + * \ingroup core * Binary logical/arithmetical operator (AND, OR, =, +, ...) */ class CORE_EXPORT NodeBinaryOperator : public QgsSQLStatement::Node { @@ -370,7 +381,8 @@ class CORE_EXPORT QgsSQLStatement Node *mOpRight = nullptr; }; - /** \ingroup core + /** + * \ingroup core * 'x IN (y, z)' operator */ class CORE_EXPORT NodeInOperator : public QgsSQLStatement::Node { @@ -400,7 +412,8 @@ class CORE_EXPORT QgsSQLStatement bool mNotIn; }; - /** \ingroup core + /** + * \ingroup core * 'X BETWEEN y and z' operator */ class CORE_EXPORT NodeBetweenOperator : public QgsSQLStatement::Node { @@ -435,7 +448,8 @@ class CORE_EXPORT QgsSQLStatement bool mNotBetween; }; - /** \ingroup core + /** + * \ingroup core * Function with a name and arguments node */ class CORE_EXPORT NodeFunction : public QgsSQLStatement::Node { @@ -462,7 +476,8 @@ class CORE_EXPORT QgsSQLStatement }; - /** \ingroup core + /** + * \ingroup core * Literal value (integer, integer64, double, string) */ class CORE_EXPORT NodeLiteral : public QgsSQLStatement::Node { @@ -483,7 +498,8 @@ class CORE_EXPORT QgsSQLStatement QVariant mValue; }; - /** \ingroup core + /** + * \ingroup core * Reference to a column */ class CORE_EXPORT NodeColumnRef : public QgsSQLStatement::Node { @@ -523,7 +539,8 @@ class CORE_EXPORT QgsSQLStatement bool mStar; }; - /** \ingroup core + /** + * \ingroup core * Selected column */ class CORE_EXPORT NodeSelectedColumn : public QgsSQLStatement::Node { @@ -554,7 +571,8 @@ class CORE_EXPORT QgsSQLStatement QString mAlias; }; - /** \ingroup core + /** + * \ingroup core * CAST operator */ class CORE_EXPORT NodeCast : public QgsSQLStatement::Node { @@ -580,7 +598,8 @@ class CORE_EXPORT QgsSQLStatement QString mType; }; - /** \ingroup core + /** + * \ingroup core * Table definition */ class CORE_EXPORT NodeTableDef : public QgsSQLStatement::Node { @@ -609,7 +628,8 @@ class CORE_EXPORT QgsSQLStatement QString mAlias; }; - /** \ingroup core + /** + * \ingroup core * Join definition */ class CORE_EXPORT NodeJoin : public QgsSQLStatement::Node { @@ -647,7 +667,8 @@ class CORE_EXPORT QgsSQLStatement JoinType mType; }; - /** \ingroup core + /** + * \ingroup core * Column in a ORDER BY */ class CORE_EXPORT NodeColumnSorted : public QgsSQLStatement::Node { @@ -675,7 +696,8 @@ class CORE_EXPORT QgsSQLStatement bool mAsc; }; - /** \ingroup core + /** + * \ingroup core * SELECT node */ class CORE_EXPORT NodeSelect : public QgsSQLStatement::Node { @@ -723,7 +745,8 @@ class CORE_EXPORT QgsSQLStatement ////// - /** \ingroup core + /** + * \ingroup core * Support for visitor pattern - algorithms dealing with the statement may be implemented without modifying the Node classes */ class CORE_EXPORT Visitor @@ -758,7 +781,8 @@ class CORE_EXPORT QgsSQLStatement virtual void visit( const QgsSQLStatement::NodeCast &n ) = 0; }; - /** \ingroup core + /** + * \ingroup core * A visitor that recursively explores all children */ class CORE_EXPORT RecursiveVisitor: public QgsSQLStatement::Visitor { diff --git a/src/core/qgsstatisticalsummary.h b/src/core/qgsstatisticalsummary.h index 1412c023dc49..26974ab8e0d9 100644 --- a/src/core/qgsstatisticalsummary.h +++ b/src/core/qgsstatisticalsummary.h @@ -27,7 +27,8 @@ * See details in QEP #17 ****************************************************************************/ -/** \ingroup core +/** + * \ingroup core * \class QgsStatisticalSummary * \brief Calculator for summary statistics for a list of doubles. * @@ -66,36 +67,42 @@ class CORE_EXPORT QgsStatisticalSummary }; Q_DECLARE_FLAGS( Statistics, Statistic ) - /** Constructor for QgsStatisticalSummary + /** + * Constructor for QgsStatisticalSummary * \param stats flags for statistics to calculate */ QgsStatisticalSummary( QgsStatisticalSummary::Statistics stats = QgsStatisticalSummary::All ); virtual ~QgsStatisticalSummary() = default; - /** Returns flags which specify which statistics will be calculated. Some statistics + /** + * Returns flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., sum, min and max). * \see setStatistics */ Statistics statistics() const { return mStatistics; } - /** Sets flags which specify which statistics will be calculated. Some statistics + /** + * Sets flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., sum, min and max). * \param stats flags for statistics to calculate * \see statistics */ void setStatistics( QgsStatisticalSummary::Statistics stats ) { mStatistics = stats; } - /** Resets the calculated values + /** + * Resets the calculated values */ void reset(); - /** Calculates summary statistics for a list of values + /** + * Calculates summary statistics for a list of values * \param values list of doubles */ void calculate( const QList &values ); - /** Adds a single value to the statistics calculation. Calling this method + /** + * Adds a single value to the statistics calculation. Calling this method * allows values to be added to the calculation one at a time. For large * quantities of values this may be more efficient then first adding all the * values to a list and calling calculate(). @@ -111,7 +118,8 @@ class CORE_EXPORT QgsStatisticalSummary */ void addValue( double value ); - /** Adds a single value to the statistics calculation. Calling this method + /** + * Adds a single value to the statistics calculation. Calling this method * allows values to be added to the calculation one at a time. For large * quantities of values this may be more efficient then first adding all the * values to a list and calling calculate(). @@ -127,7 +135,8 @@ class CORE_EXPORT QgsStatisticalSummary */ void addVariant( const QVariant &value ); - /** Must be called after adding all values with addValues() and before retrieving + /** + * Must be called after adding all values with addValues() and before retrieving * any calculated statistics. * \see addValue() * \see addVariant() @@ -135,73 +144,86 @@ class CORE_EXPORT QgsStatisticalSummary */ void finalize(); - /** Returns the value of a specified statistic + /** + * Returns the value of a specified statistic * \param stat statistic to return * \returns calculated value of statistic. A NaN value may be returned for invalid * statistics. */ double statistic( QgsStatisticalSummary::Statistic stat ) const; - /** Returns calculated count of values + /** + * Returns calculated count of values */ int count() const { return mCount; } - /** Returns the number of missing (null) values + /** + * Returns the number of missing (null) values * \since QGIS 2.16 */ int countMissing() const { return mMissing; } - /** Returns calculated sum of values + /** + * Returns calculated sum of values */ double sum() const { return mSum; } - /** Returns calculated mean of values. A NaN value may be returned if the mean cannot + /** + * Returns calculated mean of values. A NaN value may be returned if the mean cannot * be calculated. */ double mean() const { return mMean; } - /** Returns calculated median of values. This is only calculated if Statistic::Median has + /** + * Returns calculated median of values. This is only calculated if Statistic::Median has * been specified in the constructor or via setStatistics. A NaN value may be returned if the median cannot * be calculated. */ double median() const { return mMedian; } - /** Returns calculated minimum from values. A NaN value may be returned if the minimum cannot + /** + * Returns calculated minimum from values. A NaN value may be returned if the minimum cannot * be calculated. */ double min() const { return mMin; } - /** Returns calculated maximum from values. A NaN value may be returned if the maximum cannot + /** + * Returns calculated maximum from values. A NaN value may be returned if the maximum cannot * be calculated. */ double max() const { return mMax; } - /** Returns calculated range (difference between maximum and minimum values). A NaN value may be returned if the range cannot + /** + * Returns calculated range (difference between maximum and minimum values). A NaN value may be returned if the range cannot * be calculated. */ double range() const { return std::isnan( mMax ) || std::isnan( mMin ) ? std::numeric_limits::quiet_NaN() : mMax - mMin; } - /** Returns population standard deviation. This is only calculated if Statistic::StDev has + /** + * Returns population standard deviation. This is only calculated if Statistic::StDev has * been specified in the constructor or via setStatistics. A NaN value may be returned if the standard deviation cannot * be calculated. * \see sampleStDev */ double stDev() const { return mStdev; } - /** Returns sample standard deviation. This is only calculated if Statistic::StDev has + /** + * Returns sample standard deviation. This is only calculated if Statistic::StDev has * been specified in the constructor or via setStatistics. A NaN value may be returned if the standard deviation cannot * be calculated. * \see stDev */ double sampleStDev() const { return mSampleStdev; } - /** Returns variety of values. The variety is the count of unique values from the list. + /** + * Returns variety of values. The variety is the count of unique values from the list. * This is only calculated if Statistic::Variety has been specified in the constructor * or via setStatistics. */ int variety() const { return mValueCount.count(); } - /** Returns minority of values. The minority is the value with least occurrences in the list + /** + * Returns minority of values. The minority is the value with least occurrences in the list * This is only calculated if Statistic::Minority has been specified in the constructor * or via setStatistics. A NaN value may be returned if the minority cannot * be calculated. @@ -209,7 +231,8 @@ class CORE_EXPORT QgsStatisticalSummary */ double minority() const { return mMinority; } - /** Returns majority of values. The majority is the value with most occurrences in the list + /** + * Returns majority of values. The majority is the value with most occurrences in the list * This is only calculated if Statistic::Majority has been specified in the constructor * or via setStatistics. A NaN value may be returned if the majority cannot * be calculated. @@ -217,7 +240,8 @@ class CORE_EXPORT QgsStatisticalSummary */ double majority() const { return mMajority; } - /** Returns the first quartile of the values. The quartile is calculated using the + /** + * Returns the first quartile of the values. The quartile is calculated using the * "Tukey's hinges" method. A NaN value may be returned if the first quartile cannot * be calculated. * \see thirdQuartile @@ -225,7 +249,8 @@ class CORE_EXPORT QgsStatisticalSummary */ double firstQuartile() const { return mFirstQuartile; } - /** Returns the third quartile of the values. The quartile is calculated using the + /** + * Returns the third quartile of the values. The quartile is calculated using the * "Tukey's hinges" method. A NaN value may be returned if the third quartile cannot * be calculated. * \see firstQuartile @@ -233,7 +258,8 @@ class CORE_EXPORT QgsStatisticalSummary */ double thirdQuartile() const { return mThirdQuartile; } - /** Returns the inter quartile range of the values. The quartiles are calculated using the + /** + * Returns the inter quartile range of the values. The quartiles are calculated using the * "Tukey's hinges" method. A NaN value may be returned if the IQR cannot * be calculated. * \see firstQuartile @@ -241,7 +267,8 @@ class CORE_EXPORT QgsStatisticalSummary */ double interQuartileRange() const { return std::isnan( mThirdQuartile ) || std::isnan( mFirstQuartile ) ? std::numeric_limits::quiet_NaN() : mThirdQuartile - mFirstQuartile; } - /** Returns the friendly display name for a statistic + /** + * Returns the friendly display name for a statistic * \param statistic statistic to return name for */ static QString displayName( QgsStatisticalSummary::Statistic statistic ); diff --git a/src/core/qgsstringstatisticalsummary.h b/src/core/qgsstringstatisticalsummary.h index 120d550e6023..95c18bc080fc 100644 --- a/src/core/qgsstringstatisticalsummary.h +++ b/src/core/qgsstringstatisticalsummary.h @@ -27,7 +27,8 @@ * See details in QEP #17 ****************************************************************************/ -/** \ingroup core +/** + * \ingroup core * \class QgsStringStatisticalSummary * \brief Calculator for summary statistics and aggregates for a list of strings. * @@ -58,36 +59,42 @@ class CORE_EXPORT QgsStringStatisticalSummary }; Q_DECLARE_FLAGS( Statistics, Statistic ) - /** Constructor for QgsStringStatistics + /** + * Constructor for QgsStringStatistics * \param stats flags for statistics to calculate */ QgsStringStatisticalSummary( QgsStringStatisticalSummary::Statistics stats = QgsStringStatisticalSummary::All ); - /** Returns flags which specify which statistics will be calculated. Some statistics + /** + * Returns flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., count). * \see setStatistics */ Statistics statistics() const { return mStatistics; } - /** Sets flags which specify which statistics will be calculated. Some statistics + /** + * Sets flags which specify which statistics will be calculated. Some statistics * are always calculated (e.g., count). * \param stats flags for statistics to calculate * \see statistics */ void setStatistics( QgsStringStatisticalSummary::Statistics stats ) { mStatistics = stats; } - /** Resets the calculated values + /** + * Resets the calculated values */ void reset(); - /** Calculates summary statistics for an entire list of strings at once. + /** + * Calculates summary statistics for an entire list of strings at once. * \param values list of strings * \see calculateFromVariants() * \see addString() */ void calculate( const QStringList &values ); - /** Calculates summary statistics for an entire list of variants at once. Any + /** + * Calculates summary statistics for an entire list of variants at once. Any * non-string variants will be ignored. * \param values list of variants * \see calculate() @@ -95,7 +102,8 @@ class CORE_EXPORT QgsStringStatisticalSummary */ void calculateFromVariants( const QVariantList &values ); - /** Adds a single string to the statistics calculation. Calling this method + /** + * Adds a single string to the statistics calculation. Calling this method * allows strings to be added to the calculation one at a time. For large * quantities of strings this may be more efficient then first adding all the * strings to a list and calling calculate(). @@ -110,7 +118,8 @@ class CORE_EXPORT QgsStringStatisticalSummary */ void addString( const QString &string ); - /** Adds a single variant to the statistics calculation. Calling this method + /** + * Adds a single variant to the statistics calculation. Calling this method * allows variants to be added to the calculation one at a time. For large * quantities of variants this may be more efficient then first adding all the * variants to a list and calling calculateFromVariants(). @@ -124,49 +133,59 @@ class CORE_EXPORT QgsStringStatisticalSummary */ void addValue( const QVariant &value ); - /** Must be called after adding all strings with addString() and before retrieving + /** + * Must be called after adding all strings with addString() and before retrieving * any calculated string statistics. * \see addString() */ void finalize(); - /** Returns the value of a specified statistic + /** + * Returns the value of a specified statistic * \param stat statistic to return * \returns calculated value of statistic */ QVariant statistic( QgsStringStatisticalSummary::Statistic stat ) const; - /** Returns the calculated count of values. + /** + * Returns the calculated count of values. */ int count() const { return mCount; } - /** Returns the number of distinct string values. + /** + * Returns the number of distinct string values. * \see distinctValues() */ int countDistinct() const { return mValues.count(); } - /** Returns the set of distinct string values. + /** + * Returns the set of distinct string values. * \see countDistinct() */ QSet< QString > distinctValues() const { return mValues; } - /** Returns the number of missing (null) string values. + /** + * Returns the number of missing (null) string values. */ int countMissing() const { return mCountMissing; } - /** Returns the minimum (non-null) string value. + /** + * Returns the minimum (non-null) string value. */ QString min() const { return mMin; } - /** Returns the maximum (non-null) string value. + /** + * Returns the maximum (non-null) string value. */ QString max() const { return mMax; } - /** Returns the minimum length of strings. + /** + * Returns the minimum length of strings. */ int minLength() const { return mMinLength; } - /** Returns the maximum length of strings. + /** + * Returns the maximum length of strings. */ int maxLength() const { return mMaxLength; } @@ -176,7 +195,8 @@ class CORE_EXPORT QgsStringStatisticalSummary */ double meanLength() const { return mMeanLength; } - /** Returns the friendly display name for a statistic + /** + * Returns the friendly display name for a statistic * \param statistic statistic to return name for */ static QString displayName( QgsStringStatisticalSummary::Statistic statistic ); diff --git a/src/core/qgsstringutils.h b/src/core/qgsstringutils.h index 1d409f9848dd..073e9432e1e0 100644 --- a/src/core/qgsstringutils.h +++ b/src/core/qgsstringutils.h @@ -25,7 +25,8 @@ #define QGSSTRINGUTILS_H -/** \ingroup core +/** + * \ingroup core * \class QgsStringReplacement * \brief A representation of a single string replacement. * \since QGIS 3.0 @@ -36,7 +37,8 @@ class CORE_EXPORT QgsStringReplacement public: - /** Constructor for QgsStringReplacement. + /** + * Constructor for QgsStringReplacement. * \param match string to match * \param replacement string to replace match with * \param caseSensitive set to true for a case sensitive match @@ -59,7 +61,8 @@ class CORE_EXPORT QgsStringReplacement //! Returns true if match only applies to whole words, or false if partial word matches are permitted bool wholeWordOnly() const { return mWholeWordOnly; } - /** Processes a given input string, applying any valid replacements which should be made. + /** + * Processes a given input string, applying any valid replacements which should be made. * \param input input string * \returns input string with any matches replaced by replacement string */ @@ -73,12 +76,14 @@ class CORE_EXPORT QgsStringReplacement && mWholeWordOnly == other.mWholeWordOnly; } - /** Returns a map of the replacement properties. + /** + * Returns a map of the replacement properties. * \see fromProperties() */ QgsStringMap properties() const; - /** Creates a new QgsStringReplacement from an encoded properties map. + /** + * Creates a new QgsStringReplacement from an encoded properties map. * \see properties() */ static QgsStringReplacement fromProperties( const QgsStringMap &properties ); @@ -97,7 +102,8 @@ class CORE_EXPORT QgsStringReplacement }; -/** \ingroup core +/** + * \ingroup core * \class QgsStringReplacementCollection * \brief A collection of string replacements (specified using QgsStringReplacement objects). * \since QGIS 3.0 @@ -108,19 +114,22 @@ class CORE_EXPORT QgsStringReplacementCollection public: - /** Constructor for QgsStringReplacementCollection + /** + * Constructor for QgsStringReplacementCollection * \param replacements initial list of string replacements */ QgsStringReplacementCollection( const QList< QgsStringReplacement > &replacements = QList< QgsStringReplacement >() ) : mReplacements( replacements ) {} - /** Returns the list of string replacements in this collection. + /** + * Returns the list of string replacements in this collection. * \see setReplacements() */ QList< QgsStringReplacement > replacements() const { return mReplacements; } - /** Sets the list of string replacements in this collection. + /** + * Sets the list of string replacements in this collection. * \param replacements list of string replacements to apply. Replacements are applied in the * order they are specified here. * \see replacements() @@ -130,7 +139,8 @@ class CORE_EXPORT QgsStringReplacementCollection mReplacements = replacements; } - /** Processes a given input string, applying any valid replacements which should be made + /** + * Processes a given input string, applying any valid replacements which should be made * using QgsStringReplacement objects contained by this collection. Replacements * are made in order of the QgsStringReplacement objects contained in the collection. * \param input input string @@ -138,14 +148,16 @@ class CORE_EXPORT QgsStringReplacementCollection */ QString process( const QString &input ) const; - /** Writes the collection state to an XML element. + /** + * Writes the collection state to an XML element. * \param elem target DOM element * \param doc DOM document * \see readXml() */ void writeXml( QDomElement &elem, QDomDocument &doc ) const; - /** Reads the collection state from an XML element. + /** + * Reads the collection state from an XML element. * \param elem DOM element * \see writeXml() */ @@ -158,7 +170,8 @@ class CORE_EXPORT QgsStringReplacementCollection }; -/** \ingroup core +/** + * \ingroup core * \class QgsStringUtils * \brief Utility functions for working with strings. * \since QGIS 2.11 @@ -177,7 +190,8 @@ class CORE_EXPORT QgsStringUtils ForceFirstLetterToCapital = QFont::Capitalize, //!< Convert just the first letter of each word to uppercase, leave the rest untouched }; - /** Converts a string by applying capitalization rules to the string. + /** + * Converts a string by applying capitalization rules to the string. * \param string input string * \param capitalization capitalization type to apply * \returns capitalized string @@ -185,7 +199,8 @@ class CORE_EXPORT QgsStringUtils */ static QString capitalize( const QString &string, Capitalization capitalization ); - /** Returns the Levenshtein edit distance between two strings. This equates to the minimum + /** + * Returns the Levenshtein edit distance between two strings. This equates to the minimum * number of character edits (insertions, deletions or substitutions) required to change * one string to another. * \param string1 first string @@ -195,7 +210,8 @@ class CORE_EXPORT QgsStringUtils */ static int levenshteinDistance( const QString &string1, const QString &string2, bool caseSensitive = false ); - /** Returns the longest common substring between two strings. This substring is the longest + /** + * Returns the longest common substring between two strings. This substring is the longest * string that is a substring of the two input strings. For example, the longest common substring * of "ABABC" and "BABCA" is "ABC". * \param string1 first string @@ -205,7 +221,8 @@ class CORE_EXPORT QgsStringUtils */ static QString longestCommonSubstring( const QString &string1, const QString &string2, bool caseSensitive = false ); - /** Returns the Hamming distance between two strings. This equates to the number of characters at + /** + * Returns the Hamming distance between two strings. This equates to the number of characters at * corresponding positions within the input strings where the characters are different. The input * strings must be the same length. * \param string1 first string @@ -215,14 +232,16 @@ class CORE_EXPORT QgsStringUtils */ static int hammingDistance( const QString &string1, const QString &string2, bool caseSensitive = false ); - /** Returns the Soundex representation of a string. Soundex is a phonetic matching algorithm, + /** + * Returns the Soundex representation of a string. Soundex is a phonetic matching algorithm, * so strings with similar sounds should be represented by the same Soundex code. * \param string input string * \returns 4 letter Soundex code */ static QString soundex( const QString &string ); - /** Returns a string with any URL (e.g., http(s)/ftp) and mailto: text converted to valid HTML + /** + * Returns a string with any URL (e.g., http(s)/ftp) and mailto: text converted to valid HTML * links. * \param string string to insert links into * \param foundLinks if specified, will be set to true if any links were inserted into the string diff --git a/src/core/qgstaskmanager.h b/src/core/qgstaskmanager.h index 2490dd4d2d64..acd1b0e57ef8 100644 --- a/src/core/qgstaskmanager.h +++ b/src/core/qgstaskmanager.h @@ -351,7 +351,8 @@ class CORE_EXPORT QgsTask : public QObject Q_DECLARE_OPERATORS_FOR_FLAGS( QgsTask::Flags ) -/** \ingroup core +/** + * \ingroup core * \class QgsTaskManager * \brief Task manager for managing a set of long-running QgsTask tasks. This class can be created directly, * or accessed via QgsApplication::taskManager(). @@ -363,7 +364,8 @@ class CORE_EXPORT QgsTaskManager : public QObject public: - /** Constructor for QgsTaskManager. + /** + * Constructor for QgsTaskManager. * \param parent parent QObject */ QgsTaskManager( QObject *parent SIP_TRANSFERTHIS = 0 ); @@ -397,7 +399,8 @@ class CORE_EXPORT QgsTaskManager : public QObject }; - /** Adds a task to the manager. Ownership of the task is transferred + /** + * Adds a task to the manager. Ownership of the task is transferred * to the manager, and the task manager will be responsible for starting * the task. The priority argument can be used to control the run queue's * order of execution, with larger numbers @@ -416,20 +419,23 @@ class CORE_EXPORT QgsTaskManager : public QObject */ long addTask( const TaskDefinition &task SIP_TRANSFER, int priority = 0 ); - /** Returns the task with matching ID. + /** + * Returns the task with matching ID. * \param id task ID * \returns task if found, or nullptr */ QgsTask *task( long id ) const; - /** Returns all tasks tracked by the manager. + /** + * Returns all tasks tracked by the manager. */ QList tasks() const; //! Returns the number of tasks tracked by the manager. int count() const; - /** Returns the unique task ID corresponding to a task managed by the class. + /** + * Returns the unique task ID corresponding to a task managed by the class. * \param task task to find * \returns task ID, or -1 if task not found */ @@ -451,7 +457,8 @@ class CORE_EXPORT QgsTaskManager : public QObject */ QSet< long > dependencies( long taskId ) const SIP_SKIP; - /** Returns a list of layers on which as task is dependent. The task will automatically + /** + * Returns a list of layers on which as task is dependent. The task will automatically * be canceled if any of these layers are above to be removed. * \param taskId task ID * \returns list of layers @@ -465,12 +472,14 @@ class CORE_EXPORT QgsTaskManager : public QObject */ QList< QgsTask * > tasksDependentOnLayer( QgsMapLayer *layer ) const; - /** Returns a list of the active (queued or running) tasks. + /** + * Returns a list of the active (queued or running) tasks. * \see countActiveTasks() */ QList< QgsTask * > activeTasks() const; - /** Returns the number of active (queued or running) tasks. + /** + * Returns the number of active (queued or running) tasks. * \see activeTasks() * \see countActiveTasksChanged() */ diff --git a/src/core/qgstextlabelfeature.h b/src/core/qgstextlabelfeature.h index b1afaee5ab2c..745fcb4b1d58 100644 --- a/src/core/qgstextlabelfeature.h +++ b/src/core/qgstextlabelfeature.h @@ -19,7 +19,8 @@ #include "qgslabelfeature.h" -/** \ingroup core +/** + * \ingroup core * Class that adds extra information to QgsLabelFeature for text labels * * \note not part of public API @@ -33,7 +34,8 @@ class QgsTextLabelFeature : public QgsLabelFeature //! Clean up ~QgsTextLabelFeature(); - /** Returns the text component corresponding to a specified label part + /** + * Returns the text component corresponding to a specified label part * \param partId Set to -1 for labels which are not broken into parts (e.g., non-curved labels), or the required * part index for labels which are broken into parts (curved labels) * \since QGIS 2.10 diff --git a/src/core/qgstextrenderer.h b/src/core/qgstextrenderer.h index f0e9ce00478d..00095952c500 100644 --- a/src/core/qgstextrenderer.h +++ b/src/core/qgstextrenderer.h @@ -35,7 +35,8 @@ class QgsTextSettingsPrivate; class QgsVectorLayer; class QgsPaintEffect; -/** \class QgsTextBufferSettings +/** + * \class QgsTextBufferSettings * \ingroup core * Container for settings relating to a text buffer. * \note QgsTextBufferSettings objects are implicitly shared. @@ -48,63 +49,73 @@ class CORE_EXPORT QgsTextBufferSettings QgsTextBufferSettings(); - /** Copy constructor. + /** + * Copy constructor. * \param other source settings */ QgsTextBufferSettings( const QgsTextBufferSettings &other ); - /** Copy constructor. + /** + * Copy constructor. * \param other source QgsTextBufferSettings */ QgsTextBufferSettings &operator=( const QgsTextBufferSettings &other ); ~QgsTextBufferSettings(); - /** Returns whether the buffer is enabled. + /** + * Returns whether the buffer is enabled. * \see setEnabled() */ bool enabled() const; - /** Sets whether the text buffer will be drawn. + /** + * Sets whether the text buffer will be drawn. * \param enabled set to true to draw buffer * \see enabled() */ void setEnabled( bool enabled ); - /** Returns the size of the buffer. + /** + * Returns the size of the buffer. * \see sizeUnit() * \see setSize() */ double size() const; - /** Sets the size of the buffer. The size units are specified using setSizeUnit(). + /** + * Sets the size of the buffer. The size units are specified using setSizeUnit(). * \param size buffer size * \see size() * \see setSizeUnit() */ void setSize( double size ); - /** Returns the units for the buffer size. + /** + * Returns the units for the buffer size. * \see size() * \see setSizeUnit() */ QgsUnitTypes::RenderUnit sizeUnit() const; - /** Sets the units used for the buffer size. + /** + * Sets the units used for the buffer size. * \param unit size unit * \see setSize() * \see sizeUnit() */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ); - /** Returns the map unit scale object for the buffer size. This is only used if the + /** + * Returns the map unit scale object for the buffer size. This is only used if the * buffer size is set to QgsUnitTypes::RenderMapUnit. * \see setSizeMapUnitScale() * \see sizeUnit() */ QgsMapUnitScale sizeMapUnitScale() const; - /** Sets the map unit scale object for the buffer size. This is only used if the + /** + * Sets the map unit scale object for the buffer size. This is only used if the * buffer size is set to QgsUnitTypes::RenderMapUnit. * \param scale scale for buffer size * \see sizeMapUnitScale() @@ -112,88 +123,103 @@ class CORE_EXPORT QgsTextBufferSettings */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns the color of the buffer. + /** + * Returns the color of the buffer. * \see setColor() */ QColor color() const; - /** Sets the color for the buffer. + /** + * Sets the color for the buffer. * \param color buffer color * \see color() */ void setColor( const QColor &color ); - /** Returns whether the interior of the buffer will be filled in. If false, only the stroke + /** + * Returns whether the interior of the buffer will be filled in. If false, only the stroke * of the text will be drawn as the buffer. The effect of this setting is only visible for * semi-transparent text. * \see setFillBufferInterior() */ bool fillBufferInterior() const; - /** Sets whether the interior of the buffer will be filled in. + /** + * Sets whether the interior of the buffer will be filled in. * \param fill set to false to drawn only the stroke of the text as the buffer, or true to also * shade the area inside the text. The effect of this setting is only visible for semi-transparent text. * \see fillBufferInterior() */ void setFillBufferInterior( bool fill ); - /** Returns the buffer opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally + /** + * Returns the buffer opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally * opaque). * \see setOpacity() */ double opacity() const; - /** Sets the buffer opacity. + /** + * Sets the buffer opacity. * \param opacity opacity as a double value between 0 (fully transparent) and 1 (totally * opaque) * \see opacity() */ void setOpacity( double opacity ); - /** Returns the buffer join style. + /** + * Returns the buffer join style. * \see setJoinStyle */ Qt::PenJoinStyle joinStyle() const; - /** Sets the join style used for drawing the buffer. + /** + * Sets the join style used for drawing the buffer. * \param style join style * \see joinStyle() */ void setJoinStyle( Qt::PenJoinStyle style ); - /** Returns the blending mode used for drawing the buffer. + /** + * Returns the blending mode used for drawing the buffer. * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; - /** Sets the blending mode used for drawing the buffer. + /** + * Sets the blending mode used for drawing the buffer. * \param mode blending mode * \see blendMode() */ void setBlendMode( QPainter::CompositionMode mode ); - /** Reads settings from a layer's custom properties (for QGIS 2.x projects). + /** + * Reads settings from a layer's custom properties (for QGIS 2.x projects). * \param layer source vector layer */ void readFromLayer( QgsVectorLayer *layer ); - /** Read settings from a DOM element. + /** + * Read settings from a DOM element. * \see writeXml() */ void readXml( const QDomElement &elem ); - /** Write settings into a DOM element. + /** + * Write settings into a DOM element. * \see readXml() */ QDomElement writeXml( QDomDocument &doc ) const; - /** Returns the current paint effect for the buffer. + /** + * Returns the current paint effect for the buffer. * \returns paint effect * \see setPaintEffect() */ QgsPaintEffect *paintEffect() const; - /** Sets the current paint \a effect for the buffer. + /** + * Sets the current paint \a effect for the buffer. * \param effect paint effect. Ownership is transferred to the buffer settings. * \see paintEffect() */ @@ -205,7 +231,8 @@ class CORE_EXPORT QgsTextBufferSettings }; -/** \class QgsTextBackgroundSettings +/** + * \class QgsTextBackgroundSettings * \ingroup core * Container for settings relating to a text background object. * \note QgsTextBackgroundSettings objects are implicitly shared. @@ -216,7 +243,8 @@ class CORE_EXPORT QgsTextBackgroundSettings { public: - /** Background shape types. + /** + * Background shape types. */ enum ShapeType { @@ -227,7 +255,8 @@ class CORE_EXPORT QgsTextBackgroundSettings ShapeSVG //!< SVG file }; - /** Methods for determining the background shape size. + /** + * Methods for determining the background shape size. */ enum SizeType { @@ -236,7 +265,8 @@ class CORE_EXPORT QgsTextBackgroundSettings SizePercent //!< Shape size is determined by percent of text size }; - /** Methods for determining the rotation of the background shape. + /** + * Methods for determining the rotation of the background shape. */ enum RotationType { @@ -247,7 +277,8 @@ class CORE_EXPORT QgsTextBackgroundSettings QgsTextBackgroundSettings(); - /** Copy constructor. + /** + * Copy constructor. * \param other source QgsTextBackgroundSettings */ QgsTextBackgroundSettings( const QgsTextBackgroundSettings &other ); @@ -256,48 +287,56 @@ class CORE_EXPORT QgsTextBackgroundSettings ~QgsTextBackgroundSettings(); - /** Returns whether the background is enabled. + /** + * Returns whether the background is enabled. * \see setEnabled() */ bool enabled() const; - /** Sets whether the text background will be drawn. + /** + * Sets whether the text background will be drawn. * \param enabled set to true to draw background * \see enabled() */ void setEnabled( bool enabled ); - /** Returns the type of background shape (e.g., square, ellipse, SVG). + /** + * Returns the type of background shape (e.g., square, ellipse, SVG). * \see setType() */ ShapeType type() const; - /** Sets the type of background shape to draw (e.g., square, ellipse, SVG). + /** + * Sets the type of background shape to draw (e.g., square, ellipse, SVG). * \param type shape type * \see type() */ void setType( ShapeType type ); - /** Returns the absolute path to the background SVG file, if set. + /** + * Returns the absolute path to the background SVG file, if set. * \see setSvgFile() */ QString svgFile() const; - /** Sets the path to the background SVG file. This is only used if type() is set to + /** + * Sets the path to the background SVG file. This is only used if type() is set to * QgsTextBackgroundSettings::ShapeSVG. The path must be absolute. * \param file Absolute SVG file path * \see svgFile() */ void setSvgFile( const QString &file ); - /** Returns the method used to determine the size of the background shape (e.g., fixed size or buffer + /** + * Returns the method used to determine the size of the background shape (e.g., fixed size or buffer * around text). * \see setSizeType() * \see size() */ SizeType sizeType() const; - /** Sets the method used to determine the size of the background shape (e.g., fixed size or buffer + /** + * Sets the method used to determine the size of the background shape (e.g., fixed size or buffer * around text). * \param type size method * \see sizeType() @@ -305,7 +344,8 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setSizeType( SizeType type ); - /** Returns the size of the background shape. The meaning of the size depends on the current sizeType(), + /** + * Returns the size of the background shape. The meaning of the size depends on the current sizeType(), * e.g., for size types of QgsTextBackgroundSettings::SizeFixed the size will represent the actual width and * height of the shape, for QgsTextBackgroundSettings::SizeBuffer the size will represent the horizontal * and vertical margins to add to the text when calculating the size of the shape. @@ -314,7 +354,8 @@ class CORE_EXPORT QgsTextBackgroundSettings */ QSizeF size() const; - /** Sets the size of the background shape. The meaning of the size depends on the current sizeType(), + /** + * Sets the size of the background shape. The meaning of the size depends on the current sizeType(), * e.g., for size types of QgsTextBackgroundSettings::SizeFixed the size will represent the actual width and * height of the shape, for QgsTextBackgroundSettings::SizeBuffer the size will represent the horizontal * and vertical margins to add to the text when calculating the size of the shape. @@ -324,7 +365,8 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setSize( const QSizeF &size ); - /** Returns the units used for the shape's size. This value has no meaning if the sizeType() is set to + /** + * Returns the units used for the shape's size. This value has no meaning if the sizeType() is set to * QgsTextBackgroundSettings::SizePercent. * \see setSizeUnit() * \see sizeType() @@ -332,7 +374,8 @@ class CORE_EXPORT QgsTextBackgroundSettings */ QgsUnitTypes::RenderUnit sizeUnit() const; - /** Sets the units used for the shape's size. This value has no meaning if the sizeType() is set to + /** + * Sets the units used for the shape's size. This value has no meaning if the sizeType() is set to * QgsTextBackgroundSettings::SizePercent. * \param unit size units * \see sizeUnit() @@ -341,14 +384,16 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ); - /** Returns the map unit scale object for the shape size. This is only used if the + /** + * Returns the map unit scale object for the shape size. This is only used if the * sizeUnit() is set to QgsUnitTypes::RenderMapUnit. * \see setSizeMapUnitScale() * \see sizeUnit() */ QgsMapUnitScale sizeMapUnitScale() const; - /** Sets the map unit scale object for the shape size. This is only used if the + /** + * Sets the map unit scale object for the shape size. This is only used if the * sizeUnit() is set to QgsUnitTypes::RenderMapUnit. * \param scale scale for shape size * \see sizeMapUnitScale() @@ -356,13 +401,15 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns the method used for rotating the background shape. + /** + * Returns the method used for rotating the background shape. * \see setRotationType() * \see rotation() */ RotationType rotationType() const; - /** Sets the method used for rotating the background shape. + /** + * Sets the method used for rotating the background shape. * \param type rotation method * \see rotationType() * \see setRotation() @@ -383,14 +430,16 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setRotation( double rotation ); - /** Returns the offset used for drawing the background shape. Units are determined + /** + * Returns the offset used for drawing the background shape. Units are determined * via offsetUnit(). * \see setOffset() * \see offsetUnit() */ QPointF offset() const; - /** Sets the offset used for drawing the background shape. Units are specified using + /** + * Sets the offset used for drawing the background shape. Units are specified using * setOffsetUnit(). * \param offset offset for shape * \see offset() @@ -398,27 +447,31 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setOffset( const QPointF &offset ); - /** Returns the units used for the shape's offset. + /** + * Returns the units used for the shape's offset. * \see setOffsetUnit() * \see offset() */ QgsUnitTypes::RenderUnit offsetUnit() const; - /** Sets the units used for the shape's offset. + /** + * Sets the units used for the shape's offset. * \param units offset units * \see offsetUnit() * \see setOffset() */ void setOffsetUnit( QgsUnitTypes::RenderUnit units ); - /** Returns the map unit scale object for the shape offset. This is only used if the + /** + * Returns the map unit scale object for the shape offset. This is only used if the * offsetUnit() is set to QgsUnitTypes::RenderMapUnit. * \see setOffsetMapUnitScale() * \see offsetUnit() */ QgsMapUnitScale offsetMapUnitScale() const; - /** Sets the map unit scale object for the shape offset. This is only used if the + /** + * Sets the map unit scale object for the shape offset. This is only used if the * offsetUnit() is set to QgsUnitTypes::RenderMapUnit. * \param scale scale for shape offset * \see offsetMapUnitScale() @@ -426,14 +479,16 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns the radii used for rounding the corners of shapes. Units are retrieved + /** + * Returns the radii used for rounding the corners of shapes. Units are retrieved * through radiiUnit(). * \see setRadii() * \see radiiUnit() */ QSizeF radii() const; - /** Sets the radii used for rounding the corners of shapes. This is only used if + /** + * Sets the radii used for rounding the corners of shapes. This is only used if * type() is set to QgsTextBackgroundSettings::ShapeRectangle or QgsTextBackgroundSettings::ShapeSquare. * \param radii QSizeF representing horizontal and vertical radii for rounded corners. Units are * specified through setRadiiUnit() @@ -442,27 +497,31 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setRadii( const QSizeF &radii ); - /** Returns the units used for the shape's radii. + /** + * Returns the units used for the shape's radii. * \see setRadiiUnit() * \see radii() */ QgsUnitTypes::RenderUnit radiiUnit() const; - /** Sets the units used for the shape's radii. + /** + * Sets the units used for the shape's radii. * \param units radii units * \see radiiUnit() * \see setRadii() */ void setRadiiUnit( QgsUnitTypes::RenderUnit units ); - /** Returns the map unit scale object for the shape radii. This is only used if the + /** + * Returns the map unit scale object for the shape radii. This is only used if the * radiiUnit() is set to QgsUnitTypes::RenderMapUnit. * \see setRadiiMapUnitScale() * \see radiiUnit() */ QgsMapUnitScale radiiMapUnitScale() const; - /** Sets the map unit scale object for the shape radii. This is only used if the + /** + * Sets the map unit scale object for the shape radii. This is only used if the * radiiUnit() is set to QgsUnitTypes::RenderMapUnit. * \param scale scale for shape radii * \see radiiMapUnitScale() @@ -470,91 +529,105 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setRadiiMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns the background shape's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally + /** + * Returns the background shape's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally * opaque). * \see setOpacity() */ double opacity() const; - /** Sets the background shape's opacity. + /** + * Sets the background shape's opacity. * \param opacity opacity as a double value between 0 (fully transparent) and 1 (totally * opaque) * \see opacity() */ void setOpacity( double opacity ); - /** Returns the blending mode used for drawing the background shape. + /** + * Returns the blending mode used for drawing the background shape. * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; - /** Sets the blending mode used for drawing the background shape. + /** + * Sets the blending mode used for drawing the background shape. * \param mode blending mode * \see blendMode() */ void setBlendMode( QPainter::CompositionMode mode ); - /** Returns the color used for filing the background shape. + /** + * Returns the color used for filing the background shape. * \see setFillColor() * \see strokeColor() */ QColor fillColor() const; - /** Sets the color used for filing the background shape. + /** + * Sets the color used for filing the background shape. * \param color background color * \see fillColor() * \see setStrokeColor() */ void setFillColor( const QColor &color ); - /** Returns the color used for outlining the background shape. + /** + * Returns the color used for outlining the background shape. * \see setStrokeColor() * \see fillColor() */ QColor strokeColor() const; - /** Sets the color used for outlining the background shape. + /** + * Sets the color used for outlining the background shape. * \param color stroke color * \see strokeColor() * \see setFillColor() */ void setStrokeColor( const QColor &color ); - /** Returns the width of the shape's stroke (stroke). Units are retrieved through + /** + * Returns the width of the shape's stroke (stroke). Units are retrieved through * strokeWidthUnit(). * \see setStrokeWidth() * \see strokeWidthUnit() */ double strokeWidth() const; - /** Sets the width of the shape's stroke (stroke). Units are specified through + /** + * Sets the width of the shape's stroke (stroke). Units are specified through * setStrokeWidthUnit(). * \see strokeWidth() * \see setStrokeWidthUnit() */ void setStrokeWidth( double width ); - /** Returns the units used for the shape's stroke width. + /** + * Returns the units used for the shape's stroke width. * \see setStrokeWidthUnit() * \see strokeWidth() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const; - /** Sets the units used for the shape's stroke width. + /** + * Sets the units used for the shape's stroke width. * \param units stroke width units * \see strokeWidthUnit() * \see setStrokeWidth() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit units ); - /** Returns the map unit scale object for the shape stroke width. This is only used if the + /** + * Returns the map unit scale object for the shape stroke width. This is only used if the * strokeWidthUnit() is set to QgsUnitTypes::RenderMapUnit. * \see setStrokeWidthMapUnitScale() * \see strokeWidthUnit() */ QgsMapUnitScale strokeWidthMapUnitScale() const; - /** Sets the map unit scale object for the shape stroke width. This is only used if the + /** + * Sets the map unit scale object for the shape stroke width. This is only used if the * strokeWidthUnit() is set to QgsUnitTypes::RenderMapUnit. * \param scale scale for shape stroke width * \see strokeWidthMapUnitScale() @@ -562,40 +635,47 @@ class CORE_EXPORT QgsTextBackgroundSettings */ void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns the join style used for drawing the background shape. + /** + * Returns the join style used for drawing the background shape. * \see setJoinStyle */ Qt::PenJoinStyle joinStyle() const; - /** Sets the join style used for drawing the background shape. + /** + * Sets the join style used for drawing the background shape. * \param style join style * \see joinStyle() */ void setJoinStyle( Qt::PenJoinStyle style ); - /** Returns the current paint effect for the background shape. + /** + * Returns the current paint effect for the background shape. * \returns paint effect * \see setPaintEffect() */ QgsPaintEffect *paintEffect() const; - /** Sets the current paint \a effect for the background shape. + /** + * Sets the current paint \a effect for the background shape. * \param effect paint effect. Ownership is transferred to the background settings. * \see paintEffect() */ void setPaintEffect( QgsPaintEffect *effect SIP_TRANSFER ); - /** Reads settings from a layer's custom properties (for QGIS 2.x projects). + /** + * Reads settings from a layer's custom properties (for QGIS 2.x projects). * \param layer source vector layer */ void readFromLayer( QgsVectorLayer *layer ); - /** Read settings from a DOM element. + /** + * Read settings from a DOM element. * \see writeXml() */ void readXml( const QDomElement &elem, const QgsReadWriteContext &context ); - /** Write settings into a DOM element. + /** + * Write settings into a DOM element. * \see readXml() */ QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const; @@ -606,7 +686,8 @@ class CORE_EXPORT QgsTextBackgroundSettings }; -/** \class QgsTextShadowSettings +/** + * \class QgsTextShadowSettings * \ingroup core * Container for settings relating to a text shadow. * \note QgsTextShadowSettings objects are implicitly shared. @@ -617,7 +698,8 @@ class CORE_EXPORT QgsTextShadowSettings { public: - /** Placement positions for text shadow. + /** + * Placement positions for text shadow. */ enum ShadowPlacement { @@ -629,7 +711,8 @@ class CORE_EXPORT QgsTextShadowSettings QgsTextShadowSettings(); - /** Copy constructor. + /** + * Copy constructor. * \param other source QgsTextShadowSettings */ QgsTextShadowSettings( const QgsTextShadowSettings &other ); @@ -638,25 +721,29 @@ class CORE_EXPORT QgsTextShadowSettings ~QgsTextShadowSettings(); - /** Returns whether the shadow is enabled. + /** + * Returns whether the shadow is enabled. * \see setEnabled() */ bool enabled() const; - /** Sets whether the text shadow will be drawn. + /** + * Sets whether the text shadow will be drawn. * \param enabled set to true to draw shadow * \see enabled() */ void setEnabled( bool enabled ); - /** Returns the placement for the drop shadow. The placement determines + /** + * Returns the placement for the drop shadow. The placement determines * both the z-order stacking position for the shadow and the what shape (e.g., text, * background shape) is used for casting the shadow. * \see setShadowPlacement() */ QgsTextShadowSettings::ShadowPlacement shadowPlacement() const; - /** Sets the placement for the drop shadow. The placement determines + /** + * Sets the placement for the drop shadow. The placement determines * both the z-order stacking position for the shadow and the what shape (e.g., text, * background shape) is used for casting the shadow. * \param placement shadow placement @@ -664,27 +751,31 @@ class CORE_EXPORT QgsTextShadowSettings */ void setShadowPlacement( QgsTextShadowSettings::ShadowPlacement placement ); - /** Returns the angle for offsetting the position of the shadow from the text. + /** + * Returns the angle for offsetting the position of the shadow from the text. * \see setOffsetAngle * \see offsetDistance() */ int offsetAngle() const; - /** Sets the angle for offsetting the position of the shadow from the text. + /** + * Sets the angle for offsetting the position of the shadow from the text. * \param angle offset angle in degrees * \see offsetAngle() * \see setOffsetDistance() */ void setOffsetAngle( int angle ); - /** Returns the distance for offsetting the position of the shadow from the text. Offset units + /** + * Returns the distance for offsetting the position of the shadow from the text. Offset units * are retrieved via offsetUnit(). * \see setOffsetDistance() * \see offsetUnit() */ double offsetDistance() const; - /** Sets the distance for offsetting the position of the shadow from the text. Offset units + /** + * Sets the distance for offsetting the position of the shadow from the text. Offset units * are specified via setOffsetUnit(). * \param distance offset distance * \see offsetDistance() @@ -692,27 +783,31 @@ class CORE_EXPORT QgsTextShadowSettings */ void setOffsetDistance( double distance ); - /** Returns the units used for the shadow's offset. + /** + * Returns the units used for the shadow's offset. * \see setOffsetUnit() * \see offsetDistance() */ QgsUnitTypes::RenderUnit offsetUnit() const; - /** Sets the units used for the shadow's offset. + /** + * Sets the units used for the shadow's offset. * \param units shadow distance units * \see offsetUnit() * \see setOffsetDistance() */ void setOffsetUnit( QgsUnitTypes::RenderUnit units ); - /** Returns the map unit scale object for the shadow offset distance. This is only used if the + /** + * Returns the map unit scale object for the shadow offset distance. This is only used if the * offsetUnit() is set to QgsUnitTypes::RenderMapUnit. * \see setOffsetMapUnitScale() * \see offsetUnit() */ QgsMapUnitScale offsetMapUnitScale() const; - /** Sets the map unit scale object for the shadow offset distance. This is only used if the + /** + * Sets the map unit scale object for the shadow offset distance. This is only used if the * offsetUnit() is set to QgsUnitTypes::RenderMapUnit. * \param scale scale for shadow offset * \see offsetMapUnitScale() @@ -720,50 +815,58 @@ class CORE_EXPORT QgsTextShadowSettings */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns true if the global shadow offset will be used. + /** + * Returns true if the global shadow offset will be used. * \see setOffsetGlobal() */ bool offsetGlobal() const; - /** Sets whether the global shadow offset should be used. + /** + * Sets whether the global shadow offset should be used. * \param global set to true to use global shadow offset. */ void setOffsetGlobal( bool global ); - /** Returns the blur radius for the shadow. Radius units are retrieved via blurRadiusUnits(). + /** + * Returns the blur radius for the shadow. Radius units are retrieved via blurRadiusUnits(). * \see setBlurRadius() * \see blurRadiusUnit() */ double blurRadius() const; - /** Sets the blur radius for the shadow. Radius units are specified via setBlurRadiusUnits(). + /** + * Sets the blur radius for the shadow. Radius units are specified via setBlurRadiusUnits(). * \param blurRadius blur radius * \see blurRadius() * \see setBlurRadiusUnit() */ void setBlurRadius( double blurRadius ); - /** Returns the units used for the shadow's blur radius. + /** + * Returns the units used for the shadow's blur radius. * \see setBlurRadiusUnit() * \see blurRadius() */ QgsUnitTypes::RenderUnit blurRadiusUnit() const; - /** Sets the units used for the shadow's blur radius. + /** + * Sets the units used for the shadow's blur radius. * \param units shadow blur radius units * \see blurRadiusUnit() * \see setBlurRadius() */ void setBlurRadiusUnit( QgsUnitTypes::RenderUnit units ); - /** Returns the map unit scale object for the shadow blur radius. This is only used if the + /** + * Returns the map unit scale object for the shadow blur radius. This is only used if the * blurRadiusUnit() is set to QgsUnitTypes::RenderMapUnit. * \see setBlurRadiusMapUnitScale() * \see blurRadiusUnit() */ QgsMapUnitScale blurRadiusMapUnitScale() const; - /** Sets the map unit scale object for the shadow blur radius. This is only used if the + /** + * Sets the map unit scale object for the shadow blur radius. This is only used if the * blurRadiusUnit() is set to QgsUnitTypes::RenderMapUnit. * \param scale scale for shadow blur radius * \see blurRadiusMapUnitScale() @@ -771,75 +874,88 @@ class CORE_EXPORT QgsTextShadowSettings */ void setBlurRadiusMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns whether only the alpha channel for the shadow will be blurred. + /** + * Returns whether only the alpha channel for the shadow will be blurred. * \see setBlurAlphaOnly() */ bool blurAlphaOnly() const; - /** Sets whether only the alpha channel for the shadow should be blurred. + /** + * Sets whether only the alpha channel for the shadow should be blurred. * \param alphaOnly set to true to blur only the alpha channel. If false, all channels (including * red, green and blue channel) will be blurred. * \see blurAlphaOnly() */ void setBlurAlphaOnly( bool alphaOnly ); - /** Returns the shadow's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally + /** + * Returns the shadow's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally * opaque). * \see setOpacity() */ double opacity() const; - /** Sets the shadow's opacity. + /** + * Sets the shadow's opacity. * \param opacity opacity as a double value between 0 (fully transparent) and 1 (totally * opaque) * \see opacity() */ void setOpacity( double opacity ); - /** Returns the scaling used for the drop shadow (in percentage of original size). + /** + * Returns the scaling used for the drop shadow (in percentage of original size). * \see setScale() */ int scale() const; - /** Sets the scaling used for the drop shadow (in percentage of original size). + /** + * Sets the scaling used for the drop shadow (in percentage of original size). * \param scale scale percent for drop shadow * \see scale() */ void setScale( int scale ); - /** Returns the color of the drop shadow. + /** + * Returns the color of the drop shadow. * \see setColor() */ QColor color() const; - /** Sets the color for the drop shadow. + /** + * Sets the color for the drop shadow. * \param color shadow color * \see color() */ void setColor( const QColor &color ); - /** Returns the blending mode used for drawing the drop shadow. + /** + * Returns the blending mode used for drawing the drop shadow. * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; - /** Sets the blending mode used for drawing the drop shadow. + /** + * Sets the blending mode used for drawing the drop shadow. * \param mode blending mode * \see blendMode() */ void setBlendMode( QPainter::CompositionMode mode ); - /** Reads settings from a layer's custom properties (for QGIS 2.x projects). + /** + * Reads settings from a layer's custom properties (for QGIS 2.x projects). * \param layer source vector layer */ void readFromLayer( QgsVectorLayer *layer ); - /** Read settings from a DOM element. + /** + * Read settings from a DOM element. * \see writeXml() */ void readXml( const QDomElement &elem ); - /** Write settings into a DOM element. + /** + * Write settings into a DOM element. * \see readXml() */ QDomElement writeXml( QDomDocument &doc ) const; @@ -851,7 +967,8 @@ class CORE_EXPORT QgsTextShadowSettings }; -/** \class QgsTextFormat +/** + * \class QgsTextFormat * \ingroup core * Container for all settings relating to text rendering. * \note QgsTextFormat objects are implicitly shared. @@ -864,7 +981,8 @@ class CORE_EXPORT QgsTextFormat QgsTextFormat(); - /** Copy constructor. + /** + * Copy constructor. * \param other source QgsTextFormat */ QgsTextFormat( const QgsTextFormat &other ); @@ -873,55 +991,65 @@ class CORE_EXPORT QgsTextFormat ~QgsTextFormat(); - /** Returns a reference to the text buffer settings. + /** + * Returns a reference to the text buffer settings. * \see setBuffer() */ QgsTextBufferSettings &buffer() { return mBufferSettings; } - /** Returns a reference to the text buffer settings. + /** + * Returns a reference to the text buffer settings. * \see setBuffer() */ SIP_SKIP QgsTextBufferSettings buffer() const { return mBufferSettings; } - /** Sets the text's buffer settings. + /** + * Sets the text's buffer settings. * \param bufferSettings buffer settings * \see buffer() */ void setBuffer( const QgsTextBufferSettings &bufferSettings ) { mBufferSettings = bufferSettings; } - /** Returns a reference to the text background settings. + /** + * Returns a reference to the text background settings. * \see setBackground() */ QgsTextBackgroundSettings &background() { return mBackgroundSettings; } - /** Returns a reference to the text background settings. + /** + * Returns a reference to the text background settings. * \see setBackground() */ SIP_SKIP QgsTextBackgroundSettings background() const { return mBackgroundSettings; } - /** Sets the text's background settings.q + /** + * Sets the text's background settings.q * \param backgroundSettings background settings * \see background() */ void setBackground( const QgsTextBackgroundSettings &backgroundSettings ) { mBackgroundSettings = backgroundSettings; } - /** Returns a reference to the text drop shadow settings. + /** + * Returns a reference to the text drop shadow settings. * \see setShadow() */ QgsTextShadowSettings &shadow() { return mShadowSettings; } - /** Returns a reference to the text drop shadow settings. + /** + * Returns a reference to the text drop shadow settings. * \see setShadow() */ SIP_SKIP QgsTextShadowSettings shadow() const { return mShadowSettings; } - /** Sets the text's drop shadow settings. + /** + * Sets the text's drop shadow settings. * \param shadowSettings shadow settings * \see shadow() */ void setShadow( const QgsTextShadowSettings &shadowSettings ) { mShadowSettings = shadowSettings; } - /** Returns the font used for rendering text. Note that the size of the font + /** + * Returns the font used for rendering text. Note that the size of the font * is not used, and size() should be called instead to determine the size * of rendered text. * \see scaledFont() @@ -930,7 +1058,8 @@ class CORE_EXPORT QgsTextFormat */ QFont font() const; - /** Returns a font with the size scaled to match the format's size settings (including + /** + * Returns a font with the size scaled to match the format's size settings (including * units and map unit scale) for a specified render context. * \param context destination render context * \returns font with scaled size @@ -939,7 +1068,8 @@ class CORE_EXPORT QgsTextFormat */ QFont scaledFont( const QgsRenderContext &context ) const; - /** Sets the font used for rendering text. Note that the size of the font + /** + * Sets the font used for rendering text. Note that the size of the font * is not used, and setSize() should be called instead to explicitly set the size * of rendered text. * \param font desired font @@ -948,40 +1078,46 @@ class CORE_EXPORT QgsTextFormat */ void setFont( const QFont &font ); - /** Returns the named style for the font used for rendering text (e.g., "bold"). + /** + * Returns the named style for the font used for rendering text (e.g., "bold"). * \see setNamedStyle() * \see font() */ QString namedStyle() const; - /** Sets the named style for the font used for rendering text. + /** + * Sets the named style for the font used for rendering text. * \param style named style, e.g., "bold" * \see namedStyle() * \see setFont() */ void setNamedStyle( const QString &style ); - /** Returns the size for rendered text. Units are retrieved using sizeUnit(). + /** + * Returns the size for rendered text. Units are retrieved using sizeUnit(). * \see setSize() * \see sizeUnit() */ double size() const; - /** Sets the size for rendered text. + /** + * Sets the size for rendered text. * \param size size of rendered text. Units are set using setSizeUnit() * \see size() * \see setSizeUnit() */ void setSize( double size ); - /** Returns the units for the size of rendered text. + /** + * Returns the units for the size of rendered text. * \see size() * \see setSizeUnit() * \see sizeMapUnitScale() */ QgsUnitTypes::RenderUnit sizeUnit() const; - /** Sets the units for the size of rendered text. + /** + * Sets the units for the size of rendered text. * \param unit size units * \see setSize() * \see sizeUnit() @@ -989,63 +1125,73 @@ class CORE_EXPORT QgsTextFormat */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ); - /** Returns the map unit scale object for the size. This is only used if the + /** + * Returns the map unit scale object for the size. This is only used if the * sizeUnit() is set to QgsUnitTypes::RenderMapUnit. * \see setSizeMapUnitScale() * \see sizeUnit() */ QgsMapUnitScale sizeMapUnitScale() const; - /** Sets the map unit scale object for the size. This is only used if the + /** + * Sets the map unit scale object for the size. This is only used if the * sizeUnit() is set to QgsUnitTypes::RenderMapUnit. * \see sizeMapUnitScale() * \see setSizeUnit() */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns the color that text will be rendered in. + /** + * Returns the color that text will be rendered in. * \see setColor() */ QColor color() const; - /** Sets the color that text will be rendered in. + /** + * Sets the color that text will be rendered in. * \param color text color * \see color() */ void setColor( const QColor &color ); - /** Returns the text's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally + /** + * Returns the text's opacity. The opacity is a double value between 0 (fully transparent) and 1 (totally * opaque). * \see setOpacity() */ double opacity() const; - /** Sets the text's opacity. + /** + * Sets the text's opacity. * \param opacity opacity as a double value between 0 (fully transparent) and 1 (totally * opaque) * \see opacity() */ void setOpacity( double opacity ); - /** Returns the blending mode used for drawing the text. + /** + * Returns the blending mode used for drawing the text. * \see setBlendMode() */ QPainter::CompositionMode blendMode() const; - /** Sets the blending mode used for drawing the text. + /** + * Sets the blending mode used for drawing the text. * \param mode blending mode * \see blendMode() */ void setBlendMode( QPainter::CompositionMode mode ); - /** Returns the line height for text. This is a number between + /** + * Returns the line height for text. This is a number between * 0.0 and 10.0 representing the leading between lines as a * multiplier of line height. * \see setLineHeight() */ double lineHeight() const; - /** Sets the line height for text. + /** + * Sets the line height for text. * \param height a number between * 0.0 and 10.0 representing the leading between lines as a * multiplier of line height. @@ -1053,17 +1199,20 @@ class CORE_EXPORT QgsTextFormat */ void setLineHeight( double height ); - /** Reads settings from a layer's custom properties (for QGIS 2.x projects). + /** + * Reads settings from a layer's custom properties (for QGIS 2.x projects). * \param layer source vector layer */ void readFromLayer( QgsVectorLayer *layer ); - /** Read settings from a DOM element. + /** + * Read settings from a DOM element. * \see writeXml() */ void readXml( const QDomElement &elem, const QgsReadWriteContext &context ); - /** Write settings into a DOM element. + /** + * Write settings into a DOM element. * \see readXml() */ QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const; @@ -1082,18 +1231,21 @@ class CORE_EXPORT QgsTextFormat */ static QgsTextFormat fromMimeData( const QMimeData *data, bool *ok SIP_OUT = nullptr ); - /** Returns true if any component of the font format requires advanced effects + /** + * Returns true if any component of the font format requires advanced effects * such as blend modes, which require output in raster formats to be fully respected. */ bool containsAdvancedEffects() const; - /** Returns true if the specified font was found on the system, or false + /** + * Returns true if the specified font was found on the system, or false * if the font was not found and a replacement was used instead. * \see resolvedFontFamily() */ bool fontFound() const { return mTextFontFound; } - /** Returns the family for the resolved font, ie if the specified font + /** + * Returns the family for the resolved font, ie if the specified font * was not found on the system this will return the name of the replacement * font. * \see fontFound() @@ -1113,7 +1265,8 @@ class CORE_EXPORT QgsTextFormat }; -/** \class QgsTextRenderer +/** + * \class QgsTextRenderer * \ingroup core * Handles rendering text using rich formatting options, including drop shadows, buffers * and background shapes. @@ -1141,7 +1294,8 @@ class CORE_EXPORT QgsTextRenderer AlignRight, //!< Right align }; - /** Calculates pixel size (considering output size should be in pixel or map units, scale factors and optionally oversampling) + /** + * Calculates pixel size (considering output size should be in pixel or map units, scale factors and optionally oversampling) * \param size size to convert * \param c rendercontext * \param unit size units @@ -1150,7 +1304,8 @@ class CORE_EXPORT QgsTextRenderer */ static int sizeToPixel( double size, const QgsRenderContext &c, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &mapUnitScale = QgsMapUnitScale() ); - /** Draws text within a rectangle using the specified settings. + /** + * Draws text within a rectangle using the specified settings. * \param rect destination rectangle for text * \param rotation text rotation * \param alignment horizontal alignment @@ -1165,7 +1320,8 @@ class CORE_EXPORT QgsTextRenderer QgsRenderContext &context, const QgsTextFormat &format, bool drawAsOutlines = true ); - /** Draws text at a point origin using the specified settings. + /** + * Draws text at a point origin using the specified settings. * \param point origin of text * \param rotation text rotation * \param alignment horizontal alignment @@ -1180,7 +1336,8 @@ class CORE_EXPORT QgsTextRenderer QgsRenderContext &context, const QgsTextFormat &format, bool drawAsOutlines = true ); - /** Draws a single component of rendered text using the specified settings. + /** + * Draws a single component of rendered text using the specified settings. * \param rect destination rectangle for text * \param rotation text rotation * \param alignment horizontal alignment @@ -1198,7 +1355,8 @@ class CORE_EXPORT QgsTextRenderer QgsRenderContext &context, const QgsTextFormat &format, TextPart part, bool drawAsOutlines = true ); - /** Draws a single component of rendered text using the specified settings. + /** + * Draws a single component of rendered text using the specified settings. * \param origin origin for start of text. Y coordinate will be used as baseline. * \param rotation text rotation * \param alignment horizontal alignment diff --git a/src/core/qgstolerance.h b/src/core/qgstolerance.h index 55dbda7b6d76..ee7af459fab3 100644 --- a/src/core/qgstolerance.h +++ b/src/core/qgstolerance.h @@ -23,7 +23,8 @@ class QgsMapSettings; class QgsMapLayer; class QgsPointXY; -/** \ingroup core +/** + * \ingroup core * This is the class is providing tolerance value in map unit values. */ class CORE_EXPORT QgsTolerance @@ -31,7 +32,8 @@ class CORE_EXPORT QgsTolerance public: - /** Type of unit of tolerance value from settings. + /** + * Type of unit of tolerance value from settings. * For map (project) units, use ProjectUnits.*/ enum UnitType { diff --git a/src/core/qgstracer.h b/src/core/qgstracer.h index e19e8e49af2d..6986cfc67b44 100644 --- a/src/core/qgstracer.h +++ b/src/core/qgstracer.h @@ -29,7 +29,8 @@ class QgsVectorLayer; struct QgsTracerGraph; -/** \ingroup core +/** + * \ingroup core * Utility class that construct a planar graph from the input vector * layers and provides shortest path search for tracing of existing * features. diff --git a/src/core/qgstrackedvectorlayertools.h b/src/core/qgstrackedvectorlayertools.h index c30e3b9a08e7..2859d95d3501 100644 --- a/src/core/qgstrackedvectorlayertools.h +++ b/src/core/qgstrackedvectorlayertools.h @@ -19,7 +19,8 @@ #include "qgis_core.h" #include "qgsvectorlayertools.h" -/** \ingroup core +/** + * \ingroup core * \class QgsTrackedVectorLayerTools */ class CORE_EXPORT QgsTrackedVectorLayerTools : public QgsVectorLayerTools diff --git a/src/core/qgstransaction.h b/src/core/qgstransaction.h index 57ce4d5a1ade..ca4bb54902de 100644 --- a/src/core/qgstransaction.h +++ b/src/core/qgstransaction.h @@ -30,7 +30,8 @@ class QgsVectorDataProvider; class QgsVectorLayer; -/** \ingroup core +/** + * \ingroup core * This class allows including a set of layers in a database-side transaction, * provided the layer data providers support transactions and are compatible * with each other. diff --git a/src/core/qgstransactiongroup.h b/src/core/qgstransactiongroup.h index 13cc85ff62f8..fa77e54efb27 100644 --- a/src/core/qgstransactiongroup.h +++ b/src/core/qgstransactiongroup.h @@ -24,7 +24,8 @@ class QgsVectorLayer; -/** \ingroup core +/** + * \ingroup core * \class QgsTransactionGroup */ class CORE_EXPORT QgsTransactionGroup : public QObject diff --git a/src/core/qgsunittypes.h b/src/core/qgsunittypes.h index 42c1aa03cf91..dfc4158dbf82 100644 --- a/src/core/qgsunittypes.h +++ b/src/core/qgsunittypes.h @@ -27,7 +27,8 @@ * See details in QEP #17 ****************************************************************************/ -/** \ingroup core +/** + * \ingroup core * \class QgsUnitTypes * \brief Helper functions for various unit types. * \since QGIS 2.14 @@ -54,7 +55,8 @@ class CORE_EXPORT QgsUnitTypes }; Q_ENUM( DistanceUnit ); - /** Types of distance units + /** + * Types of distance units */ enum DistanceUnitType { @@ -172,18 +174,21 @@ class CORE_EXPORT QgsUnitTypes // DISTANCE UNITS - /** Returns the type for a distance unit. + /** + * Returns the type for a distance unit. */ Q_INVOKABLE static DistanceUnitType unitType( QgsUnitTypes::DistanceUnit unit ); - /** Encodes a distance unit to a string. + /** + * Encodes a distance unit to a string. * \param unit unit to encode * \returns encoded string * \see decodeDistanceUnit() */ Q_INVOKABLE static QString encodeUnit( QgsUnitTypes::DistanceUnit unit ); - /** Decodes a distance unit from a string. + /** + * Decodes a distance unit from a string. * \param string string to decode * \param ok optional boolean, will be set to true if string was converted successfully * \returns decoded units @@ -191,13 +196,15 @@ class CORE_EXPORT QgsUnitTypes */ Q_INVOKABLE static QgsUnitTypes::DistanceUnit decodeDistanceUnit( const QString &string, bool *ok SIP_OUT = 0 ); - /** Returns a translated string representing a distance unit. + /** + * Returns a translated string representing a distance unit. * \param unit unit to convert to string * \see stringToDistanceUnit() */ Q_INVOKABLE static QString toString( QgsUnitTypes::DistanceUnit unit ); - /** Returns a translated abbreviation representing a distance unit. + /** + * Returns a translated abbreviation representing a distance unit. * \param unit unit to convert to string * \see stringToDistanceUnit() * @@ -205,14 +212,16 @@ class CORE_EXPORT QgsUnitTypes */ Q_INVOKABLE static QString toAbbreviatedString( QgsUnitTypes::DistanceUnit unit ); - /** Converts a translated string to a distance unit. + /** + * Converts a translated string to a distance unit. * \param string string representing a distance unit * \param ok optional boolean, will be set to true if string was converted successfully * \see toString() */ Q_INVOKABLE static QgsUnitTypes::DistanceUnit stringToDistanceUnit( const QString &string, bool *ok SIP_OUT = 0 ); - /** Returns the conversion factor between the specified distance units. + /** + * Returns the conversion factor between the specified distance units. * \param fromUnit distance unit to convert from * \param toUnit distance unit to convert to * \returns multiplication factor to convert between units @@ -221,18 +230,21 @@ class CORE_EXPORT QgsUnitTypes // AREAL UNITS - /** Returns the type for an areal unit. + /** + * Returns the type for an areal unit. */ Q_INVOKABLE static DistanceUnitType unitType( AreaUnit unit ); - /** Encodes an areal unit to a string. + /** + * Encodes an areal unit to a string. * \param unit unit to encode * \returns encoded string * \see decodeAreaUnit() */ Q_INVOKABLE static QString encodeUnit( AreaUnit unit ); - /** Decodes an areal unit from a string. + /** + * Decodes an areal unit from a string. * \param string string to decode * \param ok optional boolean, will be set to true if string was converted successfully * \returns decoded units @@ -240,13 +252,15 @@ class CORE_EXPORT QgsUnitTypes */ Q_INVOKABLE static AreaUnit decodeAreaUnit( const QString &string, bool *ok SIP_OUT = 0 ); - /** Returns a translated string representing an areal unit. + /** + * Returns a translated string representing an areal unit. * \param unit unit to convert to string * \see stringToAreaUnit() */ Q_INVOKABLE static QString toString( AreaUnit unit ); - /** Returns a translated abbreviation representing an areal unit. + /** + * Returns a translated abbreviation representing an areal unit. * \param unit unit to convert to string * \see stringToAreaUnit() * @@ -254,21 +268,24 @@ class CORE_EXPORT QgsUnitTypes */ Q_INVOKABLE static QString toAbbreviatedString( AreaUnit unit ); - /** Converts a translated string to an areal unit. + /** + * Converts a translated string to an areal unit. * \param string string representing an areal unit * \param ok optional boolean, will be set to true if string was converted successfully * \see toString() */ Q_INVOKABLE static AreaUnit stringToAreaUnit( const QString &string, bool *ok SIP_OUT = 0 ); - /** Returns the conversion factor between the specified areal units. + /** + * Returns the conversion factor between the specified areal units. * \param fromUnit area unit to convert from * \param toUnit area unit to convert to * \returns multiplication factor to convert between units */ Q_INVOKABLE static double fromUnitToUnitFactor( AreaUnit fromUnit, AreaUnit toUnit ); - /** Converts a distance unit to its corresponding area unit, e.g., meters to square meters + /** + * Converts a distance unit to its corresponding area unit, e.g., meters to square meters * \param distanceUnit distance unit to convert * \returns matching areal unit */ @@ -276,14 +293,16 @@ class CORE_EXPORT QgsUnitTypes // ANGULAR UNITS - /** Encodes an angular unit to a string. + /** + * Encodes an angular unit to a string. * \param unit unit to encode * \returns encoded string * \see decodeAngleUnit() */ Q_INVOKABLE static QString encodeUnit( AngleUnit unit ); - /** Decodes an angular unit from a string. + /** + * Decodes an angular unit from a string. * \param string string to decode * \param ok optional boolean, will be set to true if string was converted successfully * \returns decoded units @@ -291,19 +310,22 @@ class CORE_EXPORT QgsUnitTypes */ Q_INVOKABLE static AngleUnit decodeAngleUnit( const QString &string, bool *ok SIP_OUT = 0 ); - /** Returns a translated string representing an angular unit. + /** + * Returns a translated string representing an angular unit. * \param unit unit to convert to string */ Q_INVOKABLE static QString toString( AngleUnit unit ); - /** Returns the conversion factor between the specified angular units. + /** + * Returns the conversion factor between the specified angular units. * \param fromUnit angle unit to convert from * \param toUnit angle unit to convert to * \returns multiplication factor to convert between units */ Q_INVOKABLE static double fromUnitToUnitFactor( AngleUnit fromUnit, AngleUnit toUnit ); - /** Returns an angle formatted as a friendly string. + /** + * Returns an angle formatted as a friendly string. * \param angle angle to format * \param decimals number of decimal places to show * \param unit unit of angle @@ -334,7 +356,8 @@ class CORE_EXPORT QgsUnitTypes */ Q_INVOKABLE static QgsUnitTypes::AreaValue scaledArea( double area, QgsUnitTypes::AreaUnit unit, int decimals, bool keepBaseUnit = false ); - /** Returns an distance formatted as a friendly string. + /** + * Returns an distance formatted as a friendly string. * \param distance distance to format * \param decimals number of decimal places to show * \param unit unit of distance @@ -346,7 +369,8 @@ class CORE_EXPORT QgsUnitTypes */ Q_INVOKABLE static QString formatDistance( double distance, int decimals, QgsUnitTypes::DistanceUnit unit, bool keepBaseUnit = false ); - /** Returns an area formatted as a friendly string. + /** + * Returns an area formatted as a friendly string. * \param area area to format * \param decimals number of decimal places to show * \param unit unit of area @@ -360,14 +384,16 @@ class CORE_EXPORT QgsUnitTypes // RENDER UNITS - /** Encodes a render unit to a string. + /** + * Encodes a render unit to a string. * \param unit unit to encode * \returns encoded string * \see decodeRenderUnit() */ Q_INVOKABLE static QString encodeUnit( RenderUnit unit ); - /** Decodes a render unit from a string. + /** + * Decodes a render unit from a string. * \param string string to decode * \param ok optional boolean, will be set to true if string was converted successfully * \returns decoded units @@ -393,7 +419,8 @@ class CORE_EXPORT QgsUnitTypes */ Q_INVOKABLE static QString encodeUnit( LayoutUnit unit ); - /** Decodes a layout unit from a string. + /** + * Decodes a layout unit from a string. * \param string string to decode * \param ok optional boolean, will be set to true if string was converted successfully * \returns decoded units diff --git a/src/core/qgsuserprofile.h b/src/core/qgsuserprofile.h index 0bc840bb9b64..7bcfc135f1b7 100644 --- a/src/core/qgsuserprofile.h +++ b/src/core/qgsuserprofile.h @@ -20,7 +20,8 @@ #include "qgserror.h" #include -/** \ingroup core +/** + * \ingroup core * User profile contains information about the user profile folders on the machine. * In QGIS 3 all settings, plugins, etc were moved into a %APPDATA%/profiles folder for each platform. * This allows for manage different user profiles per machine vs the single default one that was allowed in the diff --git a/src/core/qgsuserprofilemanager.h b/src/core/qgsuserprofilemanager.h index 507a88c6842e..b72b0831798e 100644 --- a/src/core/qgsuserprofilemanager.h +++ b/src/core/qgsuserprofilemanager.h @@ -26,7 +26,8 @@ #include -/** \ingroup core +/** + * \ingroup core * User profile manager is used to manager list, and manage user profiles on the users machine. * * In QGIS 3 all settings, plugins, etc were moved into a %APPDATA%/profiles folder for each platform. diff --git a/src/core/qgsvector.h b/src/core/qgsvector.h index 2b9a914f70a3..2e10f4ad9ef6 100644 --- a/src/core/qgsvector.h +++ b/src/core/qgsvector.h @@ -18,7 +18,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * A class to represent a vector. * Currently no Z axis / 2.5D support is implemented. */ @@ -28,11 +29,13 @@ class CORE_EXPORT QgsVector public: - /** Default constructor for QgsVector. Creates a vector with length of 0.0. + /** + * Default constructor for QgsVector. Creates a vector with length of 0.0. */ QgsVector() = default; - /** Constructor for QgsVector taking x and y component values. + /** + * Constructor for QgsVector taking x and y component values. * \param x x-component * \param y y-component */ @@ -41,17 +44,20 @@ class CORE_EXPORT QgsVector //! Swaps the sign of the x and y components of the vector. QgsVector operator-() const; - /** Returns a vector where the components have been multiplied by a scalar value. + /** + * Returns a vector where the components have been multiplied by a scalar value. * \param scalar factor to multiply by */ QgsVector operator*( double scalar ) const; - /** Returns a vector where the components have been divided by a scalar value. + /** + * Returns a vector where the components have been divided by a scalar value. * \param scalar factor to divide by */ QgsVector operator/( double scalar ) const; - /** Returns the dot product of two vectors, which is the sum of the x component + /** + * Returns the dot product of two vectors, which is the sum of the x component * of this vector multiplied by the x component of another * vector plus the y component of this vector multiplied by the y component of another vector. */ @@ -81,38 +87,46 @@ class CORE_EXPORT QgsVector */ QgsVector &operator-=( const QgsVector other ); - /** Returns the length of the vector. + /** + * Returns the length of the vector. */ double length() const; - /** Returns the vector's x-component. + /** + * Returns the vector's x-component. * \see y() */ double x() const; - /** Returns the vector's y-component. + /** + * Returns the vector's y-component. * \see x() */ double y() const; - /** Returns the perpendicular vector to this vector (rotated 90 degrees counter-clockwise) + /** + * Returns the perpendicular vector to this vector (rotated 90 degrees counter-clockwise) */ QgsVector perpVector() const; - /** Returns the angle of the vector in radians. + /** + * Returns the angle of the vector in radians. */ double angle() const; - /** Returns the angle between this vector and another vector in radians. + /** + * Returns the angle between this vector and another vector in radians. */ double angle( QgsVector v ) const; - /** Rotates the vector by a specified angle. + /** + * Rotates the vector by a specified angle. * \param rot angle in radians */ QgsVector rotateBy( double rot ) const; - /** Returns the vector's normalized (or "unit") vector (ie same angle but length of 1.0). + /** + * Returns the vector's normalized (or "unit") vector (ie same angle but length of 1.0). * Will throw a QgsException if called on a vector with length of 0. */ QgsVector normalized() const; diff --git a/src/core/qgsvectordataprovider.h b/src/core/qgsvectordataprovider.h index a0e2dd29d7ac..8e64486dae04 100644 --- a/src/core/qgsvectordataprovider.h +++ b/src/core/qgsvectordataprovider.h @@ -43,7 +43,8 @@ class QgsFeedback; #include "qgsfeaturerequest.h" -/** \ingroup core +/** + * \ingroup core * This is the base class for vector data providers. * * Data providers abstract the retrieval and writing (where supported) @@ -201,7 +202,8 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider, public QgsFeat virtual QStringList uniqueStringsMatching( int index, const QString &substring, int limit = -1, QgsFeedback *feedback = nullptr ) const; - /** Calculates an aggregated value from the layer's features. The base implementation does nothing, + /** + * Calculates an aggregated value from the layer's features. The base implementation does nothing, * but subclasses can override this method to handoff calculation of aggregates to the provider. * \param aggregate aggregate to calculate * \param index the index of the attribute to calculate aggregate over @@ -349,7 +351,8 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider, public QgsFeat //! Create an attribute index on the datasource virtual bool createAttributeIndex( int field ); - /** Returns flags containing the supported capabilities + /** + * Returns flags containing the supported capabilities \note, some capabilities may change depending on whether a spatial filter is active on this provider, so it may be prudent to check this value per intended operation. @@ -516,7 +519,8 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider, public QgsFeat */ virtual QString translateMetadataValue( const QString &mdKey, const QVariant &value ) const { Q_UNUSED( mdKey ); return value.toString(); } - /** Returns true if the data source has metadata, false otherwise. + /** + * Returns true if the data source has metadata, false otherwise. * * \returns true if data source has metadata, false otherwise. * diff --git a/src/core/qgsvectorfilewriter.h b/src/core/qgsvectorfilewriter.h index 53d8c35f0831..e0e12b5edfab 100644 --- a/src/core/qgsvectorfilewriter.h +++ b/src/core/qgsvectorfilewriter.h @@ -35,7 +35,8 @@ class QgsSymbolLayer; class QTextCodec; class QgsFeatureIterator; -/** \ingroup core +/** + * \ingroup core * A convenience class for writing vector files to disk. There are two possibilities how to use this class: 1. static call to QgsVectorFileWriter::writeAsVectorFormat(...) which saves the whole vector layer @@ -52,7 +53,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink Hidden }; - /** \ingroup core + /** + * \ingroup core */ class Option { @@ -66,7 +68,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink QgsVectorFileWriter::OptionType type; }; - /** \ingroup core + /** + * \ingroup core */ class SetOption : public QgsVectorFileWriter::Option { @@ -83,7 +86,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink bool allowNone; }; - /** \ingroup core + /** + * \ingroup core */ class StringOption: public QgsVectorFileWriter::Option { @@ -96,7 +100,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink QString defaultValue; }; - /** \ingroup core + /** + * \ingroup core */ class IntOption: public QgsVectorFileWriter::Option { @@ -109,7 +114,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink int defaultValue; }; - /** \ingroup core + /** + * \ingroup core */ class BoolOption : public QgsVectorFileWriter::SetOption { @@ -119,7 +125,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink {} }; - /** \ingroup core + /** + * \ingroup core */ class HiddenOption : public QgsVectorFileWriter::Option { @@ -178,7 +185,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink SymbolLayerSymbology //Exports one feature per symbol layer (considering symbol levels) }; - /** \ingroup core + /** + * \ingroup core * Interface to convert raw field values to their user-friendly value. * \since QGIS 2.16 */ @@ -190,13 +198,15 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink virtual ~FieldValueConverter() = default; - /** Return a possibly modified field definition. Default implementation will return provided field unmodified. + /** + * Return a possibly modified field definition. Default implementation will return provided field unmodified. * \param field original field definition * \returns possibly modified field definition */ virtual QgsField fieldDefinition( const QgsField &field ); - /** Convert the provided value, for field fieldIdxInLayer. Default implementation will return provided value unmodified. + /** + * Convert the provided value, for field fieldIdxInLayer. Default implementation will return provided value unmodified. * \param fieldIdxInLayer field index * \param value original raw value * \returns possibly modified value. @@ -209,7 +219,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink virtual QgsVectorFileWriter::FieldValueConverter *clone() const SIP_FACTORY; }; - /** Edition capability flags + /** + * Edition capability flags * \since QGIS 3.0 */ enum EditionCapability { @@ -226,11 +237,13 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink CanDeleteLayer = 1 << 3 }; - /** Combination of CanAddNewLayer, CanAppendToExistingLayer, CanAddNewFieldsToExistingLayer or CanDeleteLayer + /** + * Combination of CanAddNewLayer, CanAppendToExistingLayer, CanAddNewFieldsToExistingLayer or CanDeleteLayer * \since QGIS 3.0 */ Q_DECLARE_FLAGS( EditionCapabilities, EditionCapability ) - /** Enumeration to describe how to handle existing files + /** + * Enumeration to describe how to handle existing files \since QGIS 3.0 */ enum ActionOnExistingFile @@ -248,7 +261,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink AppendToLayerAddFields }; - /** Write contents of vector layer to an (OGR supported) vector formt + /** + * Write contents of vector layer to an (OGR supported) vector formt * \param layer layer to write * \param fileName file name to write to * \param fileEncoding encoding to use @@ -291,7 +305,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink QgsVectorFileWriter::FieldValueConverter *fieldValueConverter = nullptr ); - /** Writes a layer out to a vector file. + /** + * Writes a layer out to a vector file. * \param layer layer to write * \param fileName file name to write to * \param fileEncoding encoding to use @@ -337,7 +352,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink ); - /** \ingroup core + /** + * \ingroup core * Options to pass to writeAsVectorFormat() * \since QGIS 3.0 */ @@ -361,7 +377,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink //! Encoding to use QString fileEncoding; - /** Transform to reproject exported geometries with, or invalid transform + /** + * Transform to reproject exported geometries with, or invalid transform * for no transformation */ QgsCoordinateTransform ct; @@ -389,7 +406,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink //! If not empty, only features intersecting the extent will be saved QgsRectangle filterExtent; - /** Set to a valid geometry type to override the default geometry type for the layer. This parameter + /** + * Set to a valid geometry type to override the default geometry type for the layer. This parameter * allows for conversion of geometryless tables to null geometries, etc */ QgsWkbTypes::Type overrideGeometryType = QgsWkbTypes::Unknown; @@ -411,7 +429,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink QgsFeedback *feedback = nullptr; }; - /** Writes a layer out to a vector file. + /** + * Writes a layer out to a vector file. * \param layer source layer to write * \param fileName file name to write to * \param options options. @@ -438,7 +457,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink QgsVectorFileWriter::SymbologyExport symbologyExport = QgsVectorFileWriter::NoSymbology ); - /** Create a new vector file writer. + /** + * Create a new vector file writer. * \param vectorFileName file name to write to * \param fileEncoding encoding to use * \param fields fields to write @@ -487,7 +507,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink */ static QStringList supportedFormatExtensions(); - /** Returns driver list that can be used for dialogs. It contains all OGR drivers + /** + * Returns driver list that can be used for dialogs. It contains all OGR drivers * + some additional internal QGIS driver names to distinguish between more * supported formats of the same OGR driver */ @@ -531,7 +552,8 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink //! Close opened shapefile for writing ~QgsVectorFileWriter(); - /** Delete a shapefile (and its accompanying shx / dbf / prf) + /** + * Delete a shapefile (and its accompanying shx / dbf / prf) * \param fileName /path/to/file.shp * \returns bool true if the file was deleted successfully */ @@ -558,14 +580,16 @@ class CORE_EXPORT QgsVectorFileWriter : public QgsFeatureSink static bool driverMetadata( const QString &driverName, MetaData &driverMetadata ); - /** Returns a list of the default dataset options for a specified driver. + /** + * Returns a list of the default dataset options for a specified driver. * \param driverName name of OGR driver * \since QGIS 3.0 * \see defaultLayerOptions() */ static QStringList defaultDatasetOptions( const QString &driverName ); - /** Returns a list of the default layer options for a specified driver. + /** + * Returns a list of the default layer options for a specified driver. * \param driverName name of OGR driver * \since QGIS 3.0 * \see defaultDatasetOptions() diff --git a/src/core/qgsvectorlayer.cpp b/src/core/qgsvectorlayer.cpp index 34faa487b5c4..efce0ca51e7e 100644 --- a/src/core/qgsvectorlayer.cpp +++ b/src/core/qgsvectorlayer.cpp @@ -679,7 +679,8 @@ long QgsVectorLayer::featureCount( const QString &legendKey ) const return mSymbolFeatureCountMap.value( legendKey ); } -/** \ingroup core +/** + * \ingroup core * Used by QgsVectorLayer::countSymbolFeatures() to provide an interruption checker * \note not available in Python bindings */ diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h index 8730cda2bff4..a8113c180e8a 100644 --- a/src/core/qgsvectorlayer.h +++ b/src/core/qgsvectorlayer.h @@ -75,7 +75,8 @@ typedef QList QgsAttributeList; typedef QSet QgsAttributeIds; -/** \ingroup core +/** + * \ingroup core * Represents a vector layer which manages a vector based data sets. * * The QgsVectorLayer is instantiated by specifying the name of a data provider, @@ -378,7 +379,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte RemoveFromSelection, //!< Remove from current selection }; - /** Constructor - creates a vector layer + /** + * Constructor - creates a vector layer * * The QgsVectorLayer is constructed by instantiating a data provider. The provider * interprets the supplied path (url) of the data source to connect to and access the @@ -404,7 +406,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! QgsVectorLayer cannot be copied. QgsVectorLayer &operator=( QgsVectorLayer const &rhs ) = delete; - /** Returns a new instance equivalent to this one. A new provider is + /** + * Returns a new instance equivalent to this one. A new provider is * created for the same data source and renderers for features and diagrams * are cloned too. Moreover, each attributes (transparency, extent, selected * features and so on) are identicals. @@ -438,7 +441,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QString displayField() const; - /** Set the preview expression, used to create a human readable preview string. + /** + * Set the preview expression, used to create a human readable preview string. * Used e.g. in the attribute table feature list. Uses QgsExpression. * * \param displayExpression The expression which will be used to preview features @@ -463,12 +467,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! Setup the coordinate system transformation for the layer void setCoordinateSystem(); - /** Joins another vector layer to this layer + /** + * Joins another vector layer to this layer \param joinInfo join object containing join layer id, target and source field \note since 2.6 returns bool indicating whether the join can be added */ bool addJoin( const QgsVectorLayerJoinInfo &joinInfo ); - /** Removes a vector layer join + /** + * Removes a vector layer join \returns true if join was found and successfully removed */ bool removeJoin( const QString &joinLayerId ); @@ -574,7 +580,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void selectByRect( QgsRectangle &rect, SelectBehavior behavior = SetSelection ); - /** Select matching features using an expression. + /** + * Select matching features using an expression. * \param expression expression to evaluate to select features * \param behavior selection type, allows adding to current selection, removing * from selection, etc. @@ -584,7 +591,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void selectByExpression( const QString &expression, SelectBehavior behavior = SetSelection ); - /** Select matching features using a list of feature IDs. Will emit the + /** + * Select matching features using a list of feature IDs. Will emit the * selectionChanged() signal with the clearAndSelect flag set. * \param ids feature IDs to select * \param behavior selection type, allows adding to current selection, removing @@ -658,13 +666,15 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,0,0,0) is returned QgsRectangle boundingBoxOfSelected() const; - /** Returns whether the layer contains labels which are enabled and should be drawn. + /** + * Returns whether the layer contains labels which are enabled and should be drawn. * \returns true if layer contains enabled labels * \since QGIS 2.9 */ bool labelsEnabled() const; - /** Returns whether the layer contains diagrams which are enabled and should be drawn. + /** + * Returns whether the layer contains diagrams which are enabled and should be drawn. * \returns true if layer contains enabled diagrams * \since QGIS 2.9 */ @@ -680,7 +690,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! Return renderer. QgsFeatureRenderer *renderer() { return mRenderer; } - /** Return const renderer. + /** + * Return const renderer. * \note not available in Python bindings */ const QgsFeatureRenderer *renderer() const SIP_SKIP { return mRenderer; } @@ -703,17 +714,20 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsCoordinateReferenceSystem sourceCrs() const override; QString sourceName() const override; - /** Reads vector layer specific state from project file Dom node. + /** + * Reads vector layer specific state from project file Dom node. * \note Called by QgsMapLayer::readXml(). */ virtual bool readXml( const QDomNode &layer_node, const QgsReadWriteContext &context ) override; - /** Write vector layer specific state to project file Dom node. + /** + * Write vector layer specific state to project file Dom node. * \note Called by QgsMapLayer::writeXml(). */ virtual bool writeXml( QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context ) const override; - /** Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. + /** + * Resolve references to other layers (kept as layer IDs after reading XML) into layer objects. * \since QGIS 3.0 */ virtual void resolveReferences( QgsProject *project ) override; @@ -769,7 +783,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag SIP_OUT ) override; - /** Read the symbology for the current layer from the Dom node supplied. + /** + * Read the symbology for the current layer from the Dom node supplied. * \param layerNode node that will contain the symbology definition for this layer. * \param errorMessage reference to string that will be updated with any error messages * \param context reading context (used for transform from relative to absolute paths) @@ -777,7 +792,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool readSymbology( const QDomNode &layerNode, QString &errorMessage, const QgsReadWriteContext &context ) override; - /** Read the style for the current layer from the Dom node supplied. + /** + * Read the style for the current layer from the Dom node supplied. * \param node node that will contain the style definition for this layer. * \param errorMessage reference to string that will be updated with any error messages * \param context reading context (used for transform from relative to absolute paths) @@ -785,7 +801,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool readStyle( const QDomNode &node, QString &errorMessage, const QgsReadWriteContext &context ) override; - /** Write the symbology for the layer into the docment provided. + /** + * Write the symbology for the layer into the docment provided. * \param node the node that will have the style element added to it. * \param doc the document that will have the QDomNode added. * \param errorMessage reference to string that will be updated with any error messages @@ -794,7 +811,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context ) const override; - /** Write just the style information for the layer into the document + /** + * Write just the style information for the layer into the document * \param node the node that will have the style element added to it. * \param doc the document that will have the QDomNode added. * \param errorMessage reference to string that will be updated with any error messages @@ -919,44 +937,51 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool updateFeature( const QgsFeature &feature, bool skipDefaultValues = false ); - /** Insert a new vertex before the given vertex number, + /** + * Insert a new vertex before the given vertex number, * in the given ring, item (first number is index 0), and feature * Not meaningful for Point geometries */ bool insertVertex( double x, double y, QgsFeatureId atFeatureId, int beforeVertex ); - /** Insert a new vertex before the given vertex number, + /** + * Insert a new vertex before the given vertex number, * in the given ring, item (first number is index 0), and feature * Not meaningful for Point geometries */ bool insertVertex( const QgsPoint &point, QgsFeatureId atFeatureId, int beforeVertex ); - /** Moves the vertex at the given position number, + /** + * Moves the vertex at the given position number, * ring and item (first number is index 0), and feature * to the given coordinates */ bool moveVertex( double x, double y, QgsFeatureId atFeatureId, int atVertex ); - /** Moves the vertex at the given position number, + /** + * Moves the vertex at the given position number, * ring and item (first number is index 0), and feature * to the given coordinates * \note available in Python as moveVertexV2 */ bool moveVertex( const QgsPoint &p, QgsFeatureId atFeatureId, int atVertex ) SIP_PYNAME( moveVertexV2 ); - /** Deletes a vertex from a feature. + /** + * Deletes a vertex from a feature. * \param featureId ID of feature to remove vertex from * \param vertex index of vertex to delete * \since QGIS 2.14 */ EditResult deleteVertex( QgsFeatureId featureId, int vertex ); - /** Deletes the selected features + /** + * Deletes the selected features * \returns true in case of success and false otherwise */ bool deleteSelectedFeatures( int *deletedCount = nullptr ); - /** Adds a ring to polygon/multipolygon features + /** + * Adds a ring to polygon/multipolygon features * \param ring ring to add * \param featureId if specified, feature ID for feature ring was added to will be stored in this parameter * \returns @@ -971,7 +996,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte // TODO QGIS 3.0 returns an enum instead of a magic constant int addRing( const QList &ring, QgsFeatureId *featureId = nullptr ); - /** Adds a ring to polygon/multipolygon features (takes ownership) + /** + * Adds a ring to polygon/multipolygon features (takes ownership) * \param ring ring to add * \param featureId if specified, feature ID for feature ring was added to will be stored in this parameter * \returns @@ -984,7 +1010,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte // TODO QGIS 3.0 returns an enum instead of a magic constant int addRing( QgsCurve *ring SIP_TRANSFER, QgsFeatureId *featureId = nullptr ) SIP_PYNAME( addCurvedRing ); - /** Adds a new part polygon to a multipart feature + /** + * Adds a new part polygon to a multipart feature * \returns * 0 in case of success, * 1 if selected feature is not multipart, @@ -998,7 +1025,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte // TODO QGIS 3.0 returns an enum instead of a magic constant int addPart( const QList &ring ); - /** Adds a new part polygon to a multipart feature + /** + * Adds a new part polygon to a multipart feature * \returns * 0 in case of success, * 1 if selected feature is not multipart, @@ -1016,7 +1044,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! \note available in Python as addCurvedPart int addPart( QgsCurve *ring SIP_TRANSFER ) SIP_PYNAME( addCurvedPart ); - /** Translates feature by dx, dy + /** + * Translates feature by dx, dy * \param featureId id of the feature to translate * \param dx translation of x-coordinate * \param dy translation of y-coordinate @@ -1024,7 +1053,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ int translateFeature( QgsFeatureId featureId, double dx, double dy ); - /** Splits parts cut by the given line + /** + * Splits parts cut by the given line * \param splitLine line that splits the layer features * \param topologicalEditing true if topological editing is enabled * \returns @@ -1034,7 +1064,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte // TODO QGIS 3.0 returns an enum instead of a magic constant int splitParts( const QList &splitLine, bool topologicalEditing = false ); - /** Splits features cut by the given line + /** + * Splits features cut by the given line * \param splitLine line that splits the layer features * \param topologicalEditing true if topological editing is enabled * \returns @@ -1044,14 +1075,16 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte // TODO QGIS 3.0 returns an enum instead of a magic constant int splitFeatures( const QList &splitLine, bool topologicalEditing = false ); - /** Adds topological points for every vertex of the geometry. + /** + * Adds topological points for every vertex of the geometry. * \param geom the geometry where each vertex is added to segments of other features * \note geom is not going to be modified by the function * \returns 0 in case of success */ int addTopologicalPoints( const QgsGeometry &geom ); - /** Adds a vertex to segments which intersect point p but don't + /** + * Adds a vertex to segments which intersect point p but don't * already have a vertex there. If a feature already has a vertex at position p, * no additional vertex is inserted. This method is useful for topological * editing. @@ -1060,12 +1093,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ int addTopologicalPoints( const QgsPointXY &p ); - /** Access to labeling configuration. May be null if labeling is not used. + /** + * Access to labeling configuration. May be null if labeling is not used. * \since QGIS 3.0 */ const QgsAbstractVectorLayerLabeling *labeling() const { return mLabeling; } - /** Set labeling configuration. Takes ownership of the object. + /** + * Set labeling configuration. Takes ownership of the object. * \since QGIS 3.0 */ void setLabeling( QgsAbstractVectorLayerLabeling *labeling SIP_TRANSFER ); @@ -1082,7 +1117,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! Synchronises with changes in the datasource virtual void reload() override; - /** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context + /** + * Return new instance of QgsMapLayerRenderer that will be used for rendering of given context * \since QGIS 2.4 */ virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) override SIP_FACTORY; @@ -1140,7 +1176,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ long featureCount() const override; - /** Make layer read-only (editing disabled) or not + /** + * Make layer read-only (editing disabled) or not * \returns false if the layer is in editing yet */ bool setReadOnly( bool readonly = true ); @@ -1162,7 +1199,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue = QVariant(), bool skipDefaultValues = false ); - /** Add an attribute field (but does not commit it) + /** + * Add an attribute field (but does not commit it) * returns true if the field was added */ bool addAttribute( const QgsField &field ); @@ -1181,7 +1219,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void removeFieldAlias( int index ); - /** Renames an attribute field (but does not commit it). + /** + * Renames an attribute field (but does not commit it). * \param index attribute index * \param newName new name of field * \since QGIS 2.16 @@ -1266,13 +1305,15 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ bool commitChanges(); - /** Returns a list containing any error messages generated when attempting + /** + * Returns a list containing any error messages generated when attempting * to commit changes to the layer. * \see commitChanges() */ QStringList commitErrors() const; - /** Stop editing and discard the edits + /** + * Stop editing and discard the edits * \param deleteBuffer whether to delete editing buffer */ bool rollBack( bool deleteBuffer = true ); @@ -1445,7 +1486,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QgsEditorWidgetSetup editorWidgetSetup( int index ) const; - /** Calculates a list of unique values contained within an attribute in the layer. Note that + /** + * Calculates a list of unique values contained within an attribute in the layer. Note that * in some circumstances when unsaved changes are present for the layer then the returned list * may contain outdated values (for instance when the attribute value in a saved feature has * been changed inside the edit buffer then the previous saved value will be included in the @@ -1473,7 +1515,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QStringList uniqueStringsMatching( int index, const QString &substring, int limit = -1, QgsFeedback *feedback = nullptr ) const; - /** Returns the minimum value for an attribute column or an invalid variant in case of error. + /** + * Returns the minimum value for an attribute column or an invalid variant in case of error. * Note that in some circumstances when unsaved changes are present for the layer then the * returned value may be outdated (for instance when the attribute value in a saved feature has * been changed inside the edit buffer then the previous saved value may be returned as the minimum). @@ -1482,7 +1525,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QVariant minimumValue( int index ) const override; - /** Returns the maximum value for an attribute column or an invalid variant in case of error. + /** + * Returns the maximum value for an attribute column or an invalid variant in case of error. * Note that in some circumstances when unsaved changes are present for the layer then the * returned value may be outdated (for instance when the attribute value in a saved feature has * been changed inside the edit buffer then the previous saved value may be returned as the maximum). @@ -1491,7 +1535,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QVariant maximumValue( int index ) const override; - /** Calculates an aggregated value from the layer's features. + /** + * Calculates an aggregated value from the layer's features. * \param aggregate aggregate to calculate * \param fieldOrExpression source field or expression to use as basis for aggregated values. * \param parameters parameters controlling aggregate calculation @@ -1506,7 +1551,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsExpressionContext *context = nullptr, bool *ok = nullptr ) const; - /** Fetches all values from a specified field name or expression. + /** + * Fetches all values from a specified field name or expression. * \param fieldOrExpression field name or an expression string * \param ok will be set to false if field or expression is invalid, otherwise true * \param selectedOnly set to true to get values from selected features only @@ -1517,7 +1563,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ QList< QVariant > getValues( const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, QgsFeedback *feedback = nullptr ) const; - /** Fetches all double values from a specified field name or expression. Null values or + /** + * Fetches all double values from a specified field name or expression. Null values or * invalid expression results are skipped. * \param fieldOrExpression field name or an expression string evaluating to a double value * \param ok will be set to false if field or expression is invalid, otherwise true @@ -1555,17 +1602,20 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QString htmlMetadata() const override; - /** Set the simplification settings for fast rendering of features + /** + * Set the simplification settings for fast rendering of features * \since QGIS 2.2 */ void setSimplifyMethod( const QgsVectorSimplifyMethod &simplifyMethod ) { mSimplifyMethod = simplifyMethod; } - /** Returns the simplification settings for fast rendering of features + /** + * Returns the simplification settings for fast rendering of features * \since QGIS 2.2 */ inline const QgsVectorSimplifyMethod &simplifyMethod() const { return mSimplifyMethod; } - /** Returns whether the VectorLayer can apply the specified simplification hint + /** + * Returns whether the VectorLayer can apply the specified simplification hint * \note Do not use in 3rd party code - may be removed in future version! * \since QGIS 2.2 */ @@ -1695,7 +1745,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ void removeSelection(); - /** Update the extents for the layer. This is necessary if features are + /** + * Update the extents for the layer. This is necessary if features are * added/deleted or the layer has been subsetted. * * \param force true to update layer extent even if it's read from xml by default, false otherwise @@ -1973,7 +2024,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte */ virtual bool isReadOnly() const override; - /** Bind layer to a specific data provider + /** + * Bind layer to a specific data provider * \param provider should be "postgres", "ogr", or ?? * @todo XXX should this return bool? Throw exceptions? */ @@ -2009,7 +2061,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte //! Flag indicating whether the layer is in read-only mode (editing disabled) or not bool mReadOnly = false; - /** Set holding the feature IDs that are activated. Note that if a feature + /** + * Set holding the feature IDs that are activated. Note that if a feature subsequently gets deleted (i.e. by its addition to mDeletedFeatureIds), it always needs to be removed from mSelectedFeatureIds as well. */ diff --git a/src/core/qgsvectorlayercache.h b/src/core/qgsvectorlayercache.h index b3c1d0d0c639..5a50848b00cb 100644 --- a/src/core/qgsvectorlayercache.h +++ b/src/core/qgsvectorlayercache.h @@ -29,7 +29,8 @@ class QgsCachedFeatureIterator; class QgsAbstractCacheIndex; -/** \ingroup core +/** + * \ingroup core * This class caches features of a given QgsVectorLayer. * * \brief @@ -149,7 +150,8 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject */ void setFullCache( bool fullCache ); - /** Returns true if the cache is complete, ie it contains all features. This may happen as + /** + * Returns true if the cache is complete, ie it contains all features. This may happen as * a result of a call to setFullCache() or by through a feature request which resulted in * all available features being cached. * \see setFullCache() @@ -221,7 +223,8 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject */ bool isFidCached( const QgsFeatureId fid ) const; - /** Returns the set of feature IDs for features which are cached. + /** + * Returns the set of feature IDs for features which are cached. * \since QGIS 3.0 * \see isFidCached() */ @@ -396,7 +399,8 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject friend class QgsCachedFeatureWriterIterator; friend class QgsCachedFeature; - /** Returns true if the cache contains all the features required for a specified request. + /** + * Returns true if the cache contains all the features required for a specified request. * \param featureRequest feature request * \param it will be set to iterator for matching features * \returns true if cache can satisfy request diff --git a/src/core/qgsvectorlayerdiagramprovider.h b/src/core/qgsvectorlayerdiagramprovider.h index 7481ba96d5d7..e0605e033c19 100644 --- a/src/core/qgsvectorlayerdiagramprovider.h +++ b/src/core/qgsvectorlayerdiagramprovider.h @@ -23,7 +23,8 @@ #include "qgslabelfeature.h" #include "qgsdiagramrenderer.h" -/** \ingroup core +/** + * \ingroup core * Class that adds extra information to QgsLabelFeature for labeling of diagrams * * \note this class is not a part of public API yet. See notes in QgsLabelingEngine @@ -49,7 +50,8 @@ class QgsDiagramLabelFeature : public QgsLabelFeature class QgsAbstractFeatureSource; -/** \ingroup core +/** + * \ingroup core * \brief The QgsVectorLayerDiagramProvider class implements support for diagrams within * the labeling engine. Parameters for the diagrams are taken from the layer settings. * diff --git a/src/core/qgsvectorlayereditbuffer.h b/src/core/qgsvectorlayereditbuffer.h index 80ffd5b88280..23221e201286 100644 --- a/src/core/qgsvectorlayereditbuffer.h +++ b/src/core/qgsvectorlayereditbuffer.h @@ -29,7 +29,8 @@ typedef QList QgsAttributeList SIP_SKIP; typedef QSet QgsAttributeIds SIP_SKIP; typedef QMap QgsFeatureMap; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerEditBuffer */ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject @@ -42,7 +43,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject virtual bool isModified() const; - /** Adds a feature + /** + * Adds a feature \param f feature to add \returns True in case of success and False in case of error */ @@ -63,14 +65,16 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject //! Changed an attribute value (but does not commit it) virtual bool changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue = QVariant() ); - /** Add an attribute field (but does not commit it) + /** + * Add an attribute field (but does not commit it) returns true if the field was added */ virtual bool addAttribute( const QgsField &field ); //! Delete an attribute field (but does not commit it) virtual bool deleteAttribute( int attr ); - /** Renames an attribute field (but does not commit it) + /** + * Renames an attribute field (but does not commit it) * \param attr attribute index * \param newName new name of field * \since QGIS 2.16 @@ -97,64 +101,75 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject //! Stop editing and discard the edits virtual void rollBack(); - /** Returns a map of new features which are not committed. + /** + * Returns a map of new features which are not committed. * \see isFeatureAdded() */ QgsFeatureMap addedFeatures() const { return mAddedFeatures; } - /** Returns true if the specified feature ID has been added but not committed. + /** + * Returns true if the specified feature ID has been added but not committed. * \param id feature ID * \since QGIS 3.0 * \see addedFeatures() */ bool isFeatureAdded( QgsFeatureId id ) const { return mAddedFeatures.contains( id ); } - /** Returns a map of features with changed attributes values which are not committed. + /** + * Returns a map of features with changed attributes values which are not committed. * \see isFeatureAttributesChanged() */ QgsChangedAttributesMap changedAttributeValues() const { return mChangedAttributeValues; } - /** Returns true if the specified feature ID has had an attribute changed but not committed. + /** + * Returns true if the specified feature ID has had an attribute changed but not committed. * \param id feature ID * \since QGIS 3.0 * \see changedAttributeValues() */ bool isFeatureAttributesChanged( QgsFeatureId id ) const { return mChangedAttributeValues.contains( id ); } - /** Returns a list of deleted attributes fields which are not committed. The list is kept sorted. + /** + * Returns a list of deleted attributes fields which are not committed. The list is kept sorted. * \see isAttributeDeleted() */ QgsAttributeList deletedAttributeIds() const { return mDeletedAttributeIds; } - /** Returns true if the specified attribute has been deleted but not committed. + /** + * Returns true if the specified attribute has been deleted but not committed. * \param index attribute index * \since QGIS 3.0 * \see deletedAttributeIds() */ bool isAttributeDeleted( int index ) const { return mDeletedAttributeIds.contains( index ); } - /** Returns a list of added attributes fields which are not committed. + /** + * Returns a list of added attributes fields which are not committed. */ QList addedAttributes() const { return mAddedAttributes; } - /** Returns a map of features with changed geometries which are not committed. + /** + * Returns a map of features with changed geometries which are not committed. * \see hasFeatureGeometryChange() */ QgsGeometryMap changedGeometries() const { return mChangedGeometries; } - /** Returns true if the specified feature ID has had its geometry changed but not committed. + /** + * Returns true if the specified feature ID has had its geometry changed but not committed. * \param id feature ID * \since QGIS 3.0 * \see changedGeometries() */ bool isFeatureGeometryChanged( QgsFeatureId id ) const { return mChangedGeometries.contains( id ); } - /** Returns a list of deleted feature IDs which are not committed. + /** + * Returns a list of deleted feature IDs which are not committed. * \see isFeatureDeleted() */ QgsFeatureIds deletedFeatureIds() const { return mDeletedFeatureIds; } - /** Returns true if the specified feature ID has been deleted but not committed. + /** + * Returns true if the specified feature ID has been deleted but not committed. * \param id feature ID * \since QGIS 3.0 * \see deletedFeatureIds() @@ -173,7 +188,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject void featureAdded( QgsFeatureId fid ); void featureDeleted( QgsFeatureId fid ); - /** Emitted when a feature's geometry is changed. + /** + * Emitted when a feature's geometry is changed. * \param fid feature ID * \param geom new feature geometry */ @@ -183,7 +199,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject void attributeAdded( int idx ); void attributeDeleted( int idx ); - /** Emitted when an attribute has been renamed + /** + * Emitted when an attribute has been renamed * \param idx attribute index * \param newName new attribute name * \since QGIS 2.16 @@ -194,7 +211,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes ); void committedAttributesAdded( const QString &layerId, const QList &addedAttributes ); - /** Emitted after committing an attribute rename + /** + * Emitted after committing an attribute rename * \param layerId ID of layer * \param renamedAttributes map of field index to new name * \since QGIS 2.16 @@ -250,7 +268,8 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject friend class QgsVectorLayerUndoPassthroughCommandDeleteAttribute; friend class QgsVectorLayerUndoPassthroughCommandRenameAttribute; - /** Deleted feature IDs which are not committed. Note a feature can be added and then deleted + /** + * Deleted feature IDs which are not committed. Note a feature can be added and then deleted again before the change is committed - in that case the added feature would be removed from mAddedFeatures only and *not* entered here. */ diff --git a/src/core/qgsvectorlayereditpassthrough.h b/src/core/qgsvectorlayereditpassthrough.h index 917beeff176c..ef097c56d79a 100644 --- a/src/core/qgsvectorlayereditpassthrough.h +++ b/src/core/qgsvectorlayereditpassthrough.h @@ -21,7 +21,8 @@ class QgsVectorLayer; class QgsVectorLayerUndoPassthroughCommand; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerEditPassthrough */ class CORE_EXPORT QgsVectorLayerEditPassthrough : public QgsVectorLayerEditBuffer diff --git a/src/core/qgsvectorlayereditutils.h b/src/core/qgsvectorlayereditutils.h index 9f5886065f48..7b28d651d739 100644 --- a/src/core/qgsvectorlayereditutils.h +++ b/src/core/qgsvectorlayereditutils.h @@ -24,7 +24,8 @@ class QgsCurve; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerEditUtils */ class CORE_EXPORT QgsVectorLayerEditUtils diff --git a/src/core/qgsvectorlayerfeaturecounter.h b/src/core/qgsvectorlayerfeaturecounter.h index c626968765ff..fea8278d55e2 100644 --- a/src/core/qgsvectorlayerfeaturecounter.h +++ b/src/core/qgsvectorlayerfeaturecounter.h @@ -6,7 +6,8 @@ #include "qgsrenderer.h" #include "qgstaskmanager.h" -/** \ingroup core +/** + * \ingroup core * * Counts the features in a QgsVectorLayer in task. * You should most likely not use this directly and instead call diff --git a/src/core/qgsvectorlayerfeatureiterator.h b/src/core/qgsvectorlayerfeatureiterator.h index 6ee23ebd9fed..cd4da95434c4 100644 --- a/src/core/qgsvectorlayerfeatureiterator.h +++ b/src/core/qgsvectorlayerfeatureiterator.h @@ -42,14 +42,16 @@ class QgsVectorLayerFeatureIterator; % End #endif -/** \ingroup core +/** + * \ingroup core * Partial snapshot of vector layer's state (only the members necessary for access to features) */ class CORE_EXPORT QgsVectorLayerFeatureSource : public QgsAbstractFeatureSource { public: - /** Constructor for QgsVectorLayerFeatureSource. + /** + * Constructor for QgsVectorLayerFeatureSource. * \param layer source layer */ explicit QgsVectorLayerFeatureSource( const QgsVectorLayer *layer ); @@ -101,7 +103,8 @@ class CORE_EXPORT QgsVectorLayerFeatureSource : public QgsAbstractFeatureSource QgsCoordinateReferenceSystem mCrs; }; -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureIteratorFromSource { @@ -118,7 +121,8 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera virtual void setInterruptionChecker( QgsInterruptionChecker *interruptionChecker ) override SIP_SKIP; - /** Join information prepared for fast attribute id mapping in QgsVectorLayerJoinBuffer::updateFeatureAttributes(). + /** + * Join information prepared for fast attribute id mapping in QgsVectorLayerJoinBuffer::updateFeatureAttributes(). * Created in the select() method of QgsVectorLayerJoinBuffer for the joins that contain fetched attributes */ struct CORE_EXPORT FetchJoinInfo @@ -189,7 +193,8 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera */ void addVirtualAttributes( QgsFeature &f ) SIP_SKIP; - /** Adds an expression based attribute to a feature + /** + * Adds an expression based attribute to a feature * \param f feature * \param attrIndex attribute index * \since QGIS 2.14 @@ -197,12 +202,14 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera */ void addExpressionAttribute( QgsFeature &f, int attrIndex ) SIP_SKIP; - /** Update feature with uncommitted attribute updates. + /** + * Update feature with uncommitted attribute updates. * \note not available in Python bindings */ void updateChangedAttributes( QgsFeature &f ) SIP_SKIP; - /** Update feature with uncommitted geometry updates. + /** + * Update feature with uncommitted geometry updates. * \note not available in Python bindings */ void updateFeatureGeometry( QgsFeature &f ) SIP_SKIP; @@ -222,7 +229,8 @@ class CORE_EXPORT QgsVectorLayerFeatureIterator : public QgsAbstractFeatureItera bool mFetchedFid; // when iterating by FID: indicator whether it has been fetched yet or not - /** Information about joins used in the current select() statement. + /** + * Information about joins used in the current select() statement. Allows faster mapping of attribute ids compared to mVectorJoins */ QMap mFetchJoinInfo; diff --git a/src/core/qgsvectorlayerjoinbuffer.h b/src/core/qgsvectorlayerjoinbuffer.h index 1470cd887a58..80414e38d5cb 100644 --- a/src/core/qgsvectorlayerjoinbuffer.h +++ b/src/core/qgsvectorlayerjoinbuffer.h @@ -29,7 +29,8 @@ typedef QList< QgsVectorLayerJoinInfo > QgsVectorJoinList; -/** \ingroup core +/** + * \ingroup core * Manages joined fields for a vector layer*/ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSink { @@ -37,16 +38,19 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi public: QgsVectorLayerJoinBuffer( QgsVectorLayer *layer = nullptr ); - /** Joins another vector layer to this layer + /** + * Joins another vector layer to this layer \param joinInfo join object containing join layer id, target and source field \returns (since 2.6) whether the join was successfully added */ bool addJoin( const QgsVectorLayerJoinInfo &joinInfo ); - /** Removes a vector layer join + /** + * Removes a vector layer join \returns true if join was found and successfully removed */ bool removeJoin( const QString &joinLayerId ); - /** Updates field map with joined attributes + /** + * Updates field map with joined attributes \param fields map to append joined attributes */ void updateFields( QgsFields &fields ); @@ -74,7 +78,8 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi const QgsVectorJoinList &vectorJoins() const { return mVectorJoins; } - /** Finds the vector join for a layer field index. + /** + * Finds the vector join for a layer field index. \param index this layers attribute index \param fields fields of the vector layer (including joined fields) \param sourceFieldIndex Output: field's index in source layer */ @@ -92,21 +97,24 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi */ static QVector joinSubsetIndices( QgsVectorLayer *joinLayer, const QStringList &joinFieldsSubset ); - /** Returns joins where the field of a target layer is considered as an id. + /** + * Returns joins where the field of a target layer is considered as an id. * \param field the field of a target layer * \returns a list of vector joins * \since QGIS 3.0 */ QList joinsWhereFieldIsId( const QgsField &field ) const; - /** Returns the joined feature corresponding to the feature. + /** + * Returns the joined feature corresponding to the feature. * \param info the vector join information * \param feature the feature of the target layer * \since QGIS 3.0 */ QgsFeature joinedFeatureOf( const QgsVectorLayerJoinInfo *info, const QgsFeature &feature ) const; - /** Returns the targeted feature corresponding to the joined feature. + /** + * Returns the targeted feature corresponding to the joined feature. * \param info the vector join information * \param feature the feature of the joined layer * \since QGIS 3.0 diff --git a/src/core/qgsvectorlayerjoininfo.h b/src/core/qgsvectorlayerjoininfo.h index 7b973da7c22f..e2f2d03e8e12 100644 --- a/src/core/qgsvectorlayerjoininfo.h +++ b/src/core/qgsvectorlayerjoininfo.h @@ -69,61 +69,71 @@ class CORE_EXPORT QgsVectorLayerJoinInfo //! Returns whether values from the joined layer should be cached in memory to speed up lookups bool isUsingMemoryCache() const { return mMemoryCache; } - /** Returns whether the form has to be dynamically updated with joined fields + /** + * Returns whether the form has to be dynamically updated with joined fields * when a feature is being created in the target layer. * \since QGIS 3.0 */ bool isDynamicFormEnabled() const { return mDynamicForm; } - /** Sets whether the form has to be dynamically updated with joined fields + /** + * Sets whether the form has to be dynamically updated with joined fields * when a feature is being created in the target layer. * \since QGIS 3.0 */ void setDynamicFormEnabled( bool enabled ) { mDynamicForm = enabled; } - /** Returns whether joined fields may be edited through the form of + /** + * Returns whether joined fields may be edited through the form of * the target layer. * \since QGIS 3.0 */ bool isEditable() const { return mEditable; } - /** Sets whether the form of the target layer allows editing joined fields. + /** + * Sets whether the form of the target layer allows editing joined fields. * \since QGIS 3.0 */ void setEditable( bool enabled ); - /** Returns whether a feature created on the target layer has to impact + /** + * Returns whether a feature created on the target layer has to impact * the joined layer by creating a new feature if necessary. * \since QGIS 3.0 */ bool hasUpsertOnEdit() const { return mUpsertOnEdit; } - /** Sets whether a feature created on the target layer has to impact + /** + * Sets whether a feature created on the target layer has to impact * the joined layer by creating a new feature if necessary. * \since QGIS 3.0 */ void setUpsertOnEdit( bool enabled ) { mUpsertOnEdit = enabled; } - /** Returns whether a feature deleted on the target layer has to impact the + /** + * Returns whether a feature deleted on the target layer has to impact the * joined layer by deleting the corresponding joined feature. * \since QGIS 3.0 */ bool hasCascadedDelete() const { return mCascadedDelete; } - /** Sets whether a feature deleted on the target layer has to impact the + /** + * Sets whether a feature deleted on the target layer has to impact the * joined layer by deleting the corresponding joined feature. * \since QGIS 3.0 */ void setCascadedDelete( bool enabled ) { mCascadedDelete = enabled; } - /** Returns the prefixed name of the field. + /** + * Returns the prefixed name of the field. * \param field the field * \returns the prefixed name of the field * \since QGIS 3.0 */ QString prefixedFieldName( const QgsField &field ) const; - /** Extract the join feature from the target feature for the current + /** + * Extract the join feature from the target feature for the current * join layer information. * \param feature A feature from the target layer * \returns the corresponding joined feature @@ -141,11 +151,13 @@ class CORE_EXPORT QgsVectorLayerJoinInfo mPrefix == other.mPrefix; } - /** Set subset of fields to be used from joined layer. Takes ownership of the passed pointer. Null pointer tells to use all fields. + /** + * Set subset of fields to be used from joined layer. Takes ownership of the passed pointer. Null pointer tells to use all fields. \since QGIS 2.6 */ void setJoinFieldNamesSubset( QStringList *fieldNamesSubset SIP_TRANSFER ) { mJoinFieldsSubset = std::shared_ptr( fieldNamesSubset ); } - /** Get subset of fields to be used from joined layer. All fields will be used if null is returned. + /** + * Get subset of fields to be used from joined layer. All fields will be used if null is returned. \since QGIS 2.6 */ QStringList *joinFieldNamesSubset() const { return mJoinFieldsSubset.get(); } @@ -157,7 +169,8 @@ class CORE_EXPORT QgsVectorLayerJoinInfo //! Join field in the source layer QString mJoinFieldName; - /** An optional prefix. If it is a Null string "{layername}_" will be used + /** + * An optional prefix. If it is a Null string "{layername}_" will be used * \since QGIS 2.8 */ QString mPrefix; diff --git a/src/core/qgsvectorlayerlabeling.h b/src/core/qgsvectorlayerlabeling.h index aa0711b13ec7..6c48f2bc70ff 100644 --- a/src/core/qgsvectorlayerlabeling.h +++ b/src/core/qgsvectorlayerlabeling.h @@ -31,7 +31,8 @@ class QgsReadWriteContext; class QgsVectorLayer; class QgsVectorLayerLabelProvider; -/** \ingroup core +/** + * \ingroup core * Abstract base class - its implementations define different approaches to the labeling of a vector layer. * * \since QGIS 3.0 @@ -100,7 +101,8 @@ class CORE_EXPORT QgsAbstractVectorLayerLabeling }; -/** \ingroup core +/** + * \ingroup core * Basic implementation of the labeling interface. * * The configuration is kept in layer's custom properties for backward compatibility. diff --git a/src/core/qgsvectorlayerlabelprovider.h b/src/core/qgsvectorlayerlabelprovider.h index 65c8bb5d68aa..02fb043869fd 100644 --- a/src/core/qgsvectorlayerlabelprovider.h +++ b/src/core/qgsvectorlayerlabelprovider.h @@ -26,7 +26,8 @@ class QgsAbstractFeatureSource; class QgsFeatureRenderer; class QgsSymbol; -/** \ingroup core +/** + * \ingroup core * \brief The QgsVectorLayerLabelProvider class implements a label provider * for vector layers. Parameters for the labeling are taken from the layer's * custom properties or from the given settings. @@ -75,7 +76,8 @@ class CORE_EXPORT QgsVectorLayerLabelProvider : public QgsAbstractLabelProvider */ virtual void registerFeature( QgsFeature &feature, QgsRenderContext &context, const QgsGeometry &obstacleGeometry = QgsGeometry() ); - /** Returns the geometry for a point feature which should be used as an obstacle for labels. This + /** + * Returns the geometry for a point feature which should be used as an obstacle for labels. This * obstacle geometry will respect the dimensions and offsets of the symbol used to render the * point, and ensures that labels will not overlap large or offset points. * \param fet point feature diff --git a/src/core/qgsvectorlayerrenderer.h b/src/core/qgsvectorlayerrenderer.h index 2cbc4d208768..8e4f13b93134 100644 --- a/src/core/qgsvectorlayerrenderer.h +++ b/src/core/qgsvectorlayerrenderer.h @@ -45,7 +45,8 @@ typedef QList QgsAttributeList; class QgsVectorLayerLabelProvider; class QgsVectorLayerDiagramProvider; -/** \ingroup core +/** + * \ingroup core * Interruption checker used by QgsVectorLayerRenderer::render() * \note not available in Python bindings */ @@ -59,7 +60,8 @@ class QgsVectorLayerRendererInterruptionChecker: public QgsInterruptionChecker const QgsRenderContext &mContext; }; -/** \ingroup core +/** + * \ingroup core * Implementation of threaded rendering for vector layers. * * \since QGIS 2.4 @@ -75,18 +77,21 @@ class QgsVectorLayerRenderer : public QgsMapLayerRenderer private: - /** Registers label and diagram layer + /** + * Registers label and diagram layer \param layer diagram layer \param attributeNames attributes needed for labeling and diagrams will be added to the list */ void prepareLabeling( QgsVectorLayer *layer, QSet &attributeNames ); void prepareDiagrams( QgsVectorLayer *layer, QSet &attributeNames ); - /** Draw layer with renderer V2. QgsFeatureRenderer::startRender() needs to be called before using this method + /** + * Draw layer with renderer V2. QgsFeatureRenderer::startRender() needs to be called before using this method */ void drawRenderer( QgsFeatureIterator &fit ); - /** Draw layer with renderer V2 using symbol levels. QgsFeatureRenderer::startRender() needs to be called before using this method + /** + * Draw layer with renderer V2 using symbol levels. QgsFeatureRenderer::startRender() needs to be called before using this method */ void drawRendererLevels( QgsFeatureIterator &fit ); diff --git a/src/core/qgsvectorlayertools.h b/src/core/qgsvectorlayertools.h index b01d77809604..48884bdafb78 100644 --- a/src/core/qgsvectorlayertools.h +++ b/src/core/qgsvectorlayertools.h @@ -26,7 +26,8 @@ class QgsFeatureRequest; class QgsVectorLayer; -/** \ingroup core +/** + * \ingroup core * Methods in this class are used to handle basic operations on vector layers. * With an implementation of this class, parts of the application can ask for * an operation to be done and the implementation will then take care of it. diff --git a/src/core/qgsvectorlayerundocommand.h b/src/core/qgsvectorlayerundocommand.h index ff9cf9a64eb7..3bd2d6c74f24 100644 --- a/src/core/qgsvectorlayerundocommand.h +++ b/src/core/qgsvectorlayerundocommand.h @@ -32,7 +32,8 @@ class QgsGeometry; #include "qgsvectorlayer.h" #include "qgsvectorlayereditbuffer.h" -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoCommand * \brief Base class for undo commands within a QgsVectorLayerEditBuffer. */ @@ -41,7 +42,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommand : public QUndoCommand { public: - /** Constructor for QgsVectorLayerUndoCommand + /** + * Constructor for QgsVectorLayerUndoCommand * \param buffer associated edit buffer */ QgsVectorLayerUndoCommand( QgsVectorLayerEditBuffer *buffer SIP_TRANSFER ) @@ -60,7 +62,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommand : public QUndoCommand }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoCommandAddFeature * \brief Undo command for adding a feature to a vector layer. */ @@ -69,7 +72,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandAddFeature : public QgsVectorLayerUnd { public: - /** Constructor for QgsVectorLayerUndoCommandAddFeature + /** + * Constructor for QgsVectorLayerUndoCommandAddFeature * \param buffer associated edit buffer * \param f feature to add to layer */ @@ -83,7 +87,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandAddFeature : public QgsVectorLayerUnd }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoCommandDeleteFeature * \brief Undo command for deleting a feature from a vector layer. */ @@ -92,7 +97,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandDeleteFeature : public QgsVectorLayer { public: - /** Constructor for QgsVectorLayerUndoCommandDeleteFeature + /** + * Constructor for QgsVectorLayerUndoCommandDeleteFeature * \param buffer associated edit buffer * \param fid feature ID of feature to delete from layer */ @@ -106,7 +112,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandDeleteFeature : public QgsVectorLayer QgsFeature mOldAddedFeature; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoCommandChangeGeometry * \brief Undo command for modifying the geometry of a feature from a vector layer. */ @@ -115,7 +122,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandChangeGeometry : public QgsVectorLaye { public: - /** Constructor for QgsVectorLayerUndoCommandChangeGeometry + /** + * Constructor for QgsVectorLayerUndoCommandChangeGeometry * \param buffer associated edit buffer * \param fid feature ID of feature to modify geometry of * \param newGeom new geometry for feature @@ -134,7 +142,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandChangeGeometry : public QgsVectorLaye }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoCommandChangeAttribute * \brief Undo command for modifying an attribute of a feature from a vector layer. */ @@ -143,7 +152,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandChangeAttribute : public QgsVectorLay { public: - /** Constructor for QgsVectorLayerUndoCommandChangeAttribute + /** + * Constructor for QgsVectorLayerUndoCommandChangeAttribute * \param buffer associated edit buffer * \param fid feature ID of feature to modify * \param fieldIndex index of field to modify @@ -162,7 +172,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandChangeAttribute : public QgsVectorLay bool mFirstChange; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoCommandAddAttribute * \brief Undo command for adding a new attribute to a vector layer. */ @@ -171,7 +182,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandAddAttribute : public QgsVectorLayerU { public: - /** Constructor for QgsVectorLayerUndoCommandAddAttribute + /** + * Constructor for QgsVectorLayerUndoCommandAddAttribute * \param buffer associated edit buffer * \param field definition of new field to add */ @@ -185,7 +197,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandAddAttribute : public QgsVectorLayerU int mFieldIndex; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoCommandDeleteAttribute * \brief Undo command for removing an existing attribute from a vector layer. */ @@ -194,7 +207,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandDeleteAttribute : public QgsVectorLay { public: - /** Constructor for QgsVectorLayerUndoCommandDeleteAttribute + /** + * Constructor for QgsVectorLayerUndoCommandDeleteAttribute * \param buffer associated edit buffer * \param fieldIndex index of field to delete */ @@ -216,7 +230,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandDeleteAttribute : public QgsVectorLay }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoCommandRenameAttribute * \brief Undo command for renaming an existing attribute of a vector layer. * \since QGIS 2.16 @@ -226,7 +241,8 @@ class CORE_EXPORT QgsVectorLayerUndoCommandRenameAttribute : public QgsVectorLay { public: - /** Constructor for QgsVectorLayerUndoCommandRenameAttribute + /** + * Constructor for QgsVectorLayerUndoCommandRenameAttribute * \param buffer associated edit buffer * \param fieldIndex index of field to rename * \param newName new name for field diff --git a/src/core/qgsvectorlayerundopassthroughcommand.h b/src/core/qgsvectorlayerundopassthroughcommand.h index 5e4e4b66b05a..0a4c03f63ad5 100644 --- a/src/core/qgsvectorlayerundopassthroughcommand.h +++ b/src/core/qgsvectorlayerundopassthroughcommand.h @@ -20,7 +20,8 @@ #include "qgsvectorlayereditbuffer.h" -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoPassthroughCommand * \brief Undo command for vector layer in transaction group mode. * \since QGIS 3.0 @@ -31,13 +32,15 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommand : public QgsVectorLayerUn { public: - /** Constructor for QgsVectorLayerUndoPassthroughCommand + /** + * Constructor for QgsVectorLayerUndoPassthroughCommand * \param buffer associated edit buffer * \param text text associated with command */ QgsVectorLayerUndoPassthroughCommand( QgsVectorLayerEditBuffer *buffer, const QString &text ); - /** Returns error status + /** + * Returns error status */ bool hasError() const { return mHasError; } @@ -49,24 +52,28 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommand : public QgsVectorLayerUn protected: - /** Rollback command, release savepoint or set error status + /** + * Rollback command, release savepoint or set error status * save point must be set prior to call * error satus should be false prior to call */ bool rollBackToSavePoint(); - /** Set the command savepoint or set error status + /** + * Set the command savepoint or set error status * error satus should be false prior to call */ bool setSavePoint(); - /** Set error flag and append "failed" to text + /** + * Set error flag and append "failed" to text */ void setError(); }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoPassthroughCommandAddFeatures * \brief Undo command for adding a feature to a vector layer in transaction group mode. * \since QGIS 3.0 @@ -76,7 +83,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandAddFeatures : public QgsVe { public: - /** Constructor for QgsVectorLayerUndoPassthroughCommandAddFeatures + /** + * Constructor for QgsVectorLayerUndoPassthroughCommandAddFeatures * \param buffer associated edit buffer * \param features features to add to layer */ @@ -85,7 +93,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandAddFeatures : public QgsVe virtual void undo() override; virtual void redo() override; - /** List of features (added feaures can be modified by default values from database) + /** + * List of features (added feaures can be modified by default values from database) */ QgsFeatureList features() const { return mFeatures; } @@ -95,7 +104,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandAddFeatures : public QgsVe }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoPassthroughCommandDeleteFeatures * \brief Undo command for deleting features from a vector layer in transaction group. * \since QGIS 3.0 @@ -105,7 +115,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandDeleteFeatures : public Qg { public: - /** Constructor for QgsVectorLayerUndoPassthroughCommandDeleteFeatures + /** + * Constructor for QgsVectorLayerUndoPassthroughCommandDeleteFeatures * \param buffer associated edit buffer * \param fids feature IDs of features to delete from layer */ @@ -118,7 +129,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandDeleteFeatures : public Qg const QgsFeatureIds mFids; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoPassthroughCommandChangeGeometry * \brief Undo command for changing feature geometry from a vector layer in transaction group. * \since QGIS 3.0 @@ -128,7 +140,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandChangeGeometry : public Qg { public: - /** Constructor for QgsVectorLayerUndoPassthroughCommandChangeGeometry + /** + * Constructor for QgsVectorLayerUndoPassthroughCommandChangeGeometry * \param buffer associated edit buffer * \param fid feature ID of feature to change * \param geom new geometru @@ -144,7 +157,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandChangeGeometry : public Qg const QgsGeometry mOldGeom; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoPassthroughCommandChangeAttribute * \brief Undo command for changing attr value from a vector layer in transaction group. * \since QGIS 3.0 @@ -154,7 +168,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandChangeAttribute: public Qg { public: - /** Constructor for QgsVectorLayerUndoPassthroughCommandChangeAttribute + /** + * Constructor for QgsVectorLayerUndoPassthroughCommandChangeAttribute * \param buffer associated edit buffer * \param fid feature ID of feature * \param field @@ -172,7 +187,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandChangeAttribute: public Qg const QVariant mOldValue; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoPassthroughCommandAddAttribute * \brief Undo command for adding attri to a vector layer in transaction group. * \since QGIS 3.0 @@ -182,7 +198,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandAddAttribute : public QgsV { public: - /** Constructor for QgsVectorLayerUndoPassthroughCommandAddAttribute + /** + * Constructor for QgsVectorLayerUndoPassthroughCommandAddAttribute * \param buffer associated edit buffer * \param field */ @@ -195,7 +212,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandAddAttribute : public QgsV const QgsField mField; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoPassthroughCommandDeleteAttribute * \brief Undo command for deleting attri of a vector layer in transaction group. * \since QGIS 3.0 @@ -205,7 +223,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandDeleteAttribute : public Q { public: - /** Constructor for QgsVectorLayerUndoCommandDeleteAttribute + /** + * Constructor for QgsVectorLayerUndoCommandDeleteAttribute * \param buffer associated edit buffer * \param attr */ @@ -218,7 +237,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandDeleteAttribute : public Q const QgsField mField; }; -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUndoPassthroughCommandRenameAttribute * \brief Undo command for deleting attri of a vector layer in transaction group. * \since QGIS 3.0 @@ -228,7 +248,8 @@ class CORE_EXPORT QgsVectorLayerUndoPassthroughCommandRenameAttribute : public Q { public: - /** Constructor for QgsVectorLayerUndoCommandRenameAttribute + /** + * Constructor for QgsVectorLayerUndoCommandRenameAttribute * \param buffer associated edit buffer * \param attr * \param newName diff --git a/src/core/qgsvectorlayerutils.h b/src/core/qgsvectorlayerutils.h index c75a8c9139c8..e913574a2d44 100644 --- a/src/core/qgsvectorlayerutils.h +++ b/src/core/qgsvectorlayerutils.h @@ -20,7 +20,8 @@ #include "qgsvectorlayer.h" #include "qgsgeometry.h" -/** \ingroup core +/** + * \ingroup core * \class QgsVectorLayerUtils * \brief Contains utility methods for working with QgsVectorLayers. * diff --git a/src/core/qgsvectorsimplifymethod.h b/src/core/qgsvectorsimplifymethod.h index 4ed2f9ce5b55..c4d7b7b6ba02 100644 --- a/src/core/qgsvectorsimplifymethod.h +++ b/src/core/qgsvectorsimplifymethod.h @@ -19,7 +19,8 @@ #include "qgis_core.h" #include -/** \ingroup core +/** + * \ingroup core * This class contains information how to simplify geometries fetched from a vector layer * \since QGIS 2.2 */ diff --git a/src/core/qgsvirtuallayerdefinition.h b/src/core/qgsvirtuallayerdefinition.h index 13a977291182..5823ec050835 100644 --- a/src/core/qgsvirtuallayerdefinition.h +++ b/src/core/qgsvirtuallayerdefinition.h @@ -21,7 +21,8 @@ email : hugo dot mercier at oslandia dot com #include "qgsfields.h" #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * Class to manipulate the definition of a virtual layer * * It is used to extract parameters from an initial virtual layer definition as well as @@ -31,7 +32,8 @@ class CORE_EXPORT QgsVirtualLayerDefinition { public: - /** \ingroup core + /** + * \ingroup core * A SourceLayer is either a reference to a live layer in the registry * or all the parameters needed to load it (provider key, source, etc.) */ diff --git a/src/core/qgsvirtuallayerdefinitionutils.h b/src/core/qgsvirtuallayerdefinitionutils.h index ce9e46d96058..02b8601d2e87 100644 --- a/src/core/qgsvirtuallayerdefinitionutils.h +++ b/src/core/qgsvirtuallayerdefinitionutils.h @@ -22,7 +22,8 @@ email : hugo dot mercier at oslandia dot com class QgsVectorLayer; class QgsVirtualLayerDefinition; -/** \ingroup core +/** + * \ingroup core * Utils class for QgsVirtualLayerDefinition */ class CORE_EXPORT QgsVirtualLayerDefinitionUtils diff --git a/src/core/qgswebframe.h b/src/core/qgswebframe.h index bd0858fd3f6a..ada47a91315a 100644 --- a/src/core/qgswebframe.h +++ b/src/core/qgswebframe.h @@ -29,7 +29,8 @@ #include #include -/** \ingroup core +/** + * \ingroup core * \brief The QWebFrame class is a collection of stubs to mimic the API of a QWebFrame on systems * where QtWebkit is not available. */ diff --git a/src/core/qgswebpage.h b/src/core/qgswebpage.h index 0c174ecbcaae..226898cc5966 100644 --- a/src/core/qgswebpage.h +++ b/src/core/qgswebpage.h @@ -34,7 +34,8 @@ #include -/** \ingroup core +/** + * \ingroup core * \brief The QWebSettings class is a collection of stubs to mimic the API of a QWebSettings on systems * where QtWebkit is not available. */ @@ -205,7 +206,8 @@ class CORE_EXPORT QWebPage : public QObject }; #endif -/** \ingroup core +/** + * \ingroup core * \class QgsWebPage * \brief QWebPage subclass which redirects JavaScript errors and console output to the QGIS message log. * \since QGIS 2.16 @@ -217,14 +219,16 @@ class CORE_EXPORT QgsWebPage : public QWebPage public: - /** Constructor for QgsWebPage. + /** + * Constructor for QgsWebPage. * \param parent parent object */ explicit QgsWebPage( QObject *parent = 0 ) : QWebPage( parent ) {} - /** Sets an identifier for the QgsWebPage. The page's identifier is included in messages written to the + /** + * Sets an identifier for the QgsWebPage. The page's identifier is included in messages written to the * log, and should be set to a user-friendly string so that users can identify which QgsWebPage has * logged the message. * \param identifier identifier string @@ -232,7 +236,8 @@ class CORE_EXPORT QgsWebPage : public QWebPage */ void setIdentifier( const QString &identifier ) { mIdentifier = identifier; } - /** Returns the QgsWebPage's identifier. The page's identifier is included in messages written to the + /** + * Returns the QgsWebPage's identifier. The page's identifier is included in messages written to the * log so that users can identify which QgsWebPage has logged the message. * \see setIdentifier() */ diff --git a/src/core/qgswebview.h b/src/core/qgswebview.h index f31df79fff5b..cc635ebb8abe 100644 --- a/src/core/qgswebview.h +++ b/src/core/qgswebview.h @@ -28,7 +28,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core */ class CORE_EXPORT QgsWebView : public QWebView { @@ -52,7 +53,8 @@ class CORE_EXPORT QgsWebView : public QWebView class QPrinter; -/** \ingroup core +/** + * \ingroup core * \brief The QgsWebView class is a collection of stubs to mimic the API of QWebView on systems where the real * library is not available. It should be used instead of QWebView inside QGIS. * diff --git a/src/core/qgsxmlutils.h b/src/core/qgsxmlutils.h index 4938c6eca842..ebce9ec9b8a7 100644 --- a/src/core/qgsxmlutils.h +++ b/src/core/qgsxmlutils.h @@ -24,7 +24,8 @@ class QgsRectangle; #include "qgis.h" #include "qgsunittypes.h" -/** \ingroup core +/** + * \ingroup core * Assorted helper methods for reading and writing chunks of XML */ class CORE_EXPORT QgsXmlUtils @@ -33,7 +34,8 @@ class CORE_EXPORT QgsXmlUtils /* reading */ - /** Decodes a distance unit from a DOM element. + /** + * Decodes a distance unit from a DOM element. * \param element DOM element to decode * \returns distance units * \see writeMapUnits() @@ -44,7 +46,8 @@ class CORE_EXPORT QgsXmlUtils /* writing */ - /** Encodes a distance unit to a DOM element. + /** + * Encodes a distance unit to a DOM element. * \param units units to encode * \param doc DOM document * \returns element containing encoded units diff --git a/src/core/qgsziputils.h b/src/core/qgsziputils.h index edc99674c9f5..fa82360a91c2 100644 --- a/src/core/qgsziputils.h +++ b/src/core/qgsziputils.h @@ -29,14 +29,16 @@ namespace QgsZipUtils { - /** Returns true if the file name is a zipped file ( i.e with a '.qgz' + /** + * Returns true if the file name is a zipped file ( i.e with a '.qgz' * extension, false otherwise. * \param filename The name of the file * \returns true if the file is zipped, false otherwise */ CORE_EXPORT bool isZipFile( const QString &filename ); - /** Unzip a zip file in an output directory. An error is returned if the zip + /** + * Unzip a zip file in an output directory. An error is returned if the zip * filename does not exist, the output directory does not exist or is * not writable. * \param zip The zip filename @@ -46,7 +48,8 @@ namespace QgsZipUtils */ CORE_EXPORT bool unzip( const QString &zip, const QString &dir, QStringList &files SIP_OUT ); - /** Zip the list of files in the zip file. If the zip file already exists or is + /** + * Zip the list of files in the zip file. If the zip file already exists or is * empty, an error is returned. If an input file does not exist, an error is * also returned. * \param zip The zip filename diff --git a/src/core/raster/qgsbilinearrasterresampler.h b/src/core/raster/qgsbilinearrasterresampler.h index 51b30cb8e13d..4ab851e759bd 100644 --- a/src/core/raster/qgsbilinearrasterresampler.h +++ b/src/core/raster/qgsbilinearrasterresampler.h @@ -24,7 +24,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core Bilinear Raster Resampler */ class CORE_EXPORT QgsBilinearRasterResampler: public QgsRasterResampler diff --git a/src/core/raster/qgsbrightnesscontrastfilter.h b/src/core/raster/qgsbrightnesscontrastfilter.h index a4efdbcaeded..367f8dc88b12 100644 --- a/src/core/raster/qgsbrightnesscontrastfilter.h +++ b/src/core/raster/qgsbrightnesscontrastfilter.h @@ -24,7 +24,8 @@ class QDomElement; -/** \ingroup core +/** + * \ingroup core * Brightness/contrast filter pipe for rasters. */ class CORE_EXPORT QgsBrightnessContrastFilter : public QgsRasterInterface diff --git a/src/core/raster/qgscliptominmaxenhancement.h b/src/core/raster/qgscliptominmaxenhancement.h index 83ccc24726c8..a43c261a0441 100644 --- a/src/core/raster/qgscliptominmaxenhancement.h +++ b/src/core/raster/qgscliptominmaxenhancement.h @@ -22,7 +22,8 @@ email : ersts@amnh.org #include "qgis_core.h" #include "qgscontrastenhancementfunction.h" -/** \ingroup core +/** + * \ingroup core * A raster contrast enhancement that will clip a value to the specified min/max range. * For example if a min max range of [10,240] is specified in the constructor, and * a value of 250 is called using enhance(), the value will be truncated ('clipped') diff --git a/src/core/raster/qgscolorrampshader.h b/src/core/raster/qgscolorrampshader.h index 83ca8a149523..3b6b6dab7067 100644 --- a/src/core/raster/qgscolorrampshader.h +++ b/src/core/raster/qgscolorrampshader.h @@ -32,7 +32,8 @@ originally part of the larger QgsRasterLayer class #include "qgsrastershaderfunction.h" #include "qgsrectangle.h" -/** \ingroup core +/** + * \ingroup core * A ramp shader will color a raster pixel based on a list of values ranges in a ramp. */ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction @@ -56,7 +57,8 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction Quantile = 3 //!< Uses quantile (i.e. equal pixel) count }; - /** Creates a new color ramp shader. + /** + * Creates a new color ramp shader. * \param minimumValue minimum value for the raster shader * \param maximumValue maximum value for the raster shader * \param type interpolation type used @@ -66,11 +68,13 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction */ QgsColorRampShader( double minimumValue = 0.0, double maximumValue = 255.0, QgsColorRamp *colorRamp = nullptr, Type type = Interpolated, ClassificationMode classificationMode = Continuous ); - /** Copy constructor + /** + * Copy constructor */ QgsColorRampShader( const QgsColorRampShader &other ); - /** Assignment operator + /** + * Assignment operator */ QgsColorRampShader &operator=( const QgsColorRampShader &other ); @@ -112,13 +116,15 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction //! \brief Set the color ramp type void setColorRampType( QgsColorRampShader::Type colorRampType ); - /** Get the source color ramp + /** + * Get the source color ramp * \since QGIS 3.0 * \see setSourceColorRamp() */ QgsColorRamp *sourceColorRamp() const SIP_FACTORY; - /** Set the source color ramp. Ownership is transferred to the renderer. + /** + * Set the source color ramp. Ownership is transferred to the renderer. * \since QGIS 3.0 * \see sourceColorRamp() */ @@ -127,7 +133,8 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction //! \brief Set the color ramp type void setColorRampType( const QString &type ); - /** Classify color ramp shader + /** + * Classify color ramp shader * \param classes number of classes * \param band raster band used in classification (only used in quantile mode) * \param extent extent used in classification (only used in quantile mode) @@ -135,7 +142,8 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction */ void classifyColorRamp( const int classes = 0, const int band = -1, const QgsRectangle &extent = QgsRectangle(), QgsRasterInterface *input = nullptr ); - /** Classify color ramp shader + /** + * Classify color ramp shader * \param band raster band used in classification (quantile mode only) * \param extent extent used in classification (quantile mode only) * \param input raster input used in classification (quantile mode only) @@ -160,13 +168,15 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction //! Returns the classification mode ClassificationMode classificationMode() const { return mClassificationMode; } - /** Sets whether the shader should not render values out of range. + /** + * Sets whether the shader should not render values out of range. * \param clip set to true to clip values which are out of range. * \see clip() */ void setClip( bool clip ) { mClip = clip; } - /** Returns whether the shader will clip values which are out of range. + /** + * Returns whether the shader will clip values which are out of range. * \see setClip() */ bool clip() const { return mClip; } @@ -178,7 +188,8 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction private: - /** This vector holds the information for classification based on values. + /** + * This vector holds the information for classification based on values. * Each item holds a value, a label and a color. The member * mDiscreteClassification holds if one color is applied for all values * between two class breaks (true) or if the item values are (linearly) @@ -188,7 +199,8 @@ class CORE_EXPORT QgsColorRampShader : public QgsRasterShaderFunction Type mColorRampType; ClassificationMode mClassificationMode; - /** Look up table to speed up finding the right color. + /** + * Look up table to speed up finding the right color. * It is initialized on the first call to shade(). */ QVector mLUT; double mLUTOffset = 0.0; diff --git a/src/core/raster/qgscontrastenhancement.h b/src/core/raster/qgscontrastenhancement.h index 66540e1859aa..7671b03f6c3f 100644 --- a/src/core/raster/qgscontrastenhancement.h +++ b/src/core/raster/qgscontrastenhancement.h @@ -33,7 +33,8 @@ class QDomDocument; class QDomElement; class QString; -/** \ingroup core +/** + * \ingroup core * Manipulates raster pixel values so that they enhanceContrast or clip into a * specified numerical range according to the specified * ContrastEnhancementAlgorithm. diff --git a/src/core/raster/qgscontrastenhancementfunction.h b/src/core/raster/qgscontrastenhancementfunction.h index 1705851ae142..9baf703bbdc9 100644 --- a/src/core/raster/qgscontrastenhancementfunction.h +++ b/src/core/raster/qgscontrastenhancementfunction.h @@ -22,7 +22,8 @@ email : ersts@amnh.org #include "qgis_core.h" #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * A contrast enhancement function is the base class for all raster contrast enhancements. * * The purpose of a contrast enhancement is to enhanceContrast or clip a pixel value into diff --git a/src/core/raster/qgscubicrasterresampler.h b/src/core/raster/qgscubicrasterresampler.h index 236a45584ab8..c914a1631842 100644 --- a/src/core/raster/qgscubicrasterresampler.h +++ b/src/core/raster/qgscubicrasterresampler.h @@ -24,7 +24,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core Cubic Raster Resampler */ class CORE_EXPORT QgsCubicRasterResampler: public QgsRasterResampler diff --git a/src/core/raster/qgshillshaderenderer.h b/src/core/raster/qgshillshaderenderer.h index dfa858876279..d5b3e574c182 100644 --- a/src/core/raster/qgshillshaderenderer.h +++ b/src/core/raster/qgshillshaderenderer.h @@ -62,11 +62,13 @@ class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer QList usesBands() const override; - /** Returns the band used by the renderer + /** + * Returns the band used by the renderer */ int band() const { return mBand; } - /** Sets the band used by the renderer. + /** + * Sets the band used by the renderer. * \see band */ void setBand( int bandNo ); @@ -77,17 +79,20 @@ class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer */ double azimuth() const { return mLightAzimuth; } - /** Returns the angle of the light source over the raster. + /** + * Returns the angle of the light source over the raster. * \see setAltitude() */ double altitude() const { return mLightAngle; } - /** Returns the Z scaling factor. + /** + * Returns the Z scaling factor. * \see setZFactor() */ double zFactor() const { return mZFactor; } - /** Returns true if the renderer is using multi-directional hillshading. + /** + * Returns true if the renderer is using multi-directional hillshading. * \see setMultiDirectional() */ bool multiDirectional() const { return mMultiDirectional; } @@ -113,7 +118,8 @@ class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer */ void setZFactor( double zfactor ) { mZFactor = zfactor; } - /** Sets whether to render using a multi-directional hillshade algorithm. + /** + * Sets whether to render using a multi-directional hillshade algorithm. * \param isMultiDirectional set to true to use multi directional rendering * \see multiDirectional() */ diff --git a/src/core/raster/qgshuesaturationfilter.h b/src/core/raster/qgshuesaturationfilter.h index 3dda3db52361..284ab4234314 100644 --- a/src/core/raster/qgshuesaturationfilter.h +++ b/src/core/raster/qgshuesaturationfilter.h @@ -24,7 +24,8 @@ class QDomElement; -/** \ingroup core +/** + * \ingroup core * Color and saturation filter pipe for rasters. */ class CORE_EXPORT QgsHueSaturationFilter : public QgsRasterInterface diff --git a/src/core/raster/qgslinearminmaxenhancement.h b/src/core/raster/qgslinearminmaxenhancement.h index 26356ffd0560..a9800ad5c6b2 100644 --- a/src/core/raster/qgslinearminmaxenhancement.h +++ b/src/core/raster/qgslinearminmaxenhancement.h @@ -22,7 +22,8 @@ email : ersts@amnh.org #include "qgis_core.h" #include "qgscontrastenhancementfunction.h" -/** \ingroup core +/** + * \ingroup core * A color enhancement function that performs a linear enhanceContrast between min and max. */ class CORE_EXPORT QgsLinearMinMaxEnhancement : public QgsContrastEnhancementFunction diff --git a/src/core/raster/qgslinearminmaxenhancementwithclip.h b/src/core/raster/qgslinearminmaxenhancementwithclip.h index abafe581b961..5089adee8044 100644 --- a/src/core/raster/qgslinearminmaxenhancementwithclip.h +++ b/src/core/raster/qgslinearminmaxenhancementwithclip.h @@ -22,7 +22,8 @@ email : ersts@amnh.org #include "qgis_core.h" #include "qgscontrastenhancementfunction.h" -/** \ingroup core +/** + * \ingroup core * A linear enhanceContrast enhancement that first clips to min max and then enhanceContrastes * linearly between min and max. */ diff --git a/src/core/raster/qgsmultibandcolorrenderer.h b/src/core/raster/qgsmultibandcolorrenderer.h index ebcf09f8596b..dee30e2d97a3 100644 --- a/src/core/raster/qgsmultibandcolorrenderer.h +++ b/src/core/raster/qgsmultibandcolorrenderer.h @@ -25,7 +25,8 @@ class QgsContrastEnhancement; class QDomElement; -/** \ingroup core +/** + * \ingroup core * Renderer for multiband images with the color components */ class CORE_EXPORT QgsMultiBandColorRenderer: public QgsRasterRenderer diff --git a/src/core/raster/qgspalettedrasterrenderer.h b/src/core/raster/qgspalettedrasterrenderer.h index e3cb1e71d46c..4739abda790a 100644 --- a/src/core/raster/qgspalettedrasterrenderer.h +++ b/src/core/raster/qgspalettedrasterrenderer.h @@ -28,7 +28,8 @@ class QColor; class QDomElement; -/** \ingroup core +/** + * \ingroup core * Renderer for paletted raster images. */ class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer @@ -80,11 +81,13 @@ class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer */ ClassData classes() const; - /** Return optional category label + /** + * Return optional category label * \since QGIS 2.1 */ QString label( int idx ) const; - /** Set category label + /** + * Set category label * \since QGIS 2.1 */ void setLabel( int idx, const QString &label ); @@ -107,7 +110,8 @@ class CORE_EXPORT QgsPalettedRasterRenderer: public QgsRasterRenderer */ void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER ); - /** Get the source color ramp + /** + * Get the source color ramp * \since QGIS 3.0 * \see setSourceColorRamp() */ diff --git a/src/core/raster/qgsraster.h b/src/core/raster/qgsraster.h index 6f79e717a5e9..331676dda9cf 100644 --- a/src/core/raster/qgsraster.h +++ b/src/core/raster/qgsraster.h @@ -24,7 +24,8 @@ #include "qgis.h" -/** \ingroup core +/** + * \ingroup core * Raster namespace. */ class CORE_EXPORT QgsRaster @@ -100,7 +101,8 @@ class CORE_EXPORT QgsRaster SingleBandColorDataStyle // ARGB values rendered directly }; - /** Check if the specified value is representable in the given data type. + /** + * Check if the specified value is representable in the given data type. * Supported are numerical types Byte, UInt16, Int16, UInt32, Int32, Float32, Float64. * \param value * \param dataType @@ -108,7 +110,8 @@ class CORE_EXPORT QgsRaster * \note not available in Python bindings */ static bool isRepresentableValue( double value, Qgis::DataType dataType ) SIP_SKIP; - /** Get value representable by given data type. + /** + * Get value representable by given data type. * Supported are numerical types Byte, UInt16, Int16, UInt32, Int32, Float32, Float64. * This is done through C casting, so you have to be sure that the provided value is * representable in the output data type. This can be checked with isRepresentableValue(). diff --git a/src/core/raster/qgsrasterbandstats.h b/src/core/raster/qgsrasterbandstats.h index af2cec6eacd8..83f329b0bba8 100644 --- a/src/core/raster/qgsrasterbandstats.h +++ b/src/core/raster/qgsrasterbandstats.h @@ -26,7 +26,8 @@ #include "qgsrectangle.h" -/** \ingroup core +/** + * \ingroup core * The RasterBandStats struct is a container for statistics about a single * raster band. */ @@ -79,11 +80,13 @@ class CORE_EXPORT QgsRasterBandStats // TODO: check if no data are excluded in stats calculation qgssize elementCount; - /** \brief The maximum cell value in the raster band. NO_DATA values + /** + * \brief The maximum cell value in the raster band. NO_DATA values * are ignored. This does not use the gdal GetMaximmum function. */ double maximumValue; - /** \brief The minimum cell value in the raster band. NO_DATA values + /** + * \brief The minimum cell value in the raster band. NO_DATA values * are ignored. This does not use the gdal GetMinimum function. */ double minimumValue; diff --git a/src/core/raster/qgsrasterblock.h b/src/core/raster/qgsrasterblock.h index f1e9a5049741..7c95288cb7ae 100644 --- a/src/core/raster/qgsrasterblock.h +++ b/src/core/raster/qgsrasterblock.h @@ -29,7 +29,8 @@ class QgsRectangle; -/** \ingroup core +/** + * \ingroup core * Raster data container. */ class CORE_EXPORT QgsRasterBlock @@ -37,7 +38,8 @@ class CORE_EXPORT QgsRasterBlock public: QgsRasterBlock(); - /** \brief Constructor which allocates data block in memory + /** + * \brief Constructor which allocates data block in memory * \param dataType raster data type * \param width width of data matrix * \param height height of data matrix @@ -46,7 +48,8 @@ class CORE_EXPORT QgsRasterBlock virtual ~QgsRasterBlock(); - /** \brief Reset block + /** + * \brief Reset block * \param dataType raster data type * \param width width of data matrix * \param height height of data matrix @@ -57,7 +60,8 @@ class CORE_EXPORT QgsRasterBlock // TODO: consider if use isValid() at all, isEmpty() should be sufficient // and works also if block is valid but empty - difference between valid and empty? - /** \brief Returns true if the block is valid (correctly filled with data). + /** + * \brief Returns true if the block is valid (correctly filled with data). * An empty block may still be valid (if zero size block was requested). * If the block is not valid, error may be retrieved by error() method. */ @@ -66,7 +70,8 @@ class CORE_EXPORT QgsRasterBlock //! \brief Mark block as valid or invalid void setValid( bool valid ) { mValid = valid; } - /** Returns true if block is empty, i.e. its size is 0 (zero rows or cols). + /** + * Returns true if block is empty, i.e. its size is 0 (zero rows or cols). * This method does not return true if size is not zero and all values are * 'no data' (null). */ @@ -126,125 +131,146 @@ class CORE_EXPORT QgsRasterBlock //! For given data type returns wider type and sets no data value static Qgis::DataType typeWithNoDataValue( Qgis::DataType dataType, double *noDataValue ); - /** True if the block has no data value. + /** + * True if the block has no data value. * \returns true if the block has no data value * \see noDataValue(), setNoDataValue(), resetNoDataValue() */ bool hasNoDataValue() const { return mHasNoDataValue; } - /** Returns true if the block may contain no data. It does not guarantee + /** + * Returns true if the block may contain no data. It does not guarantee * that it really contains any no data. It can be used to speed up processing. * Not the difference between this method and hasNoDataValue(). * \returns true if the block may contain no data */ bool hasNoData() const; - /** Sets cell value that will be considered as "no data". + /** + * Sets cell value that will be considered as "no data". * \since QGIS 3.0 * \see noDataValue(), hasNoDataValue(), resetNoDataValue() */ void setNoDataValue( double noDataValue ); - /** Reset no data value: if there was a no data value previously set, + /** + * Reset no data value: if there was a no data value previously set, * it will be discarded. * \since QGIS 3.0 * \see noDataValue(), hasNoDataValue(), setNoDataValue() */ void resetNoDataValue(); - /** Return no data value. If the block does not have a no data value the + /** + * Return no data value. If the block does not have a no data value the * returned value is undefined. * \returns No data value * \see hasNoDataValue(), setNoDataValue(), resetNoDataValue() */ double noDataValue() const { return mNoDataValue; } - /** Get byte array representing a value. + /** + * Get byte array representing a value. * \param dataType data type * \param value value * \returns byte array representing the value */ static QByteArray valueBytes( Qgis::DataType dataType, double value ); - /** \brief Read a single value if type of block is numeric. If type is color, + /** + * \brief Read a single value if type of block is numeric. If type is color, * returned value is undefined. * \param row row index * \param column column index * \returns value */ double value( int row, int column ) const; - /** \brief Read a single value if type of block is numeric. If type is color, + /** + * \brief Read a single value if type of block is numeric. If type is color, * returned value is undefined. * \param index data matrix index (long type in Python) * \returns value */ double value( qgssize index ) const; - /** \brief Read a single color + /** + * \brief Read a single color * \param row row index * \param column column index * \returns color */ QRgb color( int row, int column ) const; - /** \brief Read a single value + /** + * \brief Read a single value * \param index data matrix index (long type in Python) * \returns color */ QRgb color( qgssize index ) const; - /** \brief Check if value at position is no data + /** + * \brief Check if value at position is no data * \param row row index * \param column column index * \returns true if value is no data */ bool isNoData( int row, int column ); - /** \brief Check if value at position is no data + /** + * \brief Check if value at position is no data * \param index data matrix index (long type in Python) * \returns true if value is no data */ bool isNoData( qgssize index ); - /** \brief Set value on position + /** + * \brief Set value on position * \param row row index * \param column column index * \param value the value to be set * \returns true on success */ bool setValue( int row, int column, double value ); - /** \brief Set value on index (indexed line by line) + /** + * \brief Set value on index (indexed line by line) * \param index data matrix index (long type in Python) * \param value the value to be set * \returns true on success */ bool setValue( qgssize index, double value ); - /** \brief Set color on position + /** + * \brief Set color on position * \param row row index * \param column column index * \param color the color to be set, QRgb value * \returns true on success */ bool setColor( int row, int column, QRgb color ); - /** \brief Set color on index (indexed line by line) + /** + * \brief Set color on index (indexed line by line) * \param index data matrix index (long type in Python) * \param color the color to be set, QRgb value * \returns true on success */ bool setColor( qgssize index, QRgb color ); - /** \brief Set no data on pixel + /** + * \brief Set no data on pixel * \param row row index * \param column column index * \returns true on success */ bool setIsNoData( int row, int column ); - /** \brief Set no data on pixel + /** + * \brief Set no data on pixel * \param index data matrix index (long type in Python) * \returns true on success */ bool setIsNoData( qgssize index ); - /** \brief Set the whole block to no data + /** + * \brief Set the whole block to no data * \returns true on success */ bool setIsNoData(); - /** \brief Set the whole block to no data except specified rectangle + /** + * \brief Set the whole block to no data except specified rectangle * \returns true on success */ bool setIsNoDataExcept( QRect exceptRect ); - /** \brief Remove no data flag on pixel. If the raster block does not have an explicit + /** + * \brief Remove no data flag on pixel. If the raster block does not have an explicit * no data value set then an internal map of no data pixels is maintained for the block. * In this case it is possible to reset a pixel to flag it as having valid data using this * method. This method has no effect for raster blocks with an explicit no data value set. @@ -253,7 +279,8 @@ class CORE_EXPORT QgsRasterBlock * \since QGIS 2.10 */ void setIsData( int row, int column ); - /** \brief Remove no data flag on pixel. If the raster block does not have an explicit + /** + * \brief Remove no data flag on pixel. If the raster block does not have an explicit * no data value set then an internal map of no data pixels is maintained for the block. * In this case it is possible to reset a pixel to flag it as having valid data using this * method. This method has no effect for raster blocks with an explicit no data value set. @@ -261,7 +288,8 @@ class CORE_EXPORT QgsRasterBlock * \since QGIS 2.10 */ void setIsData( qgssize index ); - /** Get access to raw data. + /** + * Get access to raw data. * The returned QByteArray instance is not a copy of the data: it only refers to the array * owned by the QgsRasterBlock, therefore it is only valid while the QgsRasterBlock object * still exists. Writing to the returned QByteArray will not affect the original data: @@ -271,7 +299,8 @@ class CORE_EXPORT QgsRasterBlock */ QByteArray data() const; - /** Rewrite raw pixel data. + /** + * Rewrite raw pixel data. * If the data array is shorter than the internal array within the raster block object, * pixels at the end will stay untouched. If the data array is longer than the internal * array, only the initial data from the input array will be used. @@ -281,7 +310,8 @@ class CORE_EXPORT QgsRasterBlock */ void setData( const QByteArray &data, int offset = 0 ); - /** \brief Get pointer to data + /** + * \brief Get pointer to data * \param row row index * \param column column index * \returns pointer to data @@ -289,26 +319,30 @@ class CORE_EXPORT QgsRasterBlock */ char *bits( int row, int column ) SIP_SKIP; - /** \brief Get pointer to data + /** + * \brief Get pointer to data * \param index data matrix index (long type in Python) * \returns pointer to data * \note not available in Python bindings */ char *bits( qgssize index ) SIP_SKIP; - /** \brief Get pointer to data + /** + * \brief Get pointer to data * \returns pointer to data * \note not available in Python bindings */ char *bits() SIP_SKIP; - /** \brief Print double value with all necessary significant digits. + /** + * \brief Print double value with all necessary significant digits. * It is ensured that conversion back to double gives the same number. * \param value the value to be printed * \returns string representing the value*/ static QString printValue( double value ); - /** \brief Print float value with all necessary significant digits. + /** + * \brief Print float value with all necessary significant digits. * It is ensured that conversion back to float gives the same number. * \param value the value to be printed * \returns string representing the value @@ -317,16 +351,19 @@ class CORE_EXPORT QgsRasterBlock */ static QString printValue( float value ) SIP_SKIP; - /** \brief Convert data to different type. + /** + * \brief Convert data to different type. * \param destDataType dest data type * \returns true on success */ bool convert( Qgis::DataType destDataType ); - /** \brief Get image if type is color. + /** + * \brief Get image if type is color. * \returns image */ QImage image() const; - /** \brief set image. + /** + * \brief set image. * \param image image * \returns true on success */ bool setImage( const QImage *image ); @@ -353,7 +390,8 @@ class CORE_EXPORT QgsRasterBlock QString toString() const; - /** \brief For extent and width, height find rectangle covered by subextent. + /** + * \brief For extent and width, height find rectangle covered by subextent. * The output rect has x oriented from left to right and y from top to bottom * (upper-left to lower-right orientation). * \param extent extent, usually the larger @@ -364,13 +402,15 @@ class CORE_EXPORT QgsRasterBlock */ static QRect subRect( const QgsRectangle &extent, int width, int height, const QgsRectangle &subExtent ); - /** Returns the width (number of columns) of the raster block. + /** + * Returns the width (number of columns) of the raster block. * \see height * \since QGIS 2.10 */ int width() const { return mWidth; } - /** Returns the height (number of rows) of the raster block. + /** + * Returns the height (number of rows) of the raster block. * \see width * \since QGIS 2.10 */ @@ -380,22 +420,26 @@ class CORE_EXPORT QgsRasterBlock static QImage::Format imageFormat( Qgis::DataType dataType ); static Qgis::DataType dataType( QImage::Format format ); - /** Test if value is nodata comparing to noDataValue + /** + * Test if value is nodata comparing to noDataValue * \param value tested value * \param noDataValue no data value * \returns true if value is nodata */ static bool isNoDataValue( double value, double noDataValue ); - /** Test if value is nodata for specific band + /** + * Test if value is nodata for specific band * \param value tested value * \returns true if value is nodata */ bool isNoDataValue( double value ) const; - /** Allocate no data bitmap + /** + * Allocate no data bitmap * \returns true on success */ bool createNoDataBitmap(); - /** \brief Convert block of data from one type to another. Original block memory + /** + * \brief Convert block of data from one type to another. Original block memory * is not release. * \param srcData source data * \param srcDataType source data type diff --git a/src/core/raster/qgsrasterchecker.h b/src/core/raster/qgsrasterchecker.h index f548e926ab33..b7f1a2c3e241 100644 --- a/src/core/raster/qgsrasterchecker.h +++ b/src/core/raster/qgsrasterchecker.h @@ -21,7 +21,8 @@ #include class QImage; -/** \ingroup core +/** + * \ingroup core * This is a helper class for unit tests that need to * write an image and compare it to an expected result * or render time. diff --git a/src/core/raster/qgsrasterdataprovider.h b/src/core/raster/qgsrasterdataprovider.h index bcca67e829ae..bd1bacfe596a 100644 --- a/src/core/raster/qgsrasterdataprovider.h +++ b/src/core/raster/qgsrasterdataprovider.h @@ -60,13 +60,15 @@ class CORE_EXPORT QgsImageFetcher : public QObject //! Constructor QgsImageFetcher( QObject *parent = 0 ) : QObject( parent ) {} - /** Starts the image download + /** + * Starts the image download * \note Make sure to connect to "finish" and "error" before starting */ virtual void start() = 0; signals: - /** Emitted when the download completes + /** + * Emitted when the download completes * \param legend The downloaded legend image */ void finish( const QImage &legend ); //! Emitted to report progress @@ -76,7 +78,8 @@ class CORE_EXPORT QgsImageFetcher : public QObject }; -/** \ingroup core +/** + * \ingroup core * Base class for raster data providers. */ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRasterInterface @@ -98,7 +101,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast //! Returns data type for the band specified by number virtual Qgis::DataType dataType( int bandNo ) const override = 0; - /** Returns source data type for the band specified by number, + /** + * Returns source data type for the band specified by number, * source data type may be shorter than dataType */ virtual Qgis::DataType sourceDataType( int bandNo ) const override = 0; @@ -178,12 +182,14 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast return colorName( colorInterpretation( bandNo ) ); } - /** Read band scale for raster value + /** + * Read band scale for raster value * \since QGIS 2.3 */ virtual double bandScale( int bandNo ) const { Q_UNUSED( bandNo ); return 1.0; } - /** Read band offset for raster value + /** + * Read band offset for raster value * \since QGIS 2.3 */ virtual double bandOffset( int bandNo ) const { Q_UNUSED( bandNo ); return 0.0; } @@ -213,7 +219,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast virtual QList colorTable( int bandNo ) const { Q_UNUSED( bandNo ); return QList(); } - /** \brief Returns the sublayers of this layer - useful for providers that manage + /** + * \brief Returns the sublayers of this layer - useful for providers that manage * their own layers, such as WMS */ virtual QStringList subLayers() const override { @@ -223,7 +230,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast //! \brief Returns whether the provider supplies a legend graphic virtual bool supportsLegendGraphic() const { return false; } - /** \brief Returns the legend rendered as pixmap + /** + * \brief Returns the legend rendered as pixmap * * useful for that layer that need to get legend layer remotely as WMS * \param scale Optional parameter that is the Scale of the layer @@ -274,7 +282,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast return QStringLiteral( "FAILED_NOT_SUPPORTED" ); } - /** \brief Accessor for the raster layers pyramid list. + /** + * \brief Accessor for the raster layers pyramid list. * \param overviewList used to construct the pyramid list (optional), when empty the list is defined by the provider. * A pyramid list defines the * POTENTIAL pyramids that can be in a raster. To know which of the pyramid layers @@ -293,7 +302,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast */ virtual QString metadata() = 0; - /** \brief Identify raster value(s) found on the point position. The context + /** + * \brief Identify raster value(s) found on the point position. The context * parameters extent, width and height are important to identify * on the same zoom level as a displayed map and to do effective * caching (WCS). If context params are not specified the highest @@ -356,14 +366,16 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast //! Current time stamp of data source virtual QDateTime dataTimestamp() const override { return QDateTime(); } - /** Checks whether the provider is in editing mode, i.e. raster write operations will be accepted. + /** + * Checks whether the provider is in editing mode, i.e. raster write operations will be accepted. * By default providers are not editable. Use setEditable() method to enable/disable editing. * \see setEditable(), writeBlock() * \since QGIS 3.0 */ virtual bool isEditable() const { return false; } - /** Turns on/off editing mode of the provider. When in editing mode, it is possible + /** + * Turns on/off editing mode of the provider. When in editing mode, it is possible * to overwrite data of the provider using writeBlock() calls. * \note Only some providers support editing mode and even those may fail to turn * the underlying data source into editing mode, so it is necessary to check the return @@ -387,7 +399,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast return false; } - /** Writes pixel data from a raster block into the provider data source. + /** + * Writes pixel data from a raster block into the provider data source. * * This will override previously stored pixel values. It is assumed that cells in the passed * raster block are aligned with the cells of the data source. If raster block does not cover @@ -413,7 +426,8 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast const QgsCoordinateReferenceSystem &crs, const QStringList &createOptions = QStringList() ); - /** Set no data value on created dataset + /** + * Set no data value on created dataset * \param bandNo band number * \param noDataValue no data value */ @@ -422,19 +436,22 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast //! Remove dataset virtual bool remove() { return false; } - /** Returns a list of pyramid resampling method name and label pairs + /** + * Returns a list of pyramid resampling method name and label pairs * for given provider */ static QList > pyramidResamplingMethods( const QString &providerKey ); - /** Validates creation options for a specific dataset and destination format. + /** + * Validates creation options for a specific dataset and destination format. * \note used by GDAL provider only * \note see also validateCreationOptionsFormat() in gdal provider for validating options based on format only */ virtual QString validateCreationOptions( const QStringList &createOptions, const QString &format ) { Q_UNUSED( createOptions ); Q_UNUSED( format ); return QString(); } - /** Validates pyramid creation options for a specific dataset and destination format + /** + * Validates pyramid creation options for a specific dataset and destination format * \note used by GDAL provider only */ virtual QString validatePyramidsConfigOptions( QgsRaster::RasterPyramidsFormat pyramidsFormat, @@ -462,20 +479,23 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast signals: - /** Emit a message to be displayed on status bar, usually used by network providers (WMS,WCS) + /** + * Emit a message to be displayed on status bar, usually used by network providers (WMS,WCS) * \since QGIS 2.14 */ void statusChanged( const QString & ) const; protected: - /** Read block of data + /** + * Read block of data * \note not available in Python bindings */ virtual void readBlock( int bandNo, int xBlock, int yBlock, void *data ) SIP_SKIP { Q_UNUSED( bandNo ); Q_UNUSED( xBlock ); Q_UNUSED( yBlock ); Q_UNUSED( data ); } - /** Read block of data using give extent and size + /** + * Read block of data using give extent and size * \note not available in Python bindings */ virtual void readBlock( int bandNo, QgsRectangle const &viewExtent, int width, int height, void *data, QgsRasterBlockFeedback *feedback = nullptr ) SIP_SKIP @@ -493,11 +513,13 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast static QString makeTableCell( const QString &value ); static QString makeTableCells( const QStringList &values ); - /** Dots per inch. Extended WMS (e.g. QGIS mapserver) support DPI dependent output and therefore + /** + * Dots per inch. Extended WMS (e.g. QGIS mapserver) support DPI dependent output and therefore are suited for printing. A value of -1 means it has not been set */ int mDpi = -1; - /** Source no data value is available and is set to be used or internal no data + /** + * Source no data value is available and is set to be used or internal no data * is available. Used internally only */ //bool hasNoDataValue ( int bandNo ); @@ -507,12 +529,14 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast //! \brief Source no data value exists. QList mSrcHasNoDataValue; - /** \brief Use source nodata value. User can disable usage of source nodata + /** + * \brief Use source nodata value. User can disable usage of source nodata * value as nodata. It may happen that a value is wrongly given by GDAL * as nodata (e.g. 0) and it has to be treated as regular value. */ QList mUseSrcNoDataValue; - /** \brief List of lists of user defined additional no data values + /** + * \brief List of lists of user defined additional no data values * for each band, indexed from 0 */ QList< QgsRasterRangeList > mUserNoDataValue; diff --git a/src/core/raster/qgsrasterdrawer.h b/src/core/raster/qgsrasterdrawer.h index 8e818acea602..66ae3a7a7937 100644 --- a/src/core/raster/qgsrasterdrawer.h +++ b/src/core/raster/qgsrasterdrawer.h @@ -30,7 +30,8 @@ struct QgsRasterViewPort; class QgsRasterBlockFeedback; class QgsRasterIterator; -/** \ingroup core +/** + * \ingroup core * The drawing pipe for raster layers. */ class CORE_EXPORT QgsRasterDrawer @@ -38,7 +39,8 @@ class CORE_EXPORT QgsRasterDrawer public: QgsRasterDrawer( QgsRasterIterator *iterator ); - /** Draws raster data. + /** + * Draws raster data. * \param p destination QPainter * \param viewPort viewport to render * \param qgsMapToPixel map to pixel converter @@ -48,7 +50,8 @@ class CORE_EXPORT QgsRasterDrawer protected: - /** Draws raster part + /** + * Draws raster part * \param p the painter to draw to * \param viewPort view port to draw to * \param img image to draw diff --git a/src/core/raster/qgsrasterfilewriter.h b/src/core/raster/qgsrasterfilewriter.h index 3237e02f25eb..9ad09980a4ff 100644 --- a/src/core/raster/qgsrasterfilewriter.h +++ b/src/core/raster/qgsrasterfilewriter.h @@ -31,7 +31,8 @@ class QgsRectangle; class QgsRasterDataProvider; class QgsRasterInterface; -/** \ingroup core +/** + * \ingroup core * The raster file writer which allows you to save a raster to a new file. */ class CORE_EXPORT QgsRasterFileWriter @@ -55,7 +56,8 @@ class CORE_EXPORT QgsRasterFileWriter QgsRasterFileWriter( const QString &outputUrl ); - /** Create a raster file with one band without initializing the pixel data. + /** + * Create a raster file with one band without initializing the pixel data. * Returned provider may be used to initialize the raster using writeBlock() calls. * Ownership of the returned provider is passed to the caller. * \note Does not work with tiled mode enabled. @@ -67,7 +69,8 @@ class CORE_EXPORT QgsRasterFileWriter const QgsRectangle &extent, const QgsCoordinateReferenceSystem &crs ) SIP_FACTORY; - /** Create a raster file with given number of bands without initializing the pixel data. + /** + * Create a raster file with given number of bands without initializing the pixel data. * Returned provider may be used to initialize the raster using writeBlock() calls. * Ownership of the returned provider is passed to the caller. * \note Does not work with tiled mode enabled. @@ -80,7 +83,8 @@ class CORE_EXPORT QgsRasterFileWriter const QgsCoordinateReferenceSystem &crs, int nBands ) SIP_FACTORY; - /** Write raster file + /** + * Write raster file \param pipe raster pipe \param nCols number of output columns \param nRows number of output rows (or -1 to automatically calculate row number to have square pixels) @@ -159,7 +163,8 @@ class CORE_EXPORT QgsRasterFileWriter const QgsCoordinateReferenceSystem &crs, QgsRasterBlockFeedback *feedback = nullptr ); - /** \brief Initialize vrt member variables + /** + * \brief Initialize vrt member variables * \param xSize width of vrt * \param ySize height of vrt * \param crs coordinate system of vrt @@ -181,7 +186,8 @@ class CORE_EXPORT QgsRasterFileWriter const QString &outputUrl, int fileIndex, int nBands, Qgis::DataType type, const QgsCoordinateReferenceSystem &crs ); - /** \brief Init VRT (for tiled mode) or create global output provider (single-file mode) + /** + * \brief Init VRT (for tiled mode) or create global output provider (single-file mode) * \param nCols number of tile columns * \param nRows number of tile rows * \param crs coordinate system of vrt diff --git a/src/core/raster/qgsrasterhistogram.h b/src/core/raster/qgsrasterhistogram.h index 14825218d31e..02a15f7fb22b 100644 --- a/src/core/raster/qgsrasterhistogram.h +++ b/src/core/raster/qgsrasterhistogram.h @@ -24,7 +24,8 @@ #include -/** \ingroup core +/** + * \ingroup core * The QgsRasterHistogram is a container for histogram of a single raster band. * It is used to cache computed histograms in raster providers. */ @@ -71,7 +72,8 @@ class CORE_EXPORT QgsRasterHistogram //! \brief Whether histogram includes out of range values (in first and last bin) bool includeOutOfRange; - /** \brief Store the histogram for a given layer + /** + * \brief Store the histogram for a given layer * \note not available via Python binding */ QgsRasterHistogram::HistogramVector histogramVector; diff --git a/src/core/raster/qgsrasteridentifyresult.h b/src/core/raster/qgsrasteridentifyresult.h index 6c16cedc895c..428f32366f58 100644 --- a/src/core/raster/qgsrasteridentifyresult.h +++ b/src/core/raster/qgsrasteridentifyresult.h @@ -23,7 +23,8 @@ #include "qgsraster.h" #include "qgserror.h" -/** \ingroup core +/** + * \ingroup core * Raster identify results container. */ class CORE_EXPORT QgsRasterIdentifyResult @@ -35,13 +36,15 @@ class CORE_EXPORT QgsRasterIdentifyResult */ QgsRasterIdentifyResult() = default; - /** \brief Constructor. Creates valid result. + /** + * \brief Constructor. Creates valid result. * \param format the result format * \param results the results */ QgsRasterIdentifyResult( QgsRaster::IdentifyFormat format, const QMap &results ); - /** \brief Constructor. Creates invalid result with error. + /** + * \brief Constructor. Creates invalid result with error. * \param error the error */ QgsRasterIdentifyResult( const QgsError &error ); @@ -54,7 +57,8 @@ class CORE_EXPORT QgsRasterIdentifyResult //! \brief Get results format QgsRaster::IdentifyFormat format() const { return mFormat; } - /** \brief Get results. Results are different for each format: + /** + * \brief Get results. Results are different for each format: * QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers (from 1). * QgsRaster::IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer (WMS) * QgsRaster::IdentifyFormatHtml: map of HTML strings for each sublayer (WMS). diff --git a/src/core/raster/qgsrasterinterface.h b/src/core/raster/qgsrasterinterface.h index 632deb2d3a5e..1bb9e8096081 100644 --- a/src/core/raster/qgsrasterinterface.h +++ b/src/core/raster/qgsrasterinterface.h @@ -32,7 +32,8 @@ #include "qgsrasterhistogram.h" #include "qgsrectangle.h" -/** \ingroup core +/** + * \ingroup core * Feedback object tailored for raster block reading. * * \since QGIS 3.0 @@ -89,7 +90,8 @@ class CORE_EXPORT QgsRasterBlockFeedback : public QgsFeedback }; -/** \ingroup core +/** + * \ingroup core * Base class for processing filters like renderers, reprojector, resampler etc. */ class CORE_EXPORT QgsRasterInterface @@ -194,7 +196,8 @@ class CORE_EXPORT QgsRasterInterface //! Returns data type for the band specified by number virtual Qgis::DataType dataType( int bandNo ) const = 0; - /** Returns source data type for the band specified by number, + /** + * Returns source data type for the band specified by number, * source data type may be shorter than dataType */ virtual Qgis::DataType sourceDataType( int bandNo ) const { return mInput ? mInput->sourceDataType( bandNo ) : Qgis::UnknownDataType; } @@ -223,7 +226,8 @@ class CORE_EXPORT QgsRasterInterface return tr( "Band" ) + QStringLiteral( " %1" ) .arg( bandNumber, 1 + static_cast< int >( std::log10( static_cast< double >( bandCount() ) ) ), 10, QChar( '0' ) ); } - /** Read block of data using given extent and size. + /** + * Read block of data using given extent and size. * Returns pointer to data. * Caller is responsible to free the memory returned. * \param bandNo band number @@ -234,7 +238,8 @@ class CORE_EXPORT QgsRasterInterface */ virtual QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) = 0 SIP_FACTORY; - /** Set input. + /** + * Set input. * Returns true if set correctly, false if cannot use that input */ virtual bool setInput( QgsRasterInterface *input ) { mInput = input; return true; } @@ -247,7 +252,8 @@ class CORE_EXPORT QgsRasterInterface //! Set on/off virtual void setOn( bool on ) { mOn = on; } - /** Get source / raw input, the first in pipe, usually provider. + /** + * Get source / raw input, the first in pipe, usually provider. * It may be used to get info about original data, e.g. resolution to decide * resampling etc. * \note not available in Python bindings. @@ -258,7 +264,8 @@ class CORE_EXPORT QgsRasterInterface return mInput ? mInput->sourceInput() : this; } - /** Get source / raw input, the first in pipe, usually provider. + /** + * Get source / raw input, the first in pipe, usually provider. * It may be used to get info about original data, e.g. resolution to decide * resampling etc. */ @@ -268,7 +275,8 @@ class CORE_EXPORT QgsRasterInterface return mInput ? mInput->sourceInput() : this; } - /** \brief Get band statistics. + /** + * \brief Get band statistics. * \param bandNo The band (number). * \param stats Requested statistics * \param extent Extent used to calc statistics, if empty, whole raster extent is used. @@ -281,7 +289,8 @@ class CORE_EXPORT QgsRasterInterface const QgsRectangle &extent = QgsRectangle(), int sampleSize = 0, QgsRasterBlockFeedback *feedback = nullptr ); - /** \brief Returns true if histogram is available (cached, already calculated). * The parameters are the same as in bandStatistics() + /** + * \brief Returns true if histogram is available (cached, already calculated). * The parameters are the same as in bandStatistics() * \returns true if statistics are available (ready to use) */ virtual bool hasStatistics( int bandNo, @@ -290,7 +299,8 @@ class CORE_EXPORT QgsRasterInterface int sampleSize = 0 ); - /** \brief Get histogram. Histograms are cached in providers. + /** + * \brief Get histogram. Histograms are cached in providers. * \param bandNo The band (number). * \param binCount Number of bins (intervals,buckets). If 0, the number of bins is decided automatically according to data type, raster size etc. * \param minimum Minimum value, if NaN (None for Python), raster minimum value will be used. @@ -355,7 +365,8 @@ class CORE_EXPORT QgsRasterInterface #endif - /** \brief Returns true if histogram is available (cached, already calculated) + /** + * \brief Returns true if histogram is available (cached, already calculated) * \note the parameters are the same as in \see histogram() */ #ifndef SIP_RUN @@ -407,7 +418,8 @@ class CORE_EXPORT QgsRasterInterface #endif - /** \brief Find values for cumulative pixel count cut. + /** + * \brief Find values for cumulative pixel count cut. * \param bandNo The band (number). * \param lowerCount The lower count as fraction of 1, e.g. 0.02 = 2% * \param upperCount The upper count as fraction of 1, e.g. 0.98 = 98% @@ -442,7 +454,8 @@ class CORE_EXPORT QgsRasterInterface // On/off state, if off, it does not do anything, replicates input bool mOn = true; - /** Fill in histogram defaults if not specified + /** + * Fill in histogram defaults if not specified * \note the parameters are the same as in \see histogram() */ #ifndef SIP_RUN diff --git a/src/core/raster/qgsrasteriterator.h b/src/core/raster/qgsrasteriterator.h index 127ac075b709..de7221624e62 100644 --- a/src/core/raster/qgsrasteriterator.h +++ b/src/core/raster/qgsrasteriterator.h @@ -26,7 +26,8 @@ class QgsRasterInterface; class QgsRasterProjector; struct QgsRasterViewPort; -/** \ingroup core +/** + * \ingroup core * Iterator for sequentially processing raster cells. */ class CORE_EXPORT QgsRasterIterator @@ -35,7 +36,8 @@ class CORE_EXPORT QgsRasterIterator QgsRasterIterator( QgsRasterInterface *input ); - /** Start reading of raster band. Raster data can then be retrieved by calling readNextRasterPart until it returns false. + /** + * Start reading of raster band. Raster data can then be retrieved by calling readNextRasterPart until it returns false. \param bandNumber number of raster band to read \param nCols number of columns \param nRows number of rows @@ -44,7 +46,8 @@ class CORE_EXPORT QgsRasterIterator */ void startRasterRead( int bandNumber, int nCols, int nRows, const QgsRectangle &extent, QgsRasterBlockFeedback *feedback = nullptr ); - /** Fetches next part of raster data, caller takes ownership of the block and + /** + * Fetches next part of raster data, caller takes ownership of the block and caller should delete the block. \param bandNumber band to read \param nCols number of columns on output device diff --git a/src/core/raster/qgsrasterlayer.h b/src/core/raster/qgsrasterlayer.h index bdf9fff0c887..def7b70c07c7 100644 --- a/src/core/raster/qgsrasterlayer.h +++ b/src/core/raster/qgsrasterlayer.h @@ -49,7 +49,8 @@ class QSlider; typedef QList < QPair< QString, QColor > > QgsLegendColorList; -/** \ingroup core +/** + * \ingroup core * This class provides qgis with the ability to render raster datasets * onto the mapcanvas. * @@ -165,7 +166,8 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer //! \brief Constructor. Provider is not set. QgsRasterLayer(); - /** \brief This is the constructor for the RasterLayer class. + /** + * \brief This is the constructor for the RasterLayer class. * * The main tasks carried out by the constructor are: * @@ -188,7 +190,8 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer ~QgsRasterLayer(); - /** Returns a new instance equivalent to this one. A new provider is + /** + * Returns a new instance equivalent to this one. A new provider is * created for the same data source and renderer is cloned too. * \returns a new layer instance * \since QGIS 3.0 @@ -214,7 +217,8 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer ColorLayer }; - /** This helper checks to see whether the file name appears to be a valid + /** + * This helper checks to see whether the file name appears to be a valid * raster file name. If the file name looks like it could be valid, * but some sort of error occurs in processing the file, the error is * returned in retError. @@ -258,7 +262,8 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer QgsRasterDataProvider *dataProvider() override; - /** Returns the data provider in a const-correct manner + /** + * Returns the data provider in a const-correct manner \note available in Python bindings as constDataProvider() */ const QgsRasterDataProvider *dataProvider() const SIP_PYNAME( constDataProvider ) override; @@ -266,7 +271,8 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer //! Synchronises with changes in the datasource virtual void reload() override; - /** Return new instance of QgsMapLayerRenderer that will be used for rendering of given context + /** + * Return new instance of QgsMapLayerRenderer that will be used for rendering of given context * \since QGIS 2.4 */ virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) override SIP_FACTORY; @@ -294,7 +300,8 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer //! \brief Returns the number of raster units per each raster pixel in Y axis. In a world file, this is normally the first row (without the sign) double rasterUnitsPerPixelY() const; - /** \brief Set contrast enhancement algorithm + /** + * \brief Set contrast enhancement algorithm * \param algorithm Contrast enhancement algorithm * \param limits Limits * \param extent Extent used to calculate limits, if empty, use full layer extent @@ -308,19 +315,22 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer int sampleSize = QgsRasterLayer::SAMPLE_SIZE, bool generateLookupTableFlag = true ); - /** \brief Refresh contrast enhancement with new extent. + /** + * \brief Refresh contrast enhancement with new extent. * \note not available in Python bindings */ // Used by QgisApp::legendLayerStretchUsingCurrentExtent() void refreshContrastEnhancement( const QgsRectangle &extent ) SIP_SKIP; - /** \brief Refresh renderer with new extent, if needed + /** + * \brief Refresh renderer with new extent, if needed * \note not available in Python bindings */ // Used by QgsRasterLayerRenderer void refreshRendererIfNeeded( QgsRasterRenderer *rasterRenderer, const QgsRectangle &extent ) SIP_SKIP; - /** \brief Return default contrast enhancemnt settings for that type of raster. + /** + * \brief Return default contrast enhancemnt settings for that type of raster. * \note not available in Python bindings */ bool defaultContrastEnhancementSettings( @@ -333,7 +343,8 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer //! \brief Returns the sublayers of this layer - Useful for providers that manage their own layers, such as WMS virtual QStringList subLayers() const override; - /** \brief Draws a preview of the rasterlayer into a QImage + /** + * \brief Draws a preview of the rasterlayer into a QImage \since QGIS 2.4 */ QImage previewAsImage( QSize size, const QColor &bgColor = Qt::white, QImage::Format format = QImage::Format_ARGB32_Premultiplied ); diff --git a/src/core/raster/qgsrasterlayerrenderer.h b/src/core/raster/qgsrasterlayerrenderer.h index 8329904d750d..4c62f53ddd3e 100644 --- a/src/core/raster/qgsrasterlayerrenderer.h +++ b/src/core/raster/qgsrasterlayerrenderer.h @@ -34,7 +34,8 @@ class QgsRasterLayerRenderer; ///@cond PRIVATE -/** \ingroup core +/** + * \ingroup core * Specific internal feedback class to provide preview of raster layer rendering. * \since QGIS 3.0 * \note not available in Python bindings @@ -57,7 +58,8 @@ class CORE_EXPORT QgsRasterLayerRendererFeedback : public QgsRasterBlockFeedback ///@endcond -/** \ingroup core +/** + * \ingroup core * Implementation of threaded rendering for raster layers. * * \since QGIS 2.4 diff --git a/src/core/raster/qgsrasterminmaxorigin.h b/src/core/raster/qgsrasterminmaxorigin.h index ab982db2b9c5..c26f0a6e4383 100644 --- a/src/core/raster/qgsrasterminmaxorigin.h +++ b/src/core/raster/qgsrasterminmaxorigin.h @@ -24,7 +24,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * This class describes the origin of min/max values. It does not store by * itself the min/max values. * \since QGIS 3.0 diff --git a/src/core/raster/qgsrasternuller.h b/src/core/raster/qgsrasternuller.h index f38c9b8e1317..a5f425fefe0d 100644 --- a/src/core/raster/qgsrasternuller.h +++ b/src/core/raster/qgsrasternuller.h @@ -25,7 +25,8 @@ #include -/** \ingroup core +/** + * \ingroup core * Raster pipe that deals with null values. */ class CORE_EXPORT QgsRasterNuller : public QgsRasterInterface diff --git a/src/core/raster/qgsrasterpipe.h b/src/core/raster/qgsrasterpipe.h index 1245b54d8fd8..8ccb79814efe 100644 --- a/src/core/raster/qgsrasterpipe.h +++ b/src/core/raster/qgsrasterpipe.h @@ -39,7 +39,8 @@ class QgsRasterDataProvider; #undef interface #endif -/** \ingroup core +/** + * \ingroup core * Base class for processing modules. */ class CORE_EXPORT QgsRasterPipe @@ -69,7 +70,8 @@ class CORE_EXPORT QgsRasterPipe QgsRasterPipe &operator=( const QgsRasterPipe &rh ) = delete; - /** Try to insert interface at specified index and connect + /** + * Try to insert interface at specified index and connect * if connection would fail, the interface is not inserted and false is returned */ bool insert( int idx, QgsRasterInterface *interface SIP_TRANSFER ); #ifdef SIP_RUN @@ -85,11 +87,13 @@ class CORE_EXPORT QgsRasterPipe % End #endif - /** Try to replace interface at specified index and connect + /** + * Try to replace interface at specified index and connect * if connection would fail, the interface is not inserted and false is returned */ bool replace( int idx, QgsRasterInterface *interface SIP_TRANSFER ); - /** Insert a new known interface in default place or replace interface of the same + /** + * Insert a new known interface in default place or replace interface of the same * role if it already exists. Known interfaces are: QgsRasterDataProvider, * QgsRasterRenderer, QgsRasterResampleFilter, QgsRasterProjector and their * subclasses. For unknown interfaces it mus be explicitly specified position @@ -107,7 +111,8 @@ class CORE_EXPORT QgsRasterPipe QgsRasterInterface *at( int idx ) const { return mInterfaces.at( idx ); } QgsRasterInterface *last() const { return mInterfaces.last(); } - /** Set interface at index on/off + /** + * Set interface at index on/off * Returns true on success */ bool setOn( int idx, bool on ); @@ -148,7 +153,8 @@ class CORE_EXPORT QgsRasterPipe //! Get known interface by role QgsRasterInterface *interface( Role role ) const; - /** \brief Try to connect interfaces in pipe and to the provider at beginning. + /** + * \brief Try to connect interfaces in pipe and to the provider at beginning. Returns true if connected or false if connection failed */ bool connect( QVector interfaces ); diff --git a/src/core/raster/qgsrasterprojector.h b/src/core/raster/qgsrasterprojector.h index 763572d24c66..b74dc7924c1a 100644 --- a/src/core/raster/qgsrasterprojector.h +++ b/src/core/raster/qgsrasterprojector.h @@ -37,7 +37,8 @@ class QgsPointXY; -/** \ingroup core +/** + * \ingroup core * \brief QgsRasterProjector implements approximate projection support for * it calculates grid of points in source CRS for target CRS + extent * which are used to calculate affine transformation matrices. @@ -47,7 +48,8 @@ class CORE_EXPORT QgsRasterProjector : public QgsRasterInterface { public: - /** Precision defines if each pixel is reprojected or approximate reprojection based + /** + * Precision defines if each pixel is reprojected or approximate reprojection based * on an approximation matrix of reprojected points is used. */ enum Precision @@ -128,7 +130,8 @@ class ProjectorData ProjectorData( const ProjectorData &other ) = delete; ProjectorData &operator=( const ProjectorData &other ) = delete; - /** \brief Get source row and column indexes for current source extent and resolution + /** + * \brief Get source row and column indexes for current source extent and resolution If source pixel is outside source extent srcRow and srcCol are left unchanged. \returns true if inside source */ @@ -174,11 +177,13 @@ class ProjectorData //! \brief calculate minimum source width and height void calcSrcRowsCols(); - /** \brief check error along columns + /** + * \brief check error along columns * returns true if within threshold */ bool checkCols( const QgsCoordinateTransform &ct ); - /** \brief check error along rows + /** + * \brief check error along rows * returns true if within threshold */ bool checkRows( const QgsCoordinateTransform &ct ); @@ -191,7 +196,8 @@ class ProjectorData //! Get mCPMatrix as string QString cpToString(); - /** Use approximation (requested precision is Approximate and it is possible to calculate + /** + * Use approximation (requested precision is Approximate and it is possible to calculate * an approximation matrix with a sufficient precision) */ bool mApproximate; diff --git a/src/core/raster/qgsrasterpyramid.h b/src/core/raster/qgsrasterpyramid.h index 7caead0854a6..b2ca45e2162a 100644 --- a/src/core/raster/qgsrasterpyramid.h +++ b/src/core/raster/qgsrasterpyramid.h @@ -20,7 +20,8 @@ #include "qgis_core.h" -/** \ingroup core +/** + * \ingroup core * This struct is used to store pyramid info for the raster layer. */ class CORE_EXPORT QgsRasterPyramid diff --git a/src/core/raster/qgsrasterrange.h b/src/core/raster/qgsrasterrange.h index 044b2f9ee4f9..2dc30ac07678 100644 --- a/src/core/raster/qgsrasterrange.h +++ b/src/core/raster/qgsrasterrange.h @@ -26,7 +26,8 @@ class QgsRasterRange; typedef QList QgsRasterRangeList; -/** \ingroup core +/** + * \ingroup core * Raster values range container. Represents range of values between min and max * including min and max value. */ @@ -34,11 +35,13 @@ class CORE_EXPORT QgsRasterRange { public: - /** \brief Constructor. + /** + * \brief Constructor. */ QgsRasterRange(); - /** \brief Constructor + /** + * \brief Constructor * \param min minimum value * \param max max value */ @@ -55,7 +58,8 @@ class CORE_EXPORT QgsRasterRange return qgsDoubleNear( mMin, o.mMin ) && qgsDoubleNear( mMax, o.mMax ); } - /** \brief Test if value is within the list of ranges + /** + * \brief Test if value is within the list of ranges * \param value value * \param rangeList list of ranges * \returns true if value is in at least one of ranges diff --git a/src/core/raster/qgsrasterrenderer.h b/src/core/raster/qgsrasterrenderer.h index 0769b764749b..054c26d72a9f 100644 --- a/src/core/raster/qgsrasterrenderer.h +++ b/src/core/raster/qgsrasterrenderer.h @@ -30,7 +30,8 @@ class QDomElement; class QPainter; class QgsRasterTransparency; -/** \ingroup core +/** + * \ingroup core * Raster renderer pipe that applies colors to a raster. */ class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface @@ -97,7 +98,8 @@ class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface //! Sets base class members from xml. Usually called from create() methods of subclasses void readXml( const QDomElement &rendererElem ) override; - /** Copies common properties like opacity / transparency data from other renderer. + /** + * Copies common properties like opacity / transparency data from other renderer. * Useful when cloning renderers. * \since QGIS 2.16 */ void copyCommonProperties( const QgsRasterRenderer *other, bool copyMinMaxOrigin = true ); @@ -123,7 +125,8 @@ class CORE_EXPORT QgsRasterRenderer : public QgsRasterInterface //! Raster transparency per color or value. Overwrites global alpha value QgsRasterTransparency *mRasterTransparency = nullptr; - /** Read alpha value from band. Is combined with value from raster transparency / global alpha value. + /** + * Read alpha value from band. Is combined with value from raster transparency / global alpha value. Default: -1 (not set)*/ int mAlphaBand = -1; diff --git a/src/core/raster/qgsrasterrendererregistry.h b/src/core/raster/qgsrasterrendererregistry.h index a153d6666216..b7d2a4973a15 100644 --- a/src/core/raster/qgsrasterrendererregistry.h +++ b/src/core/raster/qgsrasterrendererregistry.h @@ -37,7 +37,8 @@ class QgsRasterRendererWidget; typedef QgsRasterRenderer *( *QgsRasterRendererCreateFunc )( const QDomElement &, QgsRasterInterface *input ); typedef QgsRasterRendererWidget *( *QgsRasterRendererWidgetCreateFunc )( QgsRasterLayer *, const QgsRectangle &extent ); -/** \ingroup core +/** + * \ingroup core * Registry for raster renderer entries. */ struct CORE_EXPORT QgsRasterRendererRegistryEntry @@ -56,7 +57,8 @@ struct CORE_EXPORT QgsRasterRendererRegistryEntry QgsRasterRendererWidgetCreateFunc widgetCreateFunction = nullptr ; //pointer to create function for renderer widget }; -/** \ingroup core +/** + * \ingroup core * Registry for raster renderers. * * QgsRasterRendererRegistry is not usually directly created, but rather accessed through @@ -76,7 +78,8 @@ class CORE_EXPORT QgsRasterRendererRegistry QStringList renderersList() const; QList< QgsRasterRendererRegistryEntry > entries() const; - /** Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement). + /** + * Creates a default renderer for a raster drawing style (considering user options such as default contrast enhancement). Caller takes ownership*/ QgsRasterRenderer *defaultRendererForDrawingStyle( QgsRaster::DrawingStyle drawingStyle, QgsRasterDataProvider *provider ) const; diff --git a/src/core/raster/qgsrasterresamplefilter.h b/src/core/raster/qgsrasterresamplefilter.h index db7bed1d1d61..d434e04a9bd5 100644 --- a/src/core/raster/qgsrasterresamplefilter.h +++ b/src/core/raster/qgsrasterresamplefilter.h @@ -25,7 +25,8 @@ class QDomElement; -/** \ingroup core +/** + * \ingroup core * Resample filter pipe for rasters. */ class CORE_EXPORT QgsRasterResampleFilter : public QgsRasterInterface diff --git a/src/core/raster/qgsrasterresampler.h b/src/core/raster/qgsrasterresampler.h index aede66a66f1e..a33f11b7af38 100644 --- a/src/core/raster/qgsrasterresampler.h +++ b/src/core/raster/qgsrasterresampler.h @@ -23,7 +23,8 @@ class QImage; -/** \ingroup core +/** + * \ingroup core * Interface for resampling rasters (e.g. to have a smoother appearance) */ class CORE_EXPORT QgsRasterResampler diff --git a/src/core/raster/qgsrastershader.h b/src/core/raster/qgsrastershader.h index 9e08a93e45a1..9d8d5490bbc7 100644 --- a/src/core/raster/qgsrastershader.h +++ b/src/core/raster/qgsrastershader.h @@ -27,7 +27,8 @@ class QDomDocument; class QDomElement; class QgsRasterShaderFunction; -/** \ingroup core +/** + * \ingroup core * Interface for all raster shaders. */ class CORE_EXPORT QgsRasterShader @@ -77,7 +78,8 @@ class CORE_EXPORT QgsRasterShader int *returnBlueValue SIP_OUT, int *returnAlpha SIP_OUT ); - /** \brief A public method that allows the user to set their own shader function + /** + * \brief A public method that allows the user to set their own shader function \note Raster shader takes ownership of the shader function instance */ void setRasterShaderFunction( QgsRasterShaderFunction *function SIP_TRANSFER ); diff --git a/src/core/raster/qgsrastershaderfunction.h b/src/core/raster/qgsrastershaderfunction.h index 342de81a73dc..f6551ab4b844 100644 --- a/src/core/raster/qgsrastershaderfunction.h +++ b/src/core/raster/qgsrastershaderfunction.h @@ -20,7 +20,8 @@ email : ersts@amnh.org #ifndef QGSRASTERSHADERFUNCTION_H #define QGSRASTERSHADERFUNCTION_H -/** \ingroup core +/** + * \ingroup core * The raster shade function applies a shader to a pixel at render time - * typically used to render grayscale images as false color. */ diff --git a/src/core/raster/qgsrastertransparency.h b/src/core/raster/qgsrastertransparency.h index dc87a4192a08..2f4ae7bea0d8 100644 --- a/src/core/raster/qgsrastertransparency.h +++ b/src/core/raster/qgsrastertransparency.h @@ -24,7 +24,8 @@ email : ersts@amnh.org class QDomDocument; class QDomElement; -/** \ingroup core +/** + * \ingroup core * Defines the list of pixel values to be considered as transparent or semi * transparent when rendering rasters. */ diff --git a/src/core/raster/qgsrasterviewport.h b/src/core/raster/qgsrasterviewport.h index 52e15b902c7e..46a7c9996e34 100644 --- a/src/core/raster/qgsrasterviewport.h +++ b/src/core/raster/qgsrasterviewport.h @@ -21,7 +21,8 @@ #include "qgscoordinatereferencesystem.h" #include "qgsrectangle.h" -/** \ingroup core +/** + * \ingroup core * This class provides details of the viewable area that a raster will * be rendered into. * @@ -37,18 +38,21 @@ struct CORE_EXPORT QgsRasterViewPort % End #endif - /** \brief Coordinate (in output device coordinate system) of top left corner + /** + * \brief Coordinate (in output device coordinate system) of top left corner * of the part of the raster that is to be rendered.*/ QgsPointXY mTopLeftPoint; - /** \brief Coordinate (in output device coordinate system) of bottom right corner + /** + * \brief Coordinate (in output device coordinate system) of bottom right corner * of the part of the raster that is to be rendered.*/ QgsPointXY mBottomRightPoint; //! \brief Width, number of columns to be rendered int mWidth; - /** \brief Distance in map units from bottom edge to top edge for the part of + /** + * \brief Distance in map units from bottom edge to top edge for the part of * the raster that is to be rendered.*/ //! \brief Height, number of rows to be rendered int mHeight; diff --git a/src/core/raster/qgssinglebandcolordatarenderer.h b/src/core/raster/qgssinglebandcolordatarenderer.h index c8bdb5ef97e0..d3092f57bf80 100644 --- a/src/core/raster/qgssinglebandcolordatarenderer.h +++ b/src/core/raster/qgssinglebandcolordatarenderer.h @@ -24,7 +24,8 @@ class QDomElement; -/** \ingroup core +/** + * \ingroup core * Raster renderer pipe for single band color. */ class CORE_EXPORT QgsSingleBandColorDataRenderer: public QgsRasterRenderer diff --git a/src/core/raster/qgssinglebandgrayrenderer.h b/src/core/raster/qgssinglebandgrayrenderer.h index 71d32546b852..4890d89b280c 100644 --- a/src/core/raster/qgssinglebandgrayrenderer.h +++ b/src/core/raster/qgssinglebandgrayrenderer.h @@ -26,7 +26,8 @@ class QgsContrastEnhancement; class QDomElement; -/** \ingroup core +/** + * \ingroup core * Raster renderer pipe for single band gray. */ class CORE_EXPORT QgsSingleBandGrayRenderer: public QgsRasterRenderer diff --git a/src/core/raster/qgssinglebandpseudocolorrenderer.h b/src/core/raster/qgssinglebandpseudocolorrenderer.h index 04b6279b6d64..00a38fca3b56 100644 --- a/src/core/raster/qgssinglebandpseudocolorrenderer.h +++ b/src/core/raster/qgssinglebandpseudocolorrenderer.h @@ -28,7 +28,8 @@ class QDomElement; class QgsRasterShader; -/** \ingroup core +/** + * \ingroup core * Raster renderer pipe for single band pseudocolor. */ class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer @@ -59,7 +60,8 @@ class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer //! \note available in Python as constShader const QgsRasterShader *shader() const SIP_PYNAME( constShader ) { return mShader.get(); } - /** Creates a color ramp shader + /** + * Creates a color ramp shader * \param colorRamp vector color ramp * \param colorRampType type of color ramp shader * \param classificationMode classification mode @@ -80,12 +82,14 @@ class CORE_EXPORT QgsSingleBandPseudoColorRenderer: public QgsRasterRenderer QList usesBands() const override; - /** Returns the band used by the renderer + /** + * Returns the band used by the renderer * \since QGIS 2.7 */ int band() const { return mBand; } - /** Sets the band used by the renderer. + /** + * Sets the band used by the renderer. * \see band * \since QGIS 2.10 */ diff --git a/src/core/symbology/qgs25drenderer.h b/src/core/symbology/qgs25drenderer.h index 7610de0ca90c..2a652c9567cd 100644 --- a/src/core/symbology/qgs25drenderer.h +++ b/src/core/symbology/qgs25drenderer.h @@ -21,7 +21,8 @@ class QgsOuterGlowEffect; -/** \ingroup core +/** + * \ingroup core * \class Qgs25DRenderer */ class CORE_EXPORT Qgs25DRenderer : public QgsFeatureRenderer diff --git a/src/core/symbology/qgsarrowsymbollayer.h b/src/core/symbology/qgsarrowsymbollayer.h index cefee6f4c20d..b3422c42077e 100644 --- a/src/core/symbology/qgsarrowsymbollayer.h +++ b/src/core/symbology/qgsarrowsymbollayer.h @@ -21,7 +21,8 @@ #include "qgssymbollayer.h" -/** \ingroup core +/** + * \ingroup core * \class QgsArrowSymbolLayer * \brief Line symbol layer used for representing lines as arrows. * \since QGIS 2.16 diff --git a/src/core/symbology/qgscategorizedsymbolrenderer.h b/src/core/symbology/qgscategorizedsymbolrenderer.h index 364bb7010c64..8ab734017186 100644 --- a/src/core/symbology/qgscategorizedsymbolrenderer.h +++ b/src/core/symbology/qgscategorizedsymbolrenderer.h @@ -27,7 +27,8 @@ class QgsVectorLayer; -/** \ingroup core +/** + * \ingroup core * \brief categorized renderer */ class CORE_EXPORT QgsRendererCategory @@ -75,7 +76,8 @@ class CORE_EXPORT QgsRendererCategory typedef QList QgsCategoryList; -/** \ingroup core +/** + * \ingroup core * \class QgsCategorizedSymbolRenderer */ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer @@ -96,7 +98,8 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer virtual QString filter( const QgsFields &fields = QgsFields() ) override; virtual QgsSymbolList symbols( QgsRenderContext &context ) override; - /** Update all the symbols but leave categories and colors. This method also sets the source + /** + * Update all the symbols but leave categories and colors. This method also sets the source * symbol for the renderer. * \param sym source symbol to use for categories. Ownership is not transferred. * \see setSourceSymbol() @@ -141,14 +144,16 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer QgsLegendSymbolList legendSymbolItems() 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 + /** + * Returns the renderer's source symbol, which is the base symbol used for the each categories' symbol before applying * the categories' color. * \see setSourceSymbol() * \see sourceColorRamp() */ QgsSymbol *sourceSymbol(); - /** Sets the source symbol for the renderer, which is the base symbol used for the each categories' symbol before applying + /** + * Sets the source symbol for the renderer, which is the base symbol used for the each categories' symbol before applying * the categories' color. * \param sym source symbol, ownership is transferred to the renderer * \see sourceSymbol() @@ -156,20 +161,23 @@ class CORE_EXPORT QgsCategorizedSymbolRenderer : public QgsFeatureRenderer */ void setSourceSymbol( QgsSymbol *sym SIP_TRANSFER ); - /** Returns the source color ramp, from which each categories' color is derived. + /** + * Returns the source color ramp, from which each categories' color is derived. * \see setSourceColorRamp() * \see sourceSymbol() */ QgsColorRamp *sourceColorRamp(); - /** Sets the source color ramp. + /** + * Sets the source color ramp. * \param ramp color ramp. Ownership is transferred to the renderer * \see sourceColorRamp() * \see setSourceSymbol() */ void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER ); - /** Update the color ramp used and all symbols colors. + /** + * Update the color ramp used and all symbols colors. * \param ramp color ramp. Ownership is transferred to the renderer * \since QGIS 2.5 */ diff --git a/src/core/symbology/qgscolorbrewerpalette.h b/src/core/symbology/qgscolorbrewerpalette.h index afa40d5a4066..f54af4a5d227 100644 --- a/src/core/symbology/qgscolorbrewerpalette.h +++ b/src/core/symbology/qgscolorbrewerpalette.h @@ -21,7 +21,8 @@ #include "qgssymbollayerutils.h" -/** \ingroup core +/** + * \ingroup core * \class QgsColorBrewerPalette */ class CORE_EXPORT QgsColorBrewerPalette diff --git a/src/core/symbology/qgscptcityarchive.h b/src/core/symbology/qgscptcityarchive.h index c57d88ad8544..fdd8380ac748 100644 --- a/src/core/symbology/qgscptcityarchive.h +++ b/src/core/symbology/qgscptcityarchive.h @@ -97,7 +97,8 @@ class CORE_EXPORT QgsCptCityArchive }; -/** Base class for all items in the model +/** + * Base class for all items in the model * \ingroup core */ class CORE_EXPORT QgsCptCityDataItem : public QObject @@ -203,7 +204,8 @@ class CORE_EXPORT QgsCptCityDataItem : public QObject void endRemoveItems(); }; -/** Item that represents a layer that can be opened with one of the providers +/** + * Item that represents a layer that can be opened with one of the providers * \ingroup core */ class CORE_EXPORT QgsCptCityColorRampItem : public QgsCptCityDataItem @@ -238,7 +240,8 @@ class CORE_EXPORT QgsCptCityColorRampItem : public QgsCptCityDataItem }; -/** A Collection: logical collection of subcollections and color ramps +/** + * A Collection: logical collection of subcollections and color ramps * \ingroup core */ class CORE_EXPORT QgsCptCityCollectionItem : public QgsCptCityDataItem @@ -257,7 +260,8 @@ class CORE_EXPORT QgsCptCityCollectionItem : public QgsCptCityDataItem bool mPopulatedRamps; }; -/** A directory: contains subdirectories and color ramps +/** + * A directory: contains subdirectories and color ramps * \ingroup core */ class CORE_EXPORT QgsCptCityDirectoryItem : public QgsCptCityCollectionItem @@ -280,7 +284,8 @@ class CORE_EXPORT QgsCptCityDirectoryItem : public QgsCptCityCollectionItem QMap< QString, QStringList > mRampsMap; }; -/** \ingroup core +/** + * \ingroup core * \class QgsCptCitySelectionItem * A selection: contains subdirectories and color ramps */ @@ -301,7 +306,8 @@ class CORE_EXPORT QgsCptCitySelectionItem : public QgsCptCityCollectionItem QStringList mSelectionsList; }; -/** \ingroup core +/** + * \ingroup core * An "All ramps item", which contains all items in a flat hierarchy */ class CORE_EXPORT QgsCptCityAllRampsItem : public QgsCptCityCollectionItem { @@ -316,7 +322,8 @@ class CORE_EXPORT QgsCptCityAllRampsItem : public QgsCptCityCollectionItem QVector mItems; }; -/** \ingroup core +/** + * \ingroup core * \class QgsCptCityBrowserModel */ class CORE_EXPORT QgsCptCityBrowserModel : public QAbstractItemModel diff --git a/src/core/symbology/qgsellipsesymbollayer.h b/src/core/symbology/qgsellipsesymbollayer.h index 34be29cc2fba..55af1d5fcf0a 100644 --- a/src/core/symbology/qgsellipsesymbollayer.h +++ b/src/core/symbology/qgsellipsesymbollayer.h @@ -24,7 +24,8 @@ class QgsExpression; -/** \ingroup core +/** + * \ingroup core * A symbol layer for rendering objects with major and minor axis (e.g. ellipse, rectangle )*/ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer { @@ -58,11 +59,13 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer Qt::PenStyle strokeStyle() const { return mStrokeStyle; } void setStrokeStyle( Qt::PenStyle strokeStyle ) { mStrokeStyle = strokeStyle; } - /** Get stroke join style. + /** + * Get stroke join style. * \since QGIS 2.16 */ Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; } - /** Set stroke join style. + /** + * Set stroke join style. * \since QGIS 2.16 */ void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; } @@ -75,14 +78,16 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer void setStrokeColor( const QColor &c ) override { mStrokeColor = c; } QColor strokeColor() const override { return mStrokeColor; } - /** Sets the units for the symbol's width. + /** + * Sets the units for the symbol's width. * \param unit symbol units * \see symbolWidthUnit() * \see setSymbolHeightUnit() */ void setSymbolWidthUnit( QgsUnitTypes::RenderUnit unit ) { mSymbolWidthUnit = unit; } - /** Returns the units for the symbol's width. + /** + * Returns the units for the symbol's width. * \see setSymbolWidthUnit() * \see symbolHeightUnit() */ @@ -91,14 +96,16 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer void setSymbolWidthMapUnitScale( const QgsMapUnitScale &scale ) { mSymbolWidthMapUnitScale = scale; } const QgsMapUnitScale &symbolWidthMapUnitScale() const { return mSymbolWidthMapUnitScale; } - /** Sets the units for the symbol's height. + /** + * Sets the units for the symbol's height. * \param unit symbol units * \see symbolHeightUnit() * \see setSymbolWidthUnit() */ void setSymbolHeightUnit( QgsUnitTypes::RenderUnit unit ) { mSymbolHeightUnit = unit; } - /** Returns the units for the symbol's height. + /** + * Returns the units for the symbol's height. * \see setSymbolHeightUnit() * \see symbolWidthUnit() */ @@ -107,13 +114,15 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer void setSymbolHeightMapUnitScale( const QgsMapUnitScale &scale ) { mSymbolHeightMapUnitScale = scale; } const QgsMapUnitScale &symbolHeightMapUnitScale() const { return mSymbolHeightMapUnitScale; } - /** Sets the units for the symbol's stroke width. + /** + * Sets the units for the symbol's stroke width. * \param unit symbol units * \see strokeWidthUnit() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } - /** Returns the units for the symbol's stroke width. + /** + * Returns the units for the symbol's stroke width. * \see setStrokeWidthUnit() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } @@ -149,7 +158,8 @@ class CORE_EXPORT QgsEllipseSymbolLayer: public QgsMarkerSymbolLayer QPen mPen; QBrush mBrush; - /** Setup mPainterPath + /** + * Setup mPainterPath \param symbolName name of symbol \param context render context \param scaledWidth optional width diff --git a/src/core/symbology/qgsfillsymbollayer.h b/src/core/symbology/qgsfillsymbollayer.h index 9c314231888c..cb1fbdcdfe38 100644 --- a/src/core/symbology/qgsfillsymbollayer.h +++ b/src/core/symbology/qgsfillsymbollayer.h @@ -32,7 +32,8 @@ #include #include -/** \ingroup core +/** + * \ingroup core * \class QgsSimpleFillSymbolLayer */ class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer @@ -90,13 +91,15 @@ class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer void setOffset( QPointF offset ) { mOffset = offset; } QPointF offset() { return mOffset; } - /** Sets the units for the width of the fill's stroke. + /** + * Sets the units for the width of the fill's stroke. * \param unit width units * \see strokeWidthUnit() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } - /** Returns the units for the width of the fill's stroke. + /** + * Returns the units for the width of the fill's stroke. * \see setStrokeWidthUnit() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } @@ -104,13 +107,15 @@ class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; } const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; } - /** Sets the units for the fill's offset. + /** + * Sets the units for the fill's offset. * \param unit offset units * \see offsetUnit() */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } - /** Returns the units for the fill's offset. + /** + * Returns the units for the fill's offset. * \see setOffsetUnit() */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } @@ -158,7 +163,8 @@ class CORE_EXPORT QgsSimpleFillSymbolLayer : public QgsFillSymbolLayer class QgsColorRamp; -/** \ingroup core +/** + * \ingroup core * \class QgsGradientFillSymbolLayer */ class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer @@ -229,14 +235,16 @@ class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer GradientColorType gradientColorType() const { return mGradientColorType; } void setGradientColorType( GradientColorType gradientColorType ) { mGradientColorType = gradientColorType; } - /** Returns the color ramp used for the gradient fill. This is only + /** + * Returns the color ramp used for the gradient fill. This is only * used if the gradient color type is set to ColorRamp. * \see setColorRamp() * \see gradientColorType() */ QgsColorRamp *colorRamp() { return mGradientRamp; } - /** Sets the color ramp used for the gradient fill. This is only + /** + * Sets the color ramp used for the gradient fill. This is only * used if the gradient color type is set to ColorRamp. * \param ramp color ramp. Ownership is transferred. * \see colorRamp() @@ -324,7 +332,8 @@ class CORE_EXPORT QgsGradientFillSymbolLayer : public QgsFillSymbolLayer QPointF rotateReferencePoint( QPointF refPoint, double angle ); }; -/** \ingroup core +/** + * \ingroup core * \class QgsShapeburstFillSymbolLayer */ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer @@ -363,21 +372,24 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer double estimateMaxBleed( const QgsRenderContext &context ) const override; - /** Sets the blur radius, which controls the amount of blurring applied to the fill. + /** + * Sets the blur radius, which controls the amount of blurring applied to the fill. * \param blurRadius Radius for fill blur. Values between 0 - 17 are valid, where higher values results in a stronger blur. Set to 0 to disable blur. * \since QGIS 2.3 * \see blurRadius */ void setBlurRadius( int blurRadius ) { mBlurRadius = blurRadius; } - /** Returns the blur radius, which controls the amount of blurring applied to the fill. + /** + * Returns the blur radius, which controls the amount of blurring applied to the fill. * \returns Integer representing the radius for fill blur. Higher values indicate a stronger blur. A 0 value indicates that blurring is disabled. * \since QGIS 2.3 * \see setBlurRadius */ int blurRadius() const { return mBlurRadius; } - /** Sets whether the shapeburst fill should be drawn using the entire shape. + /** + * Sets whether the shapeburst fill should be drawn using the entire shape. * \param useWholeShape Set to true if shapeburst should cover entire shape. If false, setMaxDistance is used to calculate how far from the boundary of the shape should * be shaded * \since QGIS 2.3 @@ -386,7 +398,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setUseWholeShape( bool useWholeShape ) { mUseWholeShape = useWholeShape; } - /** Returns whether the shapeburst fill is set to cover the entire shape. + /** + * Returns whether the shapeburst fill is set to cover the entire shape. * \returns True if shapeburst fill will cover the entire shape. If false, shapeburst is drawn to a distance of maxDistance from the polygon's boundary. * \since QGIS 2.3 * \see setUseWholeShape @@ -394,7 +407,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ bool useWholeShape() const { return mUseWholeShape; } - /** Sets the maximum distance to shape inside of the shape from the polygon's boundary. + /** + * Sets the maximum distance to shape inside of the shape from the polygon's boundary. * \param maxDistance distance from boundary to shade. setUseWholeShape must be set to false for this parameter to take effect. Distance unit is controlled by setDistanceUnit. * \since QGIS 2.3 * \see maxDistance @@ -403,7 +417,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setMaxDistance( double maxDistance ) { mMaxDistance = maxDistance; } - /** Returns the maximum distance from the shape's boundary which is shaded. This parameter is only effective if useWholeShape is false. + /** + * Returns the maximum distance from the shape's boundary which is shaded. This parameter is only effective if useWholeShape is false. * \returns the maximum distance from the polygon's boundary which is shaded. Distance units are indicated by distanceUnit. * \since QGIS 2.3 * \see useWholeShape @@ -412,7 +427,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ double maxDistance() const { return mMaxDistance; } - /** Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary. + /** + * Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary. * \param unit distance unit for the maximum distance * \since QGIS 2.3 * \see setMaxDistance @@ -420,7 +436,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setDistanceUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceUnit = unit; } - /** Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary. + /** + * Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary. * \returns distance unit for the maximum distance * \since QGIS 2.3 * \see maxDistance @@ -431,7 +448,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer void setDistanceMapUnitScale( const QgsMapUnitScale &scale ) { mDistanceMapUnitScale = scale; } const QgsMapUnitScale &distanceMapUnitScale() const { return mDistanceMapUnitScale; } - /** Sets the color mode to use for the shapeburst fill. Shapeburst can either be drawn using a QgsColorRamp color ramp + /** + * Sets the color mode to use for the shapeburst fill. Shapeburst can either be drawn using a QgsColorRamp color ramp * or by simply specificing a start and end color. setColorType is used to specify which mode to use for the fill. * \param colorType color type to use for shapeburst fill * \since QGIS 2.3 @@ -442,7 +460,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setColorType( ShapeburstColorType colorType ) { mColorType = colorType; } - /** Returns the color mode used for the shapeburst fill. Shapeburst can either be drawn using a QgsColorRamp color ramp + /** + * Returns the color mode used for the shapeburst fill. Shapeburst can either be drawn using a QgsColorRamp color ramp * or by simply specificing a start and end color. * \returns current color mode used for the shapeburst fill * \since QGIS 2.3 @@ -453,7 +472,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ ShapeburstColorType colorType() const { return mColorType; } - /** Sets the color ramp used to draw the shapeburst fill. Color ramps are only used if setColorType is set ShapeburstColorType::ColorRamp. + /** + * Sets the color ramp used to draw the shapeburst fill. Color ramps are only used if setColorType is set ShapeburstColorType::ColorRamp. * \param ramp color ramp to use for shapeburst fill * \since QGIS 2.3 * \see setColorType @@ -461,7 +481,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setColorRamp( QgsColorRamp *ramp ); - /** Returns the color ramp used for the shapeburst fill. The color ramp is only used if the colorType is set to ShapeburstColorType::ColorRamp + /** + * Returns the color ramp used for the shapeburst fill. The color ramp is only used if the colorType is set to ShapeburstColorType::ColorRamp * \returns a QgsColorRamp color ramp * \since QGIS 2.3 * \see setColorRamp @@ -469,7 +490,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ QgsColorRamp *colorRamp() { return mGradientRamp; } - /** Sets the color for the endpoint of the shapeburst fill. This color is only used if setColorType is set ShapeburstColorType::SimpleTwoColor. + /** + * Sets the color for the endpoint of the shapeburst fill. This color is only used if setColorType is set ShapeburstColorType::SimpleTwoColor. * \param color2 QColor to use for endpoint of gradient * \since QGIS 2.3 * \see setColorType @@ -477,7 +499,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setColor2( const QColor &color2 ) { mColor2 = color2; } - /** Returns the color used for the endpoint of the shapeburst fill. This color is only used if the colorType is set to ShapeburstColorType::SimpleTwoColor + /** + * Returns the color used for the endpoint of the shapeburst fill. This color is only used if the colorType is set to ShapeburstColorType::SimpleTwoColor * \returns a QColor indicating the color of the endpoint of the gradient * \since QGIS 2.3 * \see setColor2 @@ -485,7 +508,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ QColor color2() const { return mColor2; } - /** Sets whether the shapeburst fill should ignore polygon rings when calculating + /** + * Sets whether the shapeburst fill should ignore polygon rings when calculating * the buffered shading. * \param ignoreRings Set to true if buffers should ignore interior rings for polygons. * \since QGIS 2.3 @@ -493,14 +517,16 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setIgnoreRings( bool ignoreRings ) { mIgnoreRings = ignoreRings; } - /** Returns whether the shapeburst fill is set to ignore polygon interior rings. + /** + * Returns whether the shapeburst fill is set to ignore polygon interior rings. * \returns True if the shapeburst fill will ignore interior rings when calculating buffered shading. * \since QGIS 2.3 * \see setIgnoreRings */ bool ignoreRings() const { return mIgnoreRings; } - /** Sets the offset for the shapeburst fill. + /** + * Sets the offset for the shapeburst fill. * \param offset QPointF indicating the horizontal/vertical offset amount * \since QGIS 2.3 * \see offset @@ -508,7 +534,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setOffset( QPointF offset ) { mOffset = offset; } - /** Returns the offset for the shapeburst fill. + /** + * Returns the offset for the shapeburst fill. * \returns a QPointF indicating the horizontal/vertical offset amount * \since QGIS 2.3 * \see setOffset @@ -516,7 +543,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ QPointF offset() const { return mOffset; } - /** Sets the units used for the offset for the shapeburst fill. + /** + * Sets the units used for the offset for the shapeburst fill. * \param unit units for fill offset * \since QGIS 2.3 * \see setOffset @@ -524,7 +552,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } - /** Returns the units used for the offset of the shapeburst fill. + /** + * Returns the units used for the offset of the shapeburst fill. * \returns units used for the fill offset * \since QGIS 2.3 * \see offset @@ -580,7 +609,8 @@ class CORE_EXPORT QgsShapeburstFillSymbolLayer : public QgsFillSymbolLayer void dtArrayToQImage( double *array, QImage *im, QgsColorRamp *ramp, double layerAlpha = 1, bool useWholeShape = true, int maxPixelDistance = 0 ); }; -/** \ingroup core +/** + * \ingroup core * Base class for polygon renderers generating texture images*/ class CORE_EXPORT QgsImageFillSymbolLayer: public QgsFillSymbolLayer { @@ -592,13 +622,15 @@ class CORE_EXPORT QgsImageFillSymbolLayer: public QgsFillSymbolLayer virtual QgsSymbol *subSymbol() override { return mStroke.get(); } virtual bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override; - /** Sets the units for the symbol's stroke width. + /** + * Sets the units for the symbol's stroke width. * \param unit symbol units * \see strokeWidthUnit() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } - /** Returns the units for the symbol's stroke width. + /** + * Returns the units for the symbol's stroke width. * \see setStrokeWidthUnit() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } @@ -641,7 +673,8 @@ class CORE_EXPORT QgsImageFillSymbolLayer: public QgsFillSymbolLayer #endif }; -/** \ingroup core +/** + * \ingroup core * \class QgsRasterFillSymbolLayer * \brief A class for filling symbols with a repeated raster image. * \since QGIS 2.7 @@ -673,26 +706,30 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer virtual QgsSymbol *subSymbol() override { return nullptr; } virtual bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override; - /** Sets the path to the raster image used for the fill. + /** + * Sets the path to the raster image used for the fill. * \param imagePath path to image file * \see imageFilePath */ void setImageFilePath( const QString &imagePath ); - /** The path to the raster image used for the fill. + /** + * The path to the raster image used for the fill. * \returns path to image file * \see setImageFilePath */ QString imageFilePath() const { return mImageFilePath; } - /** Set the coordinate mode for fill. Controls how the top left corner of the image + /** + * Set the coordinate mode for fill. Controls how the top left corner of the image * fill is positioned relative to the feature. * \param mode coordinate mode * \see coordinateMode */ void setCoordinateMode( const FillCoordinateMode mode ); - /** Coordinate mode for fill. Controls how the top left corner of the image + /** + * Coordinate mode for fill. Controls how the top left corner of the image * fill is positioned relative to the feature. * \returns coordinate mode * \see setCoordinateMode @@ -713,7 +750,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ double opacity() const { return mOpacity; } - /** Sets the offset for the fill. + /** + * Sets the offset for the fill. * \param offset offset for fill * \see offset * \see setOffsetUnit @@ -721,7 +759,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ void setOffset( QPointF offset ) { mOffset = offset; } - /** Returns the offset for the fill. + /** + * Returns the offset for the fill. * \returns offset for fill * \see setOffset * \see offsetUnit @@ -729,7 +768,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ QPointF offset() const { return mOffset; } - /** Sets the units for the fill's offset. + /** + * Sets the units for the fill's offset. * \param unit units for offset * \see offsetUnit * \see setOffset @@ -737,7 +777,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ void setOffsetUnit( const QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } - /** Returns the units for the fill's offset. + /** + * Returns the units for the fill's offset. * \returns units for offset * \see setOffsetUnit * \see offset @@ -745,7 +786,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } - /** Sets the map unit scale for the fill's offset. + /** + * Sets the map unit scale for the fill's offset. * \param scale map unit scale for offset * \see offsetMapUnitScale * \see setOffset @@ -753,7 +795,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; } - /** Returns the map unit scale for the fill's offset. + /** + * Returns the map unit scale for the fill's offset. * \returns map unit scale for offset * \see setOffsetMapUnitScale * \see offset @@ -761,7 +804,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; } - /** Sets the width for scaling the image used in the fill. The image's height will also be + /** + * Sets the width for scaling the image used in the fill. The image's height will also be * scaled to maintain the image's aspect ratio. * \param width width for scaling the image * \see width @@ -770,7 +814,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ void setWidth( const double width ) { mWidth = width; } - /** Returns the width used for scaling the image used in the fill. The image's height is + /** + * Returns the width used for scaling the image used in the fill. The image's height is * scaled to maintain the image's aspect ratio. * \returns width used for scaling the image * \see setWidth @@ -779,7 +824,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ double width() const { return mWidth; } - /** Sets the units for the image's width. + /** + * Sets the units for the image's width. * \param unit units for width * \see widthUnit * \see setWidth @@ -787,7 +833,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ void setWidthUnit( const QgsUnitTypes::RenderUnit unit ) { mWidthUnit = unit; } - /** Returns the units for the image's width. + /** + * Returns the units for the image's width. * \returns units for width * \see setWidthUnit * \see width @@ -795,7 +842,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ QgsUnitTypes::RenderUnit widthUnit() const { return mWidthUnit; } - /** Sets the map unit scale for the image's width. + /** + * Sets the map unit scale for the image's width. * \param scale map unit scale for width * \see widthMapUnitScale * \see setWidth @@ -803,7 +851,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer */ void setWidthMapUnitScale( const QgsMapUnitScale &scale ) { mWidthMapUnitScale = scale; } - /** Returns the map unit scale for the image's width. + /** + * Returns the map unit scale for the image's width. * \returns map unit scale for width * \see setWidthMapUnitScale * \see width @@ -835,7 +884,8 @@ class CORE_EXPORT QgsRasterFillSymbolLayer: public QgsImageFillSymbolLayer const QgsSymbolRenderContext &context ); }; -/** \ingroup core +/** + * \ingroup core * A class for svg fill patterns. The class automatically scales the pattern to the appropriate pixel dimensions of the output device*/ class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer @@ -883,13 +933,15 @@ class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer void setSvgStrokeWidth( double w ) { mSvgStrokeWidth = w; } double svgStrokeWidth() const { return mSvgStrokeWidth; } - /** Sets the units for the width of the SVG images in the pattern. + /** + * Sets the units for the width of the SVG images in the pattern. * \param unit width units * \see patternWidthUnit() */ void setPatternWidthUnit( QgsUnitTypes::RenderUnit unit ) { mPatternWidthUnit = unit; } - /** Returns the units for the width of the SVG images in the pattern. + /** + * Returns the units for the width of the SVG images in the pattern. * \see setPatternWidthUnit() */ QgsUnitTypes::RenderUnit patternWidthUnit() const { return mPatternWidthUnit; } @@ -897,13 +949,15 @@ class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer void setPatternWidthMapUnitScale( const QgsMapUnitScale &scale ) { mPatternWidthMapUnitScale = scale; } const QgsMapUnitScale &patternWidthMapUnitScale() const { return mPatternWidthMapUnitScale; } - /** Sets the units for the stroke width. + /** + * Sets the units for the stroke width. * \param unit width units * \see svgStrokeWidthUnit() */ void setSvgStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mSvgStrokeWidthUnit = unit; } - /** Returns the units for the stroke width. + /** + * Returns the units for the stroke width. * \see setSvgStrokeWidthUnit() */ QgsUnitTypes::RenderUnit svgStrokeWidthUnit() const { return mSvgStrokeWidthUnit; } @@ -951,7 +1005,8 @@ class CORE_EXPORT QgsSVGFillSymbolLayer: public QgsImageFillSymbolLayer double svgStrokeWidth, QgsUnitTypes::RenderUnit svgStrokeWidthUnit, const QgsSymbolRenderContext &context, const QgsMapUnitScale &patternWidthMapUnitScale, const QgsMapUnitScale &svgStrokeWidthMapUnitScale ); }; -/** \ingroup core +/** + * \ingroup core * \class QgsLinePatternFillSymbolLayer */ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer @@ -983,14 +1038,16 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer void setLineAngle( double a ) { mLineAngle = a; } double lineAngle() const { return mLineAngle; } - /** Sets the distance between lines in the fill pattern. + /** + * Sets the distance between lines in the fill pattern. * \param d distance. Units are specified by setDistanceUnit() * \see distance() * \see setDistanceUnit() */ void setDistance( double d ) { mDistance = d; } - /** Returns the distance between lines in the fill pattern. Units are retrieved by distanceUnit(). + /** + * Returns the distance between lines in the fill pattern. Units are retrieved by distanceUnit(). * \see setDistance() * \see distanceUnit() */ @@ -1003,14 +1060,16 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer void setOffset( double offset ) { mOffset = offset; } double offset() const { return mOffset; } - /** Sets the units for the distance between lines in the fill pattern. + /** + * Sets the units for the distance between lines in the fill pattern. * \param unit distance units * \see distanceUnit() * \see setDistance() */ void setDistanceUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceUnit = unit; } - /** Returns the units for the distance between lines in the fill pattern. + /** + * Returns the units for the distance between lines in the fill pattern. * \see setDistanceUnit() * \see distance() */ @@ -1019,13 +1078,15 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer void setDistanceMapUnitScale( const QgsMapUnitScale &scale ) { mDistanceMapUnitScale = scale; } const QgsMapUnitScale &distanceMapUnitScale() const { return mDistanceMapUnitScale; } - /** Sets the units for the line's width. + /** + * Sets the units for the line's width. * \param unit width units * \see lineWidthUnit() */ void setLineWidthUnit( QgsUnitTypes::RenderUnit unit ) { mLineWidthUnit = unit; } - /** Returns the units for the line's width. + /** + * Returns the units for the line's width. * \see setLineWidthUnit() */ QgsUnitTypes::RenderUnit lineWidthUnit() const { return mLineWidthUnit; } @@ -1033,13 +1094,15 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer void setLineWidthMapUnitScale( const QgsMapUnitScale &scale ) { mLineWidthMapUnitScale = scale; } const QgsMapUnitScale &lineWidthMapUnitScale() const { return mLineWidthMapUnitScale; } - /** Sets the units for the line pattern's offset. + /** + * Sets the units for the line pattern's offset. * \param unit offset units * \see offsetUnit() */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } - /** Returns the units for the line pattern's offset. + /** + * Returns the units for the line pattern's offset. * \see setOffsetUnit() */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } @@ -1089,7 +1152,8 @@ class CORE_EXPORT QgsLinePatternFillSymbolLayer: public QgsImageFillSymbolLayer QgsLineSymbol *mFillLineSymbol = nullptr; }; -/** \ingroup core +/** + * \ingroup core * \class QgsPointPatternFillSymbolLayer */ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer @@ -1131,14 +1195,16 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer bool setSubSymbol( QgsSymbol *symbol SIP_TRANSFER ) override; virtual QgsSymbol *subSymbol() override { return mMarkerSymbol; } - /** Sets the units for the horizontal distance between points in the pattern. + /** + * Sets the units for the horizontal distance between points in the pattern. * \param unit distance units * \see distanceXUnit() * \see setDistanceYUnit() */ void setDistanceXUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceXUnit = unit; } - /** Returns the units for the horizontal distance between points in the pattern. + /** + * Returns the units for the horizontal distance between points in the pattern. * \see setDistanceXUnit() * \see distanceYUnit() */ @@ -1147,14 +1213,16 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer void setDistanceXMapUnitScale( const QgsMapUnitScale &scale ) { mDistanceXMapUnitScale = scale; } const QgsMapUnitScale &distanceXMapUnitScale() const { return mDistanceXMapUnitScale; } - /** Sets the units for the vertical distance between points in the pattern. + /** + * Sets the units for the vertical distance between points in the pattern. * \param unit distance units * \see distanceYUnit() * \see setDistanceXUnit() */ void setDistanceYUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceYUnit = unit; } - /** Returns the units for the vertical distance between points in the pattern. + /** + * Returns the units for the vertical distance between points in the pattern. * \see setDistanceYUnit() * \see distanceXUnit() */ @@ -1163,14 +1231,16 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer void setDistanceYMapUnitScale( const QgsMapUnitScale &scale ) { mDistanceYMapUnitScale = scale; } const QgsMapUnitScale &distanceYMapUnitScale() const { return mDistanceYMapUnitScale; } - /** Sets the units for the horizontal displacement between rows in the pattern. + /** + * Sets the units for the horizontal displacement between rows in the pattern. * \param unit displacement units * \see displacementXUnit() * \see setDisplacementYUnit() */ void setDisplacementXUnit( QgsUnitTypes::RenderUnit unit ) { mDisplacementXUnit = unit; } - /** Returns the units for the horizontal displacement between rows in the pattern. + /** + * Returns the units for the horizontal displacement between rows in the pattern. * \see setDisplacementXUnit() * \see displacementYUnit() */ @@ -1179,14 +1249,16 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer void setDisplacementXMapUnitScale( const QgsMapUnitScale &scale ) { mDisplacementXMapUnitScale = scale; } const QgsMapUnitScale &displacementXMapUnitScale() const { return mDisplacementXMapUnitScale; } - /** Sets the units for the vertical displacement between rows in the pattern. + /** + * Sets the units for the vertical displacement between rows in the pattern. * \param unit displacement units * \see displacementYUnit() * \see setDisplacementXUnit() */ void setDisplacementYUnit( QgsUnitTypes::RenderUnit unit ) { mDisplacementYUnit = unit; } - /** Returns the units for the vertical displacement between rows in the pattern. + /** + * Returns the units for the vertical displacement between rows in the pattern. * \see setDisplacementYUnit() * \see displacementXUnit() */ @@ -1231,7 +1303,8 @@ class CORE_EXPORT QgsPointPatternFillSymbolLayer: public QgsImageFillSymbolLayer double displacementX, double displacementY ); }; -/** \ingroup core +/** + * \ingroup core * \class QgsCentroidFillSymbolLayer */ class CORE_EXPORT QgsCentroidFillSymbolLayer : public QgsFillSymbolLayer @@ -1277,11 +1350,13 @@ class CORE_EXPORT QgsCentroidFillSymbolLayer : public QgsFillSymbolLayer void setPointOnSurface( bool pointOnSurface ) { mPointOnSurface = pointOnSurface; } bool pointOnSurface() const { return mPointOnSurface; } - /** Sets whether a point is drawn for all parts or only on the biggest part of multi-part features. + /** + * Sets whether a point is drawn for all parts or only on the biggest part of multi-part features. * \since QGIS 2.16 */ void setPointOnAllParts( bool pointOnAllParts ) { mPointOnAllParts = pointOnAllParts; } - /** Returns whether a point is drawn for all parts or only on the biggest part of multi-part features. + /** + * Returns whether a point is drawn for all parts or only on the biggest part of multi-part features. * \since QGIS 2.16 */ bool pointOnAllParts() const { return mPointOnAllParts; } diff --git a/src/core/symbology/qgsgeometrygeneratorsymbollayer.h b/src/core/symbology/qgsgeometrygeneratorsymbollayer.h index 5b99c7625ade..dfe194e3dc64 100644 --- a/src/core/symbology/qgsgeometrygeneratorsymbollayer.h +++ b/src/core/symbology/qgsgeometrygeneratorsymbollayer.h @@ -19,7 +19,8 @@ #include "qgis_core.h" #include "qgssymbollayer.h" -/** \ingroup core +/** + * \ingroup core * \class QgsGeometryGeneratorSymbolLayer */ class CORE_EXPORT QgsGeometryGeneratorSymbolLayer : public QgsSymbolLayer diff --git a/src/core/symbology/qgsgraduatedsymbolrenderer.h b/src/core/symbology/qgsgraduatedsymbolrenderer.h index 235c84da08eb..7ca8ef26e9f4 100644 --- a/src/core/symbology/qgsgraduatedsymbolrenderer.h +++ b/src/core/symbology/qgsgraduatedsymbolrenderer.h @@ -26,7 +26,8 @@ #include -/** \ingroup core +/** + * \ingroup core * \class QgsRendererRange */ class CORE_EXPORT QgsRendererRange @@ -63,7 +64,8 @@ class CORE_EXPORT QgsRendererRange // debugging QString dump() const; - /** Creates a DOM element representing the range in SLD format. + /** + * Creates a DOM element representing the range in SLD format. * \param doc DOM document * \param element destination DOM element * \param props graduated renderer properties @@ -85,7 +87,8 @@ class CORE_EXPORT QgsRendererRange typedef QList QgsRangeList; -/** \ingroup core +/** + * \ingroup core * \class QgsRendererRangeLabelFormat * \since QGIS 2.6 */ @@ -132,7 +135,8 @@ class CORE_EXPORT QgsRendererRangeLabelFormat class QgsVectorLayer; class QgsColorRamp; -/** \ingroup core +/** + * \ingroup core * \class QgsGraduatedSymbolRenderer */ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer @@ -172,7 +176,8 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer //! \note available in Python bindings as addClassLowerUpper void addClass( double lower, double upper ) SIP_PYNAME( addClassLowerUpper ); - /** Add a breakpoint by splitting existing classes so that the specified + /** + * Add a breakpoint by splitting existing classes so that the specified * value becomes a break between two classes. * \param breakValue position to insert break * \param updateSymbols set to true to reapply ramp colors to the new @@ -187,13 +192,15 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer //! Moves the category at index position from to index position to. void moveClass( int from, int to ); - /** Tests whether classes assigned to the renderer have ranges which overlap. + /** + * Tests whether classes assigned to the renderer have ranges which overlap. * \returns true if ranges overlap * \since QGIS 2.10 */ bool rangesOverlap() const; - /** Tests whether classes assigned to the renderer have gaps between the ranges. + /** + * Tests whether classes assigned to the renderer have gaps between the ranges. * \returns true if ranges have gaps * \since QGIS 2.10 */ @@ -245,7 +252,8 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer */ void calculateLabelPrecision( bool updateRanges = true ); - /** Creates a new graduated renderer. + /** + * Creates a new graduated renderer. * \param vlayer vector layer * \param attrName attribute to classify * \param classes number of classes @@ -270,14 +278,16 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer QgsLegendSymbolList legendSymbolItems() 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 + /** + * Returns the renderer's source symbol, which is the base symbol used for the each classes' symbol before applying * the classes' color. * \see setSourceSymbol() * \see sourceColorRamp() */ QgsSymbol *sourceSymbol(); - /** Sets the source symbol for the renderer, which is the base symbol used for the each classes' symbol before applying + /** + * Sets the source symbol for the renderer, which is the base symbol used for the each classes' symbol before applying * the classes' color. * \param sym source symbol, ownership is transferred to the renderer * \see sourceSymbol() @@ -285,24 +295,28 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer */ void setSourceSymbol( QgsSymbol *sym SIP_TRANSFER ); - /** Returns the source color ramp, from which each classes' color is derived. + /** + * Returns the source color ramp, from which each classes' color is derived. * \see setSourceColorRamp() * \see sourceSymbol() */ QgsColorRamp *sourceColorRamp(); - /** Sets the source color ramp. + /** + * Sets the source color ramp. * \param ramp color ramp. Ownership is transferred to the renderer */ void setSourceColorRamp( QgsColorRamp *ramp SIP_TRANSFER ); - /** Update the color ramp used. Also updates all symbols colors. + /** + * Update the color ramp used. Also updates all symbols colors. * Doesn't alter current breaks. * \param ramp color ramp. Ownership is transferred to the renderer */ void updateColorRamp( QgsColorRamp *ramp SIP_TRANSFER = 0 ); - /** Update all the symbols but leave breaks and colors. This method also sets the source + /** + * Update all the symbols but leave breaks and colors. This method also sets the source * symbol for the renderer. * \param sym source symbol to use for classes. Ownership is not transferred. * \see setSourceSymbol() @@ -396,7 +410,8 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer QgsSymbol *symbolForValue( double value ); - /** Returns the matching legend key for a value. + /** + * Returns the matching legend key for a value. */ QString legendKeyForValue( double value ) const; @@ -405,7 +420,8 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer : public QgsFeatureRenderer private: - /** Returns calculated value used for classifying a feature. + /** + * Returns calculated value used for classifying a feature. */ QVariant valueForFeature( QgsFeature &feature, QgsRenderContext &context ) const; diff --git a/src/core/symbology/qgsheatmaprenderer.h b/src/core/symbology/qgsheatmaprenderer.h index d9ec43a530c1..4efce576175e 100644 --- a/src/core/symbology/qgsheatmaprenderer.h +++ b/src/core/symbology/qgsheatmaprenderer.h @@ -24,7 +24,8 @@ class QgsColorRamp; -/** \ingroup core +/** + * \ingroup core * \class QgsHeatmapRenderer * \brief A renderer which draws points as a live heatmap * \since QGIS 2.7 @@ -63,19 +64,22 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer //heatmap specific methods - /** Returns the color ramp used for shading the heatmap. + /** + * Returns the color ramp used for shading the heatmap. * \returns color ramp for heatmap * \see setColorRamp */ QgsColorRamp *colorRamp() const { return mGradientRamp; } - /** Sets the color ramp to use for shading the heatmap. + /** + * Sets the color ramp to use for shading the heatmap. * \param ramp color ramp for heatmap. Ownership of ramp is transferred to the renderer. * \see colorRamp */ void setColorRamp( QgsColorRamp *ramp SIP_TRANSFER ); - /** Returns the radius for the heatmap + /** + * Returns the radius for the heatmap * \returns heatmap radius * \see setRadius * \see radiusUnit @@ -83,7 +87,8 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer */ double radius() const { return mRadius; } - /** Sets the radius for the heatmap + /** + * Sets the radius for the heatmap * \param radius heatmap radius * \see radius * \see setRadiusUnit @@ -91,7 +96,8 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer */ void setRadius( const double radius ) { mRadius = radius; } - /** Returns the units used for the heatmap's radius + /** + * Returns the units used for the heatmap's radius * \returns units for heatmap radius * \see radius * \see setRadiusUnit @@ -99,7 +105,8 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer */ QgsUnitTypes::RenderUnit radiusUnit() const { return mRadiusUnit; } - /** Sets the units used for the heatmap's radius + /** + * Sets the units used for the heatmap's radius * \param unit units for heatmap radius * \see radiusUnit * \see setRadius @@ -107,7 +114,8 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer */ void setRadiusUnit( const QgsUnitTypes::RenderUnit unit ) { mRadiusUnit = unit; } - /** Returns the map unit scale used for the heatmap's radius + /** + * Returns the map unit scale used for the heatmap's radius * \returns map unit scale for heatmap's radius * \see radius * \see radiusUnit @@ -115,7 +123,8 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer */ const QgsMapUnitScale &radiusMapUnitScale() const { return mRadiusMapUnitScale; } - /** Sets the map unit scale used for the heatmap's radius + /** + * Sets the map unit scale used for the heatmap's radius * \param scale map unit scale for heatmap's radius * \see setRadius * \see setRadiusUnit @@ -123,41 +132,47 @@ class CORE_EXPORT QgsHeatmapRenderer : public QgsFeatureRenderer */ void setRadiusMapUnitScale( const QgsMapUnitScale &scale ) { mRadiusMapUnitScale = scale; } - /** Returns the maximum value used for shading the heatmap. + /** + * Returns the maximum value used for shading the heatmap. * \returns maximum value for heatmap shading. If 0, then maximum value will be automatically * calculated. * \see setMaximumValue */ double maximumValue() const { return mExplicitMax; } - /** Sets the maximum value used for shading the heatmap. + /** + * Sets the maximum value used for shading the heatmap. * \param value maximum value for heatmap shading. Set to 0 for automatic calculation of * maximum value. * \see maximumValue */ void setMaximumValue( const double value ) { mExplicitMax = value; } - /** Returns the render quality used for drawing the heatmap. + /** + * Returns the render quality used for drawing the heatmap. * \returns render quality. A value of 1 indicates maximum quality, and increasing the * value will result in faster drawing but lower quality rendering. * \see setRenderQuality */ double renderQuality() const { return mRenderQuality; } - /** Sets the render quality used for drawing the heatmap. + /** + * Sets the render quality used for drawing the heatmap. * \param quality render quality. A value of 1 indicates maximum quality, and increasing the * value will result in faster drawing but lower quality rendering. * \see renderQuality */ void setRenderQuality( const int quality ) { mRenderQuality = quality; } - /** Returns the expression used for weighting points when generating the heatmap. + /** + * Returns the expression used for weighting points when generating the heatmap. * \returns point weight expression. If empty, all points are equally weighted. * \see setWeightExpression */ QString weightExpression() const { return mWeightExpressionString; } - /** Sets the expression used for weighting points when generating the heatmap. + /** + * Sets the expression used for weighting points when generating the heatmap. * \param expression point weight expression. If set to empty, all points are equally weighted. * \see weightExpression */ diff --git a/src/core/symbology/qgsinvertedpolygonrenderer.h b/src/core/symbology/qgsinvertedpolygonrenderer.h index ccd4bf67ed89..9f221e29c327 100644 --- a/src/core/symbology/qgsinvertedpolygonrenderer.h +++ b/src/core/symbology/qgsinvertedpolygonrenderer.h @@ -23,7 +23,8 @@ #include "qgsfeature.h" #include "qgsgeometry.h" -/** \ingroup core +/** + * \ingroup core * QgsInvertedPolygonRenderer is a polygon-only feature renderer used to * display features inverted, where the exterior is turned to an interior * and where the exterior theoretically spans the entire plane, allowing @@ -41,7 +42,8 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer { public: - /** Constructor + /** + * Constructor * \param embeddedRenderer optional embeddedRenderer. If null, a default one will be assigned. * Ownership will be transferred. */ @@ -55,7 +57,8 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer virtual QgsInvertedPolygonRenderer *clone() const override SIP_FACTORY; virtual void startRender( QgsRenderContext &context, const QgsFields &fields ) override; - /** Renders a given feature. + /** + * Renders a given feature. * This will here collect features. The actual rendering will be postponed to stopRender() * \param feature the feature to render * \param context the rendering context @@ -79,31 +82,38 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer //! Proxy that will call this method on the embedded renderer. virtual QgsFeatureRenderer::Capabilities capabilities() override; - /** Proxy that will call this method on the embedded renderer. + /** + * Proxy that will call this method on the embedded renderer. */ virtual QgsSymbolList symbols( QgsRenderContext &context ) override; - /** Proxy that will call this method on the embedded renderer. + /** + * Proxy that will call this method on the embedded renderer. */ virtual QgsSymbol *symbolForFeature( QgsFeature &feature, QgsRenderContext &context ) override; - /** Proxy that will call this method on the embedded renderer. + /** + * Proxy that will call this method on the embedded renderer. */ virtual QgsSymbol *originalSymbolForFeature( QgsFeature &feat, QgsRenderContext &context ) override; - /** Proxy that will call this method on the embedded renderer. + /** + * Proxy that will call this method on the embedded renderer. */ virtual QgsSymbolList symbolsForFeature( QgsFeature &feat, QgsRenderContext &context ) override; - /** Proxy that will call this method on the embedded renderer. + /** + * Proxy that will call this method on the embedded renderer. */ virtual QgsSymbolList originalSymbolsForFeature( QgsFeature &feat, QgsRenderContext &context ) override; - /** Proxy that will call this method on the embedded renderer. + /** + * Proxy that will call this method on the embedded renderer. */ virtual QgsLegendSymbolList legendSymbolItems() const override; - /** Proxy that will call this method on the embedded renderer. + /** + * Proxy that will call this method on the embedded renderer. */ virtual bool willRenderFeature( QgsFeature &feat, QgsRenderContext &context ) override; @@ -132,7 +142,8 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer */ void setPreprocessingEnabled( bool enabled ) { mPreprocessingEnabled = enabled; } - /** Creates a QgsInvertedPolygonRenderer by a conversion from an existing renderer. + /** + * Creates a QgsInvertedPolygonRenderer by a conversion from an existing renderer. * \since QGIS 2.5 * \returns a new renderer if the conversion was possible, otherwise 0. */ @@ -165,7 +176,8 @@ class CORE_EXPORT QgsInvertedPolygonRenderer : public QgsFeatureRenderer //! Fields of each feature QgsFields mFields; - /** Class used to represent features that must be rendered + /** + * Class used to represent features that must be rendered * with decorations (selection, vertex markers) */ struct FeatureDecoration diff --git a/src/core/symbology/qgslegendsymbolitem.h b/src/core/symbology/qgslegendsymbolitem.h index f02165f2d5ff..1516caf9dc17 100644 --- a/src/core/symbology/qgslegendsymbolitem.h +++ b/src/core/symbology/qgslegendsymbolitem.h @@ -25,7 +25,8 @@ class QgsDataDefinedSizeLegend; class QgsSymbol; -/** \ingroup core +/** + * \ingroup core * The class stores information about one class/rule of a vector layer renderer in a unified way * that can be used by legend model for rendering of legend. * diff --git a/src/core/symbology/qgslinesymbollayer.h b/src/core/symbology/qgslinesymbollayer.h index c9d1205a1f40..12ee1e80437b 100644 --- a/src/core/symbology/qgslinesymbollayer.h +++ b/src/core/symbology/qgslinesymbollayer.h @@ -31,7 +31,8 @@ class QgsExpression; #define DEFAULT_SIMPLELINE_JOINSTYLE Qt::BevelJoin #define DEFAULT_SIMPLELINE_CAPSTYLE Qt::SquareCap -/** \ingroup core +/** + * \ingroup core * \class QgsSimpleLineSymbolLayer */ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer @@ -89,13 +90,15 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer bool useCustomDashPattern() const { return mUseCustomDashPattern; } void setUseCustomDashPattern( bool b ) { mUseCustomDashPattern = b; } - /** Sets the units for lengths used in the custom dash pattern. + /** + * Sets the units for lengths used in the custom dash pattern. * \param unit length units * \see customDashPatternUnit() */ void setCustomDashPatternUnit( QgsUnitTypes::RenderUnit unit ) { mCustomDashPatternUnit = unit; } - /** Returns the units for lengths used in the custom dash pattern. + /** + * Returns the units for lengths used in the custom dash pattern. * \see setCustomDashPatternUnit() */ QgsUnitTypes::RenderUnit customDashPatternUnit() const { return mCustomDashPatternUnit; } @@ -145,7 +148,8 @@ class CORE_EXPORT QgsSimpleLineSymbolLayer : public QgsLineSymbolLayer #define DEFAULT_MARKERLINE_ROTATE true #define DEFAULT_MARKERLINE_INTERVAL 3 -/** \ingroup core +/** + * \ingroup core * \class QgsMarkerLineSymbolLayer */ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer @@ -255,7 +259,8 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer */ void setPlacement( Placement p ) { mPlacement = p; } - /** Returns the offset along the line for the marker placement. For Interval placements, this is the distance + /** + * Returns the offset along the line for the marker placement. For Interval placements, this is the distance * between the start of the line and the first marker. For FirstVertex and LastVertex placements, this is the * distance between the marker and the start of the line or the end of the line respectively. * This setting has no effect for Vertex or CentralPoint placements. @@ -267,7 +272,8 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer */ double offsetAlongLine() const { return mOffsetAlongLine; } - /** Sets the the offset along the line for the marker placement. For Interval placements, this is the distance + /** + * Sets the the offset along the line for the marker placement. For Interval placements, this is the distance * between the start of the line and the first marker. For FirstVertex and LastVertex placements, this is the * distance between the marker and the start of the line or the end of the line respectively. * This setting has no effect for Vertex or CentralPoint placements. @@ -280,38 +286,44 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer */ void setOffsetAlongLine( double offsetAlongLine ) { mOffsetAlongLine = offsetAlongLine; } - /** Returns the unit used for calculating the offset along line for markers. + /** + * Returns the unit used for calculating the offset along line for markers. * \returns Offset along line unit type. * \see setOffsetAlongLineUnit * \see offsetAlongLine */ QgsUnitTypes::RenderUnit offsetAlongLineUnit() const { return mOffsetAlongLineUnit; } - /** Sets the unit used for calculating the offset along line for markers. + /** + * Sets the unit used for calculating the offset along line for markers. * \param unit Offset along line unit type. * \see offsetAlongLineUnit * \see setOffsetAlongLine */ void setOffsetAlongLineUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetAlongLineUnit = unit; } - /** Returns the map unit scale used for calculating the offset in map units along line for markers. + /** + * Returns the map unit scale used for calculating the offset in map units along line for markers. * \returns Offset along line map unit scale. */ const QgsMapUnitScale &offsetAlongLineMapUnitScale() const { return mOffsetAlongLineMapUnitScale; } - /** Sets the map unit scale used for calculating the offset in map units along line for markers. + /** + * Sets the map unit scale used for calculating the offset in map units along line for markers. * \param scale Offset along line map unit scale. */ void setOffsetAlongLineMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetAlongLineMapUnitScale = scale; } - /** Sets the units for the interval between markers. + /** + * Sets the units for the interval between markers. * \param unit interval units * \see intervalUnit() * \see setInterval() */ void setIntervalUnit( QgsUnitTypes::RenderUnit unit ) { mIntervalUnit = unit; } - /** Returns the units for the interval between markers. + /** + * Returns the units for the interval between markers. * \see setIntervalUnit() * \see interval() */ @@ -354,7 +366,8 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer QgsMarkerLineSymbolLayer( const QgsMarkerLineSymbolLayer &other ); #endif - /** Renders a marker by offsetting a vertex along the line by a specified distance. + /** + * Renders a marker by offsetting a vertex along the line by a specified distance. * \param points vertices making up the line * \param vertex vertex number to begin offset at * \param distance distance to offset from vertex. If distance is positive, offset is calculated diff --git a/src/core/symbology/qgsmarkersymbollayer.h b/src/core/symbology/qgsmarkersymbollayer.h index 2bb56085ef2e..9e8b74f98bd8 100644 --- a/src/core/symbology/qgsmarkersymbollayer.h +++ b/src/core/symbology/qgsmarkersymbollayer.h @@ -34,7 +34,8 @@ #include #include -/** \ingroup core +/** + * \ingroup core * \class QgsSimpleMarkerSymbolLayerBase * \brief Abstract base class for simple marker symbol layers. Handles creation of the symbol shapes but * leaves the actual drawing of the symbols to subclasses. @@ -75,13 +76,15 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer //! Returns a list of all available shape types. static QList< QgsSimpleMarkerSymbolLayerBase::Shape > availableShapes(); - /** Returns true if a symbol shape has a fill. + /** + * Returns true if a symbol shape has a fill. * \param shape shape to test * \returns true if shape uses a fill, or false if shape uses lines only */ static bool shapeIsFilled( QgsSimpleMarkerSymbolLayerBase::Shape shape ); - /** Constructor for QgsSimpleMarkerSymbolLayerBase. + /** + * Constructor for QgsSimpleMarkerSymbolLayerBase. * \param shape symbol shape for markers * \param size symbol size (in mm) * \param angle symbol rotation angle @@ -92,18 +95,21 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer double angle = DEFAULT_SIMPLEMARKER_ANGLE, QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD ); - /** Returns the shape for the rendered marker symbol. + /** + * Returns the shape for the rendered marker symbol. * \see setShape() */ QgsSimpleMarkerSymbolLayerBase::Shape shape() const { return mShape; } - /** Sets the rendered marker shape. + /** + * Sets the rendered marker shape. * \param shape new marker shape * \see shape() */ void setShape( QgsSimpleMarkerSymbolLayerBase::Shape shape ) { mShape = shape; } - /** Attempts to decode a string representation of a shape name to the corresponding + /** + * Attempts to decode a string representation of a shape name to the corresponding * shape. * \param name encoded shape name * \param ok if specified, will be set to true if shape was successfully decoded @@ -112,7 +118,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer */ static QgsSimpleMarkerSymbolLayerBase::Shape decodeShape( const QString &name, bool *ok = nullptr ); - /** Encodes a shape to its string representation. + /** + * Encodes a shape to its string representation. * \param shape shape to encode * \returns encoded string * \see decodeShape() @@ -138,7 +145,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer */ bool prepareMarkerPath( Shape symbol ); - /** Creates a polygon representing the specified shape. + /** + * Creates a polygon representing the specified shape. * \param shape shape to create * \param polygon destination polygon for shape * \returns true if shape was successfully stored in polygon @@ -146,7 +154,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer */ bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const; - /** Calculates the desired size of the marker, considering data defined size overrides. + /** + * Calculates the desired size of the marker, considering data defined size overrides. * \param context symbol render context * \param hasDataDefinedSize will be set to true if marker uses data defined sizes * \returns marker size, in original size units @@ -154,7 +163,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer */ double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const; - /** Calculates the marker offset and rotation. + /** + * Calculates the marker offset and rotation. * \param context symbol render context * \param scaledSize size of symbol to render * \param hasDataDefinedRotation will be set to true if marker has data defined rotation @@ -175,7 +185,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer private: - /** Derived classes must implement draw() to handle drawing the generated shape onto the painter surface. + /** + * Derived classes must implement draw() to handle drawing the generated shape onto the painter surface. * \param context symbol render context * \param shape shape to draw * \param polygon polygon representing transformed marker shape. May be empty, in which case the shape will be specified @@ -185,7 +196,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer virtual void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path ) = 0 SIP_FORCE; }; -/** \ingroup core +/** + * \ingroup core * \class QgsSimpleMarkerSymbolLayer * \brief Simple marker symbol layer, consisting of a rendered shape with solid fill color and an stroke. */ @@ -193,7 +205,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer { public: - /** Constructor for QgsSimpleMarkerSymbolLayer. + /** + * Constructor for QgsSimpleMarkerSymbolLayer. * \param shape symbol shape * \param size symbol size (in mm) * \param angle symbol rotation angle @@ -212,13 +225,15 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer // static methods - /** Creates a new QgsSimpleMarkerSymbolLayer. + /** + * Creates a new QgsSimpleMarkerSymbolLayer. * \param properties a property map containing symbol properties (see properties()) * \returns new QgsSimpleMarkerSymbolLayer */ static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ) SIP_FACTORY; - /** Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element. + /** + * Creates a new QgsSimpleMarkerSymbolLayer from an SLD XML element. * \param element XML element containing SLD definition of symbol * \returns new QgsSimpleMarkerSymbolLayer */ @@ -246,14 +261,16 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer // new methods - /** Returns the marker's stroke color. + /** + * Returns the marker's stroke color. * \see setStrokeColor() * \see strokeStyle() * \see penJoinStyle() */ QColor strokeColor() const override { return mStrokeColor; } - /** Sets the marker's stroke color. + /** + * Sets the marker's stroke color. * \param color stroke color * \see strokeColor() * \see setStrokeStyle() @@ -261,7 +278,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer */ void setStrokeColor( const QColor &color ) override { mStrokeColor = color; } - /** Returns the marker's stroke style (e.g., solid, dashed, etc) + /** + * Returns the marker's stroke style (e.g., solid, dashed, etc) * \since QGIS 2.4 * \see setStrokeStyle() * \see strokeColor() @@ -269,7 +287,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer */ Qt::PenStyle strokeStyle() const { return mStrokeStyle; } - /** Sets the marker's stroke style (e.g., solid, dashed, etc) + /** + * Sets the marker's stroke style (e.g., solid, dashed, etc) * \param strokeStyle style * \since QGIS 2.4 * \see strokeStyle() @@ -278,7 +297,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer */ void setStrokeStyle( Qt::PenStyle strokeStyle ) { mStrokeStyle = strokeStyle; } - /** Returns the marker's stroke join style (e.g., miter, bevel, etc). + /** + * Returns the marker's stroke join style (e.g., miter, bevel, etc). * \since QGIS 2.16 * \see setPenJoinStyle() * \see strokeColor() @@ -286,7 +306,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer */ Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; } - /** Sets the marker's stroke join style (e.g., miter, bevel, etc). + /** + * Sets the marker's stroke join style (e.g., miter, bevel, etc). * \param style join style * \since QGIS 2.16 * \see penJoinStyle() @@ -295,14 +316,16 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer */ void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; } - /** Returns the width of the marker's stroke. + /** + * Returns the width of the marker's stroke. * \see setStrokeWidth() * \see strokeWidthUnit() * \see strokeWidthMapUnitScale() */ double strokeWidth() const { return mStrokeWidth; } - /** Sets the width of the marker's stroke. + /** + * Sets the width of the marker's stroke. * \param w stroke width. See strokeWidthUnit() for units. * \see strokeWidth() * \see setStrokeWidthUnit() @@ -310,7 +333,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer */ void setStrokeWidth( double w ) { mStrokeWidth = w; } - /** Sets the unit for the width of the marker's stroke. + /** + * Sets the unit for the width of the marker's stroke. * \param u stroke width unit * \see strokeWidthUnit() * \see setStrokeWidth() @@ -318,14 +342,16 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit u ) { mStrokeWidthUnit = u; } - /** Returns the unit for the width of the marker's stroke. + /** + * Returns the unit for the width of the marker's stroke. * \see setStrokeWidthUnit() * \see strokeWidth() * \see strokeWidthMapUnitScale() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } - /** Sets the map scale for the width of the marker's stroke. + /** + * Sets the map scale for the width of the marker's stroke. * \param scale stroke width map unit scale * \see strokeWidthMapUnitScale() * \see setStrokeWidth() @@ -333,7 +359,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer */ void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; } - /** Returns the map scale for the width of the marker's stroke. + /** + * Returns the map scale for the width of the marker's stroke. * \see setStrokeWidthMapUnitScale() * \see strokeWidth() * \see strokeWidthUnit() @@ -342,14 +369,16 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer protected: - /** Draws the marker shape in the specified painter. + /** + * Draws the marker shape in the specified painter. * \param p destination QPainter * \param context symbol context * \note this method does not handle setting the painter pen or brush to match the symbol's fill or stroke */ void drawMarker( QPainter *p, QgsSymbolRenderContext &context ); - /** Prepares cache image + /** + * Prepares cache image * \returns true in case of success, false if cache image size too large */ bool prepareCache( QgsSymbolRenderContext &context ); @@ -393,7 +422,8 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer virtual void draw( QgsSymbolRenderContext &context, QgsSimpleMarkerSymbolLayerBase::Shape shape, const QPolygonF &polygon, const QPainterPath &path ) override SIP_FORCE; }; -/** \ingroup core +/** + * \ingroup core * \class QgsFilledMarkerSymbolLayer * \brief Filled marker symbol layer, consisting of a shape which is rendered using a QgsFillSymbol. This allows * the symbol to support advanced styling of the interior and stroke of the shape. @@ -403,7 +433,8 @@ class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer { public: - /** Constructor for QgsFilledMarkerSymbolLayer. + /** + * Constructor for QgsFilledMarkerSymbolLayer. * \param shape symbol shape * \param size symbol size (in mm) * \param angle symbol rotation angle @@ -414,7 +445,8 @@ class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer double angle = DEFAULT_SIMPLEMARKER_ANGLE, QgsSymbol::ScaleMethod scaleMethod = DEFAULT_SCALE_METHOD ); - /** Creates a new QgsFilledMarkerSymbolLayer. + /** + * Creates a new QgsFilledMarkerSymbolLayer. * \param properties a property map containing symbol properties (see properties()) * \returns new QgsFilledMarkerSymbolLayer */ @@ -448,7 +480,8 @@ class CORE_EXPORT QgsFilledMarkerSymbolLayer : public QgsSimpleMarkerSymbolLayer #define DEFAULT_SVGMARKER_SIZE 2*DEFAULT_POINT_SIZE #define DEFAULT_SVGMARKER_ANGLE 0 -/** \ingroup core +/** + * \ingroup core * \class QgsSvgMarkerSymbolLayer */ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer @@ -488,47 +521,55 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer void writeSldMarker( QDomDocument &doc, QDomElement &element, const QgsStringMap &props ) const override; - /** Returns the marker SVG path. + /** + * Returns the marker SVG path. * \see setPath() */ QString path() const { return mPath; } - /** Set the marker SVG path. + /** + * Set the marker SVG path. * \param path SVG path * \see path() */ void setPath( const QString &path ); - /** Returns the default marker aspect ratio between width and height, 0 if not yet calculated. + /** + * Returns the default marker aspect ratio between width and height, 0 if not yet calculated. * \see updateDefaultAspectRatio() */ double defaultAspectRatio() const { return mDefaultAspectRatio; } - /** Calculates the default marker aspect ratio between width and height. + /** + * Calculates the default marker aspect ratio between width and height. * \returns the default aspect ratio value * \see defaultAspectRatio() */ double updateDefaultAspectRatio(); - /** Returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0. + /** + * Returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0. * \see setPreservedAspectRatio() */ bool preservedAspectRatio() const { return mFixedAspectRatio <= 0.0; } - /** Set preserved the marker aspect ratio between width and height. + /** + * Set preserved the marker aspect ratio between width and height. * \param par Preserved Aspect Ratio * \returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0 * \see preservedAspectRatio() */ bool setPreservedAspectRatio( bool par ); - /** Returns the marker aspect ratio between width and height to be used in rendering, + /** + * Returns the marker aspect ratio between width and height to be used in rendering, * if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering * \see setFixedAspectRatio() QgsSvgCache */ double fixedAspectRatio() const { return mFixedAspectRatio; } - /** Set the marker aspect ratio between width and height to be used in rendering, + /** + * Set the marker aspect ratio between width and height to be used in rendering, * if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering * \param ratio Fixed Aspect Ratio * \see fixedAspectRatio() QgsSvgCache @@ -544,13 +585,15 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer double strokeWidth() const { return mStrokeWidth; } void setStrokeWidth( double w ) { mStrokeWidth = w; } - /** Sets the units for the stroke width. + /** + * Sets the units for the stroke width. * \param unit width units * \see strokeWidthUnit() */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } - /** Returns the units for the stroke width. + /** + * Returns the units for the stroke width. * \see strokeWidthUnit() */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } @@ -570,7 +613,8 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer protected: - /** Calculates the marker aspect ratio between width and height. + /** + * Calculates the marker aspect ratio between width and height. * \param context symbol render context * \param scaledSize size of symbol to render * \param hasDataDefinedAspectRatio will be set to true if marker has data defined aspectRatio @@ -611,7 +655,8 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer #define DEFAULT_FONTMARKER_JOINSTYLE Qt::MiterJoin #define DEFAULT_FONTMARKER_ANGLE 0 -/** \ingroup core +/** + * \ingroup core * \class QgsFontMarkerSymbolLayer */ class CORE_EXPORT QgsFontMarkerSymbolLayer : public QgsMarkerSymbolLayer @@ -657,35 +702,43 @@ class CORE_EXPORT QgsFontMarkerSymbolLayer : public QgsMarkerSymbolLayer QColor strokeColor() const override { return mStrokeColor; } void setStrokeColor( const QColor &color ) override { mStrokeColor = color; } - /** Get stroke width. + /** + * Get stroke width. * \since QGIS 2.16 */ double strokeWidth() const { return mStrokeWidth; } - /** Set stroke width. + /** + * Set stroke width. * \since QGIS 2.16 */ void setStrokeWidth( double width ) { mStrokeWidth = width; } - /** Get stroke width unit. + /** + * Get stroke width unit. * \since QGIS 2.16 */ QgsUnitTypes::RenderUnit strokeWidthUnit() const { return mStrokeWidthUnit; } - /** Set stroke width unit. + /** + * Set stroke width unit. * \since QGIS 2.16 */ void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit ) { mStrokeWidthUnit = unit; } - /** Get stroke width map unit scale. + /** + * Get stroke width map unit scale. * \since QGIS 2.16 */ const QgsMapUnitScale &strokeWidthMapUnitScale() const { return mStrokeWidthMapUnitScale; } - /** Set stroke width map unit scale. + /** + * Set stroke width map unit scale. * \since QGIS 2.16 */ void setStrokeWidthMapUnitScale( const QgsMapUnitScale &scale ) { mStrokeWidthMapUnitScale = scale; } - /** Get stroke join style. + /** + * Get stroke join style. * \since QGIS 2.16 */ Qt::PenJoinStyle penJoinStyle() const { return mPenJoinStyle; } - /** Set stroke join style. + /** + * Set stroke join style. * \since QGIS 2.16 */ void setPenJoinStyle( Qt::PenJoinStyle style ) { mPenJoinStyle = style; } diff --git a/src/core/symbology/qgsnullsymbolrenderer.h b/src/core/symbology/qgsnullsymbolrenderer.h index 4831fb6ed182..f9371c3aaa94 100644 --- a/src/core/symbology/qgsnullsymbolrenderer.h +++ b/src/core/symbology/qgsnullsymbolrenderer.h @@ -20,7 +20,8 @@ #include "qgsrenderer.h" #include "qgssymbol.h" -/** \ingroup core +/** + * \ingroup core * \class QgsNullSymbolRenderer * \brief Null symbol renderer. Renderer which draws no symbols for features by default, but allows for labeling * and diagrams for the layer. Selected features will also be drawn with a default symbol. @@ -46,7 +47,8 @@ class CORE_EXPORT QgsNullSymbolRenderer : public QgsFeatureRenderer virtual QgsFeatureRenderer *clone() const override SIP_FACTORY; virtual QgsSymbolList symbols( QgsRenderContext &context ) override; - /** Creates a null renderer from XML element. + /** + * Creates a null renderer from XML element. * \param element DOM element * \param context reading context * \returns new null symbol renderer @@ -55,7 +57,8 @@ class CORE_EXPORT QgsNullSymbolRenderer : public QgsFeatureRenderer virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override; - /** Creates a QgsNullSymbolRenderer from an existing renderer. + /** + * Creates a QgsNullSymbolRenderer from an existing renderer. * \param renderer renderer to convert from * \returns a new renderer if the conversion was possible, otherwise nullptr. */ diff --git a/src/core/symbology/qgspointclusterrenderer.h b/src/core/symbology/qgspointclusterrenderer.h index f990c7e106d3..e7c9a8c552b4 100644 --- a/src/core/symbology/qgspointclusterrenderer.h +++ b/src/core/symbology/qgspointclusterrenderer.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgspointdistancerenderer.h" -/** \class QgsPointClusterRenderer +/** + * \class QgsPointClusterRenderer * \ingroup core * A renderer that automatically clusters points with the same geographic position. * \since QGIS 3.0 @@ -42,18 +43,21 @@ class CORE_EXPORT QgsPointClusterRenderer: public QgsPointDistanceRenderer //! Creates a renderer from XML element static QgsFeatureRenderer *create( QDomElement &symbologyElem, const QgsReadWriteContext &context ) SIP_FACTORY; - /** Returns the symbol used for rendering clustered groups (but not ownership of the symbol). + /** + * Returns the symbol used for rendering clustered groups (but not ownership of the symbol). * \see setClusterSymbol() */ QgsMarkerSymbol *clusterSymbol(); - /** Sets the symbol for rendering clustered groups. + /** + * Sets the symbol for rendering clustered groups. * \param symbol new cluster symbol. Ownership is transferred to the renderer. * \see clusterSymbol() */ void setClusterSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER ); - /** Creates a QgsPointClusterRenderer from an existing renderer. + /** + * Creates a QgsPointClusterRenderer from an existing renderer. * \returns a new renderer if the conversion was possible, otherwise nullptr. */ static QgsPointClusterRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY; diff --git a/src/core/symbology/qgspointdisplacementrenderer.h b/src/core/symbology/qgspointdisplacementrenderer.h index 9d2c92f5b495..af3e8cd0cdc8 100644 --- a/src/core/symbology/qgspointdisplacementrenderer.h +++ b/src/core/symbology/qgspointdisplacementrenderer.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgspointdistancerenderer.h" -/** \class QgsPointDisplacementRenderer +/** + * \class QgsPointDisplacementRenderer * \ingroup core * A renderer that automatically displaces points with the same geographic location. */ @@ -30,7 +31,8 @@ class CORE_EXPORT QgsPointDisplacementRenderer: public QgsPointDistanceRenderer { public: - /** Placement methods for dispersing points + /** + * Placement methods for dispersing points */ enum Placement { @@ -38,7 +40,8 @@ class CORE_EXPORT QgsPointDisplacementRenderer: public QgsPointDistanceRenderer ConcentricRings //!< Place points in concentric rings around group }; - /** Constructor for QgsPointDisplacementRenderer. + /** + * Constructor for QgsPointDisplacementRenderer. * \param labelAttributeName optional attribute name for labeling points */ QgsPointDisplacementRenderer( const QString &labelAttributeName = QString() ); @@ -52,68 +55,79 @@ class CORE_EXPORT QgsPointDisplacementRenderer: public QgsPointDistanceRenderer //! Create a renderer from XML element static QgsFeatureRenderer *create( QDomElement &symbologyElem, const QgsReadWriteContext &context ) SIP_FACTORY; - /** Sets the line width for the displacement group circle. + /** + * Sets the line width for the displacement group circle. * \param width line width in mm * \see circleWidth() * \see setCircleColor() */ void setCircleWidth( double width ) { mCircleWidth = width; } - /** Returns the line width for the displacement group circle in mm. + /** + * Returns the line width for the displacement group circle in mm. * \see setCircleWidth() * \see circleColor() */ double circleWidth() const { return mCircleWidth; } - /** Sets the color used for drawing the displacement group circle. + /** + * Sets the color used for drawing the displacement group circle. * \param color circle color * \see circleColor() * \see setCircleWidth() */ void setCircleColor( const QColor &color ) { mCircleColor = color; } - /** Returns the color used for drawing the displacement group circle. + /** + * Returns the color used for drawing the displacement group circle. * \see setCircleColor() * \see circleWidth() */ QColor circleColor() const { return mCircleColor; } - /** Sets a factor for increasing the ring size of displacement groups. + /** + * Sets a factor for increasing the ring size of displacement groups. * \param distance addition factor * \see circleRadiusAddition() */ void setCircleRadiusAddition( double distance ) { mCircleRadiusAddition = distance; } - /** Returns the factor for increasing the ring size of displacement groups. + /** + * Returns the factor for increasing the ring size of displacement groups. * \see setCircleRadiusAddition() */ double circleRadiusAddition() const { return mCircleRadiusAddition; } - /** Returns the placement method used for dispersing the points. + /** + * Returns the placement method used for dispersing the points. * \see setPlacement() * \since QGIS 2.12 */ Placement placement() const { return mPlacement; } - /** Sets the placement method used for dispersing the points. + /** + * Sets the placement method used for dispersing the points. * \param placement placement method * \see placement() * \since QGIS 2.12 */ void setPlacement( Placement placement ) { mPlacement = placement; } - /** Returns the symbol for the center of a displacement group (but not ownership of the symbol). + /** + * Returns the symbol for the center of a displacement group (but not ownership of the symbol). * \see setCenterSymbol() */ QgsMarkerSymbol *centerSymbol(); - /** Sets the center symbol for a displacement group. + /** + * Sets the center symbol for a displacement group. * \param symbol new center symbol. Ownership is transferred to the renderer. * \see centerSymbol() */ void setCenterSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER ); - /** Creates a QgsPointDisplacementRenderer from an existing renderer. + /** + * Creates a QgsPointDisplacementRenderer from an existing renderer. * \since QGIS 2.5 * \returns a new renderer if the conversion was possible, otherwise nullptr. */ diff --git a/src/core/symbology/qgspointdistancerenderer.h b/src/core/symbology/qgspointdistancerenderer.h index 01e984b72863..2b34fdf6eaa0 100644 --- a/src/core/symbology/qgspointdistancerenderer.h +++ b/src/core/symbology/qgspointdistancerenderer.h @@ -25,7 +25,8 @@ class QgsSpatialIndex; -/** \class QgsPointDistanceRenderer +/** + * \class QgsPointDistanceRenderer * \ingroup core * An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers). * QgsPointDistanceRenderer handles calculation of point clusters using a distance based threshold. @@ -42,7 +43,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer struct GroupedFeature { - /** Constructor for GroupedFeature. + /** + * Constructor for GroupedFeature. * \param feature feature * \param symbol base symbol for rendering feature (owned by GroupedFeature) * \param isSelected set to true if feature is selected and should be rendered in a selected state @@ -74,7 +76,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer //! A group of clustered points (ie features within the distance tolerance). typedef QList< QgsPointDistanceRenderer::GroupedFeature > ClusteredGroup; - /** Constructor for QgsPointDistanceRenderer. + /** + * Constructor for QgsPointDistanceRenderer. * \param rendererName name of renderer for registry * \param labelAttributeName optional attribute for labeling points */ @@ -102,7 +105,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer void checkLegendSymbolItem( const QString &key, bool state ) override; virtual QString filter( const QgsFields &fields = QgsFields() ) override; - /** Sets the attribute name for labeling points. + /** + * Sets the attribute name for labeling points. * \param name attribute name, or empty string to avoid labeling features by the renderer * \see labelAttributeName() * \see setLabelFont() @@ -111,7 +115,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer */ void setLabelAttributeName( const QString &name ) { mLabelAttributeName = name; } - /** Returns the attribute name used for labeling points, or an empty string if no labeling + /** + * Returns the attribute name used for labeling points, or an empty string if no labeling * will be done by the renderer. * \see setLabelAttributeName() * \see labelFont() @@ -120,7 +125,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer */ QString labelAttributeName() const { return mLabelAttributeName; } - /** Sets the font used for labeling points. + /** + * Sets the font used for labeling points. * \param font label font * \see labelFont() * \see setLabelAttributeName() @@ -128,7 +134,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer */ void setLabelFont( const QFont &font ) { mLabelFont = font; } - /** Returns the font used for labeling points. + /** + * Returns the font used for labeling points. * \see setLabelFont() * \see labelAttributeName() * \see labelColor() @@ -151,7 +158,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer */ double minimumLabelScale() const { return mMinLabelScale; } - /** Sets the color to use for for labeling points. + /** + * Sets the color to use for for labeling points. * \param color label color * \see labelColor() * \see setLabelAttributeName() @@ -159,14 +167,16 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer */ void setLabelColor( const QColor &color ) { mLabelColor = color;} - /** Returns the color used for for labeling points. + /** + * Returns the color used for for labeling points. * \see setLabelColor() * \see labelAttributeName() * \see labelFont() */ QColor labelColor() const { return mLabelColor; } - /** Sets the tolerance distance for grouping points. Units are specified using + /** + * Sets the tolerance distance for grouping points. Units are specified using * setToleranceUnit(). * \param distance tolerance distance * \see tolerance() @@ -174,14 +184,16 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer */ void setTolerance( double distance ) { mTolerance = distance; } - /** Returns the tolerance distance for grouping points. Units are retrieved using + /** + * Returns the tolerance distance for grouping points. Units are retrieved using * toleranceUnit(). * \see setTolerance() * \see toleranceUnit() */ double tolerance() const { return mTolerance; } - /** Sets the units for the tolerance distance. + /** + * Sets the units for the tolerance distance. * \param unit tolerance distance units * \see setTolerance() * \see toleranceUnit() @@ -189,14 +201,16 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer */ void setToleranceUnit( QgsUnitTypes::RenderUnit unit ) { mToleranceUnit = unit; } - /** Returns the units for the tolerance distance. + /** + * Returns the units for the tolerance distance. * \see tolerance() * \see setToleranceUnit() * \since QGIS 2.12 */ QgsUnitTypes::RenderUnit toleranceUnit() const { return mToleranceUnit; } - /** Sets the map unit scale object for the distance tolerance. This is only used if the + /** + * Sets the map unit scale object for the distance tolerance. This is only used if the * toleranceUnit() is set to QgsUnitTypes::RenderMapUnits. * \param scale scale for distance tolerance * \see toleranceMapUnitScale() @@ -204,7 +218,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer */ void setToleranceMapUnitScale( const QgsMapUnitScale &scale ) { mToleranceMapUnitScale = scale; } - /** Returns the map unit scale object for the distance tolerance. This is only used if the + /** + * Returns the map unit scale object for the distance tolerance. This is only used if the * toleranceUnit() is set to QgsUnitTypes::RenderMapUnits. * \see setToleranceMapUnitScale() * \see toleranceUnit() @@ -250,7 +265,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer //! Spatial index for fast lookup of nearby points. QgsSpatialIndex *mSpatialIndex = nullptr; - /** Renders the labels for a group. + /** + * Renders the labels for a group. * \param centerPoint center point of group * \param context destination render context * \param labelShifts displacement for individual label positions @@ -261,7 +277,8 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer private: - /** Draws a group of clustered points. + /** + * Draws a group of clustered points. * \param centerPoint central point (geographic centroid) of all points contained within the cluster * \param context destination render context * \param group contents of group @@ -280,13 +297,15 @@ class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer //! Internal group rendering helper void drawGroup( const ClusteredGroup &group, QgsRenderContext &context ); - /** Returns first symbol from the embedded renderer for a feature or nullptr if none + /** + * Returns first symbol from the embedded renderer for a feature or nullptr if none * \param feature source feature * \param context target render context */ QgsMarkerSymbol *firstSymbolForFeature( QgsFeature &feature, QgsRenderContext &context ); - /** Creates an expression context scope for a clustered group, with variables reflecting the group's properties. + /** + * Creates an expression context scope for a clustered group, with variables reflecting the group's properties. * \param group clustered group * \returns new expression context scope */ diff --git a/src/core/symbology/qgsrenderer.h b/src/core/symbology/qgsrenderer.h index a028904243ae..b7309e7daeb0 100644 --- a/src/core/symbology/qgsrenderer.h +++ b/src/core/symbology/qgsrenderer.h @@ -51,7 +51,8 @@ typedef QMap QgsSymbolMap SIP_SKIP; //////// // symbol levels -/** \ingroup core +/** + * \ingroup core * \class QgsSymbolLevelItem */ class CORE_EXPORT QgsSymbolLevelItem @@ -82,7 +83,8 @@ typedef QList< QList< QgsSymbolLevelItem > > QgsSymbolLevelOrder; ////////////// // renderers -/** \ingroup core +/** + * \ingroup core * \class QgsFeatureRenderer */ class CORE_EXPORT QgsFeatureRenderer @@ -123,7 +125,8 @@ class CORE_EXPORT QgsFeatureRenderer QString type() const { return mType; } - /** To be overridden + /** + * To be overridden * * Must be called between startRender() and stopRender() calls. * \param feature feature @@ -240,7 +243,8 @@ class CORE_EXPORT QgsFeatureRenderer */ virtual QgsFeatureRenderer::Capabilities capabilities() { return 0; } - /** Returns list of symbols used by the renderer. + /** + * Returns list of symbols used by the renderer. * \param context render context * \since QGIS 2.12 */ @@ -261,7 +265,8 @@ class CORE_EXPORT QgsFeatureRenderer */ virtual QDomElement writeSld( QDomDocument &doc, const QString &styleName, const QgsStringMap &props = QgsStringMap() ) const; - /** Create a new renderer according to the information contained in + /** + * Create a new renderer according to the information contained in * the UserStyle element of a SLD style document * \param node the node in the SLD document whose the UserStyle element * is a child @@ -298,7 +303,8 @@ class CORE_EXPORT QgsFeatureRenderer */ virtual void checkLegendSymbolItem( const QString &key, bool state = true ); - /** Sets the symbol to be used for a legend symbol item. + /** + * Sets the symbol to be used for a legend symbol item. * \param key rule key for legend symbol * \param symbol new symbol for legend item. Ownership is transferred to renderer. * \since QGIS 2.14 @@ -320,27 +326,31 @@ class CORE_EXPORT QgsFeatureRenderer //! set type and size of editing vertex markers for subsequent rendering void setVertexMarkerAppearance( int type, int size ); - /** Returns whether the renderer will render a feature or not. + /** + * Returns whether the renderer will render a feature or not. * Must be called between startRender() and stopRender() calls. * Default implementation uses symbolForFeature(). * \since QGIS 2.12 */ virtual bool willRenderFeature( QgsFeature &feat, QgsRenderContext &context ); - /** Returns list of symbols used for rendering the feature. + /** + * Returns list of symbols used for rendering the feature. * For renderers that do not support MoreSymbolsPerFeature it is more efficient * to use symbolForFeature() * \since QGIS 2.12 */ virtual QgsSymbolList symbolsForFeature( QgsFeature &feat, QgsRenderContext &context ); - /** Equivalent of originalSymbolsForFeature() call + /** + * Equivalent of originalSymbolsForFeature() call * extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() * \since QGIS 2.12 */ virtual QgsSymbolList originalSymbolsForFeature( QgsFeature &feat, QgsRenderContext &context ); - /** Allows for a renderer to modify the extent of a feature request prior to rendering + /** + * Allows for a renderer to modify the extent of a feature request prior to rendering * \param extent reference to request's filter extent. Modify extent to change the * extent of feature request * \param context render context @@ -348,27 +358,31 @@ class CORE_EXPORT QgsFeatureRenderer */ virtual void modifyRequestExtent( QgsRectangle &extent, QgsRenderContext &context ) { Q_UNUSED( extent ); Q_UNUSED( context ); } - /** Returns the current paint effect for the renderer. + /** + * Returns the current paint effect for the renderer. * \returns paint effect * \since QGIS 2.9 * \see setPaintEffect */ QgsPaintEffect *paintEffect() const; - /** Sets the current paint effect for the renderer. + /** + * Sets the current paint effect for the renderer. * \param effect paint effect. Ownership is transferred to the renderer. * \since QGIS 2.9 * \see paintEffect */ void setPaintEffect( QgsPaintEffect *effect ); - /** Returns whether the renderer must render as a raster. + /** + * Returns whether the renderer must render as a raster. * \since QGIS 2.12 * \see setForceRasterRender */ bool forceRasterRender() const { return mForceRaster; } - /** Sets whether the renderer should be rendered to a raster destination. + /** + * Sets whether the renderer should be rendered to a raster destination. * \param forceRaster set to true if renderer must be drawn on a raster surface. * This may be desirable for highly detailed layers where rendering as a vector * would result in a large, complex vector output. @@ -410,7 +424,8 @@ class CORE_EXPORT QgsFeatureRenderer */ void setOrderByEnabled( bool enabled ); - /** Sets an embedded renderer (subrenderer) for this feature renderer. The base class implementation + /** + * Sets an embedded renderer (subrenderer) for this feature renderer. The base class implementation * does nothing with subrenderers, but individual derived classes can use these to modify their behavior. * \param subRenderer the embedded renderer. Ownership will be transferred. * \see embeddedRenderer() @@ -418,7 +433,8 @@ class CORE_EXPORT QgsFeatureRenderer */ virtual void setEmbeddedRenderer( QgsFeatureRenderer *subRenderer SIP_TRANSFER ) { delete subRenderer; } - /** Returns the current embedded renderer (subrenderer) for this feature renderer. The base class + /** + * Returns the current embedded renderer (subrenderer) for this feature renderer. The base class * implementation does not use subrenderers and will always return null. * \see setEmbeddedRenderer() * \since QGIS 2.16 @@ -471,12 +487,14 @@ class CORE_EXPORT QgsFeatureRenderer bool mForceRaster; - /** \note this function is used to convert old sizeScale expressions to symbol + /** + * \note this function is used to convert old sizeScale expressions to symbol * level DataDefined size */ static void convertSymbolSizeScale( QgsSymbol *symbol, QgsSymbol::ScaleMethod method, const QString &field ); - /** \note this function is used to convert old rotations expressions to symbol + /** + * \note this function is used to convert old rotations expressions to symbol * level DataDefined angle */ static void convertSymbolRotation( QgsSymbol *symbol, const QString &field ); diff --git a/src/core/symbology/qgsrendererregistry.h b/src/core/symbology/qgsrendererregistry.h index 816a27a45a94..70f256274c90 100644 --- a/src/core/symbology/qgsrendererregistry.h +++ b/src/core/symbology/qgsrendererregistry.h @@ -30,7 +30,8 @@ class QgsVectorLayer; class QgsStyle; class QgsRendererWidget SIP_EXTERNAL; -/** \ingroup core +/** + * \ingroup core Stores metadata about one renderer class. \note It's necessary to implement createRenderer() function. @@ -66,16 +67,19 @@ class CORE_EXPORT QgsRendererAbstractMetadata QIcon icon() const { return mIcon; } void setIcon( const QIcon &icon ) { mIcon = icon; } - /** Returns flags indicating the types of layer the renderer is compatible with. + /** + * Returns flags indicating the types of layer the renderer is compatible with. * \since QGIS 2.16 */ virtual QgsRendererAbstractMetadata::LayerTypes compatibleLayerTypes() const { return All; } - /** Return new instance of the renderer given the DOM element. Returns NULL on error. + /** + * Return new instance of the renderer given the DOM element. Returns NULL on error. * Pure virtual function: must be implemented in derived classes. */ virtual QgsFeatureRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) = 0 SIP_FACTORY; - /** Return new instance of settings widget for the renderer. Returns NULL on error. + /** + * Return new instance of settings widget for the renderer. Returns NULL on error. * * The \a oldRenderer argument may refer to previously used renderer (or it is null). * If not null, it may be used to initialize GUI of the widget from the previous settings. @@ -105,7 +109,8 @@ typedef QgsFeatureRenderer *( *QgsRendererCreateFunc )( QDomElement &, const Qgs typedef QgsRendererWidget *( *QgsRendererWidgetFunc )( QgsVectorLayer *, QgsStyle *, QgsFeatureRenderer * ) SIP_SKIP; typedef QgsFeatureRenderer *( *QgsRendererCreateFromSldFunc )( QDomElement &, QgsWkbTypes::GeometryType geomType ) SIP_SKIP; -/** \ingroup core +/** + * \ingroup core Convenience metadata class that uses static functions to create renderer and its widget. */ class CORE_EXPORT QgsRendererMetadata : public QgsRendererAbstractMetadata @@ -182,7 +187,8 @@ class CORE_EXPORT QgsRendererMetadata : public QgsRendererAbstractMetadata }; -/** \ingroup core +/** + * \ingroup core * \class QgsRendererRegistry * \brief Registry of renderers. * diff --git a/src/core/symbology/qgsrulebasedrenderer.h b/src/core/symbology/qgsrulebasedrenderer.h index 867a3ff8b2fc..d03453b37752 100644 --- a/src/core/symbology/qgsrulebasedrenderer.h +++ b/src/core/symbology/qgsrulebasedrenderer.h @@ -29,7 +29,8 @@ class QgsExpression; class QgsCategorizedSymbolRenderer; class QgsGraduatedSymbolRenderer; -/** \ingroup core +/** + * \ingroup core When drawing a vector layer with rule-based renderer, it goes through the rules and draws features with symbols from rules that match. */ @@ -105,7 +106,8 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer class Rule; typedef QList RuleList; - /** \ingroup core + /** + * \ingroup core This class keeps data about a rules for rule-based renderer. A rule consists of a symbol, filter expression and range of scales. If filter is empty, it matches all features. @@ -321,7 +323,8 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer //! tell which symbols will be used to render the feature QgsSymbolList symbolsForFeature( QgsFeature &feat, QgsRenderContext *context = nullptr ); - /** Returns which legend keys match the feature + /** + * Returns which legend keys match the feature * \since QGIS 2.14 */ QSet< QString > legendKeysForFeature( QgsFeature &feat, QgsRenderContext *context = nullptr ); diff --git a/src/core/symbology/qgssinglesymbolrenderer.h b/src/core/symbology/qgssinglesymbolrenderer.h index aec6b1410e85..8ae655f9e736 100644 --- a/src/core/symbology/qgssinglesymbolrenderer.h +++ b/src/core/symbology/qgssinglesymbolrenderer.h @@ -22,7 +22,8 @@ #include "qgsexpression.h" #include "qgsdatadefinedsizelegend.h" -/** \ingroup core +/** + * \ingroup core * \class QgsSingleSymbolRenderer */ class CORE_EXPORT QgsSingleSymbolRenderer : public QgsFeatureRenderer diff --git a/src/core/symbology/qgsstyle.h b/src/core/symbology/qgsstyle.h index 328bbe6c15c3..3b35f7af7bf9 100644 --- a/src/core/symbology/qgsstyle.h +++ b/src/core/symbology/qgsstyle.h @@ -41,7 +41,8 @@ typedef QMap QgsSymbolGroupMap; */ #define QGSCLIPBOARD_STYLE_MIME "application/qgis.style" -/** \ingroup core +/** + * \ingroup core * A multimap to hold the smart group conditions as constraint and parameter pairs. * Both the key and the value of the map are QString. The key is the constraint of the condition and the value is the parameter which is applied for the constraint. * @@ -67,7 +68,8 @@ enum TagmapTable { TagmapTagId, TagmapSymbolId }; enum ColorrampTable { ColorrampId, ColorrampName, ColorrampXML, ColorrampFavoriteId }; enum SmartgroupTable { SmartgroupId, SmartgroupName, SmartgroupXML }; -/** \ingroup core +/** + * \ingroup core * \class QgsStyle */ class CORE_EXPORT QgsStyle : public QObject @@ -82,7 +84,8 @@ class CORE_EXPORT QgsStyle : public QObject QgsStyle() = default; ~QgsStyle(); - /** Enum for Entities involved in a style + /** + * Enum for Entities involved in a style * * The enumerator is used for identifying the entity being operated on when generic * database functions are being run. @@ -90,7 +93,8 @@ class CORE_EXPORT QgsStyle : public QObject */ enum StyleEntity { SymbolEntity, TagEntity, ColorrampEntity, SmartgroupEntity }; - /** Adds a symbol to style and takes symbol's ownership + /** + * Adds a symbol to style and takes symbol's ownership * * \note Adding a symbol with the name of existing one replaces it. * \param name is the name of the symbol being added or updated @@ -100,7 +104,8 @@ class CORE_EXPORT QgsStyle : public QObject */ bool addSymbol( const QString &name, QgsSymbol *symbol SIP_TRANSFER, bool update = false ); - /** Adds a color ramp to the style. Calling this method takes the ramp's ownership. + /** + * Adds a color ramp to the style. Calling this method takes the ramp's ownership. * \note Adding a color ramp with the name of existing one replaces it. * \param name is the name of the color ramp being added or updated * \param colorRamp is the color ramp. Ownership is transferred. @@ -109,14 +114,16 @@ class CORE_EXPORT QgsStyle : public QObject */ bool addColorRamp( const QString &name, QgsColorRamp *colorRamp SIP_TRANSFER, bool update = false ); - /** Adds a new tag and returns the tag's id + /** + * Adds a new tag and returns the tag's id * * \param tagName the name of the new tag to be created * \returns returns an int, which is the DB id of the new tag created, 0 if the tag couldn't be created */ int addTag( const QString &tagName ); - /** Adds a new smartgroup to the database and returns the id + /** + * Adds a new smartgroup to the database and returns the id * * \param name is the name of the new Smart Group to be added * \param op is the operator between the conditions; AND/OR as QString @@ -124,7 +131,8 @@ class CORE_EXPORT QgsStyle : public QObject */ int addSmartgroup( const QString &name, const QString &op, const QgsSmartConditionMap &conditions ); - /** Returns a list of all tags in the style database + /** + * Returns a list of all tags in the style database * * \since QGIS 2.16 * \see addTag() @@ -134,7 +142,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Removes all contents of the style void clear(); - /** Returns a new copy of the specified color ramp. The caller + /** + * Returns a new copy of the specified color ramp. The caller * takes responsibility for deleting the returned object. */ QgsColorRamp *colorRamp( const QString &name ) const SIP_FACTORY; @@ -148,7 +157,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Returns a const pointer to a symbol (doesn't create new instance) const QgsColorRamp *colorRampRef( const QString &name ) const; - /** Returns the id in the style database for the given colorramp name + /** + * Returns the id in the style database for the given colorramp name * returns 0 if not found */ int colorrampId( const QString &name ); @@ -156,7 +166,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Returns default application-wide style static QgsStyle *defaultStyle(); - /** Tags the symbol with the tags in the list + /** + * Tags the symbol with the tags in the list * * Applies the given tags to the given symbol or colorramp * \param type is either SymbolEntity or ColorrampEntity @@ -166,7 +177,8 @@ class CORE_EXPORT QgsStyle : public QObject */ bool tagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags ); - /** Detags the symbol with the given list + /** + * Detags the symbol with the given list * * Removes the given tags for the specified symbol or colorramp * \param type is either SymbolEntity or ColorrampEntity @@ -176,7 +188,8 @@ class CORE_EXPORT QgsStyle : public QObject */ bool detagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags ); - /** Clears the symbol from all attached tags + /** + * Clears the symbol from all attached tags * * Removes all tags for the specified symbol or colorramp * \param type is either SymbolEntity or ColorrampEntity @@ -203,7 +216,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Returns a list of names of symbols QStringList symbolNames(); - /** Returns the id in the style database for the given symbol name + /** + * Returns the id in the style database for the given symbol name * returns 0 if not found */ int symbolId( const QString &name ); @@ -212,14 +226,16 @@ class CORE_EXPORT QgsStyle : public QObject //! Returns the DB id for the given smartgroup name int smartgroupId( const QString &smartgroup ); - /** Returns the symbol names which are flagged as favorite + /** + * Returns the symbol names which are flagged as favorite * * \param type is either SymbolEntity or ColorampEntity * \returns A QStringList of the symbol or colorramp names flagged as favorite */ QStringList symbolsOfFavorite( StyleEntity type ) const; - /** Returns the symbol names with which have the given tag + /** + * Returns the symbol names with which have the given tag * * \param type is either SymbolEntity or ColorampEntity * \param tagid is id of the tag which has been applied over the symbol as int @@ -227,7 +243,8 @@ class CORE_EXPORT QgsStyle : public QObject */ QStringList symbolsWithTag( StyleEntity type, int tagid ) const; - /** Adds the specified symbol to favorites + /** + * Adds the specified symbol to favorites * * \param type is either SymbolEntity of ColorrampEntity * \param name is the name of the symbol or coloramp whose is to be added to favorites @@ -235,7 +252,8 @@ class CORE_EXPORT QgsStyle : public QObject */ bool addFavorite( StyleEntity type, const QString &name ); - /** Removes the specified symbol from favorites + /** + * Removes the specified symbol from favorites * * \param type is either SymbolEntity of ColorrampEntity * \param name is the name of the symbol or coloramp whose is to be removed from favorites @@ -243,7 +261,8 @@ class CORE_EXPORT QgsStyle : public QObject */ bool removeFavorite( StyleEntity type, const QString &name ); - /** Renames the given entity with the specified id + /** + * Renames the given entity with the specified id * * \param type is any of the style entities. Refer enum StyleEntity. * \param id is the DB id of the entity which is to be renamed @@ -251,14 +270,16 @@ class CORE_EXPORT QgsStyle : public QObject */ void rename( StyleEntity type, int id, const QString &newName ); - /** Removes the specified entity from the db + /** + * Removes the specified entity from the db * * \param type is any of the style entities. Refer enum StyleEntity. * \param id is the DB id of the entity to be removed */ void remove( StyleEntity type, int id ); - /** Adds the symbol to the DB with the tags + /** + * Adds the symbol to the DB with the tags * * \param name is the name of the symbol as QString * \param symbol is the pointer to the new QgsSymbol being saved @@ -268,7 +289,8 @@ class CORE_EXPORT QgsStyle : public QObject */ bool saveSymbol( const QString &name, QgsSymbol *symbol, bool favorite, const QStringList &tags ); - /** Adds the colorramp to the DB + /** + * Adds the colorramp to the DB * * \param name is the name of the colorramp as QString * \param ramp is the pointer to the new QgsColorRamp being saved @@ -284,7 +306,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Changes ramp's name bool renameColorRamp( const QString &oldName, const QString &newName ); - /** Creates an on-disk database + /** + * Creates an on-disk database * * This function creates a new on-disk permanent style database. * \returns returns the success state of the database creation @@ -293,7 +316,8 @@ class CORE_EXPORT QgsStyle : public QObject */ bool createDatabase( const QString &filename ); - /** Creates a temporary memory database + /** + * Creates a temporary memory database * * This function is used to create a temporary style database in case a permanent on-disk database is not needed. * \returns returns the success state of the temporary memory database creation @@ -302,7 +326,8 @@ class CORE_EXPORT QgsStyle : public QObject */ bool createMemoryDatabase(); - /** Creates tables structure for new database + /** + * Creates tables structure for new database * * This function is used to create the tables structure in a newly-created database. * \returns returns the success state of the temporary memory database creation @@ -311,7 +336,8 @@ class CORE_EXPORT QgsStyle : public QObject */ void createTables(); - /** Loads a file into the style + /** + * Loads a file into the style * * This function will load an on-disk database and populate styles. * \param filename location of the database to load styles from @@ -328,7 +354,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Returns current file name of the style QString fileName() { return mFileName; } - /** Returns the names of the symbols which have a matching 'substring' in its definition + /** + * Returns the names of the symbols which have a matching 'substring' in its definition * * \param type is either SymbolEntity or ColorrampEntity * \param qword is the query string to search the symbols or colorramps. @@ -336,7 +363,8 @@ class CORE_EXPORT QgsStyle : public QObject * */ QStringList findSymbols( StyleEntity type, const QString &qword ); - /** Returns the tags associated with the symbol + /** + * Returns the tags associated with the symbol * * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or color ramp @@ -344,7 +372,8 @@ class CORE_EXPORT QgsStyle : public QObject */ QStringList tagsOfSymbol( StyleEntity type, const QString &symbol ); - /** Returns whether a given tag is associated with the symbol + /** + * Returns whether a given tag is associated with the symbol * * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or color ramp @@ -365,7 +394,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Returns the QgsSmartConditionMap for the given id QgsSmartConditionMap smartgroup( int id ); - /** Returns the operator for the smartgroup + /** + * Returns the operator for the smartgroup * clumsy implementation TODO create a class for smartgroups */ QString smartgroupOperator( int id ); @@ -400,7 +430,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Convenience function to open the DB and return a sqlite3 object bool openDatabase( const QString &filename ); - /** Convenience function that would run queries which don't generate return values + /** + * Convenience function that would run queries which don't generate return values * * \param query query to run * \param freeQuery release query memory @@ -414,7 +445,8 @@ class CORE_EXPORT QgsStyle : public QObject //! Gets the name from the table for the given id from the database, empty if not found QString getName( const QString &table, int id ) const; - /** Updates the properties of an existing symbol/colorramp + /** + * Updates the properties of an existing symbol/colorramp * * \note This should not be called separately, only called through addSymbol or addColorRamp * \param type is either SymbolEntity or ColorrampEntity diff --git a/src/core/symbology/qgssvgcache.h b/src/core/symbology/qgssvgcache.h index 6dba4e750f69..f7be497e4ddb 100644 --- a/src/core/symbology/qgssvgcache.h +++ b/src/core/symbology/qgssvgcache.h @@ -34,7 +34,8 @@ class QDomElement; class QImage; class QPicture; -/** \ingroup core +/** + * \ingroup core * \class QgsSvgCacheEntry */ class CORE_EXPORT QgsSvgCacheEntry @@ -43,7 +44,8 @@ class CORE_EXPORT QgsSvgCacheEntry QgsSvgCacheEntry(); - /** Constructor. + /** + * Constructor. * \param path Absolute path to SVG file (relative paths are not resolved). * \param size * \param strokeWidth width of stroke @@ -70,7 +72,8 @@ class CORE_EXPORT QgsSvgCacheEntry //! Fixed aspect ratio double fixedAspectRatio = 0; - /** SVG viewbox size. + /** + * SVG viewbox size. * \since QGIS 2.14 */ QSizeF viewboxSize; @@ -98,7 +101,8 @@ class CORE_EXPORT QgsSvgCacheEntry }; -/** \ingroup core +/** + * \ingroup core * A cache for images / pictures derived from svg files. This class supports parameter replacement in svg files according to the svg params specification (http://www.w3.org/TR/2009/WD-SVGParamPrimer-20090616/). Supported are the parameters 'fill-color', 'pen-color', 'outline-width', 'stroke-width'. E.g. QgsSymbolLayerList; -/** \ingroup core +/** + * \ingroup core * \class QgsSymbol */ class CORE_EXPORT QgsSymbol @@ -113,7 +114,8 @@ class CORE_EXPORT QgsSymbol // symbol layers handling - /** Returns list of symbol layers contained in the symbol. + /** + * Returns list of symbol layers contained in the symbol. * \returns symbol layers list * \since QGIS 2.7 * \see symbolLayer @@ -121,7 +123,8 @@ class CORE_EXPORT QgsSymbol */ QgsSymbolLayerList symbolLayers() { return mLayers; } - /** Returns a specific symbol layers contained in the symbol. + /** + * Returns a specific symbol layers contained in the symbol. * \param layer layer number * \returns corresponding symbol layer * \since QGIS 2.7 @@ -130,7 +133,8 @@ class CORE_EXPORT QgsSymbol */ QgsSymbolLayer *symbolLayer( int layer ); - /** Returns total number of symbol layers contained in the symbol. + /** + * Returns total number of symbol layers contained in the symbol. * \returns count of symbol layers * \since QGIS 2.7 * \see symbolLayers @@ -169,7 +173,8 @@ class CORE_EXPORT QgsSymbol //! delete layer at specified index and set a new one bool changeSymbolLayer( int index, QgsSymbolLayer *layer SIP_TRANSFER ); - /** Begins the rendering process for the symbol. This must be called before renderFeature(), + /** + * Begins the rendering process for the symbol. This must be called before renderFeature(), * and should be followed by a call to stopRender(). * \param context render context which symbol will be drawn using * \param fields fields for features to be rendered (usually the associated @@ -179,7 +184,8 @@ class CORE_EXPORT QgsSymbol */ void startRender( QgsRenderContext &context, const QgsFields &fields = QgsFields() ); - /** Ends the rendering process. This should be called after rendering all desired features. + /** + * Ends the rendering process. This should be called after rendering all desired features. * \param context render context, must match the context specified when startRender() * was called. * \see startRender() @@ -202,7 +208,8 @@ class CORE_EXPORT QgsSymbol //! Generate symbol as image QImage asImage( QSize size, QgsRenderContext *customContext = nullptr ); - /** Returns a large (roughly 100x100 pixel) preview image for the symbol. + /** + * Returns a large (roughly 100x100 pixel) preview image for the symbol. * \param expressionContext optional expression context, for evaluation of * data defined symbol properties */ @@ -219,7 +226,8 @@ class CORE_EXPORT QgsSymbol void toSld( QDomDocument &doc, QDomElement &element, QgsStringMap props ) const; - /** Returns the units to use for sizes and widths within the symbol. Individual + /** + * Returns the units to use for sizes and widths within the symbol. Individual * symbol layer definitions will interpret this in different ways, e.g., a marker symbol * may use it to specify the units for the marker size, while a line symbol * may use it to specify the units for the line width. @@ -228,7 +236,8 @@ class CORE_EXPORT QgsSymbol */ QgsUnitTypes::RenderUnit outputUnit() const; - /** Sets the units to use for sizes and widths within the symbol. Individual + /** + * Sets the units to use for sizes and widths within the symbol. Individual * symbol definitions will interpret this in different ways, e.g., a marker symbol * may use it to specify the units for the marker size, while a line symbol * may use it to specify the units for the line width. @@ -254,17 +263,20 @@ class CORE_EXPORT QgsSymbol */ void setOpacity( qreal opacity ) { mOpacity = opacity; } - /** Sets rendering hint flags for the symbol. + /** + * Sets rendering hint flags for the symbol. * \see renderHints() */ void setRenderHints( RenderHints hints ) { mRenderHints = hints; } - /** Returns the rendering hint flags for the symbol. + /** + * Returns the rendering hint flags for the symbol. * \see setRenderHints() */ RenderHints renderHints() const { return mRenderHints; } - /** Sets whether features drawn by the symbol should be clipped to the render context's + /** + * Sets whether features drawn by the symbol should be clipped to the render context's * extent. If this option is enabled then features which are partially outside the extent * will be clipped. This speeds up rendering of the feature, but may have undesirable * side effects for certain symbol types. @@ -274,7 +286,8 @@ class CORE_EXPORT QgsSymbol */ void setClipFeaturesToExtent( bool clipFeaturesToExtent ) { mClipFeaturesToExtent = clipFeaturesToExtent; } - /** Returns whether features drawn by the symbol will be clipped to the render context's + /** + * Returns whether features drawn by the symbol will be clipped to the render context's * extent. If this option is enabled then features which are partially outside the extent * will be clipped. This speeds up rendering of the feature, but may have undesirable * side effects for certain symbol types. @@ -291,7 +304,8 @@ class CORE_EXPORT QgsSymbol */ QSet usedAttributes( const QgsRenderContext &context ) const; - /** Returns whether the symbol utilizes any data defined properties. + /** + * Returns whether the symbol utilizes any data defined properties. * \since QGIS 2.12 */ bool hasDataDefinedProperties() const; @@ -409,14 +423,16 @@ Q_DECLARE_OPERATORS_FOR_FLAGS( QgsSymbol::RenderHints ) /////////////////////// -/** \ingroup core +/** + * \ingroup core * \class QgsSymbolRenderContext */ class CORE_EXPORT QgsSymbolRenderContext { public: - /** Constructor for QgsSymbolRenderContext + /** + * Constructor for QgsSymbolRenderContext * \param c * \param u * \param opacity value between 0 (fully transparent) and 1 (fully opaque) @@ -431,7 +447,8 @@ class CORE_EXPORT QgsSymbolRenderContext QgsRenderContext &renderContext() { return mRenderContext; } const QgsRenderContext &renderContext() const { return mRenderContext; } SIP_SKIP - /** Sets the original value variable value for data defined symbology + /** + * Sets the original value variable value for data defined symbology * \param value value for original value variable. This usually represents the symbol property value * before any data defined overrides have been applied. * \since QGIS 2.12 @@ -464,12 +481,14 @@ class CORE_EXPORT QgsSymbolRenderContext bool selected() const { return mSelected; } void setSelected( bool selected ) { mSelected = selected; } - /** Returns the rendering hint flags for the symbol. + /** + * Returns the rendering hint flags for the symbol. * \see setRenderHints() */ QgsSymbol::RenderHints renderHints() const { return mRenderHints; } - /** Sets rendering hint flags for the symbol. + /** + * Sets rendering hint flags for the symbol. * \see renderHints() */ void setRenderHints( QgsSymbol::RenderHints hints ) { mRenderHints = hints; } @@ -503,22 +522,26 @@ class CORE_EXPORT QgsSymbolRenderContext */ QgsFields fields() const { return mFields; } - /** Part count of current geometry + /** + * Part count of current geometry * \since QGIS 2.16 */ int geometryPartCount() const { return mGeometryPartCount; } - /** Sets the part count of current geometry + /** + * Sets the part count of current geometry * \since QGIS 2.16 */ void setGeometryPartCount( int count ) { mGeometryPartCount = count; } - /** Part number of current geometry + /** + * Part number of current geometry * \since QGIS 2.16 */ int geometryPartNum() const { return mGeometryPartNum; } - /** Sets the part number of current geometry + /** + * Sets the part number of current geometry * \since QGIS 2.16 */ void setGeometryPartNum( int num ) { mGeometryPartNum = num; } @@ -567,28 +590,32 @@ class CORE_EXPORT QgsSymbolRenderContext ////////////////////// -/** \ingroup core +/** + * \ingroup core * \class QgsMarkerSymbol */ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol { public: - /** Create a marker symbol with one symbol layer: SimpleMarker with specified properties. + /** + * Create a marker symbol with one symbol layer: SimpleMarker with specified properties. * This is a convenience method for easier creation of marker symbols. */ static QgsMarkerSymbol *createSimple( const QgsStringMap &properties ) SIP_FACTORY; QgsMarkerSymbol( const QgsSymbolLayerList &layers SIP_TRANSFER = QgsSymbolLayerList() ); - /** Sets the angle for the whole symbol. Individual symbol layer sizes + /** + * Sets the angle for the whole symbol. Individual symbol layer sizes * will be rotated to maintain their current relative angle to the whole symbol angle. * \param symbolAngle new symbol angle * \see angle() */ void setAngle( double symbolAngle ); - /** Returns the marker angle for the whole symbol. Note that for symbols with + /** + * Returns the marker angle for the whole symbol. Note that for symbols with * multiple symbol layers, this will correspond just to the angle of * the first symbol layer. * \since QGIS 2.16 @@ -596,13 +623,15 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ double angle() const; - /** Set data defined angle for whole symbol (including all symbol layers). + /** + * Set data defined angle for whole symbol (including all symbol layers). * \since QGIS 3.0 * \see dataDefinedAngle() */ void setDataDefinedAngle( const QgsProperty &property ); - /** Returns data defined angle for whole symbol (including all symbol layers). + /** + * Returns data defined angle for whole symbol (including all symbol layers). * \returns data defined angle, or invalid property if angle is not set * at the marker level. * \since QGIS 3.0 @@ -610,7 +639,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ QgsProperty dataDefinedAngle() const; - /** Sets the line angle modification for the symbol's angle. This angle is added to + /** + * Sets the line angle modification for the symbol's angle. This angle is added to * the marker's rotation and data defined rotation before rendering the symbol, and * is usually used for orienting symbols to match a line's angle. * \param lineAngle Angle in degrees, valid values are between 0 and 360 @@ -618,7 +648,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ void setLineAngle( double lineAngle ); - /** Sets the size for the whole symbol. Individual symbol layer sizes + /** + * Sets the size for the whole symbol. Individual symbol layer sizes * will be scaled to maintain their current relative size to the whole symbol size. * \param size new symbol size * \see size() @@ -627,7 +658,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ void setSize( double size ); - /** Returns the size for the whole symbol, which is the maximum size of + /** + * Returns the size for the whole symbol, which is the maximum size of * all marker symbol layers in the symbol. * \see setSize() * \see sizeUnit() @@ -635,7 +667,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ double size() const; - /** Sets the size units for the whole symbol (including all symbol layers). + /** + * Sets the size units for the whole symbol (including all symbol layers). * \param unit size units * \since QGIS 2.16 * \see sizeUnit() @@ -644,7 +677,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ); - /** Returns the size units for the whole symbol (including all symbol layers). + /** + * Returns the size units for the whole symbol (including all symbol layers). * \returns size units, or mixed units if symbol layers have different units * \since QGIS 2.16 * \see setSizeUnit() @@ -653,7 +687,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ QgsUnitTypes::RenderUnit sizeUnit() const; - /** Sets the size map unit scale for the whole symbol (including all symbol layers). + /** + * Sets the size map unit scale for the whole symbol (including all symbol layers). * \param scale map unit scale * \since QGIS 2.16 * \see sizeMapUnitScale() @@ -662,7 +697,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ); - /** Returns the size map unit scale for the whole symbol. Note that for symbols with + /** + * Returns the size map unit scale for the whole symbol. Note that for symbols with * multiple symbol layers, this will correspond just to the map unit scale * for the first symbol layer. * \since QGIS 2.16 @@ -672,13 +708,15 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol */ QgsMapUnitScale sizeMapUnitScale() const; - /** Set data defined size for whole symbol (including all symbol layers). + /** + * Set data defined size for whole symbol (including all symbol layers). * \since QGIS 3.0 * \see dataDefinedSize() */ void setDataDefinedSize( const QgsProperty &property ); - /** Returns data defined size for whole symbol (including all symbol layers). + /** + * Returns data defined size for whole symbol (including all symbol layers). * \returns data defined size, or invalid property if size is not set * at the marker level. * \since QGIS 3.0 @@ -691,7 +729,8 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol void renderPoint( QPointF point, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false ); - /** Returns the approximate bounding box of the marker symbol, which includes the bounding box + /** + * Returns the approximate bounding box of the marker symbol, which includes the bounding box * of all symbol layers for the symbol. It is recommended to use this method only between startRender() * and stopRender() calls, or data defined rotation and offset will not be correctly calculated. * \param point location of rendered point in painter units @@ -712,14 +751,16 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol }; -/** \ingroup core +/** + * \ingroup core * \class QgsLineSymbol */ class CORE_EXPORT QgsLineSymbol : public QgsSymbol { public: - /** Create a line symbol with one symbol layer: SimpleLine with specified properties. + /** + * Create a line symbol with one symbol layer: SimpleLine with specified properties. * This is a convenience method for easier creation of line symbols. */ static QgsLineSymbol *createSimple( const QgsStringMap &properties ) SIP_FACTORY; @@ -729,13 +770,15 @@ class CORE_EXPORT QgsLineSymbol : public QgsSymbol void setWidth( double width ); double width() const; - /** Set data defined width for whole symbol (including all symbol layers). + /** + * Set data defined width for whole symbol (including all symbol layers). * \see dataDefinedWidth() * \since QGIS 3.0 */ void setDataDefinedWidth( const QgsProperty &property ); - /** Returns data defined width for whole symbol (including all symbol layers). + /** + * Returns data defined width for whole symbol (including all symbol layers). * \returns data defined width, or invalid property if size is not set * at the line level. Caller takes responsibility for deleting the returned object. * \since QGIS 3.0 @@ -754,14 +797,16 @@ class CORE_EXPORT QgsLineSymbol : public QgsSymbol }; -/** \ingroup core +/** + * \ingroup core * \class QgsFillSymbol */ class CORE_EXPORT QgsFillSymbol : public QgsSymbol { public: - /** Create a fill symbol with one symbol layer: SimpleFill with specified properties. + /** + * Create a fill symbol with one symbol layer: SimpleFill with specified properties. * This is a convenience method for easier creation of fill symbols. */ static QgsFillSymbol *createSimple( const QgsStringMap &properties ) SIP_FACTORY; diff --git a/src/core/symbology/qgssymbollayer.h b/src/core/symbology/qgssymbollayer.h index 436a690dd12a..a1093ee4a318 100644 --- a/src/core/symbology/qgssymbollayer.h +++ b/src/core/symbology/qgssymbollayer.h @@ -41,7 +41,8 @@ class QgsExpression; class QgsRenderContext; class QgsPaintEffect; -/** \ingroup core +/** + * \ingroup core * \class QgsSymbolLayer */ class CORE_EXPORT QgsSymbolLayer @@ -204,19 +205,23 @@ class CORE_EXPORT QgsSymbolLayer */ virtual void setColor( const QColor &color ) { mColor = color; } - /** Set stroke color. Supported by marker and fill layers. + /** + * Set stroke color. Supported by marker and fill layers. * \since QGIS 2.1 */ virtual void setStrokeColor( const QColor &color ) { Q_UNUSED( color ); } - /** Get stroke color. Supported by marker and fill layers. + /** + * Get stroke color. Supported by marker and fill layers. * \since QGIS 2.1 */ virtual QColor strokeColor() const { return QColor(); } - /** Set fill color. Supported by marker and fill layers. + /** + * Set fill color. Supported by marker and fill layers. * \since QGIS 2.1 */ virtual void setFillColor( const QColor &color ) { Q_UNUSED( color ); } - /** Get fill color. Supported by marker and fill layers. + /** + * Get fill color. Supported by marker and fill layers. * \since QGIS 2.1 */ virtual QColor fillColor() const { return QColor(); } @@ -264,14 +269,16 @@ class CORE_EXPORT QgsSymbolLayer void setLocked( bool locked ) { mLocked = locked; } bool isLocked() const { return mLocked; } - /** Returns the estimated maximum distance which the layer style will bleed outside + /** + * Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. For example, polygons drawn with an stroke will draw half the width of the stroke outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.*/ virtual double estimateMaxBleed( const QgsRenderContext &context ) const { Q_UNUSED( context ); return 0; } - /** Sets the units to use for sizes and widths within the symbol layer. Individual + /** + * Sets the units to use for sizes and widths within the symbol layer. Individual * symbol layer subclasses will interpret this in different ways, e.g., a marker symbol * layer may use it to specify the units for the marker size, while a line symbol * layer may use it to specify the units for the line width. @@ -280,7 +287,8 @@ class CORE_EXPORT QgsSymbolLayer */ virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit ) { Q_UNUSED( unit ); } - /** Returns the units to use for sizes and widths within the symbol layer. Individual + /** + * Returns the units to use for sizes and widths within the symbol layer. Individual * symbol layer subclasses will interpret this in different ways, e.g., a marker symbol * layer may use it to specify the units for the marker size, while a line symbol * layer may use it to specify the units for the line width. @@ -296,12 +304,14 @@ class CORE_EXPORT QgsSymbolLayer void setRenderingPass( int renderingPass ) { mRenderingPass = renderingPass; } int renderingPass() const { return mRenderingPass; } - /** Returns the set of attributes referenced by the layer. This includes attributes + /** + * Returns the set of attributes referenced by the layer. This includes attributes * required by any data defined properties associated with the layer. */ virtual QSet usedAttributes( const QgsRenderContext &context ) const; - /** Sets a data defined property for the layer. Any existing property with the same key + /** + * Sets a data defined property for the layer. Any existing property with the same key * will be overwritten. * \since QGIS 3.0 * \see getDataDefinedProperty @@ -336,40 +346,46 @@ class CORE_EXPORT QgsSymbolLayer //! get brush/fill style virtual Qt::BrushStyle dxfBrushStyle() const; - /** Returns the current paint effect for the layer. + /** + * Returns the current paint effect for the layer. * \returns paint effect * \since QGIS 2.9 * \see setPaintEffect */ QgsPaintEffect *paintEffect() const; - /** Sets the current paint effect for the layer. + /** + * Sets the current paint effect for the layer. * \param effect paint effect. Ownership is transferred to the layer. * \since QGIS 2.9 * \see paintEffect */ void setPaintEffect( QgsPaintEffect *effect SIP_TRANSFER ); - /** Prepares all data defined property expressions for evaluation. This should + /** + * Prepares all data defined property expressions for evaluation. This should * be called prior to evaluating data defined properties. * \param context symbol render context * \since QGIS 2.12 */ virtual void prepareExpressions( const QgsSymbolRenderContext &context ); - /** Returns a reference to the symbol layer's property collection, used for data defined overrides. + /** + * Returns a reference to the symbol layer's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setProperties() */ QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; } - /** Returns a reference to the symbol layer's property collection, used for data defined overrides. + /** + * Returns a reference to the symbol layer's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; } SIP_SKIP - /** Sets the symbol layer's property collection, used for data defined overrides. + /** + * Sets the symbol layer's property collection, used for data defined overrides. * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 * \see properties() @@ -402,17 +418,20 @@ class CORE_EXPORT QgsSymbolLayer //! Whether fill styles for selected features uses symbol layer style static const bool SELECT_FILL_STYLE = false; - /** Restores older data defined properties from string map. + /** + * Restores older data defined properties from string map. * \since QGIS 3.0 */ void restoreOldDataDefinedProperties( const QgsStringMap &stringMap ); - /** Copies all data defined properties of this layer to another symbol layer. + /** + * Copies all data defined properties of this layer to another symbol layer. * \param destLayer destination layer */ void copyDataDefinedProperties( QgsSymbolLayer *destLayer ) const; - /** Copies paint effect of this layer to another symbol layer + /** + * Copies paint effect of this layer to another symbol layer * \param destLayer destination layer * \since QGIS 2.9 */ @@ -428,7 +447,8 @@ class CORE_EXPORT QgsSymbolLayer ////////////////////// -/** \ingroup core +/** + * \ingroup core * \class QgsMarkerSymbolLayer * \brief Abstract base class for marker symbol layers. */ @@ -454,7 +474,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer void startRender( QgsSymbolRenderContext &context ) override; - /** Renders a marker at the specified point. Derived classes must implement this to + /** + * Renders a marker at the specified point. Derived classes must implement this to * handle drawing the point. * \param point position at which to render point, in painter units * \param context symbol render context @@ -463,19 +484,22 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer void drawPreviewIcon( QgsSymbolRenderContext &context, QSize size ) override; - /** Sets the rotation angle for the marker. + /** + * Sets the rotation angle for the marker. * \param angle angle in degrees clockwise from north. * \see angle() * \see setLineAngle() */ void setAngle( double angle ) { mAngle = angle; } - /** Returns the rotation angle for the marker, in degrees clockwise from north. + /** + * Returns the rotation angle for the marker, in degrees clockwise from north. * \see setAngle() */ double angle() const { return mAngle; } - /** Sets the line angle modification for the symbol's angle. This angle is added to + /** + * Sets the line angle modification for the symbol's angle. This angle is added to * the marker's rotation and data defined rotation before rendering the symbol, and * is usually used for orienting symbols to match a line's angle. * \param lineAngle Angle in degrees clockwise from north, valid values are between 0 and 360 @@ -485,7 +509,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setLineAngle( double lineAngle ) { mLineAngle = lineAngle; } - /** Sets the symbol size. + /** + * Sets the symbol size. * \param size symbol size. Units are specified by sizeUnit(). * \see size() * \see setSizeUnit() @@ -493,14 +518,16 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setSize( double size ) { mSize = size; } - /** Returns the symbol size. Units are specified by sizeUnit(). + /** + * Returns the symbol size. Units are specified by sizeUnit(). * \see setSize() * \see sizeUnit() * \see sizeUnitMapScale() */ double size() const { return mSize; } - /** Sets the units for the symbol's size. + /** + * Sets the units for the symbol's size. * \param unit size units * \see sizeUnit() * \see setSize() @@ -508,14 +535,16 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setSizeUnit( QgsUnitTypes::RenderUnit unit ) { mSizeUnit = unit; } - /** Returns the units for the symbol's size. + /** + * Returns the units for the symbol's size. * \see setSizeUnit() * \see size() * \see sizeMapUnitScale() */ QgsUnitTypes::RenderUnit sizeUnit() const { return mSizeUnit; } - /** Sets the map unit scale for the symbol's size. + /** + * Sets the map unit scale for the symbol's size. * \param scale size map unit scale * \see sizeMapUnitScale() * \see setSize() @@ -523,25 +552,29 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setSizeMapUnitScale( const QgsMapUnitScale &scale ) { mSizeMapUnitScale = scale; } - /** Returns the map unit scale for the symbol's size. + /** + * Returns the map unit scale for the symbol's size. * \see setSizeMapUnitScale() * \see size() * \see sizeUnit() */ const QgsMapUnitScale &sizeMapUnitScale() const { return mSizeMapUnitScale; } - /** Sets the method to use for scaling the marker's size. + /** + * Sets the method to use for scaling the marker's size. * \param scaleMethod scale method * \see scaleMethod() */ void setScaleMethod( QgsSymbol::ScaleMethod scaleMethod ) { mScaleMethod = scaleMethod; } - /** Returns the method to use for scaling the marker's size. + /** + * Returns the method to use for scaling the marker's size. * \see setScaleMethod() */ QgsSymbol::ScaleMethod scaleMethod() const { return mScaleMethod; } - /** Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker + /** + * Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker * should have from the original feature's geometry. * \param offset marker offset. Units are specified by offsetUnit() * \see offset() @@ -550,7 +583,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setOffset( QPointF offset ) { mOffset = offset; } - /** Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker + /** + * Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker * will have from the original feature's geometry. Units are specified by offsetUnit(). * \see setOffset() * \see offsetUnit() @@ -558,7 +592,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ QPointF offset() const { return mOffset; } - /** Sets the units for the symbol's offset. + /** + * Sets the units for the symbol's offset. * \param unit offset units * \see offsetUnit() * \see setOffset() @@ -566,14 +601,16 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } - /** Returns the units for the symbol's offset. + /** + * Returns the units for the symbol's offset. * \see setOffsetUnit() * \see offset() * \see offsetMapUnitScale() */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } - /** Sets the map unit scale for the symbol's offset. + /** + * Sets the map unit scale for the symbol's offset. * \param scale offset map unit scale * \see offsetMapUnitScale() * \see setOffset() @@ -581,14 +618,16 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; } - /** Returns the map unit scale for the symbol's offset. + /** + * Returns the map unit scale for the symbol's offset. * \see setOffsetMapUnitScale() * \see offset() * \see offsetUnit() */ const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; } - /** Sets the horizontal anchor point for positioning the symbol. + /** + * Sets the horizontal anchor point for positioning the symbol. * \param h anchor point. Symbol will be drawn so that the horizontal anchor point is aligned with * the marker's desired location. * \see horizontalAnchorPoint() @@ -596,14 +635,16 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setHorizontalAnchorPoint( HorizontalAnchorPoint h ) { mHorizontalAnchorPoint = h; } - /** Returns the horizontal anchor point for positioning the symbol. The symbol will be drawn so that + /** + * Returns the horizontal anchor point for positioning the symbol. The symbol will be drawn so that * the horizontal anchor point is aligned with the marker's desired location. * \see setHorizontalAnchorPoint() * \see verticalAnchorPoint() */ HorizontalAnchorPoint horizontalAnchorPoint() const { return mHorizontalAnchorPoint; } - /** Sets the vertical anchor point for positioning the symbol. + /** + * Sets the vertical anchor point for positioning the symbol. * \param v anchor point. Symbol will be drawn so that the vertical anchor point is aligned with * the marker's desired location. * \see verticalAnchorPoint() @@ -611,7 +652,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void setVerticalAnchorPoint( VerticalAnchorPoint v ) { mVerticalAnchorPoint = v; } - /** Returns the vertical anchor point for positioning the symbol. The symbol will be drawn so that + /** + * Returns the vertical anchor point for positioning the symbol. The symbol will be drawn so that * the vertical anchor point is aligned with the marker's desired location. * \see setVerticalAnchorPoint() * \see horizontalAnchorPoint() @@ -620,7 +662,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer virtual void toSld( QDomDocument &doc, QDomElement &element, const QgsStringMap &props ) const override; - /** Writes the symbol layer definition as a SLD XML element. + /** + * Writes the symbol layer definition as a SLD XML element. * \param doc XML document * \param element parent XML element * \param props symbol layer definition (see properties()) @@ -633,7 +676,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer void setMapUnitScale( const QgsMapUnitScale &scale ) override; QgsMapUnitScale mapUnitScale() const override; - /** Returns the approximate bounding box of the marker symbol layer, taking into account + /** + * Returns the approximate bounding box of the marker symbol layer, taking into account * any data defined overrides and offsets which are set for the marker layer. * \returns approximate symbol bounds, in painter units * \since QGIS 2.14 @@ -642,12 +686,14 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer protected: - /** Constructor for QgsMarkerSymbolLayer. + /** + * Constructor for QgsMarkerSymbolLayer. * \param locked set to true to lock symbol color */ QgsMarkerSymbolLayer( bool locked = false ); - /** Calculates the required marker offset, including both the symbol offset + /** + * Calculates the required marker offset, including both the symbol offset * and any displacement required to align with the marker's anchor point. * \param context symbol render context * \param offsetX will be set to required horizontal offset (in painter units) @@ -655,7 +701,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer */ void markerOffset( QgsSymbolRenderContext &context, double &offsetX, double &offsetY ) const; - /** Calculates the required marker offset, including both the symbol offset + /** + * Calculates the required marker offset, including both the symbol offset * and any displacement required to align with the marker's anchor point. * \param context symbol render context * \param width marker width @@ -672,7 +719,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale ) const SIP_PYNAME( markerOffset2 ); - /** Adjusts a marker offset to account for rotation. + /** + * Adjusts a marker offset to account for rotation. * \param offset offset prior to rotation * \param angle rotation angle in degrees clockwise from north * \returns adjusted offset @@ -707,7 +755,8 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer static QgsMarkerSymbolLayer::VerticalAnchorPoint decodeVerticalAnchorPoint( const QString &str ); }; -/** \ingroup core +/** + * \ingroup core * \class QgsLineSymbolLayer */ class CORE_EXPORT QgsLineSymbolLayer : public QgsSymbolLayer @@ -723,13 +772,15 @@ class CORE_EXPORT QgsLineSymbolLayer : public QgsSymbolLayer double offset() const { return mOffset; } void setOffset( double offset ) { mOffset = offset; } - /** Sets the units for the line's width. + /** + * Sets the units for the line's width. * \param unit width units * \see widthUnit() */ void setWidthUnit( QgsUnitTypes::RenderUnit unit ) { mWidthUnit = unit; } - /** Returns the units for the line's width. + /** + * Returns the units for the line's width. * \see setWidthUnit() */ QgsUnitTypes::RenderUnit widthUnit() const { return mWidthUnit; } @@ -737,13 +788,15 @@ class CORE_EXPORT QgsLineSymbolLayer : public QgsSymbolLayer void setWidthMapUnitScale( const QgsMapUnitScale &scale ) { mWidthMapUnitScale = scale; } const QgsMapUnitScale &widthMapUnitScale() const { return mWidthMapUnitScale; } - /** Sets the units for the line's offset. + /** + * Sets the units for the line's offset. * \param unit offset units * \see offsetUnit() */ void setOffsetUnit( QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; } - /** Returns the units for the line's offset. + /** + * Returns the units for the line's offset. * \see setOffsetUnit() */ QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; } @@ -772,7 +825,8 @@ class CORE_EXPORT QgsLineSymbolLayer : public QgsSymbolLayer QgsMapUnitScale mOffsetMapUnitScale; }; -/** \ingroup core +/** + * \ingroup core * \class QgsFillSymbolLayer */ class CORE_EXPORT QgsFillSymbolLayer : public QgsSymbolLayer diff --git a/src/core/symbology/qgssymbollayerregistry.h b/src/core/symbology/qgssymbollayerregistry.h index b75cd7aaa4f7..5ffae9552dc6 100644 --- a/src/core/symbology/qgssymbollayerregistry.h +++ b/src/core/symbology/qgssymbollayerregistry.h @@ -24,7 +24,8 @@ class QgsPathResolver; class QgsVectorLayer; class QgsSymbolLayerWidget SIP_EXTERNAL; -/** \ingroup core +/** + * \ingroup core Stores metadata about one symbol layer class. \note It's necessary to implement createSymbolLayer() function. @@ -52,7 +53,8 @@ class CORE_EXPORT QgsSymbolLayerAbstractMetadata //! Create a symbol layer of this type given the map of properties. virtual QgsSymbolLayer *createSymbolLayerFromSld( QDomElement & ) SIP_FACTORY { return nullptr; } - /** Resolve paths in symbol layer's properties (if there are any paths). + /** + * Resolve paths in symbol layer's properties (if there are any paths). * When saving is true, paths are converted from absolute to relative, * when saving is false, paths are converted from relative to absolute. * This ensures that paths in project files can be relative, but in symbol layer @@ -77,7 +79,8 @@ typedef QgsSymbolLayerWidget *( *QgsSymbolLayerWidgetFunc )( const QgsVectorLaye typedef QgsSymbolLayer *( *QgsSymbolLayerCreateFromSldFunc )( QDomElement & ) SIP_SKIP; typedef void ( *QgsSymbolLayerPathResolverFunc )( QgsStringMap &, const QgsPathResolver &, bool ) SIP_SKIP; -/** \ingroup core +/** + * \ingroup core Convenience metadata class that uses static functions to create symbol layer and its widget. */ class CORE_EXPORT QgsSymbolLayerMetadata : public QgsSymbolLayerAbstractMetadata @@ -131,7 +134,8 @@ class CORE_EXPORT QgsSymbolLayerMetadata : public QgsSymbolLayerAbstractMetadata }; -/** \ingroup core +/** + * \ingroup core * Registry of available symbol layer classes. * * QgsSymbolLayerRegistry is not usually directly created, but rather accessed through @@ -161,7 +165,8 @@ class CORE_EXPORT QgsSymbolLayerRegistry //! create a new instance of symbol layer given symbol layer name and SLD QgsSymbolLayer *createSymbolLayerFromSld( const QString &name, QDomElement &element ) const SIP_FACTORY; - /** Resolve paths in properties of a particular symbol layer. + /** + * Resolve paths in properties of a particular symbol layer. * This normally means converting relative paths to absolute paths when loading * and converting absolute paths to relative paths when saving. * \since QGIS 3.0 diff --git a/src/core/symbology/qgssymbollayerutils.h b/src/core/symbology/qgssymbollayerutils.h index afba020689ee..98ef1f00c677 100644 --- a/src/core/symbology/qgssymbollayerutils.h +++ b/src/core/symbology/qgssymbollayerutils.h @@ -46,7 +46,8 @@ class QPixmap; class QPointF; class QSize; -/** \ingroup core +/** + * \ingroup core * \class QgsSymbolLayerUtils */ class CORE_EXPORT QgsSymbolLayerUtils @@ -86,26 +87,30 @@ class CORE_EXPORT QgsSymbolLayerUtils static QString encodeSldBrushStyle( Qt::BrushStyle style ); static Qt::BrushStyle decodeSldBrushStyle( const QString &str ); - /** Encodes a QPointF to a string. + /** + * Encodes a QPointF to a string. * \see decodePoint() * \see encodeSize() */ static QString encodePoint( QPointF point ); - /** Decodes a QSizeF from a string. + /** + * Decodes a QSizeF from a string. * \see encodePoint() * \see decodeSize() */ static QPointF decodePoint( const QString &string ); - /** Encodes a QSizeF to a string. + /** + * Encodes a QSizeF to a string. * \see decodeSize() * \see encodePoint() * \since QGIS 3.0 */ static QString encodeSize( QSizeF size ); - /** Decodes a QSizeF from a string. + /** + * Decodes a QSizeF from a string. * \see encodeSize() * \see decodePoint() * \since QGIS 3.0 @@ -121,7 +126,8 @@ class CORE_EXPORT QgsSymbolLayerUtils static QString encodeSldRealVector( const QVector &v ); static QVector decodeSldRealVector( const QString &s ); - /** Encodes a render unit into an SLD unit of measure string. + /** + * Encodes a render unit into an SLD unit of measure string. * \param unit unit to encode * \param scaleFactor if specified, will be set to scale factor for unit of measure * \returns encoded string @@ -129,7 +135,8 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QString encodeSldUom( QgsUnitTypes::RenderUnit unit, double *scaleFactor ); - /** Decodes a SLD unit of measure string to a render unit. + /** + * Decodes a SLD unit of measure string to a render unit. * \param str string to decode * \param scaleFactor if specified, will be set to scale factor for unit of measure * \returns matching render unit @@ -137,7 +144,8 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QgsUnitTypes::RenderUnit decodeSldUom( const QString &str, double *scaleFactor ); - /** Returns the size scaled in pixels according to the uom attribute. + /** + * Returns the size scaled in pixels according to the uom attribute. * \param uom The uom attribute from SLD 1.1 version * \param size The original size * \returns the size in pixels @@ -150,7 +158,8 @@ class CORE_EXPORT QgsSymbolLayerUtils static QPainter::CompositionMode decodeBlendMode( const QString &s ); - /** Returns an icon preview for a color ramp. + /** + * Returns an icon preview for a color ramp. * \param symbol symbol * \param size target pixmap size * \param padding space between icon edge and symbol @@ -158,7 +167,8 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QIcon symbolPreviewIcon( QgsSymbol *symbol, QSize size, int padding = 0 ); - /** Returns a pixmap preview for a color ramp. + /** + * Returns a pixmap preview for a color ramp. * \param symbol symbol * \param size target pixmap size * \param padding space between icon edge and symbol @@ -168,7 +178,8 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QPixmap symbolPreviewPixmap( QgsSymbol *symbol, QSize size, int padding = 0, QgsRenderContext *customContext = nullptr ); - /** Draws a symbol layer preview to a QPicture + /** + * Draws a symbol layer preview to a QPicture * \param layer symbol layer to draw * \param units size units * \param size target size of preview picture @@ -179,7 +190,8 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QPicture symbolLayerPreviewPicture( QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit units, QSize size, const QgsMapUnitScale &scale = QgsMapUnitScale() ); - /** Draws a symbol layer preview to an icon. + /** + * Draws a symbol layer preview to an icon. * \param layer symbol layer to draw * \param u size units * \param size target size of preview icon @@ -189,7 +201,8 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QIcon symbolLayerPreviewIcon( QgsSymbolLayer *layer, QgsUnitTypes::RenderUnit u, QSize size, const QgsMapUnitScale &scale = QgsMapUnitScale() ); - /** Returns an icon preview for a color ramp. + /** + * Returns an icon preview for a color ramp. * \param ramp color ramp * \param size target icon size * \param padding space between icon edge and color ramp @@ -197,7 +210,8 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QIcon colorRampPreviewIcon( QgsColorRamp *ramp, QSize size, int padding = 0 ); - /** Returns a pixmap preview for a color ramp. + /** + * Returns a pixmap preview for a color ramp. * \param ramp color ramp * \param size target pixmap size * \param padding space between icon edge and color ramp @@ -210,14 +224,16 @@ class CORE_EXPORT QgsSymbolLayerUtils //! Returns the maximum estimated bleed for the symbol static double estimateMaxSymbolBleed( QgsSymbol *symbol, const QgsRenderContext &context ); - /** Attempts to load a symbol from a DOM element + /** + * Attempts to load a symbol from a DOM element * \param element DOM element representing symbol * \param context object to transform relative to absolute paths * \returns decoded symbol, if possible */ static QgsSymbol *loadSymbol( const QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY; - /** Attempts to load a symbol from a DOM element and cast it to a particular symbol + /** + * Attempts to load a symbol from a DOM element and cast it to a particular symbol * type. * \param element DOM element representing symbol * \param context object to transform relative to absolute paths @@ -246,7 +262,8 @@ class CORE_EXPORT QgsSymbolLayerUtils //! Writes a symbol definition to XML static QDomElement saveSymbol( const QString &symbolName, QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context ); - /** Returns a string representing the symbol. Can be used to test for equality + /** + * Returns a string representing the symbol. Can be used to test for equality * between symbols. * \since QGIS 2.12 */ @@ -319,7 +336,8 @@ class CORE_EXPORT QgsSymbolLayerUtils double offset = 0.0, const QVector *dashPattern = nullptr ); - /** Create ogr feature style string for brush + /** + * Create ogr feature style string for brush \param fillColr fill color*/ static QString ogrFeatureStyleBrush( const QColor &fillColr ); @@ -390,14 +408,16 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QgsSymbol *symbolFromMimeData( const QMimeData *data ) SIP_FACTORY; - /** Creates a color ramp from the settings encoded in an XML element + /** + * Creates a color ramp from the settings encoded in an XML element * \param element DOM element * \returns new color ramp. Caller takes responsibility for deleting the returned value. * \see saveColorRamp() */ static QgsColorRamp *loadColorRamp( QDomElement &element ) SIP_FACTORY; - /** Encodes a color ramp's settings to an XML element + /** + * Encodes a color ramp's settings to an XML element * \param name name of ramp * \param ramp color ramp to save * \param doc XML document @@ -525,7 +545,8 @@ class CORE_EXPORT QgsSymbolLayerUtils //! Blurs an image in place, e.g. creating Qt-independent drop shadows static void blurImageInPlace( QImage &image, QRect rect, int radius, bool alphaOnly ); - /** Converts a QColor into a premultiplied ARGB QColor value using a specified alpha value + /** + * Converts a QColor into a premultiplied ARGB QColor value using a specified alpha value * \since QGIS 2.3 */ static void premultiplyColor( QColor &rgb, int alpha ); @@ -541,7 +562,8 @@ class CORE_EXPORT QgsSymbolLayerUtils //! Return a list of svg files at the specified directory static QStringList listSvgFilesAt( const QString &directory ); - /** Get SVG symbol's path from its name. + /** + * Get SVG symbol's path from its name. * If the name is not absolute path the file is searched in SVG paths specified * in settings svg/searchPathsForSVG. */ @@ -559,7 +581,8 @@ class CORE_EXPORT QgsSymbolLayerUtils //! Calculate whether a point is within of a QPolygonF static bool pointInPolygon( const QPolygonF &points, QPointF point ); - /** Return a new valid expression instance for given field or expression string. + /** + * Return a new valid expression instance for given field or expression string. * If the input is not a valid expression, it is assumed that it is a field name and gets properly quoted. * If the string is empty, returns null pointer. * This is useful when accepting input which could be either a non-quoted field name or expression. @@ -567,7 +590,8 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QgsExpression *fieldOrExpressionToExpression( const QString &fieldOrExpression ) SIP_FACTORY; - /** Return a field name if the whole expression is just a name of the field . + /** + * Return a field name if the whole expression is just a name of the field . * Returns full expression string if the expression is more complex than just one field. * Using just expression->expression() method may return quoted field name, but that is not * wanted for saving (due to backward compatibility) or display in GUI. @@ -575,26 +599,30 @@ class CORE_EXPORT QgsSymbolLayerUtils */ static QString fieldOrExpressionFromExpression( QgsExpression *expression ); - /** Computes a sequence of about 'classes' equally spaced round values + /** + * Computes a sequence of about 'classes' equally spaced round values * which cover the range of values from 'minimum' to 'maximum'. * The values are chosen so that they are 1, 2 or 5 times a power of 10. * \since QGIS 2.10 */ static QList prettyBreaks( double minimum, double maximum, int classes ); - /** Rescales the given size based on the uomScale found in the props, if any is found, otherwise + /** + * Rescales the given size based on the uomScale found in the props, if any is found, otherwise * returns the value un-modified * \since QGIS 3.0 */ static double rescaleUom( double size, QgsUnitTypes::RenderUnit unit, const QgsStringMap &props ); - /** Rescales the given point based on the uomScale found in the props, if any is found, otherwise + /** + * Rescales the given point based on the uomScale found in the props, if any is found, otherwise * returns a copy of the original point * \since QGIS 3.0 */ static QPointF rescaleUom( QPointF point, QgsUnitTypes::RenderUnit unit, const QgsStringMap &props ) SIP_PYNAME( rescalePointUom ); - /** Rescales the given array based on the uomScale found in the props, if any is found, otherwise + /** + * Rescales the given array based on the uomScale found in the props, if any is found, otherwise * returns a copy of the original point * \since QGIS 3.0 */ diff --git a/src/core/symbology/qgsvectorfieldsymbollayer.h b/src/core/symbology/qgsvectorfieldsymbollayer.h index 1e58170ebd1e..03f33f5df175 100644 --- a/src/core/symbology/qgsvectorfieldsymbollayer.h +++ b/src/core/symbology/qgsvectorfieldsymbollayer.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgssymbollayer.h" -/** \ingroup core +/** + * \ingroup core * A symbol layer class for displaying displacement arrows based on point layer attributes*/ class CORE_EXPORT QgsVectorFieldSymbolLayer: public QgsMarkerSymbolLayer { @@ -92,13 +93,15 @@ class CORE_EXPORT QgsVectorFieldSymbolLayer: public QgsMarkerSymbolLayer void setMapUnitScale( const QgsMapUnitScale &scale ) override; QgsMapUnitScale mapUnitScale() const override; - /** Sets the units for the distance. + /** + * Sets the units for the distance. * \param unit distance units * \see distanceUnit() */ void setDistanceUnit( QgsUnitTypes::RenderUnit unit ) { mDistanceUnit = unit; } - /** Returns the units for the distance. + /** + * Returns the units for the distance. * \see setDistanceUnit() */ QgsUnitTypes::RenderUnit distanceUnit() const { return mDistanceUnit; } diff --git a/src/gui/attributetable/qgsattributetabledelegate.h b/src/gui/attributetable/qgsattributetabledelegate.h index 6b28adc5c443..df97392c4862 100644 --- a/src/gui/attributetable/qgsattributetabledelegate.h +++ b/src/gui/attributetable/qgsattributetabledelegate.h @@ -26,7 +26,8 @@ class QgsVectorLayer; class QgsAttributeTableModel; class QToolButton; -/** \ingroup gui +/** + * \ingroup gui * A delegate item class for QgsAttributeTable (see Qt documentation for * QItemDelegate). */ diff --git a/src/gui/attributetable/qgsattributetablefiltermodel.h b/src/gui/attributetable/qgsattributetablefiltermodel.h index 83aa619ec753..19afffb6b565 100644 --- a/src/gui/attributetable/qgsattributetablefiltermodel.h +++ b/src/gui/attributetable/qgsattributetablefiltermodel.h @@ -29,7 +29,8 @@ class QgsVectorLayerCache; class QgsMapCanvas; class QItemSelectionModel; -/** \ingroup gui +/** + * \ingroup gui * \class QgsAttributeTableFilterModel */ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, public QgsFeatureModel diff --git a/src/gui/attributetable/qgsattributetablemodel.h b/src/gui/attributetable/qgsattributetablemodel.h index 14299972ff20..d833fa29214e 100644 --- a/src/gui/attributetable/qgsattributetablemodel.h +++ b/src/gui/attributetable/qgsattributetablemodel.h @@ -36,7 +36,8 @@ class QgsMapLayerAction; class QgsEditorWidgetFactory; class QgsFieldFormatter; -/** \ingroup gui +/** + * \ingroup gui * A model backed by a QgsVectorLayerCache which is able to provide * feature/attribute information to a QAbstractItemView. * @@ -260,7 +261,8 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel */ virtual void loadLayer(); - /** Handles updating the model when the conditional style for a field changes. + /** + * Handles updating the model when the conditional style for a field changes. * \param fieldName name of field whose conditional style has changed * \since QGIS 2.12 */ diff --git a/src/gui/attributetable/qgsattributetableview.h b/src/gui/attributetable/qgsattributetableview.h index 20f129834843..5d9d962bda2a 100644 --- a/src/gui/attributetable/qgsattributetableview.h +++ b/src/gui/attributetable/qgsattributetableview.h @@ -35,7 +35,8 @@ class QMenu; class QProgressDialog; class QgsAttributeTableConfig; -/** \ingroup gui +/** + * \ingroup gui * \brief * Provides a table view of features of a QgsVectorLayer. * @@ -138,7 +139,8 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView */ void willShowContextMenu( QMenu *menu, const QModelIndex &atIndex ); - /** Emitted when a column in the view has been resized. + /** + * Emitted when a column in the view has been resized. * \param column column index (starts at 0) * \param width new width in pixel * \since QGIS 2.16 diff --git a/src/gui/attributetable/qgsdualview.h b/src/gui/attributetable/qgsdualview.h index 915935bbf9d0..3c1c67fda137 100644 --- a/src/gui/attributetable/qgsdualview.h +++ b/src/gui/attributetable/qgsdualview.h @@ -32,7 +32,8 @@ class QSignalMapper; class QgsMapLayerAction; class QgsScrollArea; -/** \ingroup gui +/** + * \ingroup gui * This widget is used to show the attributes of a set of features of a QgsVectorLayer. * The attributes can be edited. * It supports two different layouts: the table layout, in which the attributes for the features @@ -216,12 +217,14 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas void openConditionalStyles(); - /** Sets whether multi edit mode is enabled. + /** + * Sets whether multi edit mode is enabled. * \since QGIS 2.16 */ void setMultiEditEnabled( bool enabled ); - /** Toggles whether search mode should be enabled in the form. + /** + * Toggles whether search mode should be enabled in the form. * \param enabled set to true to switch on search mode * \since QGIS 2.16 */ @@ -246,14 +249,16 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas */ void filterChanged(); - /** Is emitted when a filter expression is set using the view. + /** + * Is emitted when a filter expression is set using the view. * \param expression filter expression * \param type filter type * \since QGIS 2.16 */ void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type ); - /** Emitted when the form changes mode. + /** + * Emitted when the form changes mode. * \param mode new mode */ void formModeChanged( QgsAttributeForm::Mode mode ); @@ -368,7 +373,8 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas friend class TestQgsAttributeTable; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsAttributeTableAction */ class GUI_EXPORT QgsAttributeTableAction : public QAction @@ -399,7 +405,8 @@ class GUI_EXPORT QgsAttributeTableAction : public QAction QModelIndex mFieldIdx; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsAttributeTableMapLayerAction */ class GUI_EXPORT QgsAttributeTableMapLayerAction : public QAction diff --git a/src/gui/attributetable/qgsfeaturelistmodel.h b/src/gui/attributetable/qgsfeaturelistmodel.h index cd29554c5b9d..abd2512210fe 100644 --- a/src/gui/attributetable/qgsfeaturelistmodel.h +++ b/src/gui/attributetable/qgsfeaturelistmodel.h @@ -32,7 +32,8 @@ class QgsAttributeTableFilterModel; class QgsAttributeTableModel; class QgsVectorLayerCache; -/** \ingroup gui +/** + * \ingroup gui * \class QgsFeatureListModel */ class GUI_EXPORT QgsFeatureListModel : public QAbstractProxyModel, public QgsFeatureModel diff --git a/src/gui/attributetable/qgsfeaturelistview.h b/src/gui/attributetable/qgsfeaturelistview.h index fa08217ab8e6..44c32367d45e 100644 --- a/src/gui/attributetable/qgsfeaturelistview.h +++ b/src/gui/attributetable/qgsfeaturelistview.h @@ -34,7 +34,8 @@ class QgsVectorLayerCache; class QgsFeatureListViewDelegate; class QRect; -/** \ingroup gui +/** + * \ingroup gui * Shows a list of features and renders a edit button next to each feature. * * Accepts a display expression to define the way, features are rendered. diff --git a/src/gui/attributetable/qgsfeaturelistviewdelegate.h b/src/gui/attributetable/qgsfeaturelistviewdelegate.h index c275e1486524..28ee3a78d4fe 100644 --- a/src/gui/attributetable/qgsfeaturelistviewdelegate.h +++ b/src/gui/attributetable/qgsfeaturelistviewdelegate.h @@ -24,7 +24,8 @@ class QgsFeatureListModel; class QgsFeatureSelectionModel; class QPosition; -/** \ingroup gui +/** + * \ingroup gui * \class QgsFeatureListViewDelegate */ class GUI_EXPORT QgsFeatureListViewDelegate : public QItemDelegate diff --git a/src/gui/attributetable/qgsfeaturemodel.h b/src/gui/attributetable/qgsfeaturemodel.h index e83c690ae9b9..9269ee2131a8 100644 --- a/src/gui/attributetable/qgsfeaturemodel.h +++ b/src/gui/attributetable/qgsfeaturemodel.h @@ -19,7 +19,8 @@ #include "qgsfeature.h" // QgsFeatureId #include -/** \ingroup gui +/** + * \ingroup gui * \class QgsFeatureModel */ class GUI_EXPORT QgsFeatureModel diff --git a/src/gui/attributetable/qgsfeatureselectionmodel.h b/src/gui/attributetable/qgsfeatureselectionmodel.h index 801181d7f847..2c85a5962ed5 100644 --- a/src/gui/attributetable/qgsfeatureselectionmodel.h +++ b/src/gui/attributetable/qgsfeatureselectionmodel.h @@ -25,7 +25,8 @@ class QgsVectorLayer; class QgsFeatureModel; class QgsIFeatureSelectionManager; -/** \ingroup gui +/** + * \ingroup gui * \class QgsFeatureSelectionModel */ class GUI_EXPORT QgsFeatureSelectionModel : public QItemSelectionModel diff --git a/src/gui/attributetable/qgsfieldconditionalformatwidget.h b/src/gui/attributetable/qgsfieldconditionalformatwidget.h index b52baa31e28b..ea2e4f430601 100644 --- a/src/gui/attributetable/qgsfieldconditionalformatwidget.h +++ b/src/gui/attributetable/qgsfieldconditionalformatwidget.h @@ -27,7 +27,8 @@ #include "qgsconditionalstyle.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsFieldConditionalFormatWidget * A widget for customising conditional formatting options. * \since QGIS 2.12 @@ -37,21 +38,25 @@ class GUI_EXPORT QgsFieldConditionalFormatWidget : public QWidget, private Ui::Q Q_OBJECT public: - /** Constructor for QgsFieldConditionalFormatWidget. + /** + * Constructor for QgsFieldConditionalFormatWidget. * \param parent parent widget */ explicit QgsFieldConditionalFormatWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Switches the widget to the rules page. + /** + * Switches the widget to the rules page. */ void viewRules(); - /** Sets the vector layer associated with the widget. + /** + * Sets the vector layer associated with the widget. * \param layer vector layer */ void setLayer( QgsVectorLayer *layer ); - /** Switches the widget to the edit style mode for the specified style. + /** + * Switches the widget to the edit style mode for the specified style. * \param index index of conditional style to edit * \param style initial conditional styling options */ @@ -62,7 +67,8 @@ class GUI_EXPORT QgsFieldConditionalFormatWidget : public QWidget, private Ui::Q */ void loadStyle( const QgsConditionalStyle &style ); - /** Resets the formatting options to their default state. + /** + * Resets the formatting options to their default state. */ void reset(); @@ -81,7 +87,8 @@ class GUI_EXPORT QgsFieldConditionalFormatWidget : public QWidget, private Ui::Q signals: - /** Emitted when the conditional styling rules are updated. + /** + * Emitted when the conditional styling rules are updated. * \param fieldName name of field whose rules have been modified. */ void rulesUpdated( const QString &fieldName ); diff --git a/src/gui/attributetable/qgsgenericfeatureselectionmanager.h b/src/gui/attributetable/qgsgenericfeatureselectionmanager.h index 8239f1938e23..5182b2888a2c 100644 --- a/src/gui/attributetable/qgsgenericfeatureselectionmanager.h +++ b/src/gui/attributetable/qgsgenericfeatureselectionmanager.h @@ -22,7 +22,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * This selection manager synchronizes a local set of selected features with an attribute table. * If you want to synchronize the attribute table selection with the map canvas selection, you * should use QgsVectorLayerSelectionManager instead. diff --git a/src/gui/attributetable/qgsifeatureselectionmanager.h b/src/gui/attributetable/qgsifeatureselectionmanager.h index 876503b2ce32..a3dcd3da1f05 100644 --- a/src/gui/attributetable/qgsifeatureselectionmanager.h +++ b/src/gui/attributetable/qgsifeatureselectionmanager.h @@ -22,7 +22,8 @@ #include "qgsfeature.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Is an interface class to abstract feature selection handling. * * e.g. QgsVectorLayer implements this interface to manage its selections. diff --git a/src/gui/attributetable/qgsorganizetablecolumnsdialog.h b/src/gui/attributetable/qgsorganizetablecolumnsdialog.h index 89982f41a9f3..faeb9d6ea941 100644 --- a/src/gui/attributetable/qgsorganizetablecolumnsdialog.h +++ b/src/gui/attributetable/qgsorganizetablecolumnsdialog.h @@ -26,7 +26,8 @@ class QgsVectorLayer; -/** \class QgsOrganizeTableColumnsDialog +/** + * \class QgsOrganizeTableColumnsDialog * \ingroup gui * Dialog for organising (hiding and reordering) columns in the attributes table. * \since QGIS 2.16 diff --git a/src/gui/attributetable/qgsvectorlayerselectionmanager.h b/src/gui/attributetable/qgsvectorlayerselectionmanager.h index 962a26286d64..8e7518ea57b1 100644 --- a/src/gui/attributetable/qgsvectorlayerselectionmanager.h +++ b/src/gui/attributetable/qgsvectorlayerselectionmanager.h @@ -24,7 +24,8 @@ SIP_NO_FILE class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsVectorLayerSelectionManager * \note not available in Python bindings */ diff --git a/src/gui/auth/qgsauthauthoritieseditor.h b/src/gui/auth/qgsauthauthoritieseditor.h index d85cb8adbb5f..7fc63913eaa5 100644 --- a/src/gui/auth/qgsauthauthoritieseditor.h +++ b/src/gui/auth/qgsauthauthoritieseditor.h @@ -30,7 +30,8 @@ class QgsMessageBar; class QMenu; class QAction; -/** \ingroup gui +/** + * \ingroup gui * Widget for viewing and editing authentication identities database */ class GUI_EXPORT QgsAuthAuthoritiesEditor : public QWidget, private Ui::QgsAuthAuthoritiesEditor diff --git a/src/gui/auth/qgsauthcertificateinfo.h b/src/gui/auth/qgsauthcertificateinfo.h index 3977c8c1258e..30e7174c272f 100644 --- a/src/gui/auth/qgsauthcertificateinfo.h +++ b/src/gui/auth/qgsauthcertificateinfo.h @@ -32,7 +32,8 @@ #include "qgsauthcertutils.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Widget for viewing detailed info on a certificate and its hierarchical trust chain */ class GUI_EXPORT QgsAuthCertInfo : public QWidget, private Ui::QgsAuthCertInfo @@ -135,7 +136,8 @@ class GUI_EXPORT QgsAuthCertInfo : public QWidget, private Ui::QgsAuthCertInfo //////////////// Embed in dialog /////////////////// -/** \ingroup gui +/** + * \ingroup gui * Dialog wrapper for widget displaying detailed info on a certificate and its hierarchical trust chain */ class GUI_EXPORT QgsAuthCertInfoDialog : public QDialog @@ -159,7 +161,8 @@ class GUI_EXPORT QgsAuthCertInfoDialog : public QDialog //! Get access to embedded info widget QgsAuthCertInfo *certInfoWidget() { return mCertInfoWdgt; } - /** Whether the trust cache has been rebuilt + /** + * Whether the trust cache has been rebuilt * \note This happens when a trust policy has been adjusted for any cert in the hierarchy */ bool trustCacheRebuilt() { return mCertInfoWdgt->trustCacheRebuilt(); } diff --git a/src/gui/auth/qgsauthcertificatemanager.h b/src/gui/auth/qgsauthcertificatemanager.h index 21fbb15031ba..72e10609b0df 100644 --- a/src/gui/auth/qgsauthcertificatemanager.h +++ b/src/gui/auth/qgsauthcertificatemanager.h @@ -25,7 +25,8 @@ #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Wrapper widget to manage available certificate editors */ class GUI_EXPORT QgsAuthCertEditors : public QWidget, private Ui::QgsAuthCertManager @@ -50,7 +51,8 @@ class GUI_EXPORT QgsAuthCertEditors : public QWidget, private Ui::QgsAuthCertMan //////////////// Embed in dialog /////////////////// -/** \ingroup gui +/** + * \ingroup gui * Dialog wrapper for widget to manage available certificate editors */ class GUI_EXPORT QgsAuthCertManager : public QDialog diff --git a/src/gui/auth/qgsauthcerttrustpolicycombobox.h b/src/gui/auth/qgsauthcerttrustpolicycombobox.h index cfc206e81c47..b560588f2e14 100644 --- a/src/gui/auth/qgsauthcerttrustpolicycombobox.h +++ b/src/gui/auth/qgsauthcerttrustpolicycombobox.h @@ -22,7 +22,8 @@ #include "qgsauthcertutils.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Widget for editing the trust policy associated with a Certificate (Intermediate) Authority */ class GUI_EXPORT QgsAuthCertTrustPolicyComboBox : public QComboBox diff --git a/src/gui/auth/qgsauthconfigedit.h b/src/gui/auth/qgsauthconfigedit.h index 2fc7d862e683..9412b4169d76 100644 --- a/src/gui/auth/qgsauthconfigedit.h +++ b/src/gui/auth/qgsauthconfigedit.h @@ -28,7 +28,8 @@ class QgsAuthMethodEdit; -/** \ingroup gui +/** + * \ingroup gui * Widget for editing an authentication configuration * \note not available in Python bindings */ diff --git a/src/gui/auth/qgsauthconfigeditor.h b/src/gui/auth/qgsauthconfigeditor.h index 8d692d6f22c3..9d9fe02579f8 100644 --- a/src/gui/auth/qgsauthconfigeditor.h +++ b/src/gui/auth/qgsauthconfigeditor.h @@ -27,7 +27,8 @@ class QgsMessageBar; -/** \ingroup gui +/** + * \ingroup gui * Widget for editing authentication configuration database */ class GUI_EXPORT QgsAuthConfigEditor : public QWidget, private Ui::QgsAuthConfigEditor diff --git a/src/gui/auth/qgsauthconfigidedit.h b/src/gui/auth/qgsauthconfigidedit.h index 5b20776963b2..be357dbbf337 100644 --- a/src/gui/auth/qgsauthconfigidedit.h +++ b/src/gui/auth/qgsauthconfigidedit.h @@ -24,7 +24,8 @@ #define SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \brief Custom widget for editing an authentication configuration ID * \note Validates the input against the database and for ID's 7-character alphanumeric syntax * \note not available in Python bindings diff --git a/src/gui/auth/qgsauthconfigselect.h b/src/gui/auth/qgsauthconfigselect.h index 3df9425764ad..45e9779d3e34 100644 --- a/src/gui/auth/qgsauthconfigselect.h +++ b/src/gui/auth/qgsauthconfigselect.h @@ -26,7 +26,8 @@ #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Selector widget for authentication configs */ class GUI_EXPORT QgsAuthConfigSelect : public QWidget, private Ui::QgsAuthConfigSelect @@ -101,7 +102,8 @@ class GUI_EXPORT QgsAuthConfigSelect : public QWidget, private Ui::QgsAuthConfig class QPushButton; -/** \ingroup gui +/** + * \ingroup gui * Dialog wrapper of select widget to edit an authcfg in a data source URI */ class GUI_EXPORT QgsAuthConfigUriEdit : public QDialog, private Ui::QgsAuthConfigUriEdit diff --git a/src/gui/auth/qgsautheditorwidgets.h b/src/gui/auth/qgsautheditorwidgets.h index e979481f52b2..e6e4f83c14b2 100644 --- a/src/gui/auth/qgsautheditorwidgets.h +++ b/src/gui/auth/qgsautheditorwidgets.h @@ -23,7 +23,8 @@ #include "ui_qgsauthmethodplugins.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Dialog for viewing available authentication method plugins */ class GUI_EXPORT QgsAuthMethodPlugins : public QDialog, private Ui::QgsAuthMethodPlugins @@ -49,7 +50,8 @@ class GUI_EXPORT QgsAuthMethodPlugins : public QDialog, private Ui::QgsAuthMetho }; -/** \ingroup gui +/** + * \ingroup gui * Wrapper widget for available authentication editors */ class GUI_EXPORT QgsAuthEditorWidgets : public QWidget, private Ui::QgsAuthEditors diff --git a/src/gui/auth/qgsauthguiutils.h b/src/gui/auth/qgsauthguiutils.h index 47c0f4c3721c..967b07127094 100644 --- a/src/gui/auth/qgsauthguiutils.h +++ b/src/gui/auth/qgsauthguiutils.h @@ -26,7 +26,8 @@ class QgsMessageBar; #define SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \brief Utility functions for use by authentication GUI widgets or standalone apps * \note not available in Python bindings */ diff --git a/src/gui/auth/qgsauthidentitieseditor.h b/src/gui/auth/qgsauthidentitieseditor.h index 9e5e792ce235..ea0c32c4d180 100644 --- a/src/gui/auth/qgsauthidentitieseditor.h +++ b/src/gui/auth/qgsauthidentitieseditor.h @@ -27,7 +27,8 @@ class QgsMessageBar; -/** \ingroup gui +/** + * \ingroup gui * Widget for viewing and editing authentication identities database */ class GUI_EXPORT QgsAuthIdentitiesEditor : public QWidget, private Ui::QgsAuthIdentitiesEditor diff --git a/src/gui/auth/qgsauthimportcertdialog.h b/src/gui/auth/qgsauthimportcertdialog.h index fde9d1696c7d..8ef4e3d175b8 100644 --- a/src/gui/auth/qgsauthimportcertdialog.h +++ b/src/gui/auth/qgsauthimportcertdialog.h @@ -26,7 +26,8 @@ class QPushButton; -/** \ingroup gui +/** + * \ingroup gui * Widget for importing a certificate into the authentication database */ class GUI_EXPORT QgsAuthImportCertDialog : public QDialog, private Ui::QgsAuthImportCertDialog diff --git a/src/gui/auth/qgsauthimportidentitydialog.h b/src/gui/auth/qgsauthimportidentitydialog.h index 578683c13346..85a75b18e88f 100644 --- a/src/gui/auth/qgsauthimportidentitydialog.h +++ b/src/gui/auth/qgsauthimportidentitydialog.h @@ -28,7 +28,8 @@ #include "qgsauthconfig.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Widget for importing an identity certificate/key bundle into the authentication database */ class GUI_EXPORT QgsAuthImportIdentityDialog : public QDialog, private Ui::QgsAuthImportIdentityDialog @@ -68,7 +69,8 @@ class GUI_EXPORT QgsAuthImportIdentityDialog : public QDialog, private Ui::QgsAu //! Get identity type QgsAuthImportIdentityDialog::IdentityType identityType(); - /** Get certificate/key bundle to be imported. + /** + * Get certificate/key bundle to be imported. * \note not available in Python bindings */ const QPair certBundleToImport() SIP_SKIP; diff --git a/src/gui/auth/qgsauthmasterpassresetdialog.h b/src/gui/auth/qgsauthmasterpassresetdialog.h index 32876c5dbc63..6cdd2c4a57ce 100644 --- a/src/gui/auth/qgsauthmasterpassresetdialog.h +++ b/src/gui/auth/qgsauthmasterpassresetdialog.h @@ -29,7 +29,8 @@ class QVBoxLayout; class QgsMessageBar; -/** \ingroup gui +/** + * \ingroup gui * \brief Dialog to verify current master password and initiate reset of * authentication database with a new password * \note not available in Python bindings diff --git a/src/gui/auth/qgsauthmethodedit.h b/src/gui/auth/qgsauthmethodedit.h index 458e1bce42c2..ef22b0860ab1 100644 --- a/src/gui/auth/qgsauthmethodedit.h +++ b/src/gui/auth/qgsauthmethodedit.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Abstract base class for the edit widget of authentication method plugins */ class GUI_EXPORT QgsAuthMethodEdit : public QWidget diff --git a/src/gui/auth/qgsauthserverseditor.h b/src/gui/auth/qgsauthserverseditor.h index 08e311a56821..1258c3bfd8db 100644 --- a/src/gui/auth/qgsauthserverseditor.h +++ b/src/gui/auth/qgsauthserverseditor.h @@ -26,7 +26,8 @@ class QgsMessageBar; -/** \ingroup gui +/** + * \ingroup gui * Widget for viewing and editing servers in authentication database */ class GUI_EXPORT QgsAuthServersEditor : public QWidget, private Ui::QgsAuthServersEditor diff --git a/src/gui/auth/qgsauthsettingswidget.h b/src/gui/auth/qgsauthsettingswidget.h index e66e7407005b..a6a841a6ac50 100644 --- a/src/gui/auth/qgsauthsettingswidget.h +++ b/src/gui/auth/qgsauthsettingswidget.h @@ -23,7 +23,8 @@ #include -/** \ingroup gui +/** + * \ingroup gui * Widget for entering authentication credentials both in the form username/password * and by using QGIS Authentication Database and its authentication configurations. * diff --git a/src/gui/auth/qgsauthsslconfigwidget.h b/src/gui/auth/qgsauthsslconfigwidget.h index 8d452a5cbaba..a7786f3a7bc7 100644 --- a/src/gui/auth/qgsauthsslconfigwidget.h +++ b/src/gui/auth/qgsauthsslconfigwidget.h @@ -32,7 +32,8 @@ class QComboBox; class QGroupBox; class QSpinBox; -/** \ingroup gui +/** + * \ingroup gui * Widget for editing an SSL server configuration */ class GUI_EXPORT QgsAuthSslConfigWidget : public QWidget, private Ui::QgsAuthSslConfigWidget @@ -76,7 +77,8 @@ class GUI_EXPORT QgsAuthSslConfigWidget : public QWidget, private Ui::QgsAuthSsl //! Get the client's peer verify mode for connections QSslSocket::PeerVerifyMode sslPeerVerifyMode(); - /** Get the client's peer verify depth for connections + /** + * Get the client's peer verify depth for connections * \note Value of 0 = unlimited */ int sslPeerVerifyDepth(); @@ -182,7 +184,8 @@ class GUI_EXPORT QgsAuthSslConfigWidget : public QWidget, private Ui::QgsAuthSsl //////////////// Embed in dialog /////////////////// -/** \ingroup gui +/** + * \ingroup gui * Dialog wrapper of widget for editing an SSL server configuration */ class GUI_EXPORT QgsAuthSslConfigDialog : public QDialog diff --git a/src/gui/auth/qgsauthsslerrorsdialog.h b/src/gui/auth/qgsauthsslerrorsdialog.h index fe15f394f908..409184970a1c 100644 --- a/src/gui/auth/qgsauthsslerrorsdialog.h +++ b/src/gui/auth/qgsauthsslerrorsdialog.h @@ -27,7 +27,8 @@ class QNetworkReply; class QPushButton; -/** \ingroup gui +/** + * \ingroup gui * Widget for reporting SSL errors and offering an option to store an SSL server exception into the authentication database */ class GUI_EXPORT QgsAuthSslErrorsDialog : public QDialog, private Ui::QgsAuthSslErrorsDialog diff --git a/src/gui/auth/qgsauthsslimportdialog.h b/src/gui/auth/qgsauthsslimportdialog.h index fd9bf06cb47e..c91d40af8754 100644 --- a/src/gui/auth/qgsauthsslimportdialog.h +++ b/src/gui/auth/qgsauthsslimportdialog.h @@ -75,7 +75,8 @@ class QSslSocket; class QTimer; -/** \ingroup gui +/** + * \ingroup gui * Widget for importing an SSL server certificate exception into the authentication database */ class GUI_EXPORT QgsAuthSslImportDialog : public QDialog, private Ui::QgsAuthSslTestDialog diff --git a/src/gui/auth/qgsauthtrustedcasdialog.h b/src/gui/auth/qgsauthtrustedcasdialog.h index 4406d936bd91..1361181e77e9 100644 --- a/src/gui/auth/qgsauthtrustedcasdialog.h +++ b/src/gui/auth/qgsauthtrustedcasdialog.h @@ -28,7 +28,8 @@ class QgsMessageBar; -/** \ingroup gui +/** + * \ingroup gui * Widget for listing trusted Certificate (Intermediate) Authorities used in secure connections */ class GUI_EXPORT QgsAuthTrustedCAsDialog : public QDialog, private Ui::QgsAuthTrustedCAsDialog diff --git a/src/gui/editorwidgets/core/qgseditorconfigwidget.h b/src/gui/editorwidgets/core/qgseditorconfigwidget.h index 5e423613cee0..b1ceb0b122e3 100644 --- a/src/gui/editorwidgets/core/qgseditorconfigwidget.h +++ b/src/gui/editorwidgets/core/qgseditorconfigwidget.h @@ -26,7 +26,8 @@ class QgsVectorLayer; class QgsPropertyOverrideButton; -/** \ingroup gui +/** + * \ingroup gui * This class should be subclassed for every configurable editor widget type. * * It implements the GUI configuration widget and transforms this to/from a configuration. @@ -80,7 +81,8 @@ class GUI_EXPORT QgsEditorConfigWidget : public QWidget, public QgsExpressionCon signals: - /** Emitted when the configuration of the widget is changed. + /** + * Emitted when the configuration of the widget is changed. * \since QGIS 3.0 */ void changed(); diff --git a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp index 29bcced7c2a4..48bd4ba384ec 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp +++ b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp @@ -17,7 +17,8 @@ #include "qgsvectordataprovider.h" #include "qgsgui.h" -/** \ingroup gui +/** + * \ingroup gui * Widget auto conf plugin that guesses what widget type to use in function of what the widgets support. * * \note not available in Python bindings @@ -54,7 +55,8 @@ class FromFactoriesPlugin: public QgsEditorWidgetAutoConfPlugin }; -/** \ingroup gui +/** + * \ingroup gui * Widget auto conf plugin that reads the widget setup to use from what the data provider says. * * \note not available in Python bindings diff --git a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h index ca0e166db35b..3097e5166a67 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h @@ -23,7 +23,8 @@ class QgsVectorLayer; class QgsEditorWidgetSetup; -/** \ingroup gui +/** + * \ingroup gui * Base class for plugins allowing to pick automatically a widget type for editing fields. * * \since QGIS 3.0 @@ -51,7 +52,8 @@ class GUI_EXPORT QgsEditorWidgetAutoConfPlugin ///@cond PRIVATE -/** \ingroup gui +/** + * \ingroup gui * Class that allows registering plugins to pick automatically a widget type for editing fields. * This class has only one instance, owned by the QgsEditorWidgetRegistry singleton * diff --git a/src/gui/editorwidgets/core/qgseditorwidgetfactory.h b/src/gui/editorwidgets/core/qgseditorwidgetfactory.h index 1055a3637c81..4adfc6b9fdee 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetfactory.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetfactory.h @@ -30,7 +30,8 @@ class QgsVectorLayer; class QWidget; class QgsSearchWidgetWrapper; -/** \ingroup gui +/** + * \ingroup gui * Every attribute editor widget needs a factory, which inherits this class * * It provides metadata for the widgets such as the name (human readable), it serializes diff --git a/src/gui/editorwidgets/core/qgseditorwidgetregistry.h b/src/gui/editorwidgets/core/qgseditorwidgetregistry.h index d8863006c885..58fd8bf991e9 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetregistry.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetregistry.h @@ -35,7 +35,8 @@ class QgsEditorConfigWidget; class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * This class manages all known edit widget factories. * * QgsEditorWidgetRegistry is not usually directly created, but rather accessed through diff --git a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h index 151b876fbe83..22f4b0b553ed 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h @@ -27,7 +27,8 @@ class QgsField; #include "qgswidgetwrapper.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Manages an editor widget * Widget and wrapper share the same parent * @@ -124,7 +125,8 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper */ virtual void setEnabled( bool enabled ) override; - /** Sets the widget to display in an indeterminate "mixed value" state. + /** + * Sets the widget to display in an indeterminate "mixed value" state. * \since QGIS 2.16 */ virtual void showIndeterminateState() {} diff --git a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h index 342539945fb6..dcddaaeab5cf 100644 --- a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h @@ -77,7 +77,8 @@ class QgsField; }; #endif -/** \ingroup gui +/** + * \ingroup gui * Manages an editor widget * Widget and wrapper share the same parent * @@ -116,19 +117,22 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper }; Q_DECLARE_FLAGS( FilterFlags, FilterFlag ) - /** Returns a list of exclusive filter flags, which cannot be combined with other flags (e.g., EqualTo/NotEqualTo) + /** + * Returns a list of exclusive filter flags, which cannot be combined with other flags (e.g., EqualTo/NotEqualTo) * \since QGIS 2.16 * \see nonExclusiveFilterFlags() */ static QList< QgsSearchWidgetWrapper::FilterFlag > exclusiveFilterFlags(); - /** Returns a list of non-exclusive filter flags, which can be combined with other flags (e.g., CaseInsensitive) + /** + * Returns a list of non-exclusive filter flags, which can be combined with other flags (e.g., CaseInsensitive) * \since QGIS 2.16 * \see exclusiveFilterFlags() */ static QList< QgsSearchWidgetWrapper::FilterFlag > nonExclusiveFilterFlags(); - /** Returns a translated string representing a filter flag. + /** + * Returns a translated string representing a filter flag. * \param flag flag to convert to string * \since QGIS 2.16 */ @@ -143,13 +147,15 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper */ explicit QgsSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns filter flags supported by the search widget. + /** + * Returns filter flags supported by the search widget. * \since QGIS 2.16 * \see defaultFlags() */ virtual FilterFlags supportedFlags() const; - /** Returns the filter flags which should be set by default for the search widget. + /** + * Returns the filter flags which should be set by default for the search widget. * \since QGIS 2.16 * \see supportedFlags() */ @@ -172,7 +178,8 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper */ virtual bool applyDirectly() = 0; - /** Creates a filter expression based on the current state of the search widget + /** + * Creates a filter expression based on the current state of the search widget * and the specified filter flags. * \param flags filter flags * \returns filter expression @@ -183,12 +190,14 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper public slots: - /** Clears the widget's current value and resets it back to the default state + /** + * Clears the widget's current value and resets it back to the default state * \since QGIS 2.16 */ virtual void clearWidget() {} - /** Toggles whether the search widget is enabled or disabled. + /** + * Toggles whether the search widget is enabled or disabled. * \param enabled set to true to enable widget */ virtual void setEnabled( bool enabled ) override { Q_UNUSED( enabled ); } @@ -201,12 +210,14 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper */ void expressionChanged( const QString &exp ); - /** Emitted when a user changes the value of the search widget. + /** + * Emitted when a user changes the value of the search widget. * \since QGIS 2.16 */ void valueChanged(); - /** Emitted when a user changes the value of the search widget back + /** + * Emitted when a user changes the value of the search widget back * to an empty, default state. * \since QGIS 2.16 */ diff --git a/src/gui/editorwidgets/core/qgswidgetwrapper.h b/src/gui/editorwidgets/core/qgswidgetwrapper.h index 446f4fb4330a..ab22daaee4a5 100644 --- a/src/gui/editorwidgets/core/qgswidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgswidgetwrapper.h @@ -35,7 +35,8 @@ class QgsVectorLayer; % End #endif -/** \ingroup gui +/** + * \ingroup gui * Manages an editor widget * Widget and wrapper share the same parent * @@ -173,7 +174,8 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject virtual bool valid() const = 0; - /** Returns a reference to the editor widget's property collection, used for data defined overrides. + /** + * Returns a reference to the editor widget's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() * @@ -181,13 +183,15 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject */ QgsPropertyCollection &dataDefinedProperties() { return mPropertyCollection; } SIP_SKIP - /** Returns a reference to the editor widget's property collection, used for data defined overrides. + /** + * Returns a reference to the editor widget's property collection, used for data defined overrides. * \since QGIS 3.0 * \see setDataDefinedProperties() */ const QgsPropertyCollection &dataDefinedProperties() const { return mPropertyCollection; } - /** Sets the editor widget's property collection, used for data defined overrides. + /** + * Sets the editor widget's property collection, used for data defined overrides. * \param collection property collection. Existing properties will be replaced. * \since QGIS 3.0 * \see dataDefinedProperties() diff --git a/src/gui/editorwidgets/qgscheckboxconfigdlg.h b/src/gui/editorwidgets/qgscheckboxconfigdlg.h index c0d227cc16f5..e62cd1d0bd7a 100644 --- a/src/gui/editorwidgets/qgscheckboxconfigdlg.h +++ b/src/gui/editorwidgets/qgscheckboxconfigdlg.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsCheckBoxConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h b/src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h index ab910164b672..83e03436df08 100644 --- a/src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h @@ -27,7 +27,8 @@ class QCheckBox; class QgsCheckboxWidgetFactory; -/** \ingroup gui +/** + * \ingroup gui * \class QgsCheckboxSearchWidgetWrapper * Wraps a checkbox edit widget for searching. * \since QGIS 2.16 @@ -39,14 +40,16 @@ class GUI_EXPORT QgsCheckboxSearchWidgetWrapper : public QgsSearchWidgetWrapper public: - /** Constructor for QgsCheckboxSearchWidgetWrapper. + /** + * Constructor for QgsCheckboxSearchWidgetWrapper. * \param vl associated vector layer * \param fieldIdx index of associated field * \param parent parent widget */ explicit QgsCheckboxSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a variant representing the current state of the widget. + /** + * Returns a variant representing the current state of the widget. * \note this will not be a boolean true or false value, it will instead * be the values configured to represent checked and unchecked states in * the editor widget configuration. diff --git a/src/gui/editorwidgets/qgscheckboxwidgetfactory.h b/src/gui/editorwidgets/qgscheckboxwidgetfactory.h index cacf2c57f1e7..b985dbc118c8 100644 --- a/src/gui/editorwidgets/qgscheckboxwidgetfactory.h +++ b/src/gui/editorwidgets/qgscheckboxwidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsCheckboxWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgscheckboxwidgetwrapper.h b/src/gui/editorwidgets/qgscheckboxwidgetwrapper.h index 7a60d131989a..9dc7558d7caf 100644 --- a/src/gui/editorwidgets/qgscheckboxwidgetwrapper.h +++ b/src/gui/editorwidgets/qgscheckboxwidgetwrapper.h @@ -24,7 +24,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Wraps a checkbox widget. This will offer a checkbox to represent boolean values. * * Options: diff --git a/src/gui/editorwidgets/qgsclassificationwidgetwrapper.h b/src/gui/editorwidgets/qgsclassificationwidgetwrapper.h index 6b50fa6e18de..658b9a51d63b 100644 --- a/src/gui/editorwidgets/qgsclassificationwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsclassificationwidgetwrapper.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsClassificationWidgetWrapper * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsclassificationwidgetwrapperfactory.h b/src/gui/editorwidgets/qgsclassificationwidgetwrapperfactory.h index 0216d347f119..5cf8103a3b41 100644 --- a/src/gui/editorwidgets/qgsclassificationwidgetwrapperfactory.h +++ b/src/gui/editorwidgets/qgsclassificationwidgetwrapperfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsClassificationWidgetWrapperFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgscolorwidgetfactory.h b/src/gui/editorwidgets/qgscolorwidgetfactory.h index 6a4667fb52ab..9a80e73d7760 100644 --- a/src/gui/editorwidgets/qgscolorwidgetfactory.h +++ b/src/gui/editorwidgets/qgscolorwidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgscolorwidgetwrapper.h b/src/gui/editorwidgets/qgscolorwidgetwrapper.h index 53dc00e688c9..68dac3310e53 100644 --- a/src/gui/editorwidgets/qgscolorwidgetwrapper.h +++ b/src/gui/editorwidgets/qgscolorwidgetwrapper.h @@ -23,7 +23,8 @@ SIP_NO_FILE class QgsColorButton; -/** \ingroup gui +/** + * \ingroup gui * Wraps a color widget. Users will be able to choose a color. * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsdatetimeedit.h b/src/gui/editorwidgets/qgsdatetimeedit.h index a76e66f0b8c2..db9fdc6e5309 100644 --- a/src/gui/editorwidgets/qgsdatetimeedit.h +++ b/src/gui/editorwidgets/qgsdatetimeedit.h @@ -23,7 +23,8 @@ class QToolButton; class QLineEdit; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsDateTimeEdit class is a QDateTimeEdit with the capability of setting/reading null date/times. */ class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit @@ -56,7 +57,8 @@ class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit */ virtual void clear() override; - /** Resets the widget to show no value (ie, an "unknown" state). + /** + * Resets the widget to show no value (ie, an "unknown" state). * \since QGIS 2.16 */ void setEmpty(); @@ -82,7 +84,8 @@ class GUI_EXPORT QgsDateTimeEdit : public QDateTimeEdit QLineEdit *mNullLabel = nullptr; QToolButton *mClearButton = nullptr; - /** Set the lowest Date that can be displayed with the Qt::ISODate format + /** + * Set the lowest Date that can be displayed with the Qt::ISODate format * - uses QDateTimeEdit::setMinimumDateTime (since Qt 4.4) * \note * - QDate and QDateTime does not support minus years for the Qt::ISODate format diff --git a/src/gui/editorwidgets/qgsdatetimeeditconfig.h b/src/gui/editorwidgets/qgsdatetimeeditconfig.h index e28f8f55b105..19bb759722e0 100644 --- a/src/gui/editorwidgets/qgsdatetimeeditconfig.h +++ b/src/gui/editorwidgets/qgsdatetimeeditconfig.h @@ -22,7 +22,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsDateTimeEditConfig * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsdatetimeeditfactory.h b/src/gui/editorwidgets/qgsdatetimeeditfactory.h index d850a4a1705b..7e8a918def58 100644 --- a/src/gui/editorwidgets/qgsdatetimeeditfactory.h +++ b/src/gui/editorwidgets/qgsdatetimeeditfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsDateTimeEditFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsdatetimeeditwrapper.h b/src/gui/editorwidgets/qgsdatetimeeditwrapper.h index 4f3830cda0c5..fcd54194aa14 100644 --- a/src/gui/editorwidgets/qgsdatetimeeditwrapper.h +++ b/src/gui/editorwidgets/qgsdatetimeeditwrapper.h @@ -25,7 +25,8 @@ SIP_NO_FILE class QgsDateTimeEdit; -/** \ingroup gui +/** + * \ingroup gui * Wraps a date time widget. Users will be able to choose date and time from an appropriate dialog. * * Options: diff --git a/src/gui/editorwidgets/qgsdatetimesearchwidgetwrapper.h b/src/gui/editorwidgets/qgsdatetimesearchwidgetwrapper.h index 1b7a4f7f7147..e2f26fa6eadf 100644 --- a/src/gui/editorwidgets/qgsdatetimesearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsdatetimesearchwidgetwrapper.h @@ -27,7 +27,8 @@ class QgsDateTimeEditFactory; class QgsDateTimeEdit; -/** \ingroup gui +/** + * \ingroup gui * \class QgsDateTimeSearchWidgetWrapper * Wraps a date/time edit widget for searching. * \since QGIS 2.16 @@ -39,14 +40,16 @@ class GUI_EXPORT QgsDateTimeSearchWidgetWrapper : public QgsSearchWidgetWrapper public: - /** Constructor for QgsDateTimeSearchWidgetWrapper. + /** + * Constructor for QgsDateTimeSearchWidgetWrapper. * \param vl associated vector layer * \param fieldIdx index of associated field * \param parent parent widget */ explicit QgsDateTimeSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a variant representing the current state of the widget, respecting + /** + * Returns a variant representing the current state of the widget, respecting * the editor widget's configured field format for date/time values. */ QVariant value() const; diff --git a/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h b/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h index ee33e2c9cce2..3c2a46b47886 100644 --- a/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h @@ -23,7 +23,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Wraps a search widget. Default form is just a QgsLineFilterEdit */ @@ -60,13 +61,15 @@ class GUI_EXPORT QgsDefaultSearchWidgetWrapper : public QgsSearchWidgetWrapper void initWidget( QWidget *editor ) override; bool valid() const override; - /** Returns a pointer to the line edit part of the widget. + /** + * Returns a pointer to the line edit part of the widget. * \note this method is in place for unit testing only, and is not considered * stable API */ QgsFilterLineEdit *lineEdit(); - /** Returns a pointer to the case sensitivity checkbox in the widget. + /** + * Returns a pointer to the case sensitivity checkbox in the widget. * \note this method is in place for unit testing only, and is not considered * stable API */ diff --git a/src/gui/editorwidgets/qgsdoublespinbox.h b/src/gui/editorwidgets/qgsdoublespinbox.h index 0128f9cad0cf..532f114b4605 100644 --- a/src/gui/editorwidgets/qgsdoublespinbox.h +++ b/src/gui/editorwidgets/qgsdoublespinbox.h @@ -33,7 +33,8 @@ class QgsSpinBoxLineEdit; #endif -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. * The clear value can be either the minimum or the maiximum value of the spin box or a custom value. * This value can then be handled by a special value text. @@ -65,31 +66,36 @@ class GUI_EXPORT QgsDoubleSpinBox : public QDoubleSpinBox CustomValue, //!< Reset value to custom value (see setClearValue() ) }; - /** Constructor for QgsDoubleSpinBox. + /** + * Constructor for QgsDoubleSpinBox. * \param parent parent widget */ explicit QgsDoubleSpinBox( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets whether the widget will show a clear button. The clear button + /** + * Sets whether the widget will show a clear button. The clear button * allows users to reset the widget to a default or empty state. * \param showClearButton set to true to show the clear button, or false to hide it * \see showClearButton() */ void setShowClearButton( const bool showClearButton ); - /** Returns whether the widget is showing a clear button. + /** + * Returns whether the widget is showing a clear button. * \see setShowClearButton() */ bool showClearButton() const {return mShowClearButton;} - /** Sets if the widget will allow entry of simple expressions, which are + /** + * Sets if the widget will allow entry of simple expressions, which are * evaluated and then discarded. * \param enabled set to true to allow expression entry * \since QGIS 2.7 */ void setExpressionsEnabled( const bool enabled ); - /** Returns whether the widget will allow entry of simple expressions, which are + /** + * Returns whether the widget will allow entry of simple expressions, which are * evaluated and then discarded. * \returns true if spin box allows expression entry * \since QGIS 2.7 @@ -114,7 +120,8 @@ class GUI_EXPORT QgsDoubleSpinBox : public QDoubleSpinBox */ void setClearValueMode( ClearValueMode mode, const QString &clearValueText = QString() ); - /** Returns the value used when clear() is called. + /** + * Returns the value used when clear() is called. * \see setClearValue() */ double clearValue() const; diff --git a/src/gui/editorwidgets/qgsdummyconfigdlg.h b/src/gui/editorwidgets/qgsdummyconfigdlg.h index 472c15e8232b..56c3c10eab71 100644 --- a/src/gui/editorwidgets/qgsdummyconfigdlg.h +++ b/src/gui/editorwidgets/qgsdummyconfigdlg.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsDummyConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsenumerationwidgetfactory.h b/src/gui/editorwidgets/qgsenumerationwidgetfactory.h index a86aaf48a837..d56e084c461d 100644 --- a/src/gui/editorwidgets/qgsenumerationwidgetfactory.h +++ b/src/gui/editorwidgets/qgsenumerationwidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsEnumerationWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsenumerationwidgetwrapper.h b/src/gui/editorwidgets/qgsenumerationwidgetwrapper.h index bc50f68cbab4..4e3657f26610 100644 --- a/src/gui/editorwidgets/qgsenumerationwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsenumerationwidgetwrapper.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsEnumerationWidgetWrapper * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsexternalresourceconfigdlg.h b/src/gui/editorwidgets/qgsexternalresourceconfigdlg.h index 715cb4feff68..d222939e161b 100644 --- a/src/gui/editorwidgets/qgsexternalresourceconfigdlg.h +++ b/src/gui/editorwidgets/qgsexternalresourceconfigdlg.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsExternalResourceConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsexternalresourcewidgetfactory.h b/src/gui/editorwidgets/qgsexternalresourcewidgetfactory.h index b830676ad1b4..29d6883dce3c 100644 --- a/src/gui/editorwidgets/qgsexternalresourcewidgetfactory.h +++ b/src/gui/editorwidgets/qgsexternalresourcewidgetfactory.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsExternalResourceWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h b/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h index b2bc52f2b68b..d92785f0a008 100644 --- a/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h +++ b/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h @@ -28,7 +28,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Wraps a file name widget. Will offer a file browser to choose files. * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgshiddenwidgetfactory.h b/src/gui/editorwidgets/qgshiddenwidgetfactory.h index fa3a0a2a5bff..32058c7f3251 100644 --- a/src/gui/editorwidgets/qgshiddenwidgetfactory.h +++ b/src/gui/editorwidgets/qgshiddenwidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsHiddenWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgshiddenwidgetwrapper.h b/src/gui/editorwidgets/qgshiddenwidgetwrapper.h index 1498aaacb522..6b093c6940ff 100644 --- a/src/gui/editorwidgets/qgshiddenwidgetwrapper.h +++ b/src/gui/editorwidgets/qgshiddenwidgetwrapper.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Wraps a hidden widget. Fields with this widget type will not be visible. * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h b/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h index 76f30c61d4ff..8638942f91ce 100644 --- a/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h +++ b/src/gui/editorwidgets/qgskeyvaluewidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Factory for widgets for editing a QVariantMap * \since QGIS 3.0 * \note not available in Python bindings diff --git a/src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h b/src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h index 85db3a85d2c5..d2e56aa0130a 100644 --- a/src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h +++ b/src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h @@ -23,7 +23,8 @@ SIP_NO_FILE class QgsKeyValueWidget; -/** \ingroup gui +/** + * \ingroup gui * Wraps a key/value widget. * \since QGIS 3.0 * \note not available in Python bindings diff --git a/src/gui/editorwidgets/qgslistwidgetfactory.h b/src/gui/editorwidgets/qgslistwidgetfactory.h index 6818a77de26a..169deaf33b86 100644 --- a/src/gui/editorwidgets/qgslistwidgetfactory.h +++ b/src/gui/editorwidgets/qgslistwidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Factory for widgets for editing a QVariantList or a QStringList * \since QGIS 3.0 * \note not available in Python bindings diff --git a/src/gui/editorwidgets/qgslistwidgetwrapper.h b/src/gui/editorwidgets/qgslistwidgetwrapper.h index 9907ac048ed5..346235abb6be 100644 --- a/src/gui/editorwidgets/qgslistwidgetwrapper.h +++ b/src/gui/editorwidgets/qgslistwidgetwrapper.h @@ -23,7 +23,8 @@ SIP_NO_FILE class QgsListWidget; -/** \ingroup gui +/** + * \ingroup gui * Wraps a list widget. * \since QGIS 3.0 * \note not available in Python bindings diff --git a/src/gui/editorwidgets/qgsmultiedittoolbutton.h b/src/gui/editorwidgets/qgsmultiedittoolbutton.h index cbab01b42259..314b66176456 100644 --- a/src/gui/editorwidgets/qgsmultiedittoolbutton.h +++ b/src/gui/editorwidgets/qgsmultiedittoolbutton.h @@ -21,7 +21,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsMultiEditToolButton * A tool button widget which is displayed next to editor widgets in attribute forms, and * allows for controlling how the widget behaves and interacts with the form while in multi @@ -42,16 +43,19 @@ class GUI_EXPORT QgsMultiEditToolButton : public QToolButton Changed, //!< Value for widget has changed but changes have not yet been committed }; - /** Constructor for QgsMultiEditToolButton. + /** + * Constructor for QgsMultiEditToolButton. * \param parent parent object */ explicit QgsMultiEditToolButton( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns the current displayed state of the button. + /** + * Returns the current displayed state of the button. */ State state() const { return mState; } - /** Sets the field associated with this button. This is used to customise the widget menu + /** + * Sets the field associated with this button. This is used to customise the widget menu * and tooltips to match the field properties. * \param field associated field */ @@ -59,7 +63,8 @@ class GUI_EXPORT QgsMultiEditToolButton : public QToolButton public slots: - /** Sets whether the associated field contains mixed values. + /** + * Sets whether the associated field contains mixed values. * \param mixed whether field values are mixed * \see isMixed() * \see setIsChanged() @@ -67,7 +72,8 @@ class GUI_EXPORT QgsMultiEditToolButton : public QToolButton */ void setIsMixed( bool mixed ) { mIsMixedValues = mixed; updateState(); } - /** Sets whether the associated field has changed. + /** + * Sets whether the associated field has changed. * \param changed whether field has changed * \see isChanged() * \see setIsMixed() @@ -75,14 +81,16 @@ class GUI_EXPORT QgsMultiEditToolButton : public QToolButton */ void setIsChanged( bool changed ) { mIsChanged = changed; updateState(); } - /** Resets the changed state for the field. + /** + * Resets the changed state for the field. * \see setIsMixed() * \see setIsChanged() * \see changesCommitted() */ void resetChanges() { mIsChanged = false; updateState(); } - /** Called when field values have been changed and field now contains all the same values. + /** + * Called when field values have been changed and field now contains all the same values. * \see resetChanges() */ void changesCommitted() { mIsMixedValues = false; mIsChanged = false; updateState(); } diff --git a/src/gui/editorwidgets/qgsrangeconfigdlg.h b/src/gui/editorwidgets/qgsrangeconfigdlg.h index a2d3da3d7182..30a1055c13ad 100644 --- a/src/gui/editorwidgets/qgsrangeconfigdlg.h +++ b/src/gui/editorwidgets/qgsrangeconfigdlg.h @@ -22,7 +22,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsRangeConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsrangewidgetfactory.h b/src/gui/editorwidgets/qgsrangewidgetfactory.h index a7b7f2c4c2d6..18ac1675cd9e 100644 --- a/src/gui/editorwidgets/qgsrangewidgetfactory.h +++ b/src/gui/editorwidgets/qgsrangewidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsRangeWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsrangewidgetwrapper.h b/src/gui/editorwidgets/qgsrangewidgetwrapper.h index c4dcaf169bea..88b44fc2975b 100644 --- a/src/gui/editorwidgets/qgsrangewidgetwrapper.h +++ b/src/gui/editorwidgets/qgsrangewidgetwrapper.h @@ -30,7 +30,8 @@ class QDial; class QgsSlider; class QgsDial; -/** \ingroup gui +/** + * \ingroup gui * Wraps a range widget. * * Options: diff --git a/src/gui/editorwidgets/qgsrelationreferenceconfigdlg.h b/src/gui/editorwidgets/qgsrelationreferenceconfigdlg.h index ef769b5a4224..d957379c10e1 100644 --- a/src/gui/editorwidgets/qgsrelationreferenceconfigdlg.h +++ b/src/gui/editorwidgets/qgsrelationreferenceconfigdlg.h @@ -24,7 +24,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsRelationReferenceConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsrelationreferencefactory.h b/src/gui/editorwidgets/qgsrelationreferencefactory.h index 14166ac013e4..d60e4a6d43b7 100644 --- a/src/gui/editorwidgets/qgsrelationreferencefactory.h +++ b/src/gui/editorwidgets/qgsrelationreferencefactory.h @@ -25,7 +25,8 @@ SIP_NO_FILE class QgsMapCanvas; class QgsMessageBar; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRelationReferenceFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsrelationreferencesearchwidgetwrapper.h b/src/gui/editorwidgets/qgsrelationreferencesearchwidgetwrapper.h index 7da863504ffe..61edf5f40199 100644 --- a/src/gui/editorwidgets/qgsrelationreferencesearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsrelationreferencesearchwidgetwrapper.h @@ -27,7 +27,8 @@ class QgsRelationReferenceWidgetFactory; class QgsMapCanvas; class QgsRelationReferenceWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRelationReferenceSearchWidgetWrapper * Wraps a relation reference search widget. * \since QGIS 2.16 @@ -39,7 +40,8 @@ class GUI_EXPORT QgsRelationReferenceSearchWidgetWrapper : public QgsSearchWidge public: - /** Constructor for QgsRelationReferenceSearchWidgetWrapper + /** + * Constructor for QgsRelationReferenceSearchWidgetWrapper * \param vl associated vector layer * \param fieldIdx associated field index * \param canvas optional map canvas @@ -47,7 +49,8 @@ class GUI_EXPORT QgsRelationReferenceSearchWidgetWrapper : public QgsSearchWidge */ explicit QgsRelationReferenceSearchWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QgsMapCanvas *canvas, QWidget *parent = nullptr ); - /** Returns a variant representing the current state of the widget. + /** + * Returns a variant representing the current state of the widget. */ QVariant value() const; diff --git a/src/gui/editorwidgets/qgsrelationreferencewidget.h b/src/gui/editorwidgets/qgsrelationreferencewidget.h index 13b944800f31..26ed258e5a1f 100644 --- a/src/gui/editorwidgets/qgsrelationreferencewidget.h +++ b/src/gui/editorwidgets/qgsrelationreferencewidget.h @@ -49,7 +49,8 @@ class QLabel; % End #endif -/** \ingroup gui +/** + * \ingroup gui * \class QgsRelationReferenceWidget */ class GUI_EXPORT QgsRelationReferenceWidget : public QWidget @@ -136,7 +137,8 @@ class GUI_EXPORT QgsRelationReferenceWidget : public QWidget */ QgsFeature referencedFeature() const; - /** Sets the widget to display in an indeterminate "mixed value" state. + /** + * Sets the widget to display in an indeterminate "mixed value" state. * \since QGIS 2.16 */ void showIndeterminateState(); diff --git a/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.h b/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.h index c31744dd7f7e..2138fd5a181a 100644 --- a/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.h +++ b/src/gui/editorwidgets/qgsrelationreferencewidgetwrapper.h @@ -24,7 +24,8 @@ class QgsRelationReferenceWidget; class QgsMapCanvas; class QgsMessageBar; -/** \ingroup gui +/** + * \ingroup gui * Wraps a relation reference widget. * * Options: diff --git a/src/gui/editorwidgets/qgsrelationwidgetwrapper.h b/src/gui/editorwidgets/qgsrelationwidgetwrapper.h index 3c82254a09ac..99a508b14662 100644 --- a/src/gui/editorwidgets/qgsrelationwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsrelationwidgetwrapper.h @@ -22,7 +22,8 @@ class QgsRelationEditorWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRelationWidgetWrapper * \note not available in Python bindings */ @@ -86,7 +87,8 @@ class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper public slots: void setFeature( const QgsFeature &feature ) override; - /** Sets the visibility of the wrapper's widget. + /** + * Sets the visibility of the wrapper's widget. * \param visible set to true to show widget, false to hide widget * \since QGIS 2.16 */ diff --git a/src/gui/editorwidgets/qgssearchwidgettoolbutton.h b/src/gui/editorwidgets/qgssearchwidgettoolbutton.h index 77033ccdbbf8..d9630c979776 100644 --- a/src/gui/editorwidgets/qgssearchwidgettoolbutton.h +++ b/src/gui/editorwidgets/qgssearchwidgettoolbutton.h @@ -21,7 +21,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsSearchWidgetToolButton * A tool button widget which is displayed next to search widgets in forms, and * allows for controlling how the widget behaves and how the filtering/searching @@ -34,12 +35,14 @@ class GUI_EXPORT QgsSearchWidgetToolButton : public QToolButton public: - /** Constructor for QgsSearchWidgetToolButton. + /** + * Constructor for QgsSearchWidgetToolButton. * \param parent parent object */ explicit QgsSearchWidgetToolButton( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets the available filter flags to show in the widget. Any active flags + /** + * Sets the available filter flags to show in the widget. Any active flags * (see activeFlags()) which are not present in the new available filter * flags will be cleared; * \param flags available flags to show in widget @@ -49,20 +52,23 @@ class GUI_EXPORT QgsSearchWidgetToolButton : public QToolButton */ void setAvailableFlags( QgsSearchWidgetWrapper::FilterFlags flags ); - /** Sets the default filter flags to show in the widget. + /** + * Sets the default filter flags to show in the widget. * \param flags default flags to show in widget * \see setAvailableFlags() * \see setActiveFlags() */ void setDefaultFlags( QgsSearchWidgetWrapper::FilterFlags flags ); - /** Returns the available filter flags shown in the widget. + /** + * Returns the available filter flags shown in the widget. * \see setAvailableFlags() * \see activeFlags() */ QgsSearchWidgetWrapper::FilterFlags availableFlags() const { return mAvailableFilterFlags; } - /** Sets the current active filter flags for the widget. Any flags + /** + * Sets the current active filter flags for the widget. Any flags * which are not present in the available filter flags (see availableFlags()) * will not be set. * \param flags active flags to show in widget @@ -72,7 +78,8 @@ class GUI_EXPORT QgsSearchWidgetToolButton : public QToolButton */ void setActiveFlags( QgsSearchWidgetWrapper::FilterFlags flags ); - /** Toggles an individual active filter flag for the widget. Any flags + /** + * Toggles an individual active filter flag for the widget. Any flags * which are not present in the available filter flags (see availableFlags()) * will be ignore. Other flags may be cleared if they conflict with the newly * toggled flag. @@ -82,14 +89,16 @@ class GUI_EXPORT QgsSearchWidgetToolButton : public QToolButton */ void toggleFlag( QgsSearchWidgetWrapper::FilterFlag flag ); - /** Returns the active filter flags shown in the widget. + /** + * Returns the active filter flags shown in the widget. * \see setActiveFlags() * \see toggleFlag() * \see availableFlags() */ QgsSearchWidgetWrapper::FilterFlags activeFlags() const { return mFilterFlags; } - /** Returns true if the widget is set to be included in the search. + /** + * Returns true if the widget is set to be included in the search. * \see setInactive() * \see setActive() */ @@ -97,13 +106,15 @@ class GUI_EXPORT QgsSearchWidgetToolButton : public QToolButton public slots: - /** Sets the search widget as inactive, ie do not search the corresponding field. + /** + * Sets the search widget as inactive, ie do not search the corresponding field. * \see isActive() * \see setActive() */ void setInactive(); - /** Sets the search widget as active by selecting the first available search type. + /** + * Sets the search widget as active by selecting the first available search type. * \see isActive() * \see setInactive() */ @@ -111,7 +122,8 @@ class GUI_EXPORT QgsSearchWidgetToolButton : public QToolButton signals: - /** Emitted when the active flags selected in the widget is changed + /** + * Emitted when the active flags selected in the widget is changed * \param flags active flags */ void activeFlagsChanged( QgsSearchWidgetWrapper::FilterFlags flags ); diff --git a/src/gui/editorwidgets/qgsspinbox.h b/src/gui/editorwidgets/qgsspinbox.h index 6bc884a0df60..9a37944cf2d9 100644 --- a/src/gui/editorwidgets/qgsspinbox.h +++ b/src/gui/editorwidgets/qgsspinbox.h @@ -33,7 +33,8 @@ class QgsSpinBoxLineEdit; #endif -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsSpinBox is a spin box with a clear button that will set the value to the defined clear value. * The clear value can be either the minimum or the maiximum value of the spin box or a custom value. * This value can then be handled by a special value text. @@ -65,31 +66,36 @@ class GUI_EXPORT QgsSpinBox : public QSpinBox CustomValue, //!< Reset value to custom value (see setClearValue() ) }; - /** Constructor for QgsSpinBox. + /** + * Constructor for QgsSpinBox. * \param parent parent widget */ explicit QgsSpinBox( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets whether the widget will show a clear button. The clear button + /** + * Sets whether the widget will show a clear button. The clear button * allows users to reset the widget to a default or empty state. * \param showClearButton set to true to show the clear button, or false to hide it * \see showClearButton() */ void setShowClearButton( const bool showClearButton ); - /** Returns whether the widget is showing a clear button. + /** + * Returns whether the widget is showing a clear button. * \see setShowClearButton() */ bool showClearButton() const {return mShowClearButton;} - /** Sets if the widget will allow entry of simple expressions, which are + /** + * Sets if the widget will allow entry of simple expressions, which are * evaluated and then discarded. * \param enabled set to true to allow expression entry * \since QGIS 2.7 */ void setExpressionsEnabled( const bool enabled ); - /** Returns whether the widget will allow entry of simple expressions, which are + /** + * Returns whether the widget will allow entry of simple expressions, which are * evaluated and then discarded. * \returns true if spin box allows expression entry * \since QGIS 2.7 @@ -114,7 +120,8 @@ class GUI_EXPORT QgsSpinBox : public QSpinBox */ void setClearValueMode( ClearValueMode mode, const QString &clearValueText = QString() ); - /** Returns the value used when clear() is called. + /** + * Returns the value used when clear() is called. * \see setClearValue() */ int clearValue() const; diff --git a/src/gui/editorwidgets/qgstexteditconfigdlg.h b/src/gui/editorwidgets/qgstexteditconfigdlg.h index 61129668ac49..f55b2f6282bb 100644 --- a/src/gui/editorwidgets/qgstexteditconfigdlg.h +++ b/src/gui/editorwidgets/qgstexteditconfigdlg.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsTextEditConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h b/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h index a89ee9301d92..263b2122202b 100644 --- a/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgstexteditsearchwidgetwrapper.h @@ -23,7 +23,8 @@ SIP_NO_FILE class QgsTextEditWidgetFactory; -/** \ingroup gui +/** + * \ingroup gui * \class QgsTextEditSearchWidgetWrapper * Wraps a text edit widget for searching. * \since QGIS 2.16 @@ -36,7 +37,8 @@ class GUI_EXPORT QgsTextEditSearchWidgetWrapper : public QgsDefaultSearchWidgetW public: - /** Constructor for QgsTextEditSearchWidgetWrapper. + /** + * Constructor for QgsTextEditSearchWidgetWrapper. * \param vl associated vector layer * \param fieldIdx index of associated field * \param parent parent widget diff --git a/src/gui/editorwidgets/qgstexteditwidgetfactory.h b/src/gui/editorwidgets/qgstexteditwidgetfactory.h index aa3f7408c76e..cbc2e4cb817e 100644 --- a/src/gui/editorwidgets/qgstexteditwidgetfactory.h +++ b/src/gui/editorwidgets/qgstexteditwidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsTextEditWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgstexteditwrapper.h b/src/gui/editorwidgets/qgstexteditwrapper.h index fabb7bb0c444..533087b77ff7 100644 --- a/src/gui/editorwidgets/qgstexteditwrapper.h +++ b/src/gui/editorwidgets/qgstexteditwrapper.h @@ -25,7 +25,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Wraps a text widget. Users will be able to modify text with this widget type. * * Options: diff --git a/src/gui/editorwidgets/qgsuniquevaluesconfigdlg.h b/src/gui/editorwidgets/qgsuniquevaluesconfigdlg.h index 866081f911b9..c39e848e7814 100644 --- a/src/gui/editorwidgets/qgsuniquevaluesconfigdlg.h +++ b/src/gui/editorwidgets/qgsuniquevaluesconfigdlg.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsUniqueValuesConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsuniquevaluewidgetwrapper.h b/src/gui/editorwidgets/qgsuniquevaluewidgetwrapper.h index 9f7c8eda7f9c..11eb39bf6316 100644 --- a/src/gui/editorwidgets/qgsuniquevaluewidgetwrapper.h +++ b/src/gui/editorwidgets/qgsuniquevaluewidgetwrapper.h @@ -24,7 +24,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Wraps a unique value widget. Will offer any value previously used for this field. * * Options: diff --git a/src/gui/editorwidgets/qgsuuidwidgetfactory.h b/src/gui/editorwidgets/qgsuuidwidgetfactory.h index 0406dc579bc5..b3194e689c60 100644 --- a/src/gui/editorwidgets/qgsuuidwidgetfactory.h +++ b/src/gui/editorwidgets/qgsuuidwidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsUuidWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsuuidwidgetwrapper.h b/src/gui/editorwidgets/qgsuuidwidgetwrapper.h index 84ec3eb638e0..f6f2aa7faeea 100644 --- a/src/gui/editorwidgets/qgsuuidwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsuuidwidgetwrapper.h @@ -25,7 +25,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Wraps a uuid widget. Will create a new UUID if empty or represent the current value if not empty. * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsvaluemapconfigdlg.h b/src/gui/editorwidgets/qgsvaluemapconfigdlg.h index 8fac638475fa..465f5149c374 100644 --- a/src/gui/editorwidgets/qgsvaluemapconfigdlg.h +++ b/src/gui/editorwidgets/qgsvaluemapconfigdlg.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsValueMapConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsvaluemapsearchwidgetwrapper.h b/src/gui/editorwidgets/qgsvaluemapsearchwidgetwrapper.h index 13eeb381c600..385e995b56f3 100644 --- a/src/gui/editorwidgets/qgsvaluemapsearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsvaluemapsearchwidgetwrapper.h @@ -21,7 +21,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Wraps a value map search widget. This widget will offer a combobox with values from another layer * referenced by a foreign key (a constraint may be set but is not required on data level). * It will be used as a search widget and produces expression to look for in the layer. diff --git a/src/gui/editorwidgets/qgsvaluemapwidgetfactory.h b/src/gui/editorwidgets/qgsvaluemapwidgetfactory.h index 27318009d499..b0b9cd1d71e7 100644 --- a/src/gui/editorwidgets/qgsvaluemapwidgetfactory.h +++ b/src/gui/editorwidgets/qgsvaluemapwidgetfactory.h @@ -21,7 +21,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsValueMapWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsvaluemapwidgetwrapper.h b/src/gui/editorwidgets/qgsvaluemapwidgetwrapper.h index ee2d3d18ab2a..f406fec7a7bf 100644 --- a/src/gui/editorwidgets/qgsvaluemapwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsvaluemapwidgetwrapper.h @@ -24,7 +24,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Wraps a value map widget. * * Options: diff --git a/src/gui/editorwidgets/qgsvaluerelationconfigdlg.h b/src/gui/editorwidgets/qgsvaluerelationconfigdlg.h index b6c4e9983d15..d94160e5d4f4 100644 --- a/src/gui/editorwidgets/qgsvaluerelationconfigdlg.h +++ b/src/gui/editorwidgets/qgsvaluerelationconfigdlg.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsValueRelationConfigDlg * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsvaluerelationsearchwidgetwrapper.h b/src/gui/editorwidgets/qgsvaluerelationsearchwidgetwrapper.h index 7ee5c11e1633..bf2445085434 100644 --- a/src/gui/editorwidgets/qgsvaluerelationsearchwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsvaluerelationsearchwidgetwrapper.h @@ -27,7 +27,8 @@ class QgsValueRelationWidgetFactory; -/** \ingroup gui +/** + * \ingroup gui * Wraps a value relation search widget. This widget will offer a combobox with values from another layer * referenced by a foreign key (a constraint may be set but is not required on data level). * It will be used as a search widget and produces expression to look for in the layer. diff --git a/src/gui/editorwidgets/qgsvaluerelationwidgetfactory.h b/src/gui/editorwidgets/qgsvaluerelationwidgetfactory.h index 28ddcb498a10..b0348dad40df 100644 --- a/src/gui/editorwidgets/qgsvaluerelationwidgetfactory.h +++ b/src/gui/editorwidgets/qgsvaluerelationwidgetfactory.h @@ -23,7 +23,8 @@ SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsValueRelationWidgetFactory * \note not available in Python bindings */ diff --git a/src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.h b/src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.h index abf4d09dd1cf..acc892357950 100644 --- a/src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.h @@ -28,7 +28,8 @@ SIP_NO_FILE class QgsValueRelationWidgetFactory; -/** \ingroup gui +/** + * \ingroup gui * Wraps a value relation widget. This widget will offer a combobox with values from another layer * referenced by a foreign key (a constraint may be set but is not required on data level). * This is useful for having value lists on a separate layer containing codes and their diff --git a/src/gui/effects/qgseffectdrawmodecombobox.h b/src/gui/effects/qgseffectdrawmodecombobox.h index 47fe05ed551e..0ad21abb9f6d 100644 --- a/src/gui/effects/qgseffectdrawmodecombobox.h +++ b/src/gui/effects/qgseffectdrawmodecombobox.h @@ -20,7 +20,8 @@ #include "qgspainteffect.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsEffectDrawModeComboBox * \brief A combo box allowing selection of paint effect draw modes * @@ -35,12 +36,14 @@ class GUI_EXPORT QgsEffectDrawModeComboBox : public QComboBox QgsEffectDrawModeComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Returns the currently selected draw mode for the combo box + /** + * Returns the currently selected draw mode for the combo box * \returns current draw mode */ QgsPaintEffect::DrawMode drawMode() const; - /** Sets the currently selected draw mode for the combo box + /** + * Sets the currently selected draw mode for the combo box * \param drawMode selected draw mode */ void setDrawMode( QgsPaintEffect::DrawMode drawMode ); diff --git a/src/gui/effects/qgseffectstackpropertieswidget.h b/src/gui/effects/qgseffectstackpropertieswidget.h index a4b037cfa78e..9c9cbf89f68c 100644 --- a/src/gui/effects/qgseffectstackpropertieswidget.h +++ b/src/gui/effects/qgseffectstackpropertieswidget.h @@ -34,7 +34,8 @@ class QgsPanelWidget; class QgsEffectStack; class QgsPaintEffect; -/** \ingroup gui +/** + * \ingroup gui * \class QgsEffectStackPropertiesWidget * \brief A widget for modifying the properties of a QgsEffectStack, including adding * and reordering effects within the stack. @@ -51,7 +52,8 @@ class GUI_EXPORT QgsEffectStackPropertiesWidget : public QgsPanelWidget, private public: - /** QgsEffectStackPropertiesWidget constructor + /** + * QgsEffectStackPropertiesWidget constructor * \param stack QgsEffectStack to modify in the widget * \param parent parent widget */ @@ -59,43 +61,52 @@ class GUI_EXPORT QgsEffectStackPropertiesWidget : public QgsPanelWidget, private ~QgsEffectStackPropertiesWidget(); - /** Returns effect stack attached to the widget + /** + * Returns effect stack attached to the widget * \returns QgsEffectStack modified by the widget */ QgsEffectStack *stack() { return mStack; } - /** Sets the picture to use for effect previews for the dialog + /** + * Sets the picture to use for effect previews for the dialog * \param picture preview picture */ void setPreviewPicture( const QPicture &picture ); public slots: - /** Moves the currently selected effect down in the stack. + /** + * Moves the currently selected effect down in the stack. */ void moveEffectDown(); - /** Moves the currently selected effect up in the stack. + /** + * Moves the currently selected effect up in the stack. */ void moveEffectUp(); - /** Adds a new effect to the stack. + /** + * Adds a new effect to the stack. */ void addEffect(); - /** Removes the currently selected effect from the stack. + /** + * Removes the currently selected effect from the stack. */ void removeEffect(); - /** Updates the widget when the selected effect changes type. + /** + * Updates the widget when the selected effect changes type. */ void effectChanged(); - /** Updates the effect preview icon. + /** + * Updates the effect preview icon. */ void updatePreview(); - /** Updates the effect stack when the currently selected effect changes properties. + /** + * Updates the effect stack when the currently selected effect changes properties. * \param newEffect new effect to replace existing effect at selected position within the stack. */ void changeEffect( QgsPaintEffect *newEffect ); @@ -107,36 +118,43 @@ class GUI_EXPORT QgsEffectStackPropertiesWidget : public QgsPanelWidget, private QWidget *mPresentWidget = nullptr; QPicture *mPreviewPicture = nullptr; - /** Refreshes the widget to reflect the current state of the stack. + /** + * Refreshes the widget to reflect the current state of the stack. */ void loadStack(); - /** Refreshes the widget to reflect the current state of a specified stack. + /** + * Refreshes the widget to reflect the current state of a specified stack. * \param stack QgsEffectStack for widget */ void loadStack( QgsEffectStack *stack ); - /** Enables or disables widgets depending on the selected effect within the stack. + /** + * Enables or disables widgets depending on the selected effect within the stack. */ void updateUi(); - /** Returns the currently selected effect within the stack. + /** + * Returns the currently selected effect within the stack. * \note not available in Python bindings */ EffectItem *currentEffectItem() SIP_SKIP; - /** Moves the currently selected effect within the stack by a specified offset + /** + * Moves the currently selected effect within the stack by a specified offset */ void moveEffectByOffset( int offset ); - /** Sets the effect properties widget + /** + * Sets the effect properties widget */ void setWidget( QWidget *widget ); }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsEffectStackPropertiesDialog * \brief A dialog for modifying the properties of a QgsEffectStack, including adding * and reordering effects within the stack. @@ -153,19 +171,22 @@ class GUI_EXPORT QgsEffectStackPropertiesDialog: public QgsDialog public: - /** QgsEffectStackPropertiesDialog constructor + /** + * QgsEffectStackPropertiesDialog constructor * \param stack QgsEffectStack to modify in the dialog * \param parent parent widget * \param f window flags */ QgsEffectStackPropertiesDialog( QgsEffectStack *stack, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags f = 0 ); - /** Returns effect stack attached to the dialog + /** + * Returns effect stack attached to the dialog * \returns QgsEffectStack modified by the dialog */ QgsEffectStack *stack(); - /** Sets the picture to use for effect previews for the dialog + /** + * Sets the picture to use for effect previews for the dialog * \param picture preview picture */ void setPreviewPicture( const QPicture &picture ); @@ -177,7 +198,8 @@ class GUI_EXPORT QgsEffectStackPropertiesDialog: public QgsDialog }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsEffectStackCompactWidget * \brief A small widget consisting of a checkbox for enabling/disabling an effect stack * and a button for opening an effect stack customisation dialog. @@ -194,7 +216,8 @@ class GUI_EXPORT QgsEffectStackCompactWidget: public QgsPanelWidget public: - /** QgsEffectStackCompactWidget constructor + /** + * QgsEffectStackCompactWidget constructor * \param parent parent widget * \param effect QgsPaintEffect for modification by the widget. If the effect * is not a QgsEffectStack, it will be automatically converted to an effect @@ -203,7 +226,8 @@ class GUI_EXPORT QgsEffectStackCompactWidget: public QgsPanelWidget QgsEffectStackCompactWidget( QWidget *parent SIP_TRANSFERTHIS = 0, QgsPaintEffect *effect = nullptr ); ~QgsEffectStackCompactWidget(); - /** Sets paint effect attached to the widget, + /** + * Sets paint effect attached to the widget, * \param effect QgsPaintEffect for modification by the widget. If the effect * is not a QgsEffectStack, it will be automatically converted to an effect * stack consisting of the original effect @@ -211,20 +235,23 @@ class GUI_EXPORT QgsEffectStackCompactWidget: public QgsPanelWidget */ void setPaintEffect( QgsPaintEffect *effect ); - /** Returns paint effect attached to the widget + /** + * Returns paint effect attached to the widget * \returns QgsPaintEffect modified by the widget * \see setPaintEffect */ QgsPaintEffect *paintEffect() const; - /** Sets the picture to use for effect previews for the dialog + /** + * Sets the picture to use for effect previews for the dialog * \param picture preview picture */ void setPreviewPicture( const QPicture &picture ); signals: - /** Emitted when the paint effect properties change + /** + * Emitted when the paint effect properties change */ void changed(); diff --git a/src/gui/effects/qgspainteffectpropertieswidget.h b/src/gui/effects/qgspainteffectpropertieswidget.h index 981acdb0a659..b00191185464 100644 --- a/src/gui/effects/qgspainteffectpropertieswidget.h +++ b/src/gui/effects/qgspainteffectpropertieswidget.h @@ -23,7 +23,8 @@ class QgsPaintEffect; -/** \ingroup gui +/** + * \ingroup gui * \class QgsPaintEffectPropertiesWidget * \brief A widget which modifies the properties of a QgsPaintEffect * @@ -36,7 +37,8 @@ class GUI_EXPORT QgsPaintEffectPropertiesWidget : public QWidget, private Ui::Ef public: - /** QgsPaintEffectPropertiesWidget constructor + /** + * QgsPaintEffectPropertiesWidget constructor * \param effect QgsPaintEffect to modify in the widget * \param parent parent widget */ @@ -44,21 +46,25 @@ class GUI_EXPORT QgsPaintEffectPropertiesWidget : public QWidget, private Ui::Ef public slots: - /** Update widget when effect type changes + /** + * Update widget when effect type changes */ void effectTypeChanged(); - /** Emits the changed signal + /** + * Emits the changed signal */ void emitSignalChanged(); signals: - /** Emitted when paint effect properties changes + /** + * Emitted when paint effect properties changes */ void changed(); - /** Emitted when paint effect type changes + /** + * Emitted when paint effect type changes */ void changeEffect( QgsPaintEffect *effect ); diff --git a/src/gui/effects/qgspainteffectwidget.h b/src/gui/effects/qgspainteffectwidget.h index 19d3961732fe..4876036128ca 100644 --- a/src/gui/effects/qgspainteffectwidget.h +++ b/src/gui/effects/qgspainteffectwidget.h @@ -29,7 +29,8 @@ class QgsTransformEffect; class QgsColorEffect; -/** \ingroup gui +/** + * \ingroup gui * \class QgsPaintEffectWidget * \brief Base class for effect properties widgets. * @@ -62,7 +63,8 @@ class GUI_EXPORT QgsPaintEffectWidget : public QWidget #include "ui_widget_drawsource.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsDrawSourceWidget */ class GUI_EXPORT QgsDrawSourceWidget : public QgsPaintEffectWidget, private Ui::WidgetDrawSource @@ -94,7 +96,8 @@ class GUI_EXPORT QgsDrawSourceWidget : public QgsPaintEffectWidget, private Ui:: #include "ui_widget_blur.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsBlurWidget */ class GUI_EXPORT QgsBlurWidget : public QgsPaintEffectWidget, private Ui::WidgetBlur @@ -128,7 +131,8 @@ class GUI_EXPORT QgsBlurWidget : public QgsPaintEffectWidget, private Ui::Widget #include "ui_widget_shadoweffect.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsShadowEffectWidget */ class GUI_EXPORT QgsShadowEffectWidget : public QgsPaintEffectWidget, private Ui::WidgetShadowEffect @@ -163,7 +167,8 @@ class GUI_EXPORT QgsShadowEffectWidget : public QgsPaintEffectWidget, private Ui #include "ui_widget_glow.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsGlowWidget */ class GUI_EXPORT QgsGlowWidget : public QgsPaintEffectWidget, private Ui::WidgetGlow @@ -198,7 +203,8 @@ class GUI_EXPORT QgsGlowWidget : public QgsPaintEffectWidget, private Ui::Widget #include "ui_widget_transform.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsTransformWidget */ class GUI_EXPORT QgsTransformWidget : public QgsPaintEffectWidget, private Ui::WidgetTransform @@ -237,7 +243,8 @@ class GUI_EXPORT QgsTransformWidget : public QgsPaintEffectWidget, private Ui::W #include "ui_widget_coloreffects.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorEffectWidget */ class GUI_EXPORT QgsColorEffectWidget : public QgsPaintEffectWidget, private Ui::WidgetColorEffect diff --git a/src/gui/layertree/qgslayertreeembeddedconfigwidget.h b/src/gui/layertree/qgslayertreeembeddedconfigwidget.h index 1dfa440d9620..dc9ac7e8fc6f 100644 --- a/src/gui/layertree/qgslayertreeembeddedconfigwidget.h +++ b/src/gui/layertree/qgslayertreeembeddedconfigwidget.h @@ -22,7 +22,8 @@ class QgsMapLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsLayerTreeEmbeddedConfigWidget * A widget to configure layer tree embedded widgets for a particular map layer. * \since QGIS 2.16 diff --git a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h index 7be3540998e9..8d6fac393ee0 100644 --- a/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h +++ b/src/gui/layertree/qgslayertreeembeddedwidgetregistry.h @@ -24,7 +24,8 @@ class QgsMapLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsLayerTreeEmbeddedWidgetProvider * Provider interface to be implemented in order to introduce new kinds of embedded widgets for use in layer tree. * Embedded widgets are assigned per individual map layers and they are shown before any legend entries. @@ -53,7 +54,8 @@ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetProvider virtual bool supportsLayer( QgsMapLayer *layer ) = 0; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsLayerTreeEmbeddedWidgetRegistry * Registry of widgets that may be embedded into layer tree view. * Embedded widgets are assigned per individual map layers and they are shown before any legend entries. @@ -90,11 +92,13 @@ class GUI_EXPORT QgsLayerTreeEmbeddedWidgetRegistry //! Get provider object from the provider's ID QgsLayerTreeEmbeddedWidgetProvider *provider( const QString &providerId ) const; - /** Register a provider, takes ownership of the object. + /** + * Register a provider, takes ownership of the object. * Returns true on success, false if the provider is already registered. */ bool addProvider( QgsLayerTreeEmbeddedWidgetProvider *provider SIP_TRANSFER ); - /** Unregister a provider, the provider object is deleted. + /** + * Unregister a provider, the provider object is deleted. * Returns true on success, false if the provider was not registered. */ bool removeProvider( const QString &providerId ); diff --git a/src/gui/layertree/qgslayertreeview.h b/src/gui/layertree/qgslayertreeview.h index 0aaf9df22cea..4a1ed5eac3a2 100644 --- a/src/gui/layertree/qgslayertreeview.h +++ b/src/gui/layertree/qgslayertreeview.h @@ -87,7 +87,8 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView //! Get current group node. If a layer is current node, the function will return parent group. May be null. QgsLayerTreeGroup *currentGroupNode() const; - /** Get current legend node. May be null if current node is not a legend node. + /** + * Get current legend node. May be null if current node is not a legend node. * \since QGIS 2.14 */ QgsLayerTreeModelLegendNode *currentLegendNode() const; @@ -157,7 +158,8 @@ class GUI_EXPORT QgsLayerTreeView : public QTreeView }; -/** \ingroup gui +/** + * \ingroup gui * Implementation of this interface can be implemented to allow QgsLayerTreeView * instance to provide custom context menus (opened upon right-click). * diff --git a/src/gui/layout/qgslayoutdesignerinterface.h b/src/gui/layout/qgslayoutdesignerinterface.h index abc76013de2f..ee8c7ca1c2b5 100644 --- a/src/gui/layout/qgslayoutdesignerinterface.h +++ b/src/gui/layout/qgslayoutdesignerinterface.h @@ -23,7 +23,8 @@ class QgsLayout; class QgsLayoutView; -/** \ingroup gui +/** + * \ingroup gui * \class QgsLayoutDesignerInterface * A common interface for layout designer dialogs and widgets. * diff --git a/src/gui/ogr/qgsnewogrconnection.h b/src/gui/ogr/qgsnewogrconnection.h index 509059847ab0..e96d2b9c5246 100644 --- a/src/gui/ogr/qgsnewogrconnection.h +++ b/src/gui/ogr/qgsnewogrconnection.h @@ -25,7 +25,8 @@ #include "qgis_gui.h" -/** \class QgsNewOgrConnection +/** + * \class QgsNewOgrConnection * \brief Dialog to allow the user to define, test and save connection * information for OGR databases * \note not available in python bindings diff --git a/src/gui/ogr/qgsogrhelperfunctions.h b/src/gui/ogr/qgsogrhelperfunctions.h index ed26ebed26bb..08d7da10762f 100644 --- a/src/gui/ogr/qgsogrhelperfunctions.h +++ b/src/gui/ogr/qgsogrhelperfunctions.h @@ -21,13 +21,15 @@ #define SIP_NO_FILE -/** CreateDatabaseURI +/** + * CreateDatabaseURI * \brief Create database uri from connection parameters * \note not available in python bindings */ QString GUI_EXPORT createDatabaseURI( const QString &connectionType, const QString &host, const QString &database, QString port, const QString &user, const QString &password ); -/** CreateProtocolURI +/** + * CreateProtocolURI * \brief Create protocol uri from connection parameters * \note not available in python bindings */ diff --git a/src/gui/ogr/qgsvectorlayersaveasdialog.h b/src/gui/ogr/qgsvectorlayersaveasdialog.h index 206433db91b5..ce737bf6f6de 100644 --- a/src/gui/ogr/qgsvectorlayersaveasdialog.h +++ b/src/gui/ogr/qgsvectorlayersaveasdialog.h @@ -61,7 +61,8 @@ class GUI_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec QgsAttributeList attributesAsDisplayedValues() const; bool addToCanvas() const; - /** Returns type of symbology export. + /** + * Returns type of symbology export. 0: No symbology 1: Feature symbology 2: Symbol level symbology*/ @@ -83,33 +84,39 @@ class GUI_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec bool onlySelected() const; - /** Returns the selected flat geometry type for the export. + /** + * Returns the selected flat geometry type for the export. * \see automaticGeometryType() * \see forceMulti() * \see includeZ() */ QgsWkbTypes::Type geometryType() const; - /** Returns true if geometry type is set to automatic. + /** + * Returns true if geometry type is set to automatic. * \see geometryType() */ bool automaticGeometryType() const; - /** Returns true if force multi geometry type is checked. + /** + * Returns true if force multi geometry type is checked. * \see includeZ() */ bool forceMulti() const; - /** Sets whether the force multi geometry checkbox should be checked. + /** + * Sets whether the force multi geometry checkbox should be checked. */ void setForceMulti( bool checked ); - /** Returns true if include z dimension is checked. + /** + * Returns true if include z dimension is checked. * \see forceMulti() */ bool includeZ() const; - /** Sets whether the include z dimension checkbox should be checked. + /** + * Sets whether the include z dimension checkbox should be checked. */ void setIncludeZ( bool checked ); diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h index 514f54330fe8..10e822dd517d 100644 --- a/src/gui/qgisinterface.h +++ b/src/gui/qgisinterface.h @@ -57,7 +57,8 @@ class QgsStatusBar; #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * QgisInterface * Abstract base class defining interfaces exposed by QgisApp and * made available to plugins. @@ -83,7 +84,8 @@ class GUI_EXPORT QgisInterface : public QObject virtual QgsLayerTreeView *layerTreeView() = 0; - /** Add action to context menu for layers in the layer tree. + /** + * Add action to context menu for layers in the layer tree. * If allLayers is true, then the action will be available for all layers of given type, * otherwise the action will be available only for specific layers added with addCustomActionForLayer() * after this call. @@ -97,14 +99,16 @@ class GUI_EXPORT QgisInterface : public QObject virtual void addCustomActionForLayerType( QAction *action, QString menu, QgsMapLayer::LayerType type, bool allLayers ) = 0; - /** Add action to context menu for a specific layer in the layer tree. + /** + * Add action to context menu for a specific layer in the layer tree. * It is necessary to first call addCustomActionForLayerType() with allLayers=false * in order for this method to have any effect. * \see addCustomActionForLayerType() */ virtual void addCustomActionForLayer( QAction *action, QgsMapLayer *layer ) = 0; - /** Remove action for layers in the layer tree previously added with addCustomActionForLayerType() + /** + * Remove action for layers in the layer tree previously added with addCustomActionForLayerType() * \see addCustomActionForLayerType() */ virtual bool removeCustomActionForLayerType( QAction *action ) = 0; @@ -342,7 +346,8 @@ class GUI_EXPORT QgisInterface : public QObject //! Return changeable options built from settings and/or defaults virtual QMap defaultStyleSheetOptions() = 0; - /** Generate stylesheet + /** + * Generate stylesheet * \param opts generated default option values, or a changed copy of them */ virtual void buildStyleSheet( const QMap &opts ) = 0; @@ -395,7 +400,8 @@ class GUI_EXPORT QgisInterface : public QObject //! Remove specified dock widget from main window (doesn't delete it). virtual void removeDockWidget( QDockWidget *dockwidget ) = 0; - /** Advanced digitizing dock widget + /** + * Advanced digitizing dock widget * \since QGIS 2.12 */ virtual QgsAdvancedDigitizingDockWidget *cadDockWidget() = 0; @@ -406,11 +412,13 @@ class GUI_EXPORT QgisInterface : public QObject //! Open attribute table dialog virtual QDialog *showAttributeTable( QgsVectorLayer *l, const QString &filterExpression = QString() ) = 0; - /** Add window to Window menu. The action title is the window title + /** + * Add window to Window menu. The action title is the window title * and the action should raise, unminimize and activate the window. */ virtual void addWindow( QAction *action ) = 0; - /** Remove window from Window menu. Calling this is necessary only for + /** + * Remove window from Window menu. Calling this is necessary only for * windows which are hidden rather than deleted when closed. */ virtual void removeWindow( QAction *action ) = 0; @@ -420,47 +428,54 @@ class GUI_EXPORT QgisInterface : public QObject //! Unregister a previously registered action. (e.g. when plugin is going to be unloaded) virtual bool unregisterMainWindowAction( QAction *action ) = 0; - /** Register a new tab in the vector layer properties dialog. + /** + * Register a new tab in the vector layer properties dialog. * \since QGIS 2.16 * \note Ownership of the factory is not transferred, and the factory must * be unregistered when plugin is unloaded. * \see unregisterMapLayerPropertiesFactory() */ virtual void registerMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0; - /** Unregister a previously registered tab in the vector layer properties dialog. + /** + * Unregister a previously registered tab in the vector layer properties dialog. * \since QGIS 2.16 * \see registerMapLayerPropertiesFactory() */ virtual void unregisterMapLayerConfigWidgetFactory( QgsMapLayerConfigWidgetFactory *factory ) = 0; - /** Register a new tab in the options dialog. + /** + * Register a new tab in the options dialog. * \since QGIS 3.0 * \note Ownership of the factory is not transferred, and the factory must * be unregistered when plugin is unloaded. * \see unregisterOptionsWidgetFactory() */ virtual void registerOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0; - /** Unregister a previously registered tab in the options dialog. + /** + * Unregister a previously registered tab in the options dialog. * \since QGIS 3.0 * \see registerOptionsWidgetFactory() */ virtual void unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) = 0; - /** Register a new custom drop handler. + /** + * Register a new custom drop handler. * \since QGIS 3.0 * \note Ownership of the factory is not transferred, and the factory must * be unregistered when plugin is unloaded. * \see unregisterCustomDropHandler() */ virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) = 0; - /** Unregister a previously registered custom drop handler. + /** + * Unregister a previously registered custom drop handler. * \since QGIS 3.0 * \see registerCustomDropHandler() */ virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) = 0; // @todo is this deprecated in favour of QgsContextHelp? - /** Open a url in the users browser. By default the QGIS doc directory is used + /** + * Open a url in the users browser. By default the QGIS doc directory is used * as the base for the URL. To open a URL that is not relative to the installed * QGIS documentation, set useQgisDocDirectory to false. * \param url URL to open @@ -473,7 +488,8 @@ class GUI_EXPORT QgisInterface : public QObject #endif virtual void openURL( const QString &url, bool useQgisDocDirectory = true ) = 0 SIP_DEPRECATED; - /** Accessors for inserting items into menus and toolbars. + /** + * Accessors for inserting items into menus and toolbars. * An item can be inserted before any existing action. */ @@ -668,7 +684,8 @@ class GUI_EXPORT QgisInterface : public QObject */ virtual QgsVectorLayerTools *vectorLayerTools() = 0; - /** This method is only needed when using a UI form with a custom widget plugin and calling + /** + * This method is only needed when using a UI form with a custom widget plugin and calling * openFeatureForm or getFeatureForm from Python (PyQt4) and you haven't used the info tool first. * Python will crash bringing QGIS with it * if the custom form is not loaded from a C++ method call. @@ -681,7 +698,8 @@ class GUI_EXPORT QgisInterface : public QObject */ virtual void preloadForm( const QString &uifile ) = 0; - /** Return vector layers in edit mode + /** + * Return vector layers in edit mode * \param modified whether to return only layers that have been modified * \returns list of layers in legend order, or empty list */ virtual QList editableLayers( bool modified = false ) const = 0; @@ -722,12 +740,14 @@ class GUI_EXPORT QgisInterface : public QObject signals: - /** Emitted whenever current (selected) layer changes. + /** + * Emitted whenever current (selected) layer changes. * The pointer to layer can be null if no layer is selected */ void currentLayerChanged( QgsMapLayer *layer ); - /** Signal emitted when the current \a theme is changed so plugins + /** + * Signal emitted when the current \a theme is changed so plugins * can change their tool button icons. * \since QGIS 3.0 */ @@ -786,7 +806,8 @@ class GUI_EXPORT QgisInterface : public QObject */ void initializationCompleted(); - /** Emitted when a project file is successfully read + /** + * Emitted when a project file is successfully read * \note * This is useful for plug-ins that store properties with project files. A * plug-in can connect to this signal. When it is emitted, the plug-in @@ -794,7 +815,8 @@ class GUI_EXPORT QgisInterface : public QObject */ void projectRead(); - /** Emitted when starting an entirely new project + /** + * Emitted when starting an entirely new project * \note * This is similar to projectRead(); plug-ins might want to be notified * that they're in a new project. Yes, projectRead() could have been @@ -804,7 +826,8 @@ class GUI_EXPORT QgisInterface : public QObject */ void newProjectCreated(); - /** This signal is emitted when a layer has been saved using save as + /** + * This signal is emitted when a layer has been saved using save as * \note * added in version 2.7 */ diff --git a/src/gui/qgsabstractdatasourcewidget.h b/src/gui/qgsabstractdatasourcewidget.h index df6311c38571..cbf5b90c63a9 100644 --- a/src/gui/qgsabstractdatasourcewidget.h +++ b/src/gui/qgsabstractdatasourcewidget.h @@ -30,7 +30,8 @@ class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * \brief Abstract base Data Source Widget to create connections and add layers * This class provides common functionality and the interface for all * source select dialogs used by data providers to configure data sources @@ -46,7 +47,8 @@ class GUI_EXPORT QgsAbstractDataSourceWidget : public QDialog //! Destructor ~QgsAbstractDataSourceWidget() = default; - /** Store a pointer to the map canvas to retrieve extent and CRS + /** + * Store a pointer to the map canvas to retrieve extent and CRS * Used to select an appropriate CRS and possibly to retrieve data only in the current extent */ void setMapCanvas( const QgsMapCanvas *mapCanvas ); @@ -54,25 +56,29 @@ class GUI_EXPORT QgsAbstractDataSourceWidget : public QDialog public slots: - /** Triggered when the provider's connections need to be refreshed + /** + * Triggered when the provider's connections need to be refreshed * The default implementation does nothing */ virtual void refresh() {} - /** Triggered when the add button is clicked, the add layer signal is emitted + /** + * Triggered when the add button is clicked, the add layer signal is emitted * Concrete classes should implement the right behavior depending on the layer * being added. */ virtual void addButtonClicked() { } - /** Triggered when the dialog is accepted, call addButtonClicked() and + /** + * Triggered when the dialog is accepted, call addButtonClicked() and * emit the accepted() signal */ virtual void okButtonClicked(); signals: - /** Emitted when the provider's connections have changed + /** + * Emitted when the provider's connections have changed * This signal is normally forwarded the app and used to refresh browser items */ void connectionsChanged(); @@ -91,14 +97,16 @@ class GUI_EXPORT QgsAbstractDataSourceWidget : public QDialog */ void addVectorLayer( const QString &uri, const QString &layerName, const QString &providerKey = QString() ); - /** Emitted when one or more OGR supported layers are selected for addition + /** + * Emitted when one or more OGR supported layers are selected for addition * \param layerList list of layers protocol URIs * \param encoding encoding * \param dataSourceType string (can be "file" or "database") */ void addVectorLayers( const QStringList &layerList, const QString &encoding, const QString &dataSourceType ); - /** Emitted when a layer needs to be replaced + /** + * Emitted when a layer needs to be replaced * \param oldId old layer ID * \param source URI of the layer * \param name of the layer diff --git a/src/gui/qgsactionmenu.h b/src/gui/qgsactionmenu.h index 93985df2c24d..8adc3ee86404 100644 --- a/src/gui/qgsactionmenu.h +++ b/src/gui/qgsactionmenu.h @@ -29,7 +29,8 @@ class QgsMapLayerAction; class QgsVectorLayer; class QgsActionManager; -/** \ingroup gui +/** + * \ingroup gui * This class is a menu that is populated automatically with the actions defined for a given layer. */ diff --git a/src/gui/qgsadvanceddigitizingcanvasitem.h b/src/gui/qgsadvanceddigitizingcanvasitem.h index 1edb4eb2b8b5..fc29856aa7ec 100644 --- a/src/gui/qgsadvanceddigitizingcanvasitem.h +++ b/src/gui/qgsadvanceddigitizingcanvasitem.h @@ -23,7 +23,8 @@ class QgsAdvancedDigitizingDockWidget; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsAdvancedDigitizingCanvasItem class draws the graphical elements of the CAD tools (\see QgsAdvancedDigitizingDockWidget) on the map canvas. */ class GUI_EXPORT QgsAdvancedDigitizingCanvasItem : public QgsMapCanvasItem diff --git a/src/gui/qgsadvanceddigitizingdockwidget.h b/src/gui/qgsadvanceddigitizingdockwidget.h index 1dd435bf535d..3a1603eea857 100644 --- a/src/gui/qgsadvanceddigitizingdockwidget.h +++ b/src/gui/qgsadvanceddigitizingdockwidget.h @@ -32,7 +32,8 @@ class QgsMapTool; class QgsMapToolAdvancedDigitizing; class QgsPointXY; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsAdvancedDigitizingDockWidget class is a dockable widget * used to handle the CAD tools on top of a selection of map tools. * It handles both the UI and the constraints. Constraints are applied @@ -68,7 +69,8 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private Parallel //!< Parallel }; - /** \ingroup gui + /** + * \ingroup gui * \brief The CadConstraint is an abstract class for all basic constraints (angle/distance/x/y). * It contains all values (locked, value, relative) and pointers to corresponding widgets. * \note Relative is not mandatory since it is not used for distance. @@ -87,7 +89,8 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private HardLock }; - /** Constructor for CadConstraint. + /** + * Constructor for CadConstraint. * \param lineEdit associated line edit for constraint value * \param lockerButton associated button for locking constraint * \param relativeButton optional button for toggling relative constraint mode @@ -115,7 +118,8 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private */ bool isLocked() const { return mLockMode != NoLock; } - /** Returns true if a repeating lock is set for the constraint. Repeating locks are not + /** + * Returns true if a repeating lock is set for the constraint. Repeating locks are not * automatically cleared after a new point is added. * \since QGIS 2.16 * \see setRepeatingLock() @@ -142,7 +146,8 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private */ void setLockMode( LockMode mode ); - /** Sets whether a repeating lock is set for the constraint. Repeating locks are not + /** + * Sets whether a repeating lock is set for the constraint. Repeating locks are not * automatically cleared after a new point is added. * \param repeating set to true to set the lock to repeat automatically * \since QGIS 2.16 @@ -249,12 +254,14 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private //! Constraint on a common angle bool commonAngleConstraint() const { return mCommonAngleConstraint; } - /** Removes all points from the CAD point list + /** + * Removes all points from the CAD point list * \since QGIS 3.0 */ void clearPoints(); - /** Adds point to the CAD point list + /** + * Adds point to the CAD point list * \since QGIS 3.0 */ void addPoint( const QgsPointXY &point ); @@ -431,7 +438,8 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private //! Attempts to convert a user input value to double, either directly or via expression double parseUserInput( const QString &inputValue, bool &ok ) const; - /** Updates a constraint value based on a text input. + /** + * Updates a constraint value based on a text input. * \param constraint constraint to update * \param textValue user entered text value, may be an expression * \param convertExpression set to true to update widget contents to calculated expression value diff --git a/src/gui/qgsattributedialog.h b/src/gui/qgsattributedialog.h index 96ebd355f4cd..9d6de62458f1 100644 --- a/src/gui/qgsattributedialog.h +++ b/src/gui/qgsattributedialog.h @@ -30,7 +30,8 @@ class QgsDistanceArea; class QgsHighlight; -/** \ingroup gui +/** + * \ingroup gui * \class QgsAttributeDialog */ class GUI_EXPORT QgsAttributeDialog : public QDialog @@ -54,12 +55,14 @@ class GUI_EXPORT QgsAttributeDialog : public QDialog ~QgsAttributeDialog(); - /** Saves the size and position for the next time + /** + * Saves the size and position for the next time * this dialog box will be used. */ void saveGeometry(); - /** Restores the size and position from the last time + /** + * Restores the size and position from the last time * this dialog box was used. */ void restoreGeometry(); diff --git a/src/gui/qgsattributeeditorcontext.h b/src/gui/qgsattributeeditorcontext.h index c613f4236714..bddeb15f42d5 100644 --- a/src/gui/qgsattributeeditorcontext.h +++ b/src/gui/qgsattributeeditorcontext.h @@ -25,7 +25,8 @@ #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * This class contains context information for attribute editor widgets. * It will be passed to embedded widgets whenever this occurs (e.g. when * showing an embedded form due to relations) @@ -93,25 +94,29 @@ class GUI_EXPORT QgsAttributeEditorContext inline const QgsRelation &relation() const { return mRelation; } inline RelationMode relationMode() const { return mRelationMode; } - /** Returns the form mode. + /** + * Returns the form mode. * \see setFormMode() */ inline FormMode formMode() const { return mFormMode; } - /** Sets the form mode. + /** + * Sets the form mode. * \param mode form mode * \see formMode() * \since QGIS 2.16 */ inline void setFormMode( FormMode mode ) { mFormMode = mode; } - /** Returns true if the attribute editor should permit use of custom UI forms. + /** + * Returns true if the attribute editor should permit use of custom UI forms. * \see setAllowCustomUi() * \since QGIS 2.16 */ bool allowCustomUi() const { return mAllowCustomUi; } - /** Sets whether the attribute editor should permit use of custom UI forms. + /** + * Sets whether the attribute editor should permit use of custom UI forms. * \param allow set to true to allow custom UI forms, or false to disable them and use default generated * QGIS forms * \see allowCustomUi() diff --git a/src/gui/qgsattributeform.h b/src/gui/qgsattributeform.h index 0bf7bc6929d4..355cbc289258 100644 --- a/src/gui/qgsattributeform.h +++ b/src/gui/qgsattributeform.h @@ -35,7 +35,8 @@ class QgsMessageBarItem; class QgsWidgetWrapper; class QgsTabWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsAttributeForm */ class GUI_EXPORT QgsAttributeForm : public QWidget @@ -111,13 +112,15 @@ class GUI_EXPORT QgsAttributeForm : public QWidget */ bool editable(); - /** Returns the current mode of the form. + /** + * Returns the current mode of the form. * \since QGIS 2.16 * \see setMode() */ Mode mode() const { return mMode; } - /** Sets the current mode of the form. + /** + * Sets the current mode of the form. * \param mode form mode * \since QGIS 2.16 * \see mode() @@ -141,13 +144,15 @@ class GUI_EXPORT QgsAttributeForm : public QWidget */ bool eventFilter( QObject *object, QEvent *event ) override; - /** Sets all feature IDs which are to be edited if the form is in multiedit mode + /** + * Sets all feature IDs which are to be edited if the form is in multiedit mode * \param fids feature ID list * \since QGIS 2.16 */ void setMultiEditFeatureIds( const QgsFeatureIds &fids ); - /** Sets the message bar to display feedback from the form in. This is used in the search/filter + /** + * Sets the message bar to display feedback from the form in. This is used in the search/filter * mode to display the count of selected features. * \param messageBar target message bar * \since QGIS 2.16 @@ -179,19 +184,22 @@ class GUI_EXPORT QgsAttributeForm : public QWidget */ void featureSaved( const QgsFeature &feature ); - /** Is emitted when a filter expression is set using the form. + /** + * Is emitted when a filter expression is set using the form. * \param expression filter expression * \param type filter type * \since QGIS 2.16 */ void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type ); - /** Emitted when the form changes mode. + /** + * Emitted when the form changes mode. * \param mode new mode */ void modeChanged( QgsAttributeForm::Mode mode ); - /** Emitted when the user selects the close option from the form's button bar. + /** + * Emitted when the user selects the close option from the form's button bar. * \since QGIS 2.16 */ void closed(); @@ -238,7 +246,8 @@ class GUI_EXPORT QgsAttributeForm : public QWidget */ void resetValues(); - /** Resets the search/filter form values. + /** + * Resets the search/filter form values. * \since QGIS 2.16 */ void resetSearch(); diff --git a/src/gui/qgsattributeformeditorwidget.h b/src/gui/qgsattributeformeditorwidget.h index 32f402c359ab..36e2f580c099 100644 --- a/src/gui/qgsattributeformeditorwidget.h +++ b/src/gui/qgsattributeformeditorwidget.h @@ -32,7 +32,8 @@ class QgsVectorLayer; class QStackedWidget; class QgsAttributeEditorContext; -/** \ingroup gui +/** + * \ingroup gui * \class QgsAttributeFormEditorWidget * A widget consisting of both an editor widget and additional widgets for controlling the behavior * of the editor widget depending on a number of possible modes. For instance, if the parent attribute @@ -54,7 +55,8 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget SearchMode, //!< Layer search/filter mode }; - /** Constructor for QgsAttributeFormEditorWidget. + /** + * Constructor for QgsAttributeFormEditorWidget. * \param editorWidget associated editor widget wrapper (for default/edit modes) * \param form parent attribute form */ @@ -63,7 +65,8 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget ~QgsAttributeFormEditorWidget(); - /** Creates the search widget wrappers for the widget used when the form is in + /** + * Creates the search widget wrappers for the widget used when the form is in * search mode. * \param widgetId id of the widget type to create a search wrapper for * \param fieldIdx index of field associated with widget @@ -74,34 +77,40 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget const QVariantMap &config, const QgsAttributeEditorContext &context SIP_PYARGREMOVE = QgsAttributeEditorContext() ); - /** Sets the current mode for the widget. The widget will adapt its state and visible widgets to + /** + * Sets the current mode for the widget. The widget will adapt its state and visible widgets to * reflect the updated mode. For example, showing multi edit tool buttons if the mode is set to MultiEditMode. * \param mode widget mode * \see mode() */ void setMode( Mode mode ); - /** Returns the current mode for the widget. + /** + * Returns the current mode for the widget. * \see setMode() */ Mode mode() const { return mMode; } - /** Resets the widget to an initial value. + /** + * Resets the widget to an initial value. * \param initialValue initial value to show in widget * \param mixedValues set to true to initially show the mixed values state */ void initialize( const QVariant &initialValue, bool mixedValues = false ); - /** Returns true if the widget's value has been changed since it was initialized. + /** + * Returns true if the widget's value has been changed since it was initialized. * \see initialize() */ bool hasChanged() const { return mIsChanged; } - /** Returns the current value of the attached editor widget. + /** + * Returns the current value of the attached editor widget. */ QVariant currentValue() const; - /** Creates an expression matching the current search filter value and + /** + * Creates an expression matching the current search filter value and * search properties represented in the widget. * \since QGIS 2.16 */ @@ -109,16 +118,19 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget public slots: - /** Sets whether the widget should be displayed in a "mixed values" mode. + /** + * Sets whether the widget should be displayed in a "mixed values" mode. * \param mixed set to true to show in a mixed values state */ void setIsMixed( bool mixed ); - /** Called when field values have been committed; + /** + * Called when field values have been committed; */ void changesCommitted(); - /** Resets the search/filter value of the widget. + /** + * Resets the search/filter value of the widget. */ void resetSearch(); @@ -146,13 +158,15 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget protected: - /** Returns a pointer to the search widget tool button in the widget. + /** + * Returns a pointer to the search widget tool button in the widget. * \note this method is in place for unit testing only, and is not considered * stable API */ QgsSearchWidgetToolButton *searchWidgetToolButton(); - /** Sets the search widget wrapper for the widget used when the form is in + /** + * Sets the search widget wrapper for the widget used when the form is in * search mode. * \param wrapper search widget wrapper. * \note the search widget wrapper should be created using searchWidgetFrame() @@ -162,14 +176,16 @@ class GUI_EXPORT QgsAttributeFormEditorWidget : public QWidget */ void setSearchWidgetWrapper( QgsSearchWidgetWrapper *wrapper ); - /** Returns the widget which should be used as a parent during construction + /** + * Returns the widget which should be used as a parent during construction * of the search widget wrapper. * \note this method is in place for unit testing only, and is not considered * stable AP */ QWidget *searchWidgetFrame(); - /** Returns the search widget wrapper used in this widget. The wrapper must + /** + * Returns the search widget wrapper used in this widget. The wrapper must * first be created using createSearchWidgetWrapper() * \note this method is in place for unit testing only, and is not considered * stable AP diff --git a/src/gui/qgsattributeforminterface.h b/src/gui/qgsattributeforminterface.h index a08fbb5c8152..5a70210053c2 100644 --- a/src/gui/qgsattributeforminterface.h +++ b/src/gui/qgsattributeforminterface.h @@ -21,7 +21,8 @@ class QgsAttributeForm; class QgsFeature; -/** \ingroup gui +/** + * \ingroup gui * \class QgsAttributeFormInterface */ class GUI_EXPORT QgsAttributeFormInterface diff --git a/src/gui/qgsattributeformlegacyinterface.h b/src/gui/qgsattributeformlegacyinterface.h index 341731846512..678e9dfbe901 100644 --- a/src/gui/qgsattributeformlegacyinterface.h +++ b/src/gui/qgsattributeformlegacyinterface.h @@ -23,7 +23,8 @@ #define SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * This class helps to support legacy open form scripts to be compatible with the new * QgsAttributeForm style interface. * \note not available in Python bindings diff --git a/src/gui/qgsattributetypeloaddialog.h b/src/gui/qgsattributetypeloaddialog.h index 2a7e4c5eeb0e..c5070454e2ef 100644 --- a/src/gui/qgsattributetypeloaddialog.h +++ b/src/gui/qgsattributetypeloaddialog.h @@ -28,7 +28,8 @@ class QgsField; class QgsMapCanvas; class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsAttributeTypeLoadDialog */ class GUI_EXPORT QgsAttributeTypeLoadDialog: public QDialog, private Ui::QgsAttributeLoadValues diff --git a/src/gui/qgsblendmodecombobox.h b/src/gui/qgsblendmodecombobox.h index 2684d0411bbd..f3ee6501c4da 100644 --- a/src/gui/qgsblendmodecombobox.h +++ b/src/gui/qgsblendmodecombobox.h @@ -23,7 +23,8 @@ #include // For QPainter::CompositionMode enum #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * A combobox which lets the user select blend modes from a predefined list **/ class GUI_EXPORT QgsBlendModeComboBox : public QComboBox @@ -38,7 +39,8 @@ class GUI_EXPORT QgsBlendModeComboBox : public QComboBox void setBlendMode( QPainter::CompositionMode blendMode ); private: - /** Returns a QStringList of the translated blend modes + /** + * Returns a QStringList of the translated blend modes * "-" is used to indicate the position of a separator in the list * This list is designed to emulate GIMP's layer modes, where * blending modes are grouped by their effect (lightening, darkening, etc) @@ -52,7 +54,8 @@ class GUI_EXPORT QgsBlendModeComboBox : public QComboBox public slots: - /** Populates the blend mode combo box, and sets up mapping for + /** + * Populates the blend mode combo box, and sets up mapping for * blend modes to combo box indexes */ void updateModes(); diff --git a/src/gui/qgsbrowserdockwidget_p.h b/src/gui/qgsbrowserdockwidget_p.h index b500b3779b77..a46182d90494 100644 --- a/src/gui/qgsbrowserdockwidget_p.h +++ b/src/gui/qgsbrowserdockwidget_p.h @@ -91,7 +91,8 @@ class QgsBrowserPropertiesWidget : public QWidget //! Set content widget, usually item paramWidget. Takes ownership. virtual void setWidget( QWidget *widget ); - /** Sets whether the properties widget should display in condensed mode, ie, for display in a dock + /** + * Sets whether the properties widget should display in condensed mode, ie, for display in a dock * widget rather than it's own separate dialog. * \param condensedMode set to true to enable condensed mode * \since QGIS 2.10 @@ -115,7 +116,8 @@ class QgsBrowserLayerProperties : public QgsBrowserPropertiesWidget, private Ui: //! Set item void setItem( QgsDataItem *item ) override; - /** Sets whether the properties widget should display in condensed mode, ie, for display in a dock + /** + * Sets whether the properties widget should display in condensed mode, ie, for display in a dock * widget rather than it's own separate dialog. * \param condensedMode set to true to enable condensed mode * \since QGIS 2.10 diff --git a/src/gui/qgsbrowsertreeview.h b/src/gui/qgsbrowsertreeview.h index b7f24fa7c9ba..e42146656baa 100644 --- a/src/gui/qgsbrowsertreeview.h +++ b/src/gui/qgsbrowsertreeview.h @@ -22,7 +22,8 @@ class QgsBrowserModel; -/** \ingroup gui +/** + * \ingroup gui * The QgsBrowserTreeView class extends QTreeView with save/restore tree state functionality. * * \see QgsBrowserModel diff --git a/src/gui/qgsbusyindicatordialog.h b/src/gui/qgsbusyindicatordialog.h index 94fc241e32bf..2e264fe85c15 100644 --- a/src/gui/qgsbusyindicatordialog.h +++ b/src/gui/qgsbusyindicatordialog.h @@ -26,7 +26,8 @@ #include "qgis_sip.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsBusyIndicatorDialog * A simple dialog to show an indeterminate busy progress indicator. */ @@ -35,7 +36,8 @@ class GUI_EXPORT QgsBusyIndicatorDialog : public QDialog Q_OBJECT public: - /** Constructor + /** + * Constructor * Modal busy indicator dialog with no buttons. * \param message Text to show above busy progress indicator. * \param parent parent object (owner) diff --git a/src/gui/qgscharacterselectordialog.h b/src/gui/qgscharacterselectordialog.h index d3183299f6e3..c848ac4d8d57 100644 --- a/src/gui/qgscharacterselectordialog.h +++ b/src/gui/qgscharacterselectordialog.h @@ -26,7 +26,8 @@ class CharacterWidget; -/** \ingroup gui +/** + * \ingroup gui * A dialog for selecting a single character from a single font */ diff --git a/src/gui/qgscheckablecombobox.h b/src/gui/qgscheckablecombobox.h index 6b6a701daf22..f2401a7179a4 100644 --- a/src/gui/qgscheckablecombobox.h +++ b/src/gui/qgscheckablecombobox.h @@ -28,7 +28,8 @@ class QEvent; -/** \class QgsCheckableItemModel +/** + * \class QgsCheckableItemModel * \ingroup gui * QStandardItemModel subclass which makes all items checkable * by default. @@ -42,26 +43,30 @@ class QgsCheckableItemModel : public QStandardItemModel public: - /** Constructor for QgsCheckableItemModel. + /** + * Constructor for QgsCheckableItemModel. * \param parent parent object */ QgsCheckableItemModel( QObject *parent = nullptr ); - /** Returns a combination of the item flags: items are enabled + /** + * Returns a combination of the item flags: items are enabled * (ItemIsEnabled), selectable (ItemIsSelectable) and checkable * (ItemIsUserCheckable). * \param index item index */ virtual Qt::ItemFlags flags( const QModelIndex &index ) const; - /** Returns the data stored under the given role for the item + /** + * Returns the data stored under the given role for the item * referred to by the index. * \param index item index * \param role data role */ virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const; - /** Sets the role data for the item at index to value. + /** + * Sets the role data for the item at index to value. * \param index item index * \param value data value * \param role data role @@ -71,13 +76,15 @@ class QgsCheckableItemModel : public QStandardItemModel signals: - /** This signal is emitted whenever the items checkstate has changed. + /** + * This signal is emitted whenever the items checkstate has changed. */ void itemCheckStateChanged(); }; -/** \class QgsCheckBoxDelegate +/** + * \class QgsCheckBoxDelegate * \ingroup gui * QStyledItemDelegate subclass for QgsCheckableComboBox. Needed for * correct drawing of the checkable items on Mac and GTK. @@ -91,12 +98,14 @@ class QgsCheckBoxDelegate : public QStyledItemDelegate public: - /** Constructor for QgsCheckBoxDelegate. + /** + * Constructor for QgsCheckBoxDelegate. * \param parent parent object */ QgsCheckBoxDelegate( QObject *parent = nullptr ); - /** Renders the delegate using the given painter and style option + /** + * Renders the delegate using the given painter and style option * for the item specified by index. * \param painter painter to use * \param option style option @@ -106,7 +115,8 @@ class QgsCheckBoxDelegate : public QStyledItemDelegate }; #endif -/** \class QgsCheckableComboBox +/** + * \class QgsCheckableComboBox * \ingroup gui * QComboBox subclass which allows selecting multiple items. * \since QGIS 3.0 @@ -122,47 +132,55 @@ class GUI_EXPORT QgsCheckableComboBox : public QComboBox public: - /** Constructor for QgsCheckableComboBox. + /** + * Constructor for QgsCheckableComboBox. */ QgsCheckableComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Returns separator used to separate items in the display text. + /** + * Returns separator used to separate items in the display text. * \see setSeparator() */ QString separator() const; - /** Set separator used to separate items in the display text. + /** + * Set separator used to separate items in the display text. * \param separator separator to use * \see separator() */ void setSeparator( const QString &separator ); - /** Returns default text which will be displayed in the widget + /** + * Returns default text which will be displayed in the widget * when no items selected. * \see setDefaultText() */ QString defaultText() const; - /** Set default text which will be displayed in the widget when + /** + * Set default text which will be displayed in the widget when * no items selected. * \param text default text * \see defaultText() */ void setDefaultText( const QString &text ); - /** Returns currently checked items. + /** + * Returns currently checked items. * \see setCheckedItems() */ QStringList checkedItems() const; - /** Returns the checked state of the item identified by index + /** + * Returns the checked state of the item identified by index * \param index item index * \see setItemCheckState() * \see toggleItemCheckState() */ Qt::CheckState itemCheckState( int index ) const; - /** Sets the item check state to state + /** + * Sets the item check state to state * \param index item index * \param state check state * \see itemCheckState() @@ -170,31 +188,36 @@ class GUI_EXPORT QgsCheckableComboBox : public QComboBox */ void setItemCheckState( int index, Qt::CheckState state ); - /** Toggles the item check state + /** + * Toggles the item check state * \param index item index * \see itemCheckState() * \see setItemCheckState() */ void toggleItemCheckState( int index ); - /** Hides the list of items in the combobox if it is currently + /** + * Hides the list of items in the combobox if it is currently * visible and resets the internal state. */ virtual void hidePopup() override; - /** Filters events to enable context menu + /** + * Filters events to enable context menu */ virtual bool eventFilter( QObject *object, QEvent *event ) override; signals: - /** This signal is emitted whenever the checked items list changed. + /** + * This signal is emitted whenever the checked items list changed. */ void checkedItemsChanged( const QStringList &items ); public slots: - /** Set items which should be checked/selected. + /** + * Set items which should be checked/selected. * \param items items to select * \see checkedItems() */ @@ -202,22 +225,26 @@ class GUI_EXPORT QgsCheckableComboBox : public QComboBox protected: - /** Handler for widget resizing + /** + * Handler for widget resizing */ virtual void resizeEvent( QResizeEvent *event ) override; protected slots: - /** Display context menu which allows selecting/deselecting + /** + * Display context menu which allows selecting/deselecting * all items at once. */ void showContextMenu( const QPoint &pos ); - /** Selects all items. + /** + * Selects all items. */ void selectAllOptions(); - /** Removes selection from all items. + /** + * Removes selection from all items. */ void deselectAllOptions(); diff --git a/src/gui/qgscodeeditor.h b/src/gui/qgscodeeditor.h index e9a8830b8472..6364ae9fa55b 100644 --- a/src/gui/qgscodeeditor.h +++ b/src/gui/qgscodeeditor.h @@ -29,7 +29,8 @@ SIP_IF_MODULE( HAVE_QSCI_SIP ) class QWidget; -/** \ingroup gui +/** + * \ingroup gui * A text editor based on QScintilla2. * \since QGIS 2.6 * \note may not be available in Python bindings, depending on platform support @@ -51,24 +52,28 @@ class GUI_EXPORT QgsCodeEditor : public QsciScintilla */ QgsCodeEditor( QWidget *parent SIP_TRANSFERTHIS = nullptr, const QString &title = QString(), bool folding = false, bool margin = false ); - /** Set the widget title + /** + * Set the widget title * \param title widget title */ void setTitle( const QString &title ); - /** Set margin visible state + /** + * Set margin visible state * \param margin Set margin in the editor */ void setMarginVisible( bool margin ); bool marginVisible() { return mMargin; } - /** Set folding visible state + /** + * Set folding visible state * \param folding Set folding in the editor */ void setFoldingVisible( bool folding ); bool foldingVisible() { return mFolding; } - /** Insert text at cursor position, or replace any selected text if user has + /** + * Insert text at cursor position, or replace any selected text if user has * made a selection. * \param text The text to be inserted */ diff --git a/src/gui/qgscodeeditorcss.h b/src/gui/qgscodeeditorcss.h index 877b60a4d4a3..a913d9adbbb4 100644 --- a/src/gui/qgscodeeditorcss.h +++ b/src/gui/qgscodeeditorcss.h @@ -23,7 +23,8 @@ SIP_IF_MODULE( HAVE_QSCI_SIP ) -/** \ingroup gui +/** + * \ingroup gui * A CSS editor based on QScintilla2. Adds syntax highlighting and * code autocompletion. * \since QGIS 2.6 diff --git a/src/gui/qgscodeeditorhtml.h b/src/gui/qgscodeeditorhtml.h index e6ffc2bfc0c8..0c0fd9330281 100644 --- a/src/gui/qgscodeeditorhtml.h +++ b/src/gui/qgscodeeditorhtml.h @@ -22,7 +22,8 @@ SIP_IF_MODULE( HAVE_QSCI_SIP ) -/** \ingroup gui +/** + * \ingroup gui * A HTML editor based on QScintilla2. Adds syntax highlighting and * code autocompletion. * \since QGIS 2.6 diff --git a/src/gui/qgscodeeditorpython.h b/src/gui/qgscodeeditorpython.h index 4b8f72dbd739..44407c2c6543 100644 --- a/src/gui/qgscodeeditorpython.h +++ b/src/gui/qgscodeeditorpython.h @@ -23,7 +23,8 @@ SIP_IF_MODULE( HAVE_QSCI_SIP ) -/** \ingroup gui +/** + * \ingroup gui * A Python editor based on QScintilla2. Adds syntax highlighting and * code autocompletion. * \since QGIS 2.6 @@ -44,12 +45,14 @@ class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor */ QgsCodeEditorPython( QWidget *parent SIP_TRANSFERTHIS = 0, const QList &filenames = QList() ); - /** Load APIs from one or more files + /** + * Load APIs from one or more files * \param filenames The list of apis files to load for the Python lexer */ void loadAPIs( const QList &filenames ); - /** Load a script file + /** + * Load a script file * \param script The script file to load */ bool loadScript( const QString &script ); diff --git a/src/gui/qgscodeeditorsql.h b/src/gui/qgscodeeditorsql.h index be7ed6d48143..44d05482e999 100644 --- a/src/gui/qgscodeeditorsql.h +++ b/src/gui/qgscodeeditorsql.h @@ -23,7 +23,8 @@ SIP_IF_MODULE( HAVE_QSCI_SIP ) -/** \ingroup gui +/** + * \ingroup gui * A SQL editor based on QScintilla2. Adds syntax highlighting and * code autocompletion. * \since QGIS 2.6 @@ -45,7 +46,8 @@ class GUI_EXPORT QgsCodeEditorSQL : public QgsCodeEditor #ifndef SIP_RUN ///@cond PRIVATE -/** Internal use. +/** + * Internal use. setAutoCompletionCaseSensitivity( false ) is not sufficient when installing a lexer, since its caseSensitive() method is actually used, and defaults diff --git a/src/gui/qgscollapsiblegroupbox.h b/src/gui/qgscollapsiblegroupbox.h index deff6271c8e0..487af29ab928 100644 --- a/src/gui/qgscollapsiblegroupbox.h +++ b/src/gui/qgscollapsiblegroupbox.h @@ -30,7 +30,8 @@ class QToolButton; class QScrollArea; -/** \ingroup gui +/** + * \ingroup gui * \class QgsGroupBoxCollapseButton */ class GUI_EXPORT QgsGroupBoxCollapseButton : public QToolButton @@ -61,7 +62,8 @@ class GUI_EXPORT QgsGroupBoxCollapseButton : public QToolButton bool mShiftDown = false; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsCollapsibleGroupBoxBasic * A groupbox that collapses/expands when toggled. * Basic class QgsCollapsibleGroupBoxBasic does not auto-save collapsed or checked state @@ -166,7 +168,8 @@ class GUI_EXPORT QgsCollapsibleGroupBoxBasic : public QGroupBox QIcon mExpandIcon; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsCollapsibleGroupBox * A groupbox that collapses/expands when toggled and can save its collapsed and checked states. * By default, it auto-saves only its collapsed state to the global settings based on the widget and it's parent names. @@ -202,7 +205,8 @@ class GUI_EXPORT QgsCollapsibleGroupBox : public QgsCollapsibleGroupBoxBasic //! set this to false to not save/restore collapsed state void setSaveCollapsedState( bool save ) { mSaveCollapsedState = save; } - /** Set this to true to save/restore checked state + /** + * Set this to true to save/restore checked state * \note only turn on mSaveCheckedState for groupboxes NOT used * in multiple places or used as options for different parent objects */ void setSaveCheckedState( bool save ) { mSaveCheckedState = save; } diff --git a/src/gui/qgscolorbrewercolorrampdialog.h b/src/gui/qgscolorbrewercolorrampdialog.h index bc5be7749e7e..b14bcd325cf3 100644 --- a/src/gui/qgscolorbrewercolorrampdialog.h +++ b/src/gui/qgscolorbrewercolorrampdialog.h @@ -25,7 +25,8 @@ class QgsColorBrewerColorRamp; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorBrewerColorRampWidget * A widget which allows users to modify the properties of a QgsColorBrewerColorRamp. * \since QGIS 3.0 @@ -37,18 +38,21 @@ class GUI_EXPORT QgsColorBrewerColorRampWidget : public QgsPanelWidget, private public: - /** Constructor for QgsColorBrewerColorRampWidget. + /** + * Constructor for QgsColorBrewerColorRampWidget. * \param ramp initial ramp to show in dialog * \param parent parent widget */ QgsColorBrewerColorRampWidget( const QgsColorBrewerColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Returns a color ramp representing the current settings from the dialog. + /** + * Returns a color ramp representing the current settings from the dialog. * \see setRamp() */ QgsColorBrewerColorRamp ramp() const { return mRamp; } - /** Sets the color ramp to show in the dialog. + /** + * Sets the color ramp to show in the dialog. * \param ramp color ramp * \see ramp() */ @@ -72,7 +76,8 @@ class GUI_EXPORT QgsColorBrewerColorRampWidget : public QgsPanelWidget, private QgsColorBrewerColorRamp mRamp; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorBrewerColorRampDialog * A dialog which allows users to modify the properties of a QgsColorBrewerColorRamp. * \since QGIS 3.0 @@ -84,18 +89,21 @@ class GUI_EXPORT QgsColorBrewerColorRampDialog : public QDialog public: - /** Constructor for QgsColorBrewerColorRampDialog. + /** + * Constructor for QgsColorBrewerColorRampDialog. * \param ramp initial ramp to show in dialog * \param parent parent widget */ QgsColorBrewerColorRampDialog( const QgsColorBrewerColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Returns a color ramp representing the current settings from the dialog. + /** + * Returns a color ramp representing the current settings from the dialog. * \see setRamp() */ QgsColorBrewerColorRamp ramp() const { return mWidget->ramp(); } - /** Sets the color ramp to show in the dialog. + /** + * Sets the color ramp to show in the dialog. * \param ramp color ramp * \see ramp() */ diff --git a/src/gui/qgscolorbutton.h b/src/gui/qgscolorbutton.h index e916a37adedd..97d623bd1738 100644 --- a/src/gui/qgscolorbutton.h +++ b/src/gui/qgscolorbutton.h @@ -25,7 +25,8 @@ class QMimeData; class QgsColorSchemeRegistry; class QgsPanelWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorButton * A cross platform button subclass for selecting colors. Will open a color chooser dialog when clicked. * Offers live updates to button from color chooser dialog. An attached drop-down menu allows for copying @@ -59,7 +60,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton public: - /** Specifies the behavior when the button is clicked + /** + * Specifies the behavior when the button is clicked */ enum Behavior { @@ -68,7 +70,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton }; Q_ENUM( Behavior ); - /** Construct a new color ramp button. + /** + * Construct a new color ramp button. * Use \a parent to attach a parent QWidget to the dialog. * Use \a cdt string to define the title to show in the color ramp dialog * Use a color scheme \a registry for color swatch grids to show in the drop-down menu. If not specified, @@ -79,7 +82,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton virtual QSize minimumSizeHint() const override; virtual QSize sizeHint() const override; - /** Return the currently selected color. + /** + * Return the currently selected color. * \returns currently selected color * \see setColor */ @@ -103,58 +107,67 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ bool allowOpacity() const { return mAllowOpacity; } - /** Set the title for the color chooser dialog window. + /** + * Set the title for the color chooser dialog window. * \param title Title for the color chooser dialog * \see colorDialogTitle */ void setColorDialogTitle( const QString &title ); - /** Returns the title for the color chooser dialog window. + /** + * Returns the title for the color chooser dialog window. * \returns title for the color chooser dialog * \see setColorDialogTitle */ QString colorDialogTitle() const; - /** Returns whether the button accepts live updates from QColorDialog. + /** + * Returns whether the button accepts live updates from QColorDialog. * \returns true if the button will be accepted immediately when the dialog's color changes * \see setAcceptLiveUpdates */ bool acceptLiveUpdates() const { return mAcceptLiveUpdates; } - /** Sets whether the button accepts live updates from QColorDialog. Live updates may cause changes + /** + * Sets whether the button accepts live updates from QColorDialog. Live updates may cause changes * that are not undoable on QColorDialog cancel. * \param accept set to true to enable live updates * \see acceptLiveUpdates */ void setAcceptLiveUpdates( const bool accept ) { mAcceptLiveUpdates = accept; } - /** Sets whether the drop-down menu should be shown for the button. The default behavior is to + /** + * Sets whether the drop-down menu should be shown for the button. The default behavior is to * show the menu. * \param showMenu set to false to hide the drop-down menu * \see showMenu */ void setShowMenu( const bool showMenu ); - /** Returns whether the drop-down menu is shown for the button. + /** + * Returns whether the drop-down menu is shown for the button. * \returns true if drop-down menu is shown * \see setShowMenu */ bool showMenu() const { return menu() ? true : false; } - /** Sets the behavior for when the button is clicked. The default behavior is to show + /** + * Sets the behavior for when the button is clicked. The default behavior is to show * a color picker dialog. * \param behavior behavior when button is clicked * \see behavior */ void setBehavior( const Behavior behavior ); - /** Returns the behavior for when the button is clicked. + /** + * Returns the behavior for when the button is clicked. * \returns behavior when button is clicked * \see setBehavior */ Behavior behavior() const { return mBehavior; } - /** Sets the default color for the button, which is shown in the button's drop-down menu for the + /** + * Sets the default color for the button, which is shown in the button's drop-down menu for the * "default color" option. * \param color default color for the button. Set to an invalid QColor to disable the default color * option. @@ -162,7 +175,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ void setDefaultColor( const QColor &color ); - /** Returns the default color for the button, which is shown in the button's drop-down menu for the + /** + * Returns the default color for the button, which is shown in the button's drop-down menu for the * "default color" option. * \returns default color for the button. Returns an invalid QColor if the default color * option is disabled. @@ -170,7 +184,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ QColor defaultColor() const { return mDefaultColor; } - /** Sets whether the "no color" option should be shown in the button's drop-down menu. If selected, + /** + * Sets whether the "no color" option should be shown in the button's drop-down menu. If selected, * the "no color" option sets the color button's color to a totally transparent color. * \param showNoColorOption set to true to show the no color option. This is disabled by default. * \see showNoColor @@ -180,7 +195,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ void setShowNoColor( const bool showNoColorOption ) { mShowNoColorOption = showNoColorOption; } - /** Returns whether the "no color" option is shown in the button's drop-down menu. If selected, + /** + * Returns whether the "no color" option is shown in the button's drop-down menu. If selected, * the "no color" option sets the color button's color to a totally transparent color. * \returns true if the no color option is shown. * \see setShowNoColor @@ -190,7 +206,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ bool showNoColor() const { return mShowNoColorOption; } - /** Sets the string to use for the "no color" option in the button's drop-down menu. + /** + * Sets the string to use for the "no color" option in the button's drop-down menu. * \param noColorString string to use for the "no color" menu option * \see noColorString * \see setShowNoColor @@ -199,7 +216,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ void setNoColorString( const QString &noColorString ) { mNoColorString = noColorString; } - /** Sets whether a set to null (clear) option is shown in the button's drop-down menu. + /** + * Sets whether a set to null (clear) option is shown in the button's drop-down menu. * \param showNull set to true to show a null option * \since QGIS 2.16 * \see showNull() @@ -207,21 +225,24 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ void setShowNull( bool showNull ); - /** Returns whether the set to null (clear) option is shown in the button's drop-down menu. + /** + * Returns whether the set to null (clear) option is shown in the button's drop-down menu. * \since QGIS 2.16 * \see setShowNull() * \see isNull() */ bool showNull() const; - /** Returns true if the current color is null. + /** + * Returns true if the current color is null. * \since QGIS 2.16 * \see setShowNull() * \see showNull() */ bool isNull() const; - /** Returns the string used for the "no color" option in the button's drop-down menu. + /** + * Returns the string used for the "no color" option in the button's drop-down menu. * \returns string used for the "no color" menu option * \see setNoColorString * \see showNoColor @@ -230,7 +251,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ QString noColorString() const { return mNoColorString; } - /** Sets the context string for the color button. The context string is passed to all color swatch + /** + * Sets the context string for the color button. The context string is passed to all color swatch * grids shown in the button's drop-down menu, to allow them to customise their display colors * based on the context. * \param context context string for the color button's color swatch grids @@ -238,7 +260,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ void setContext( const QString &context ) { mContext = context; } - /** Returns the context string for the color button. The context string is passed to all color swatch + /** + * Returns the context string for the color button. The context string is passed to all color swatch * grids shown in the button's drop-down menu, to allow them to customise their display colors * based on the context. * \returns context string for the color button's color swatch grids @@ -246,7 +269,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ QString context() const { return mContext; } - /** Sets the color scheme registry for the button, which controls the color swatch grids + /** + * Sets the color scheme registry for the button, which controls the color swatch grids * that are shown in the button's drop-down menu. * \param registry color scheme registry for the button. Set to 0 to hide all color * swatch grids from the button's drop-down menu. @@ -254,7 +278,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ void setColorSchemeRegistry( QgsColorSchemeRegistry *registry ) { mColorSchemeRegistry = registry; } - /** Returns the color scheme registry for the button, which controls the color swatch grids + /** + * Returns the color scheme registry for the button, which controls the color swatch grids * that are shown in the button's drop-down menu. * \returns color scheme registry for the button. If returned value is 0 then all color * swatch grids are hidden from the button's drop-down menu. @@ -264,14 +289,16 @@ class GUI_EXPORT QgsColorButton : public QToolButton public slots: - /** Sets the current color for the button. Will emit a colorChanged signal if the color is different + /** + * Sets the current color for the button. Will emit a colorChanged signal if the color is different * to the previous color. * \param color new color for the button * \see color */ void setColor( const QColor &color ); - /** Sets the background pixmap for the button based upon color and transparency. + /** + * Sets the background pixmap for the button based upon color and transparency. * Call directly to update background after adding/removing QColorDialog::ShowAlphaChannel option * but the color has not changed, i.e. setColor() wouldn't update button and * you want the button to retain the set color's alpha component regardless @@ -280,36 +307,42 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ void setButtonBackground( const QColor &color = QColor() ); - /** Copies the current color to the clipboard + /** + * Copies the current color to the clipboard * \see pasteColor */ void copyColor(); - /** Pastes a color from the clipboard to the color button. If clipboard does not contain a valid + /** + * Pastes a color from the clipboard to the color button. If clipboard does not contain a valid * color or string representation of a color, then no change is applied. * \see copyColor */ void pasteColor(); - /** Activates the color picker tool, which allows for sampling a color from anywhere on the screen + /** + * Activates the color picker tool, which allows for sampling a color from anywhere on the screen */ void activatePicker(); - /** Sets color to a totally transparent color. + /** + * Sets color to a totally transparent color. * \note If the color button is not set to show an opacity channel in the color * dialog (see setColorDialogOptions) then the color will not be changed. * \see setToNull() */ void setToNoColor(); - /** Sets color to the button's default color, if set. + /** + * Sets color to the button's default color, if set. * \see setDefaultColor * \see defaultColor * \see setToNull() */ void setToDefaultColor(); - /** Sets color to null. + /** + * Sets color to null. * \see setToDefaultColor() * \see setToNoColor() * \since QGIS 2.16 @@ -318,13 +351,15 @@ class GUI_EXPORT QgsColorButton : public QToolButton signals: - /** Is emitted whenever a new color is set for the button. The color is always valid. + /** + * Is emitted whenever a new color is set for the button. The color is always valid. * In case the new color is the same no signal is emitted, to avoid infinite loops. * \param color New color */ void colorChanged( const QColor &color ); - /** Emitted when the button is clicked, if the button's behavior is set to SignalOnly + /** + * Emitted when the button is clicked, if the button's behavior is set to SignalOnly * \param color button color * \see setBehavior * \see behavior @@ -338,7 +373,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton void showEvent( QShowEvent *e ) override; void resizeEvent( QResizeEvent *event ) override; - /** Returns a checkboard pattern pixmap for use as a background to transparent colors + /** + * Returns a checkboard pattern pixmap for use as a background to transparent colors */ static const QPixmap &transparentBackground(); @@ -403,7 +439,8 @@ class GUI_EXPORT QgsColorButton : public QToolButton QSize mIconSize; - /** Attempts to parse mimeData as a color, either via the mime data's color data or by + /** + * Attempts to parse mimeData as a color, either via the mime data's color data or by * parsing a textual representation of a color. * \returns true if mime data could be intrepreted as a color * \param mimeData mime data @@ -412,14 +449,16 @@ class GUI_EXPORT QgsColorButton : public QToolButton */ bool colorFromMimeData( const QMimeData *mimeData, QColor &resultColor ); - /** Ends a color picking operation + /** + * Ends a color picking operation * \param eventPos global position of pixel to sample color from * \param sampleColor set to true to actually sample the color, false to just cancel * the color picking operation */ void stopPicking( QPointF eventPos, bool sampleColor = true ); - /** Create a color icon for display in the drop-down menu + /** + * Create a color icon for display in the drop-down menu * \param color for icon * \param showChecks set to true to display a checkboard pattern behind * transparent colors @@ -432,21 +471,25 @@ class GUI_EXPORT QgsColorButton : public QToolButton void showColorDialog(); - /** Sets color for button, if valid. + /** + * Sets color for button, if valid. */ void setValidColor( const QColor &newColor ); - /** Sets color for button, if valid. The color is treated as a temporary color, and is not + /** + * Sets color for button, if valid. The color is treated as a temporary color, and is not * added to the recent colors list. */ void setValidTemporaryColor( const QColor &newColor ); - /** Adds a color to the recent colors list + /** + * Adds a color to the recent colors list * \param color to add to recent colors list */ void addRecentColor( const QColor &color ); - /** Creates the drop-down menu entries + /** + * Creates the drop-down menu entries */ void prepareMenu(); }; diff --git a/src/gui/qgscolordialog.h b/src/gui/qgscolordialog.h index ba7da6c496f2..5bb2b6d2e678 100644 --- a/src/gui/qgscolordialog.h +++ b/src/gui/qgscolordialog.h @@ -25,7 +25,8 @@ class QColor; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorDialog * A custom QGIS dialog for selecting a color. Has many improvements over the standard Qt color picker dialog, including * hue wheel supports, color swatches, and a color sampler. @@ -39,7 +40,8 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase public: - /** Create a new color picker dialog + /** + * Create a new color picker dialog * \param parent parent widget * \param fl window flags * \param color initial color for dialog @@ -47,24 +49,28 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase QgsColorDialog( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, const QColor &color = QColor() ); - /** Returns the current color for the dialog + /** + * Returns the current color for the dialog * \returns dialog color */ QColor color() const; - /** Sets the title for the color dialog + /** + * Sets the title for the color dialog * \param title title for dialog box */ void setTitle( const QString &title ); - /** Sets whether opacity modification (transparency) is permitted + /** + * Sets whether opacity modification (transparency) is permitted * for the color dialog. Defaults to true. * \param allowOpacity set to false to disable opacity modification * \since QGIS 3.0 */ void setAllowOpacity( const bool allowOpacity ); - /** Return a color selection from a color dialog, with live updating of interim selections. + /** + * Return a color selection from a color dialog, with live updating of interim selections. * \param initialColor the initial color of the selection dialog. * \param updateObject the receiver object of the live updating. * \param updateSlot the receiver object's slot for live updating (e.g. SLOT( setValidColor( const QColor& ) ) ). @@ -79,7 +85,8 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase const QString &title = QString(), const bool allowOpacity = true ); - /** Return a color selection from a color dialog. + /** + * Return a color selection from a color dialog. * \param initialColor the initial color of the selection dialog. * \param parent parent widget * \param title the title of the dialog. @@ -92,14 +99,16 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase signals: - /** Emitted when the dialog's color changes + /** + * Emitted when the dialog's color changes * \param color current color */ void currentColorChanged( const QColor &color ); public slots: - /** Sets the current color for the dialog + /** + * Sets the current color for the dialog * \param color desired color */ void setColor( const QColor &color ); @@ -122,7 +131,8 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase bool mAllowOpacity = true; - /** Saves all dialog and widget settings + /** + * Saves all dialog and widget settings */ void saveSettings(); diff --git a/src/gui/qgscolorrampbutton.h b/src/gui/qgscolorrampbutton.h index 074c9422f554..76ef153f12dd 100644 --- a/src/gui/qgscolorrampbutton.h +++ b/src/gui/qgscolorrampbutton.h @@ -26,7 +26,8 @@ class QgsPanelWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorRampButton * A cross platform button subclass for selecting color ramps. Will open color ramp dialogs when clicked. * Offers live updates to button from color ramp dialog. An attached drop-down menu allows for access to @@ -44,7 +45,8 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton public: - /** Construct a new color ramp button. + /** + * Construct a new color ramp button. * Use \a parent to attach a parent QWidget to the dialog. * Use \a dialogTitle string to define the title to show in the color ramp dialog */ @@ -54,50 +56,58 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton virtual QSize sizeHint() const override; - /** Return a copy of the current color ramp. + /** + * Return a copy of the current color ramp. * \see setColorRamp() */ QgsColorRamp *colorRamp() const SIP_FACTORY; - /** Set the title for the color ramp dialog window. + /** + * Set the title for the color ramp dialog window. * \param title Title for the color ramp dialog * \see colorRampDialogTitle */ void setColorRampDialogTitle( const QString &title ); - /** Returns the title for the color ramp dialog window. + /** + * Returns the title for the color ramp dialog window. * \returns title for the color ramp dialog * \see setColorRampDialogTitle */ QString colorRampDialogTitle() const; - /** Returns whether the button accepts live updates from QgsColorRampDialog. + /** + * Returns whether the button accepts live updates from QgsColorRampDialog. * \returns true if the button will be accepted immediately when the dialog's color ramp changes * \see setAcceptLiveUpdates */ bool acceptLiveUpdates() const { return mAcceptLiveUpdates; } - /** Sets whether the button accepts live updates from QgsColorRampDialog. Live updates may cause changes + /** + * Sets whether the button accepts live updates from QgsColorRampDialog. Live updates may cause changes * that are not undoable on QColorRampDialog cancel. * \param accept set to true to enable live updates * \see acceptLiveUpdates */ void setAcceptLiveUpdates( const bool accept ) { mAcceptLiveUpdates = accept; } - /** Sets whether the drop-down menu should be shown for the button. The default behavior is to + /** + * Sets whether the drop-down menu should be shown for the button. The default behavior is to * show the menu. * \param showMenu set to false to hide the drop-down menu * \see showMenu */ void setShowMenu( const bool showMenu ); - /** Returns whether the drop-down menu is shown for the button. + /** + * Returns whether the drop-down menu is shown for the button. * \returns true if drop-down menu is shown * \see setShowMenu */ bool showMenu() const { return menu() ? true : false; } - /** Sets the default color ramp for the button, which is shown in the button's drop-down menu for the + /** + * Sets the default color ramp for the button, which is shown in the button's drop-down menu for the * "default color ramp" option. * \param colorramp default color ramp for the button. Set to a null pointer to disable the default color * ramp option. The ramp will be cloned and ownership is not transferred. @@ -105,7 +115,8 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton */ void setDefaultColorRamp( QgsColorRamp *colorramp ); - /** Returns a copy of the default color ramp for the button, which is shown in the button's drop-down menu for the + /** + * Returns a copy of the default color ramp for the button, which is shown in the button's drop-down menu for the * "default color ramp" option. * \returns default color ramp for the button. Returns a null pointer if the default color ramp * option is disabled. @@ -113,43 +124,50 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton */ QgsColorRamp *defaultColorRamp() const SIP_FACTORY { return mDefaultColorRamp ? mDefaultColorRamp->clone() : nullptr ; } - /** Sets whether a random colors option is shown in the button's drop-down menu. + /** + * Sets whether a random colors option is shown in the button's drop-down menu. * \param showRandom set to true to show a random colors option * \see showRandom() */ void setShowRandomColorRamp( bool showRandom ) { mShowRandomColorRamp = showRandom; } - /** Returns whether random colors option is shown in the button's drop-down menu. + /** + * Returns whether random colors option is shown in the button's drop-down menu. * \see setShowRandom() */ bool showRandomColorRamp() const { return mShowRandomColorRamp; } - /** Returns true if the current color is null. + /** + * Returns true if the current color is null. * \see setShowNull() * \see showNull() */ bool isRandomColorRamp() const; - /** Sets whether a set to null (clear) option is shown in the button's drop-down menu. + /** + * Sets whether a set to null (clear) option is shown in the button's drop-down menu. * \param showNull set to true to show a null option * \see showNull() * \see isNull() */ void setShowNull( bool showNull ); - /** Returns whether the set to null (clear) option is shown in the button's drop-down menu. + /** + * Returns whether the set to null (clear) option is shown in the button's drop-down menu. * \see setShowNull() * \see isNull() */ bool showNull() const; - /** Returns true if the current color is null. + /** + * Returns true if the current color is null. * \see setShowNull() * \see showNull() */ bool isNull() const; - /** Sets the context string for the color ramp button. The context string is passed to all color ramp + /** + * Sets the context string for the color ramp button. The context string is passed to all color ramp * preview icons shown in the button's drop-down menu, to (eventually) allow them to customise their display colors * based on the context. * \param context context string for the color dialog button's color ramp preview icons @@ -157,7 +175,8 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton */ void setContext( const QString &context ) { mContext = context; } - /** Returns the context string for the color ramp button. The context string is passed to all color ramp + /** + * Returns the context string for the color ramp button. The context string is passed to all color ramp * preview icons shown in the button's drop-down menu, to (eventually) allow them to customise their display colors * based on the context. * \returns context context string for the color dialog button's color ramp preview icons @@ -165,71 +184,82 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton */ QString context() const { return mContext; } - /** Sets whether the color ramp button only shows gradient type ramps + /** + * Sets whether the color ramp button only shows gradient type ramps * \param gradientonly set to true to show only gradient type ramps * \see showGradientOnly */ void setShowGradientOnly( bool gradientonly ) { mShowGradientOnly = gradientonly; } - /** Returns true if the color ramp button only shows gradient type ramps + /** + * Returns true if the color ramp button only shows gradient type ramps * \see setShowGradientOnly */ bool showGradientOnly() const { return mShowGradientOnly; } - /** Sets the name of the current color ramp when it's available in the style manager + /** + * Sets the name of the current color ramp when it's available in the style manager * \param name Name of the saved color ramp * \see colorRampName */ void setColorRampName( const QString &name ) { mColorRampName = name; } - /** Returns the name of the current color ramp when it's available in the style manager + /** + * Returns the name of the current color ramp when it's available in the style manager * \see setColorRampName */ QString colorRampName() const { return mColorRampName; } public slots: - /** Sets the current color ramp for the button. Will emit a colorRampChanged() signal if the color ramp is different + /** + * Sets the current color ramp for the button. Will emit a colorRampChanged() signal if the color ramp is different * to the previous color ramp. * \param colorramp New color ramp for the button. The ramp will be cloned and ownership is not transferred. * \see setRandomColorRamp, setColorRampFromName, colorRamp */ void setColorRamp( QgsColorRamp *colorramp ); - /** Sets the current color ramp for the button to random colors. Will emit a colorRampChanged() signal + /** + * Sets the current color ramp for the button to random colors. Will emit a colorRampChanged() signal * if the color ramp is different to the previous color ramp. * \see setColorRamp, setColorRampFromName, colorRamp */ void setRandomColorRamp(); - /** Sets the current color ramp for the button using a saved color ramp name. Will emit a colorRampChanged() signal + /** + * Sets the current color ramp for the button using a saved color ramp name. Will emit a colorRampChanged() signal * if the color ramp is different to the previous color ramp. * \param name Name of saved color ramp * \see setColorRamp, setRandomColorRamp, colorRamp */ void setColorRampFromName( const QString &name = QString() ); - /** Sets the background pixmap for the button based upon current color ramp. + /** + * Sets the background pixmap for the button based upon current color ramp. * \param colorramp Color ramp for button background. If no color ramp is specified, the button's current * color ramp will be used */ void setButtonBackground( QgsColorRamp *colorramp = nullptr ); - /** Sets color ramp to the button's default color ramp, if set. + /** + * Sets color ramp to the button's default color ramp, if set. * \see setDefaultColorRamp * \see defaultColorRamp * \see setToNull() */ void setToDefaultColorRamp(); - /** Sets color ramp to null. + /** + * Sets color ramp to null. * \see setToDefaultColorRamp() */ void setToNull(); signals: - /** Emitted whenever a new color ramp is set for the button. The color ramp is always valid. + /** + * Emitted whenever a new color ramp is set for the button. The color ramp is always valid. * In case the new color ramp is the same, no signal is emitted to avoid infinite loops. */ void colorRampChanged(); @@ -270,7 +300,8 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton QSize mIconSize; - /** Create a color ramp icon for display in the drop-down menu + /** + * Create a color ramp icon for display in the drop-down menu * \param colorramp Color ramp to create an icon from */ QPixmap createMenuIcon( QgsColorRamp *colorramp ); @@ -279,27 +310,33 @@ class GUI_EXPORT QgsColorRampButton : public QToolButton void buttonClicked(); - /** Show a color ramp dialog based on the ramp type + /** + * Show a color ramp dialog based on the ramp type */ void showColorRampDialog(); - /** Creates a new color ramp + /** + * Creates a new color ramp */ void createColorRamp(); - /** Creates a new color ramp + /** + * Creates a new color ramp */ void saveColorRamp(); - /** Inverts the current color ramp + /** + * Inverts the current color ramp */ void invertColorRamp(); - /** Load a color ramp from a menu entry + /** + * Load a color ramp from a menu entry */ void loadColorRamp(); - /** Creates the drop-down menu entries + /** + * Creates the drop-down menu entries */ void prepareMenu(); }; diff --git a/src/gui/qgscolorschemelist.h b/src/gui/qgscolorschemelist.h index 5a82db885780..6553d41af70c 100644 --- a/src/gui/qgscolorschemelist.h +++ b/src/gui/qgscolorschemelist.h @@ -26,7 +26,8 @@ class QMimeData; class QgsPanelWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorSwatchDelegate * A delegate for showing a color swatch in a list * \see QgsColorSchemeList @@ -49,14 +50,16 @@ class GUI_EXPORT QgsColorSwatchDelegate : public QAbstractItemDelegate private: QWidget *mParent = nullptr; - /** Generates a checkboard pattern for transparent color backgrounds + /** + * Generates a checkboard pattern for transparent color backgrounds * \returns checkboard pixmap */ QPixmap transparentBackground() const; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorSchemeModel * A model for colors in a color scheme * \see QgsColorSchemeList @@ -68,7 +71,8 @@ class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel public: - /** Constructor + /** + * Constructor * \param scheme color scheme for list * \param context context string for color scheme * \param baseColor base color for color scheme @@ -92,38 +96,44 @@ class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel QMimeData *mimeData( const QModelIndexList &indexes ) const override; bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) override; - /** Returns a list of colors shown in the widget + /** + * Returns a list of colors shown in the widget * \returns colors shown in the widget */ QgsNamedColorList colors() const { return mColors; } - /** Sets the color scheme to show in the widget + /** + * Sets the color scheme to show in the widget * \param scheme color scheme * \param context context for color scheme * \param baseColor base color for color scheme */ void setScheme( QgsColorScheme *scheme, const QString &context = QString(), const QColor &baseColor = QColor() ); - /** Get the current color scheme context for the model + /** + * Get the current color scheme context for the model * \returns context string which is passed to scheme for color generation * \see baseColor */ QString context() const { return mContext; } - /** Get the base color for the color scheme used by the model + /** + * Get the base color for the color scheme used by the model * \returns base color which is passed to scheme for color generation * \see context */ QColor baseColor() const { return mBaseColor; } - /** Add a color to the list + /** + * Add a color to the list * \param color color to add * \param label label for color * \param allowDuplicate set to true to allow duplicate colors to be added (colors which are already present in the list) */ void addColor( const QColor &color, const QString &label = QString(), bool allowDuplicate = false ); - /** Returns whether the color scheme model has been modified + /** + * Returns whether the color scheme model has been modified * \returns true if colors have been modified */ bool isDirty() const { return mIsDirty; } @@ -143,7 +153,8 @@ class GUI_EXPORT QgsColorSchemeModel: public QAbstractItemModel bool mIsDirty; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorSchemeList * An editable list of color swatches, taken from an associated QgsColorScheme. * \see QgsColorSchemeList @@ -155,7 +166,8 @@ class GUI_EXPORT QgsColorSchemeList: public QTreeView public: - /** Construct a new color swatch grid. + /** + * Construct a new color swatch grid. * \param parent parent widget * \param scheme QgsColorScheme for colors to show in the list * \param context context string provided to color scheme @@ -163,30 +175,35 @@ class GUI_EXPORT QgsColorSchemeList: public QTreeView */ QgsColorSchemeList( QWidget *parent SIP_TRANSFERTHIS = nullptr, QgsColorScheme *scheme = nullptr, const QString &context = QString(), const QColor &baseColor = QColor() ); - /** Saves the current colors shown in the list back to a color scheme, if supported + /** + * Saves the current colors shown in the list back to a color scheme, if supported * by the color scheme. * \note this method is only effective if the color scheme is editable */ bool saveColorsToScheme(); - /** Import colors from a GPL palette file to the list + /** + * Import colors from a GPL palette file to the list * \param file file to import * \see exportColorsToGpl */ bool importColorsFromGpl( QFile &file ); - /** Export colors to a GPL palette file from the list + /** + * Export colors to a GPL palette file from the list * \param file destination file * \see importColorsFromGpl */ bool exportColorsToGpl( QFile &file ); - /** Returns whether the color scheme list has been modified + /** + * Returns whether the color scheme list has been modified * \returns true if colors have been modified */ bool isDirty() const; - /** Returns the scheme currently selected in the list. + /** + * Returns the scheme currently selected in the list. * \since QGIS 3.0 * \see setScheme() */ @@ -194,7 +211,8 @@ class GUI_EXPORT QgsColorSchemeList: public QTreeView public slots: - /** Sets the color scheme to show in the list + /** + * Sets the color scheme to show in the list * \param scheme QgsColorScheme for colors to show in the list * \param context context string provided to color scheme * \param baseColor base color for color scheme @@ -202,34 +220,40 @@ class GUI_EXPORT QgsColorSchemeList: public QTreeView */ void setScheme( QgsColorScheme *scheme, const QString &context = QString(), const QColor &baseColor = QColor() ); - /** Removes any selected colors from the list + /** + * Removes any selected colors from the list */ void removeSelection(); - /** Adds a color to the list + /** + * Adds a color to the list * \param color color to add * \param label optional label for color * \param allowDuplicate set to true to allow duplicate colors to be added, ie colors which already exist in the list */ void addColor( const QColor &color, const QString &label = QString(), bool allowDuplicate = false ); - /** Pastes colors from clipboard to the list + /** + * Pastes colors from clipboard to the list * \see copyColors */ void pasteColors(); - /** Copies colors from the list to the clipboard + /** + * Copies colors from the list to the clipboard * \see pasteColors */ void copyColors(); - /** Displays a file picker dialog allowing users to import colors into the list from a file. + /** + * Displays a file picker dialog allowing users to import colors into the list from a file. * \since QGIS 3.0 * \see showExportColorsDialog() */ void showImportColorsDialog(); - /** Displays a file picker dialog allowing users to export colors from the list into a file. + /** + * Displays a file picker dialog allowing users to export colors from the list into a file. * \since QGIS 3.0 * \see showImportColorsDialog() */ @@ -237,7 +261,8 @@ class GUI_EXPORT QgsColorSchemeList: public QTreeView signals: - /** Emitted when a color is selected from the list + /** + * Emitted when a color is selected from the list * \param color color selected */ void colorSelected( const QColor &color ); diff --git a/src/gui/qgscolorswatchgrid.h b/src/gui/qgscolorswatchgrid.h index e7ec563e5bef..95d504795c75 100644 --- a/src/gui/qgscolorswatchgrid.h +++ b/src/gui/qgscolorswatchgrid.h @@ -21,7 +21,8 @@ #include "qgis_gui.h" #include "qgis.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorSwatchGrid * A grid of color swatches, which allows for user selection. Colors are taken from an * associated QgsColorScheme. @@ -34,7 +35,8 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget public: - /** Construct a new color swatch grid. + /** + * Construct a new color swatch grid. * \param scheme QgsColorScheme for colors to show in grid * \param context context string provided to color scheme * \param parent parent widget @@ -47,49 +49,57 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget //Reimplemented to set fixed size on widget virtual QSize sizeHint() const override; - /** Get the current context for the grid + /** + * Get the current context for the grid * \returns context string which is passed to scheme for color generation * \see setContext */ QString context() const { return mContext; } - /** Sets the current context for the grid + /** + * Sets the current context for the grid * \param context string which is passed to scheme for color generation * \see context */ void setContext( const QString &context ); - /** Get the base color for the widget + /** + * Get the base color for the widget * \returns base color which is passed to scheme for color generation * \see setBaseColor */ QColor baseColor() const { return mBaseColor; } - /** Sets the base color for the widget + /** + * Sets the base color for the widget * \param baseColor base color to pass to scheme for color generation * \see baseColor */ void setBaseColor( const QColor &baseColor ); - /** Gets the list of colors shown in the grid + /** + * Gets the list of colors shown in the grid * \returns list of colors currently shown in the grid */ QgsNamedColorList *colors() { return &mColors; } public slots: - /** Reload colors from scheme and redraws the widget + /** + * Reload colors from scheme and redraws the widget */ void refreshColors(); signals: - /** Emitted when a color has been selected from the widget + /** + * Emitted when a color has been selected from the widget * \param color selected color */ void colorChanged( const QColor &color ); - /** Emitted when mouse hovers over widget + /** + * Emitted when mouse hovers over widget */ void hovered(); @@ -135,35 +145,41 @@ class GUI_EXPORT QgsColorSwatchGrid : public QWidget bool mPressedOnWidget; - /** Calculate height of widget based on number of colors + /** + * Calculate height of widget based on number of colors * \returns required height of widget in pixels */ int calculateHeight() const; - /** Draws widget + /** + * Draws widget * \param painter destination painter */ void draw( QPainter &painter ); - /** Calculate swatch corresponding to a position within the widget + /** + * Calculate swatch corresponding to a position within the widget * \param position position * \returns swatch number (starting at 0), or -1 if position is outside a swatch */ int swatchForPosition( QPoint position ) const; - /** Updates the widget's tooltip for a given color index + /** + * Updates the widget's tooltip for a given color index * \param colorIdx color index to use for calculating tooltip */ void updateTooltip( const int colorIdx ); - /** Generates a checkboard pattern for transparent color backgrounds + /** + * Generates a checkboard pattern for transparent color backgrounds * \returns checkboard pixmap */ QPixmap transparentBackground(); }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorSwatchGridAction * A color swatch grid which can be embedded into a menu. * \see QgsColorSwatchGrid @@ -176,7 +192,8 @@ class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction public: - /** Construct a new color swatch grid action. + /** + * Construct a new color swatch grid action. * \param scheme QgsColorScheme for colors to show in grid * \param menu parent menu * \param context context string provided to color scheme @@ -184,31 +201,36 @@ class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction */ QgsColorSwatchGridAction( QgsColorScheme *scheme, QMenu *menu = nullptr, const QString &context = QString(), QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Sets the base color for the color grid + /** + * Sets the base color for the color grid * \param baseColor base color to pass to scheme for color generation * \see baseColor */ void setBaseColor( const QColor &baseColor ); - /** Get the base color for the color grid + /** + * Get the base color for the color grid * \returns base color which is passed to scheme for color generation * \see setBaseColor */ QColor baseColor() const; - /** Get the current context for the color grid + /** + * Get the current context for the color grid * \returns context string which is passed to scheme for color generation * \see setContext */ QString context() const; - /** Sets the current context for the color grid + /** + * Sets the current context for the color grid * \param context string which is passed to scheme for color generation * \see context */ void setContext( const QString &context ); - /** Sets whether the parent menu should be dismissed and closed when a color is selected + /** + * Sets whether the parent menu should be dismissed and closed when a color is selected * from the action's color widget. * \param dismiss set to true (default) to immediately close the menu when a color is selected * from the widget. If set to false, the colorChanged signal will be emitted but the menu will @@ -218,7 +240,8 @@ class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction */ void setDismissOnColorSelection( bool dismiss ) { mDismissOnColorSelection = dismiss; } - /** Returns whether the parent menu will be dismissed after a color is selected from the + /** + * Returns whether the parent menu will be dismissed after a color is selected from the * action's color widget. * \see setDismissOnColorSelection * \since QGIS 2.14 @@ -227,13 +250,15 @@ class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction public slots: - /** Reload colors from scheme and redraws the widget + /** + * Reload colors from scheme and redraws the widget */ void refreshColors(); signals: - /** Emitted when a color has been selected from the widget + /** + * Emitted when a color has been selected from the widget * \param color selected color */ void colorChanged( const QColor &color ); @@ -248,11 +273,13 @@ class GUI_EXPORT QgsColorSwatchGridAction: public QWidgetAction private slots: - /** Emits color changed signal and closes parent menu + /** + * Emits color changed signal and closes parent menu */ void setColor( const QColor &color ); - /** Handles setting the active action for the menu when cursor hovers over color grid + /** + * Handles setting the active action for the menu when cursor hovers over color grid */ void onHover(); }; diff --git a/src/gui/qgscolorwidgets.h b/src/gui/qgscolorwidgets.h index 5ccc012717e5..1087792dbd1d 100644 --- a/src/gui/qgscolorwidgets.h +++ b/src/gui/qgscolorwidgets.h @@ -26,7 +26,8 @@ class QSpinBox; class QLineEdit; class QToolButton; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorWidget * A base class for interactive color widgets. Widgets can either allow setting a single component of * a color (e.g., the red or green components), or an entire color. The QgsColorWidget also keeps track of @@ -41,7 +42,8 @@ class GUI_EXPORT QgsColorWidget : public QWidget public: - /** Specifies the color component which the widget alters + /** + * Specifies the color component which the widget alters */ enum ColorComponent { @@ -55,25 +57,29 @@ class GUI_EXPORT QgsColorWidget : public QWidget Alpha //!< Alpha component (opacity) of color }; - /** Construct a new color widget. + /** + * Construct a new color widget. * \param parent parent QWidget for the widget * \param component color component the widget alters */ QgsColorWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, const ColorComponent component = Multiple ); - /** Returns the current color for the widget + /** + * Returns the current color for the widget * \returns current widget color * \see setColor */ QColor color() const; - /** Returns the color component which the widget controls + /** + * Returns the color component which the widget controls * \returns color component for widget * \see setComponent */ ColorComponent component() const { return mComponent; } - /** Returns the current value of the widget's color component + /** + * Returns the current value of the widget's color component * \returns value of color component, or -1 if widget has multiple components or an invalid color * set * \see setComponentValue @@ -81,27 +87,31 @@ class GUI_EXPORT QgsColorWidget : public QWidget */ int componentValue() const; - /** Create an icon for dragging colors + /** + * Create an icon for dragging colors * \param color for icon */ static QPixmap createDragIcon( const QColor &color ); public slots: - /** Sets the color for the widget + /** + * Sets the color for the widget * \param color widget color * \param emitSignals set to true to emit the colorChanged signal after setting color * \see color */ virtual void setColor( const QColor &color, const bool emitSignals = false ); - /** Sets the color component which the widget controls + /** + * Sets the color component which the widget controls * \param component color component for widget * \see component */ virtual void setComponent( const ColorComponent component ); - /** Alters the widget's color by setting the value for the widget's color component + /** + * Alters the widget's color by setting the value for the widget's color component * \param value value for widget's color component. This value is automatically * clipped to the range of valid values for the color component. * \see componentValue @@ -113,12 +123,14 @@ class GUI_EXPORT QgsColorWidget : public QWidget signals: - /** Emitted when the widget's color changes + /** + * Emitted when the widget's color changes * \param color new widget color */ void colorChanged( const QColor &color ); - /** Emitted when mouse hovers over widget. + /** + * Emitted when mouse hovers over widget. * \since QGIS 2.14 */ void hovered(); @@ -129,22 +141,26 @@ class GUI_EXPORT QgsColorWidget : public QWidget ColorComponent mComponent; - /** QColor wipes the hue information when it is ambiguous (e.g., for saturation = 0). So + /** + * QColor wipes the hue information when it is ambiguous (e.g., for saturation = 0). So * the hue is stored in mExplicit hue to keep it around, as it is useful when modifying colors */ int mExplicitHue = 0; - /** Returns the range of valid values for the color widget's component + /** + * Returns the range of valid values for the color widget's component * \returns maximum value allowed for color component, or -1 if widget has multiple components */ int componentRange() const; - /** Returns the range of valid values a color component + /** + * Returns the range of valid values a color component * \returns maximum value allowed for color component */ int componentRange( const ColorComponent component ) const; - /** Returns the value of a component of the widget's current color. This method correctly + /** + * Returns the value of a component of the widget's current color. This method correctly * handles hue values when the color has an ambiguous hue (e.g., black or white shades) * \param component color component to return * \returns value of color component, or -1 if widget has an invalid color set @@ -152,13 +168,15 @@ class GUI_EXPORT QgsColorWidget : public QWidget */ int componentValue( const ColorComponent component ) const; - /** Returns the hue for the widget. This may differ from the hue for the QColor returned by color(), + /** + * Returns the hue for the widget. This may differ from the hue for the QColor returned by color(), * as QColor returns a hue of -1 if the color's hue is ambiguous (e.g., if the saturation is zero). * \returns explicitly set hue for widget */ int hue() const; - /** Alters a color by modifiying the value of a specific color component + /** + * Alters a color by modifiying the value of a specific color component * \param color color to alter * \param component color component to alter * \param newValue new value of color component. Values are automatically clipped to a @@ -166,7 +184,8 @@ class GUI_EXPORT QgsColorWidget : public QWidget */ void alterColor( QColor &color, const QgsColorWidget::ColorComponent component, const int newValue ) const; - /** Generates a checkboard pattern pixmap for use as a background to transparent colors + /** + * Generates a checkboard pattern pixmap for use as a background to transparent colors * \returns checkerboard pixmap */ static const QPixmap &transparentBackground(); @@ -183,7 +202,8 @@ class GUI_EXPORT QgsColorWidget : public QWidget }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorWidgetAction * An action containing a color widget, which can be embedded into a menu. * \see QgsColorWidget @@ -196,18 +216,21 @@ class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction public: - /** Construct a new color widget action. + /** + * Construct a new color widget action. * \param colorWidget QgsColorWidget to show in action * \param menu parent menu * \param parent parent widget */ QgsColorWidgetAction( QgsColorWidget *colorWidget, QMenu *menu = nullptr, QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Returns the color widget contained in the widget action. + /** + * Returns the color widget contained in the widget action. */ QgsColorWidget *colorWidget() { return mColorWidget; } - /** Sets whether the parent menu should be dismissed and closed when a color is selected + /** + * Sets whether the parent menu should be dismissed and closed when a color is selected * from the action's color widget. * \param dismiss set to true (default) to immediately close the menu when a color is selected * from the widget. If set to false, the colorChanged signal will be emitted but the menu will @@ -216,7 +239,8 @@ class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction */ void setDismissOnColorSelection( bool dismiss ) { mDismissOnColorSelection = dismiss; } - /** Returns whether the parent menu will be dismissed after a color is selected from the + /** + * Returns whether the parent menu will be dismissed after a color is selected from the * action's color widget. * \see setDismissOnColorSelection */ @@ -224,7 +248,8 @@ class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction signals: - /** Emitted when a color has been selected from the widget + /** + * Emitted when a color has been selected from the widget * \param color selected color */ void colorChanged( const QColor &color ); @@ -240,18 +265,21 @@ class GUI_EXPORT QgsColorWidgetAction: public QWidgetAction private slots: - /** Handles setting the active action for the menu when cursor hovers over color widget + /** + * Handles setting the active action for the menu when cursor hovers over color widget */ void onHover(); - /** Emits color changed signal and closes parent menu + /** + * Emits color changed signal and closes parent menu */ void setColor( const QColor &color ); }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorWheel * A color wheel widget. This widget consists of an outer ring which allows for hue selection, and an * inner rotating triangle which allows for saturation and value selection. @@ -264,7 +292,8 @@ class GUI_EXPORT QgsColorWheel : public QgsColorWidget public: - /** Constructs a new color wheel widget. + /** + * Constructs a new color wheel widget. * \param parent parent QWidget for the widget */ QgsColorWheel( QWidget *parent SIP_TRANSFERTHIS = nullptr ); @@ -321,7 +350,8 @@ class GUI_EXPORT QgsColorWheel : public QgsColorWidget /*Conical gradient brush used for drawing hue wheel*/ QBrush mWheelBrush; - /** Creates cache images for specified widget size + /** + * Creates cache images for specified widget size * \param size widget size for images */ void createImages( const QSizeF size ); @@ -332,7 +362,8 @@ class GUI_EXPORT QgsColorWheel : public QgsColorWidget //! Creates the inner triangle image void createTriangle(); - /** Sets the widget color based on a point in the widget + /** + * Sets the widget color based on a point in the widget * \param pos position for color */ void setColorFromPos( const QPointF pos ); @@ -340,7 +371,8 @@ class GUI_EXPORT QgsColorWheel : public QgsColorWidget }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorBox * A color box widget. This widget consists of a two dimensional rectangle filled with color * variations, where a different color component varies along both the horizontal and vertical @@ -354,7 +386,8 @@ class GUI_EXPORT QgsColorBox : public QgsColorWidget public: - /** Construct a new color box widget. + /** + * Construct a new color box widget. * \param parent parent QWidget for the widget * \param component constant color component for the widget. The color components * which vary along the horizontal and vertical axis are automatically assigned @@ -389,37 +422,45 @@ class GUI_EXPORT QgsColorBox : public QgsColorWidget /*Whether the cached image requires redrawing*/ bool mDirty = true; - /** Creates the color box background cached image + /** + * Creates the color box background cached image */ void createBox(); - /** Returns the range of permissible values along the x axis + /** + * Returns the range of permissible values along the x axis * \returns maximum color component value for x axis */ int valueRangeX() const; - /** Returns the range of permissible values along the y axis + /** + * Returns the range of permissible values along the y axis * \returns maximum color component value for y axis */ int valueRangeY() const; - /** Returns the color component which varies along the y axis + /** + * Returns the color component which varies along the y axis */ QgsColorWidget::ColorComponent yComponent() const; - /** Returns the value of the color component which varies along the y axis + /** + * Returns the value of the color component which varies along the y axis */ int yComponentValue() const; - /** Returns the color component which varies along the x axis + /** + * Returns the color component which varies along the x axis */ QgsColorWidget::ColorComponent xComponent() const; - /** Returns the value of the color component which varies along the x axis + /** + * Returns the value of the color component which varies along the x axis */ int xComponentValue() const; - /** Updates the widget's color based on a point within the widget + /** + * Updates the widget's color based on a point within the widget * \param point point within the widget */ void setColorFromPoint( QPoint point ); @@ -427,7 +468,8 @@ class GUI_EXPORT QgsColorBox : public QgsColorWidget }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorRampWidget * A color ramp widget. This widget consists of an interactive box filled with a color which varies along * its length by a single color component (e.g., varying saturation from 0 to 100%). @@ -440,7 +482,8 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget public: - /** Specifies the orientation of a color ramp + /** + * Specifies the orientation of a color ramp */ enum Orientation { @@ -448,7 +491,8 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget Vertical //!< Vertical ramp }; - /** Construct a new color ramp widget. + /** + * Construct a new color ramp widget. * \param parent parent QWidget for the widget * \param component color component which varies along the ramp * \param orientation orientation for widget @@ -460,50 +504,58 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget virtual QSize sizeHint() const override; void paintEvent( QPaintEvent *event ) override; - /** Sets the orientation for the color ramp + /** + * Sets the orientation for the color ramp * \param orientation new orientation for the ramp * \see orientation */ void setOrientation( const Orientation orientation ); - /** Fetches the orientation for the color ramp + /** + * Fetches the orientation for the color ramp * \returns orientation for the ramp * \see setOrientation */ Orientation orientation() const { return mOrientation; } - /** Sets the margin between the edge of the widget and the ramp + /** + * Sets the margin between the edge of the widget and the ramp * \param margin margin around the ramp * \see interiorMargin */ void setInteriorMargin( const int margin ); - /** Fetches the margin between the edge of the widget and the ramp + /** + * Fetches the margin between the edge of the widget and the ramp * \returns margin around the ramp * \see setInteriorMargin */ int interiorMargin() const { return mMargin; } - /** Sets whether the ramp should be drawn within a frame + /** + * Sets whether the ramp should be drawn within a frame * \param showFrame set to true to draw a frame around the ramp * \see showFrame */ void setShowFrame( const bool showFrame ); - /** Fetches whether the ramp is drawn within a frame + /** + * Fetches whether the ramp is drawn within a frame * \returns true if a frame is drawn around the ramp * \see setShowFrame */ bool showFrame() const { return mShowFrame; } - /** Sets the size for drawing the triangular markers on the ramp + /** + * Sets the size for drawing the triangular markers on the ramp * \param markerSize marker size in pixels */ void setMarkerSize( const int markerSize ); signals: - /** Emitted when the widget's color component value changes + /** + * Emitted when the widget's color component value changes * \param value new value of color component */ void valueChanged( const int value ); @@ -532,7 +584,8 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget /*Polygon for lower triangle marker*/ QPolygonF mBottomTriangle; - /** Updates the widget's color based on a point within the widget + /** + * Updates the widget's color based on a point within the widget * \param point point within the widget */ void setColorFromPoint( QPointF point ); @@ -540,7 +593,8 @@ class GUI_EXPORT QgsColorRampWidget : public QgsColorWidget }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorSliderWidget * A composite horizontal color ramp widget and associated spinbox for manual value entry. * \since QGIS 2.5 @@ -552,7 +606,8 @@ class GUI_EXPORT QgsColorSliderWidget : public QgsColorWidget public: - /** Construct a new color slider widget. + /** + * Construct a new color slider widget. * \param parent parent QWidget for the widget * \param component color component which is controlled by the slider */ @@ -570,7 +625,8 @@ class GUI_EXPORT QgsColorSliderWidget : public QgsColorWidget /*Spin box widget*/ QSpinBox *mSpinBox = nullptr; - /** Converts the real value of a color component to a friendly display value. For instance, + /** + * Converts the real value of a color component to a friendly display value. For instance, * alpha values from 0-255 have little meaning to users, so we translate them to 0-100% * \param realValue actual value of the color component * \returns display value of color component @@ -578,7 +634,8 @@ class GUI_EXPORT QgsColorSliderWidget : public QgsColorWidget */ int convertRealToDisplay( const int realValue ) const; - /** Converts the display value of a color component to a real value. + /** + * Converts the display value of a color component to a real value. * \param displayValue friendly display value of the color component * \returns real value of color component * \see convertRealToDisplay @@ -587,22 +644,26 @@ class GUI_EXPORT QgsColorSliderWidget : public QgsColorWidget private slots: - /** Called when the color for the ramp changes + /** + * Called when the color for the ramp changes */ void rampColorChanged( const QColor &color ); - /** Called when the value of the spin box changes + /** + * Called when the value of the spin box changes */ void spinChanged( int value ); - /** Called when the value for the ramp changes + /** + * Called when the value for the ramp changes */ void rampChanged( int value ); }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorTextWidget * A line edit widget which displays colors as text and accepts string representations * of colors. @@ -615,7 +676,8 @@ class GUI_EXPORT QgsColorTextWidget : public QgsColorWidget public: - /** Construct a new color line edit widget. + /** + * Construct a new color line edit widget. * \param parent parent QWidget for the widget */ QgsColorTextWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr ); @@ -627,7 +689,8 @@ class GUI_EXPORT QgsColorTextWidget : public QgsColorWidget private: - /** Specifies the display format for a color + /** + * Specifies the display format for a color */ enum ColorTextFormat { @@ -645,23 +708,27 @@ class GUI_EXPORT QgsColorTextWidget : public QgsColorWidget /*Display format for colors*/ ColorTextFormat mFormat = QgsColorTextWidget::HexRgb; - /** Updates the text based on the current color + /** + * Updates the text based on the current color */ void updateText(); private slots: - /** Called when the user enters text into the widget + /** + * Called when the user enters text into the widget */ void textChanged(); - /** Called when the drop-down arrow is clicked to show the format selection menu + /** + * Called when the drop-down arrow is clicked to show the format selection menu */ void showMenu(); }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsColorPreviewWidget * A preview box which displays one or two colors as swatches. * \since QGIS 2.5 @@ -673,7 +740,8 @@ class GUI_EXPORT QgsColorPreviewWidget : public QgsColorWidget public: - /** Construct a new color preview widget. + /** + * Construct a new color preview widget. * \param parent parent QWidget for the widget */ QgsColorPreviewWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr ); @@ -681,7 +749,8 @@ class GUI_EXPORT QgsColorPreviewWidget : public QgsColorWidget void paintEvent( QPaintEvent *event ) override; virtual QSize sizeHint() const override; - /** Returns the secondary color for the widget + /** + * Returns the secondary color for the widget * \returns secondary widget color, or an invalid color if the widget * has no secondary color * \see color @@ -691,7 +760,8 @@ class GUI_EXPORT QgsColorPreviewWidget : public QgsColorWidget public slots: - /** Sets the second color for the widget + /** + * Sets the second color for the widget * \param color secondary widget color. Set to an invalid color to prevent * drawing of a secondary color * \see setColor diff --git a/src/gui/qgscomposerinterface.h b/src/gui/qgscomposerinterface.h index 6ed22cc1c414..465f588aafd7 100644 --- a/src/gui/qgscomposerinterface.h +++ b/src/gui/qgscomposerinterface.h @@ -23,7 +23,8 @@ class QgsComposerView; class QgsComposition; -/** \ingroup gui +/** + * \ingroup gui * \class QgsComposerInterface * A common interface for composer dialogs. * diff --git a/src/gui/qgscomposeritemcombobox.h b/src/gui/qgscomposeritemcombobox.h index f09344c05311..66a5b8279b43 100644 --- a/src/gui/qgscomposeritemcombobox.h +++ b/src/gui/qgscomposeritemcombobox.h @@ -45,46 +45,54 @@ class GUI_EXPORT QgsComposerItemComboBox : public QComboBox */ explicit QgsComposerItemComboBox( QWidget *parent SIP_TRANSFERTHIS = 0, QgsComposition *composition = nullptr ); - /** Sets the composition containing the items to list in the combo box. + /** + * Sets the composition containing the items to list in the combo box. */ void setComposition( QgsComposition *composition ); - /** Sets a filter for the item type to show in the combo box. + /** + * Sets a filter for the item type to show in the combo box. * \param itemType type of items to show. Set to QgsComposerItem::ComposerItem to * show all items. * \see itemType() */ void setItemType( QgsComposerItem::ItemType itemType ); - /** Returns the filter for the item types to show in the combo box. + /** + * Returns the filter for the item types to show in the combo box. * \see setItemType() */ QgsComposerItem::ItemType itemType() const; - /** Sets a list of specific items to exclude from the combo box. + /** + * Sets a list of specific items to exclude from the combo box. * \param exceptList list of items to exclude * \see exceptedItemList() */ void setExceptedItemList( const QList< QgsComposerItem * > &exceptList ); - /** Returns the list of specific items excluded from the combo box. + /** + * Returns the list of specific items excluded from the combo box. * \see setExceptedItemList() */ QList< QgsComposerItem * > exceptedItemList() const; - /** Return the item currently shown at the specified index within the combo box. + /** + * Return the item currently shown at the specified index within the combo box. * \param index position of item to return * \see currentItem() */ QgsComposerItem *item( int index ) const; - /** Returns the item currently selected in the combo box. + /** + * Returns the item currently selected in the combo box. */ QgsComposerItem *currentItem() const; public slots: - /** Sets the currently selected item in the combo box. + /** + * Sets the currently selected item in the combo box. * \param item selected item */ void setItem( const QgsComposerItem *item ); diff --git a/src/gui/qgscomposerruler.h b/src/gui/qgscomposerruler.h index 1de42289f06d..b749b63e2b60 100644 --- a/src/gui/qgscomposerruler.h +++ b/src/gui/qgscomposerruler.h @@ -21,7 +21,8 @@ class QgsComposition; class QGraphicsLineItem; -/** \ingroup gui +/** + * \ingroup gui * A class to show paper scale and the current cursor position */ class GUI_EXPORT QgsComposerRuler: public QWidget diff --git a/src/gui/qgscomposerview.h b/src/gui/qgscomposerview.h index 25a06dc2103e..a5e8abeec1d9 100644 --- a/src/gui/qgscomposerview.h +++ b/src/gui/qgscomposerview.h @@ -43,7 +43,8 @@ class QgsComposerNodesItem; class QgsComposerAttributeTableV2; class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * Widget to display the composer items. Manages the composer tools and the * mouse/key events. * Creates the composer items according to the current map tools and keeps track @@ -137,7 +138,8 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView QgsComposerView::Tool currentTool() const {return mCurrentTool;} void setCurrentTool( QgsComposerView::Tool t ); - /** Sets the composition for the view. If the composition is being set manually and not by a QgsComposer, then this must + /** + * Sets the composition for the view. If the composition is being set manually and not by a QgsComposer, then this must * be set BEFORE adding any items to the composition. */ void setComposition( QgsComposition *c SIP_KEEPREFERENCE ); @@ -160,21 +162,24 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView //! Set zoom level, where a zoom level of 1.0 corresponds to 100% void setZoomLevel( double zoomLevel ); - /** Scales the view in a safe way, by limiting the acceptable range + /** + * Scales the view in a safe way, by limiting the acceptable range * of the scale applied. * \param scale factor to scale view by * \since QGIS 2.16 */ void scaleSafe( double scale ); - /** Sets whether a preview effect should be used to alter the view's appearance + /** + * Sets whether a preview effect should be used to alter the view's appearance * \param enabled Set to true to enable the preview effect on the view * \since QGIS 2.3 * \see setPreviewMode */ void setPreviewModeEnabled( bool enabled ); - /** Sets the preview mode which should be used to modify the view's appearance. Preview modes are only used + /** + * Sets the preview mode which should be used to modify the view's appearance. Preview modes are only used * if setPreviewMode is set to true. * \param mode PreviewMode to be used to draw the view * \since QGIS 2.3 @@ -182,7 +187,8 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView */ void setPreviewMode( QgsPreviewEffect::PreviewMode mode ); - /** Sets the map canvas associated with the view. This allows the + /** + * Sets the map canvas associated with the view. This allows the * view to retrieve map settings from the canvas. * \since QGIS 3.0 * \see mapCanvas() @@ -307,7 +313,8 @@ class GUI_EXPORT QgsComposerView: public QGraphicsView //! Is emitted when a composer item has been removed from the scene void itemRemoved( QgsComposerItem * ); - /** Current action (e.g. adding composer map) has been finished. The purpose of this signal is that + /** + * Current action (e.g. adding composer map) has been finished. The purpose of this signal is that QgsComposer may set the selection tool again*/ void actionFinished(); //! Is emitted when mouse cursor coordinates change diff --git a/src/gui/qgscompoundcolorwidget.h b/src/gui/qgscompoundcolorwidget.h index c6db892479dd..52c1119394a0 100644 --- a/src/gui/qgscompoundcolorwidget.h +++ b/src/gui/qgscompoundcolorwidget.h @@ -22,7 +22,8 @@ #include "ui_qgscompoundcolorwidget.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsCompoundColorWidget * A custom QGIS widget for selecting a color, including options for selecting colors via * hue wheel, color swatches, and a color sampler. @@ -43,7 +44,8 @@ class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::Qgs LayoutVertical, //!< Use a narrower, vertically stacked layout }; - /** Constructor for QgsCompoundColorWidget + /** + * Constructor for QgsCompoundColorWidget * \param parent parent widget * \param color initial color for dialog * \param layout widget layout to use @@ -52,19 +54,22 @@ class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::Qgs ~QgsCompoundColorWidget(); - /** Returns the current color for the dialog + /** + * Returns the current color for the dialog * \returns dialog color */ QColor color() const; - /** Sets whether opacity modification (transparency) is permitted + /** + * Sets whether opacity modification (transparency) is permitted * for the color dialog. Defaults to true. * \param allowOpacity set to false to disable opacity modification * \since QGIS 3.0 */ void setAllowOpacity( const bool allowOpacity ); - /** Sets whether the widget's color has been "discarded" and the selected color should not + /** + * Sets whether the widget's color has been "discarded" and the selected color should not * be stored in the recent color list. * \param discarded set to true to avoid adding color to recent color list on widget destruction. * \since QGIS 3.0 @@ -73,19 +78,22 @@ class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::Qgs signals: - /** Emitted when the dialog's color changes + /** + * Emitted when the dialog's color changes * \param color current color */ void currentColorChanged( const QColor &color ); public slots: - /** Sets the current color for the dialog + /** + * Sets the current color for the dialog * \param color desired color */ void setColor( const QColor &color ); - /** Sets the color to show in an optional "previous color" section + /** + * Sets the color to show in an optional "previous color" section * \param color previous color */ void setPreviousColor( const QColor &color ); @@ -137,34 +145,40 @@ class GUI_EXPORT QgsCompoundColorWidget : public QgsPanelWidget, private Ui::Qgs bool mDiscarded = false; - /** Saves all widget settings + /** + * Saves all widget settings */ void saveSettings(); - /** Ends a color picking operation + /** + * Ends a color picking operation * \param eventPos global position of pixel to sample color from * \param takeSample set to true to actually sample the color, false to just cancel * the color picking operation */ void stopPicking( QPoint eventPos, const bool takeSample = true ); - /** Returns the average color from the pixels in an image + /** + * Returns the average color from the pixels in an image * \param image image to sample * \returns average color from image */ QColor averageColor( const QImage &image ) const; - /** Samples a color from the desktop + /** + * Samples a color from the desktop * \param point position of color to sample * \returns average color from sampled position */ QColor sampleColor( QPoint point ) const; - /** Repopulates the scheme combo box with current color schemes + /** + * Repopulates the scheme combo box with current color schemes */ void refreshSchemeComboBox(); - /** Returns the path to the user's palette folder + /** + * Returns the path to the user's palette folder */ QString gplFilePath(); diff --git a/src/gui/qgsconfigureshortcutsdialog.h b/src/gui/qgsconfigureshortcutsdialog.h index 0d951b13bb26..7d6730c64ec2 100644 --- a/src/gui/qgsconfigureshortcutsdialog.h +++ b/src/gui/qgsconfigureshortcutsdialog.h @@ -26,7 +26,8 @@ class QShortcut; class QgsShortcutsManager; -/** \ingroup gui +/** + * \ingroup gui * \class QgsConfigureShortcutsDialog * Reusable dialog for allowing users to configure shortcuts contained in a QgsShortcutsManager. * \since QGIS 2.16 @@ -38,7 +39,8 @@ class GUI_EXPORT QgsConfigureShortcutsDialog : public QDialog, private Ui::QgsCo public: - /** Constructor for QgsConfigureShortcutsDialog. + /** + * Constructor for QgsConfigureShortcutsDialog. * \param parent parent widget * \param manager associated QgsShortcutsManager, or leave as null to use the default * singleton QgsShortcutsManager instance. diff --git a/src/gui/qgscredentialdialog.h b/src/gui/qgscredentialdialog.h index 678d5d97fd0c..43cd73a0a96f 100644 --- a/src/gui/qgscredentialdialog.h +++ b/src/gui/qgscredentialdialog.h @@ -27,7 +27,8 @@ class QPushButton; -/** \ingroup gui +/** + * \ingroup gui * A generic dialog for requesting credentials */ class GUI_EXPORT QgsCredentialDialog : public QDialog, public QgsCredentials, private Ui_QgsCredentialDialog diff --git a/src/gui/qgscursors.h b/src/gui/qgscursors.h index 7c3fd164b089..e8210e68ae37 100644 --- a/src/gui/qgscursors.h +++ b/src/gui/qgscursors.h @@ -22,7 +22,8 @@ #define SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * Bitmap cursors for map operations. */ extern GUI_EXPORT const char *zoom_in[]; diff --git a/src/gui/qgscurveeditorwidget.h b/src/gui/qgscurveeditorwidget.h index f831b7bad01d..75fd1ab0a0f6 100644 --- a/src/gui/qgscurveeditorwidget.h +++ b/src/gui/qgscurveeditorwidget.h @@ -43,7 +43,8 @@ typedef QPointF QwtDoublePoint SIP_SKIP; // just internal guff - definitely not for exposing to public API! ///@cond PRIVATE -/** \class QgsHistogramValuesGatherer +/** + * \class QgsHistogramValuesGatherer * Calculates a histogram in a thread. * \note not available in Python bindings */ @@ -133,7 +134,8 @@ class QgsHistogramValuesGatherer: public QThread #endif -/** \ingroup gui +/** + * \ingroup gui * \class QgsCurveEditorWidget * A widget for manipulating QgsCurveTransform curves. * \since QGIS 3.0 diff --git a/src/gui/qgscustomdrophandler.h b/src/gui/qgscustomdrophandler.h index c317d22cb03d..0fb283069fa9 100644 --- a/src/gui/qgscustomdrophandler.h +++ b/src/gui/qgscustomdrophandler.h @@ -19,7 +19,8 @@ #include "qgsmimedatautils.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Abstract base class that may be implemented to handle new types of data to be dropped in QGIS. * * Implementations have three approaches they can use to handle drops. diff --git a/src/gui/qgsdatasourcemanagerdialog.h b/src/gui/qgsdatasourcemanagerdialog.h index 364d14a7d204..0b8b90375497 100644 --- a/src/gui/qgsdatasourcemanagerdialog.h +++ b/src/gui/qgsdatasourcemanagerdialog.h @@ -34,7 +34,8 @@ class QgsMapCanvas; class QgsAbstractDataSourceWidget; class QgsBrowserModel; -/** \ingroup gui +/** + * \ingroup gui * The QgsDataSourceManagerDialog class embeds the browser panel and all * the provider dialogs. * The dialog does not handle layer addition directly but emits signals that @@ -48,7 +49,8 @@ class GUI_EXPORT QgsDataSourceManagerDialog : public QgsOptionsDialogBase, priva public: - /** QgsDataSourceManagerDialog constructor + /** + * QgsDataSourceManagerDialog constructor * \param browserModel instance of the (shared) browser model * \param parent the object * \param canvas a pointer to the map canvas diff --git a/src/gui/qgsdatumtransformdialog.h b/src/gui/qgsdatumtransformdialog.h index 4968e3064157..798847c06ce0 100644 --- a/src/gui/qgsdatumtransformdialog.h +++ b/src/gui/qgsdatumtransformdialog.h @@ -23,7 +23,8 @@ #define SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * \class QgsDatumTransformDialog * \note not available in Python bindings */ diff --git a/src/gui/qgsdetaileditemdata.h b/src/gui/qgsdetaileditemdata.h index 8101dd91b500..20ebd8cfc010 100644 --- a/src/gui/qgsdetaileditemdata.h +++ b/src/gui/qgsdetaileditemdata.h @@ -23,7 +23,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * This class is the data only representation of a * QgsDetailedItemWidget, designed to be used in custom views. */ @@ -44,7 +45,8 @@ class GUI_EXPORT QgsDetailedItemData void setChecked( const bool flag ); void setEnabled( bool flag ); - /** This is a hint to the delegate to render using + /** + * This is a hint to the delegate to render using * a widget rather than manually painting every * part of the list item. * \note the delegate may completely ignore this diff --git a/src/gui/qgsdetaileditemdelegate.h b/src/gui/qgsdetaileditemdelegate.h index 800ad3fd68b4..ea9b7156d11f 100644 --- a/src/gui/qgsdetaileditemdelegate.h +++ b/src/gui/qgsdetaileditemdelegate.h @@ -28,7 +28,8 @@ class QgsDetailedItemData; class QFontMetrics; class QFont; -/** \ingroup gui +/** + * \ingroup gui * A custom model/view delegate that can display an icon, heading * and detail sections. * \see also QgsDetailedItemData diff --git a/src/gui/qgsdetaileditemwidget.h b/src/gui/qgsdetaileditemwidget.h index 830425879845..731ce0050ef8 100644 --- a/src/gui/qgsdetaileditemwidget.h +++ b/src/gui/qgsdetaileditemwidget.h @@ -22,7 +22,8 @@ #include "qgsdetaileditemdata.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * A widget renderer for detailed item views. * \see also QgsDetailedItem and QgsDetailedItemData. */ diff --git a/src/gui/qgsdial.h b/src/gui/qgsdial.h index d75f4979c692..a2601546a6a4 100644 --- a/src/gui/qgsdial.h +++ b/src/gui/qgsdial.h @@ -22,7 +22,8 @@ class QPaintEvent; -/** \ingroup gui +/** + * \ingroup gui * \class QgsDial */ class GUI_EXPORT QgsDial : public QDial diff --git a/src/gui/qgsdialog.h b/src/gui/qgsdialog.h index 397d76536c62..d7cdf96a81da 100644 --- a/src/gui/qgsdialog.h +++ b/src/gui/qgsdialog.h @@ -26,7 +26,8 @@ #include "qgis_gui.h" #include "qgis.h" -/** \ingroup gui +/** + * \ingroup gui * A generic dialog with layout and button box */ class GUI_EXPORT QgsDialog : public QDialog diff --git a/src/gui/qgsdockwidget.h b/src/gui/qgsdockwidget.h index dbd408644f59..493fc07c58ba 100644 --- a/src/gui/qgsdockwidget.h +++ b/src/gui/qgsdockwidget.h @@ -21,7 +21,8 @@ #include "qgis_gui.h" #include "qgis.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsDockWidget * QgsDockWidget subclass with more fine-grained control over how the widget is closed or opened. * \since QGIS 2.16 @@ -33,13 +34,15 @@ class GUI_EXPORT QgsDockWidget : public QDockWidget public: - /** Constructor for QgsDockWidget. + /** + * Constructor for QgsDockWidget. * \param parent parent widget * \param flags window flags */ explicit QgsDockWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = 0 ); - /** Constructor for QgsDockWidget. + /** + * Constructor for QgsDockWidget. * \param title dock title * \param parent parent widget * \param flags window flags @@ -48,7 +51,8 @@ class GUI_EXPORT QgsDockWidget : public QDockWidget public slots: - /** Sets the dock widget as visible to a user, ie both shown and raised to the front. + /** + * Sets the dock widget as visible to a user, ie both shown and raised to the front. * \param visible set to true to show the dock to the user, or false to hide the dock. * When setting a dock as user visible, the dock will be opened (if it is not already * opened) and raised to the front. @@ -62,7 +66,8 @@ class GUI_EXPORT QgsDockWidget : public QDockWidget */ void setUserVisible( bool visible ); - /** Returns true if the dock is both opened and raised to the front (ie not hidden by + /** + * Returns true if the dock is both opened and raised to the front (ie not hidden by * any other tabs. * \see setUserVisible() */ @@ -75,26 +80,30 @@ class GUI_EXPORT QgsDockWidget : public QDockWidget signals: - /** Emitted when dock widget is closed. + /** + * Emitted when dock widget is closed. * \see closedStateChanged() * \see opened() */ void closed(); - /** Emitted when dock widget is closed (or opened). + /** + * Emitted when dock widget is closed (or opened). * \param wasClosed will be true if dock widget was closed, or false if dock widget was opened * \see closed() * \see openedStateChanged() */ void closedStateChanged( bool wasClosed ); - /** Emitted when dock widget is opened. + /** + * Emitted when dock widget is opened. * \see openedStateChanged() * \see closed() */ void opened(); - /** Emitted when dock widget is opened (or closed). + /** + * Emitted when dock widget is opened (or closed). * \param wasOpened will be true if dock widget was opened, or false if dock widget was closed * \see closedStateChanged() * \see opened() diff --git a/src/gui/qgsencodingfiledialog.h b/src/gui/qgsencodingfiledialog.h index 695c0ed2cb9c..96c678269439 100644 --- a/src/gui/qgsencodingfiledialog.h +++ b/src/gui/qgsencodingfiledialog.h @@ -23,7 +23,8 @@ class QComboBox; class QPushButton; -/** \ingroup gui +/** + * \ingroup gui * A file dialog which lets the user select the preferred encoding type for a data provider. **/ class GUI_EXPORT QgsEncodingFileDialog: public QFileDialog diff --git a/src/gui/qgserrordialog.h b/src/gui/qgserrordialog.h index 930af030be56..dec2f0fb8b30 100644 --- a/src/gui/qgserrordialog.h +++ b/src/gui/qgserrordialog.h @@ -25,7 +25,8 @@ #include "qgis_gui.h" #include "qgis.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsErrorDialog */ class GUI_EXPORT QgsErrorDialog: public QDialog, private Ui::QgsErrorDialogBase @@ -38,7 +39,8 @@ class GUI_EXPORT QgsErrorDialog: public QDialog, private Ui::QgsErrorDialogBase */ QgsErrorDialog( const QgsError &error, const QString &title, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags ); - /** Show dialog with error + /** + * Show dialog with error * \param error error * \param title title * \param parent parent object diff --git a/src/gui/qgsexpressionbuilderdialog.h b/src/gui/qgsexpressionbuilderdialog.h index 00bf86607cd8..220329e82fdc 100644 --- a/src/gui/qgsexpressionbuilderdialog.h +++ b/src/gui/qgsexpressionbuilderdialog.h @@ -22,7 +22,8 @@ #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * A generic dialog for building expression strings * @remarks This class also shows an example on how to use QgsExpressionBuilderWidget */ @@ -44,14 +45,16 @@ class GUI_EXPORT QgsExpressionBuilderDialog : public QDialog, private Ui::QgsExp QString expressionText(); - /** Returns the expression context for the dialog. The context is used for the expression + /** + * Returns the expression context for the dialog. The context is used for the expression * preview result and for populating the list of available functions and variables. * \see setExpressionContext * \since QGIS 2.12 */ QgsExpressionContext expressionContext() const; - /** Sets the expression context for the dialog. The context is used for the expression + /** + * Sets the expression context for the dialog. The context is used for the expression * preview result and for populating the list of available functions and variables. * \param context expression context * \see expressionContext diff --git a/src/gui/qgsexpressionbuilderwidget.h b/src/gui/qgsexpressionbuilderwidget.h index 9f525378da3d..20c10ca5bd59 100644 --- a/src/gui/qgsexpressionbuilderwidget.h +++ b/src/gui/qgsexpressionbuilderwidget.h @@ -33,7 +33,8 @@ class QgsFields; class QgsExpressionHighlighter; class QgsRelation; -/** \ingroup gui +/** + * \ingroup gui * An expression item that can be used in the QgsExpressionBuilderWidget tree. */ class GUI_EXPORT QgsExpressionItem : public QStandardItem @@ -70,19 +71,22 @@ class GUI_EXPORT QgsExpressionItem : public QStandardItem QString getExpressionText() const { return mExpressionText; } - /** Get the help text that is associated with this expression item. + /** + * Get the help text that is associated with this expression item. * * \returns The help text. */ QString getHelpText() const { return mHelpText; } - /** Set the help text for the current item + /** + * Set the help text for the current item * * \note The help text can be set as a html string. */ void setHelpText( const QString &helpText ) { mHelpText = helpText; } - /** Get the type of expression item, e.g., header, field, ExpressionNode. + /** + * Get the type of expression item, e.g., header, field, ExpressionNode. * * \returns The QgsExpressionItem::ItemType */ @@ -100,7 +104,8 @@ class GUI_EXPORT QgsExpressionItem : public QStandardItem }; -/** \ingroup gui +/** + * \ingroup gui * Search proxy used to filter the QgsExpressionBuilderWidget tree. * The default search for a tree model only searches top level this will handle one * level down @@ -120,7 +125,8 @@ class GUI_EXPORT QgsExpressionItemSearchProxy : public QSortFilterProxyModel }; -/** \ingroup gui +/** + * \ingroup gui * A reusable widget that can be used to build a expression string. * See QgsExpressionBuilderDialog for example of usage. */ @@ -135,19 +141,22 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp QgsExpressionBuilderWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); ~QgsExpressionBuilderWidget(); - /** Sets layer in order to get the fields and values + /** + * Sets layer in order to get the fields and values * \note this needs to be called before calling loadFieldNames(). */ void setLayer( QgsVectorLayer *layer ); - /** Loads all the field names from the layer. + /** + * Loads all the field names from the layer. * @remarks Should this really be public couldn't we just do this for the user? */ void loadFieldNames(); void loadFieldNames( const QgsFields &fields ); - /** Loads field names and values from the specified map. + /** + * Loads field names and values from the specified map. * \note The field values must be quoted appropriately if they are strings. * \since QGIS 2.12 */ @@ -156,21 +165,24 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp //! Sets geometry calculator used in distance/area calculations. void setGeomCalculator( const QgsDistanceArea &da ); - /** Gets the expression string that has been set in the expression area. + /** + * Gets the expression string that has been set in the expression area. * \returns The expression as a string. */ QString expressionText(); //! Sets the expression string for the widget void setExpressionText( const QString &expression ); - /** Returns the expression context for the widget. The context is used for the expression + /** + * Returns the expression context for the widget. The context is used for the expression * preview result and for populating the list of available functions and variables. * \see setExpressionContext * \since QGIS 2.12 */ QgsExpressionContext expressionContext() const { return mExpressionContext; } - /** Sets the expression context for the widget. The context is used for the expression + /** + * Sets the expression context for the widget. The context is used for the expression * preview result and for populating the list of available functions and variables. * \param context expression context * \see expressionContext @@ -178,7 +190,8 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp */ void setExpressionContext( const QgsExpressionContext &context ); - /** Registers a node item for the expression builder. + /** + * Registers a node item for the expression builder. * \param group The group the item will be show in the tree view. If the group doesn't exsit it will be created. * \param label The label that is show to the user for the item in the tree. * \param expressionText The text that is inserted into the expression area when the user double clicks on the item. @@ -206,23 +219,28 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp */ void loadRecent( const QString &collection = "generic" ); - /** Create a new file in the function editor + /** + * Create a new file in the function editor */ void newFunctionFile( const QString &fileName = "scratch" ); - /** Save the current function editor text to the given file. + /** + * Save the current function editor text to the given file. */ void saveFunctionFile( QString fileName ); - /** Load code from the given file into the function editor + /** + * Load code from the given file into the function editor */ void loadCodeFromFile( QString path ); - /** Load code into the function editor + /** + * Load code into the function editor */ void loadFunctionCode( const QString &code ); - /** Update the list of function files found at the given path + /** + * Update the list of function files found at the given path */ void updateFunctionFileList( const QString &path ); @@ -290,7 +308,8 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp signals: - /** Emitted when the user changes the expression in the widget. + /** + * Emitted when the user changes the expression in the widget. * Users of this widget should connect to this signal to decide if to let the user * continue. * \param isValid Is true if the expression the user has typed is valid. @@ -315,7 +334,8 @@ class GUI_EXPORT QgsExpressionBuilderWidget : public QWidget, private Ui::QgsExp //! Loads current project layer names/ids into the expression help tree void loadLayers(); - /** Registers a node item for the expression builder, adding multiple items when the function exists in multiple groups + /** + * Registers a node item for the expression builder, adding multiple items when the function exists in multiple groups * \param groups The groups the item will be show in the tree view. If a group doesn't exist it will be created. * \param label The label that is show to the user for the item in the tree. * \param expressionText The text that is inserted into the expression area when the user double clicks on the item. diff --git a/src/gui/qgsexpressionhighlighter.h b/src/gui/qgsexpressionhighlighter.h index 783c3aa298c1..586c5f679330 100644 --- a/src/gui/qgsexpressionhighlighter.h +++ b/src/gui/qgsexpressionhighlighter.h @@ -25,7 +25,8 @@ class QTextDocument; -/** \ingroup gui +/** + * \ingroup gui * \class QgsExpressionHighlighter */ class GUI_EXPORT QgsExpressionHighlighter : public QSyntaxHighlighter diff --git a/src/gui/qgsexpressionlineedit.h b/src/gui/qgsexpressionlineedit.h index d517c22f7153..b35778424e6d 100644 --- a/src/gui/qgsexpressionlineedit.h +++ b/src/gui/qgsexpressionlineedit.h @@ -29,7 +29,8 @@ class QgsDistanceArea; class QgsExpressionContextGenerator; class QgsCodeEditorSQL; -/** \ingroup gui +/** + * \ingroup gui * \class QgsExpressionLineEdit * \brief The QgsExpressionLineEdit widget includes a line edit for entering expressions * together with a button to open the expression creation dialog. @@ -115,7 +116,8 @@ class GUI_EXPORT QgsExpressionLineEdit : public QWidget signals: - /** Emitted when the expression is changed. + /** + * Emitted when the expression is changed. * \param expression new expression */ void expressionChanged( const QString &expression ); diff --git a/src/gui/qgsexpressionselectiondialog.h b/src/gui/qgsexpressionselectiondialog.h index a6f060ba626e..953baef7abde 100644 --- a/src/gui/qgsexpressionselectiondialog.h +++ b/src/gui/qgsexpressionselectiondialog.h @@ -26,7 +26,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * This class offers a dialog to change feature selections. * To do so, a QgsExpressionBuilderWidget is shown in a dialog. * It offers the possibilities to create a new selection, add to the current selection @@ -69,7 +70,8 @@ class GUI_EXPORT QgsExpressionSelectionDialog : public QDialog, private Ui::QgsE */ void setGeomCalculator( const QgsDistanceArea &da ); - /** Sets the message bar to display feedback from the dialog. This is used when zooming to + /** + * Sets the message bar to display feedback from the dialog. This is used when zooming to * features to display the count of selected features. * \param messageBar target message bar * \since QGIS 3.0 diff --git a/src/gui/qgsextentgroupbox.h b/src/gui/qgsextentgroupbox.h index b3093f064a45..09df7cdf168c 100644 --- a/src/gui/qgsextentgroupbox.h +++ b/src/gui/qgsextentgroupbox.h @@ -33,7 +33,8 @@ class QgsCoordinateReferenceSystem; class QgsMapLayerModel; class QgsMapLayer; -/** \ingroup gui +/** + * \ingroup gui * Collapsible group box for configuration of extent, typically for a save operation. * * Besides allowing the user to enter the extent manually, it comes with options to use @@ -177,14 +178,16 @@ class GUI_EXPORT QgsExtentGroupBox : public QgsCollapsibleGroupBox, private Ui:: */ void setOutputExtentFromDrawOnCanvas(); - /** Sets a fixed aspect ratio to be used when dragging extent onto the canvas. + /** + * Sets a fixed aspect ratio to be used when dragging extent onto the canvas. * To unset a fixed aspect ratio, set the width and height to zero. * \param ratio aspect ratio's width and height * \since QGIS 3.0 * */ void setRatio( QSize ratio ) { mRatio = ratio; } - /** Returns the current fixed aspect ratio to be used when dragging extent onto the canvas. + /** + * Returns the current fixed aspect ratio to be used when dragging extent onto the canvas. * If the aspect ratio isn't fixed, the width and height will be set to zero. * \since QGIS 3.0 * */ diff --git a/src/gui/qgsexternalresourcewidget.h b/src/gui/qgsexternalresourcewidget.h index e7a1ee83894a..c198b5c6a7f3 100644 --- a/src/gui/qgsexternalresourcewidget.h +++ b/src/gui/qgsexternalresourcewidget.h @@ -38,7 +38,8 @@ class QgsPixmapLabel; #endif -/** \ingroup gui +/** + * \ingroup gui * Widget to display file path with a push button for an "open file" dialog * It can also be used to display a picture or a web page. **/ diff --git a/src/gui/qgsfeatureselectiondlg.h b/src/gui/qgsfeatureselectiondlg.h index bdbd4a623723..7c6562cf48fd 100644 --- a/src/gui/qgsfeatureselectiondlg.h +++ b/src/gui/qgsfeatureselectiondlg.h @@ -30,7 +30,8 @@ class QgsGenericFeatureSelectionManager; % End #endif -/** \ingroup gui +/** + * \ingroup gui * \class QgsFeatureSelectionDlg */ class GUI_EXPORT QgsFeatureSelectionDlg : public QDialog, private Ui::QgsFeatureSelectionDlg diff --git a/src/gui/qgsfieldcombobox.h b/src/gui/qgsfieldcombobox.h index d53b1c6dd71f..1425be971cd1 100644 --- a/src/gui/qgsfieldcombobox.h +++ b/src/gui/qgsfieldcombobox.h @@ -26,7 +26,8 @@ class QgsMapLayer; class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsFieldComboBox is a combo box which displays the list of fields of a given layer. * It might be combined with a QgsMapLayerComboBox to automatically update fields according to a chosen layer. * If expression must be used, QgsFieldExpressionWidget shall be used instead. diff --git a/src/gui/qgsfieldexpressionwidget.h b/src/gui/qgsfieldexpressionwidget.h index c380aef25113..2aca72387ab0 100644 --- a/src/gui/qgsfieldexpressionwidget.h +++ b/src/gui/qgsfieldexpressionwidget.h @@ -34,7 +34,8 @@ class QgsMapLayer; class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsFieldExpressionWidget class reates a widget to choose fields and edit expressions * It contains a combo boxto display the fields and expression and a button to open the expression dialog. * The combo box is editable, allowing expressions to be edited inline. diff --git a/src/gui/qgsfieldvalidator.h b/src/gui/qgsfieldvalidator.h index c406fa2b147e..59cf490da6f0 100644 --- a/src/gui/qgsfieldvalidator.h +++ b/src/gui/qgsfieldvalidator.h @@ -26,7 +26,8 @@ #include "qgsfields.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsFieldValidator */ class GUI_EXPORT QgsFieldValidator : public QValidator diff --git a/src/gui/qgsfieldvalueslineedit.h b/src/gui/qgsfieldvalueslineedit.h index 3fbf5f4e5da3..7ddc3376a05d 100644 --- a/src/gui/qgsfieldvalueslineedit.h +++ b/src/gui/qgsfieldvalueslineedit.h @@ -35,7 +35,8 @@ class QgsFloatingWidget; // just internal guff - definitely not for exposing to public API! ///@cond PRIVATE -/** \class QgsFieldValuesLineEditValuesGatherer +/** + * \class QgsFieldValuesLineEditValuesGatherer * Collates unique values containing a matching substring in a thread. */ class QgsFieldValuesLineEditValuesGatherer: public QThread @@ -49,7 +50,8 @@ class QgsFieldValuesLineEditValuesGatherer: public QThread , mWasCanceled( false ) {} - /** Sets the substring to find matching values containing + /** + * Sets the substring to find matching values containing */ void setSubstring( const QString &string ) { mSubstring = string; } @@ -93,7 +95,8 @@ class QgsFieldValuesLineEditValuesGatherer: public QThread signals: - /** Emitted when values have been collected + /** + * Emitted when values have been collected * \param values list of unique matching string values */ void collectedValues( const QStringList &values ); @@ -113,7 +116,8 @@ class QgsFieldValuesLineEditValuesGatherer: public QThread #endif -/** \class QgsFieldValuesLineEdit +/** + * \class QgsFieldValuesLineEdit * \ingroup gui * A line edit with an autocompleter which takes unique values from a vector layer's fields. * The autocompleter is populated from the vector layer in the background to ensure responsive @@ -129,34 +133,39 @@ class GUI_EXPORT QgsFieldValuesLineEdit: public QgsFilterLineEdit public: - /** Constructor for QgsFieldValuesLineEdit + /** + * Constructor for QgsFieldValuesLineEdit * \param parent parent widget */ QgsFieldValuesLineEdit( QWidget *parent SIP_TRANSFERTHIS = 0 ); virtual ~QgsFieldValuesLineEdit(); - /** Sets the layer containing the field that values will be shown from. + /** + * Sets the layer containing the field that values will be shown from. * \param layer vector layer * \see layer() * \see setAttributeIndex() */ void setLayer( QgsVectorLayer *layer ); - /** Returns the layer containing the field that values will be shown from. + /** + * Returns the layer containing the field that values will be shown from. * \see setLayer() * \see attributeIndex() */ QgsVectorLayer *layer() const { return mLayer; } - /** Sets the attribute index for the field containing values to show in the widget. + /** + * Sets the attribute index for the field containing values to show in the widget. * \param index index of attribute * \see attributeIndex() * \see setLayer() */ void setAttributeIndex( int index ); - /** Returns the attribute index for the field containing values shown in the widget. + /** + * Returns the attribute index for the field containing values shown in the widget. * \see setAttributeIndex() * \see layer() */ @@ -164,34 +173,40 @@ class GUI_EXPORT QgsFieldValuesLineEdit: public QgsFilterLineEdit signals: - /** Emitted when the layer associated with the widget changes. + /** + * Emitted when the layer associated with the widget changes. * \param layer vector layer */ void layerChanged( QgsVectorLayer *layer ); - /** Emitted when the field associated with the widget changes. + /** + * Emitted when the field associated with the widget changes. * \param index new attribute index for field */ void attributeIndexChanged( int index ); private slots: - /** Requests that the autocompleter updates its completion list. The update will not occur immediately + /** + * Requests that the autocompleter updates its completion list. The update will not occur immediately * but after a preset timeout to avoid multiple updates while a user is quickly typing. */ void requestCompleterUpdate(); - /** Updates the autocompleter list immediately. Calling + /** + * Updates the autocompleter list immediately. Calling * this will trigger a background request to the layer to fetch matching unique values. */ void triggerCompleterUpdate(); - /** Updates the values shown in the completer list. + /** + * Updates the values shown in the completer list. * \param values list of string values to show */ void updateCompleter( const QStringList &values ); - /** Called when the gatherer thread is complete, regardless of whether it finished collecting values. + /** + * Called when the gatherer thread is complete, regardless of whether it finished collecting values. * Cleans up the gatherer thread and triggers a new background thread if the widget's text has changed * in the meantime. */ diff --git a/src/gui/qgsfiledownloader.h b/src/gui/qgsfiledownloader.h index 7855d39a48c1..2c719bd63d32 100644 --- a/src/gui/qgsfiledownloader.h +++ b/src/gui/qgsfiledownloader.h @@ -26,7 +26,8 @@ #include #endif -/** \ingroup gui +/** + * \ingroup gui * QgsFileDownloader is a utility class for downloading files. * * To use this class, it is necessary to pass the URL and an output file name as diff --git a/src/gui/qgsfilewidget.h b/src/gui/qgsfilewidget.h index 4f0c741c0be8..5a8ec85a1685 100644 --- a/src/gui/qgsfilewidget.h +++ b/src/gui/qgsfilewidget.h @@ -28,7 +28,8 @@ class QHBoxLayout; #include "qgis.h" #include "qgsfilterlineedit.h" -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsFileWidget class creates a widget for selecting a file or a folder. */ class GUI_EXPORT QgsFileWidget : public QWidget @@ -195,7 +196,8 @@ class GUI_EXPORT QgsFileWidget : public QWidget #ifndef SIP_RUN -/** \ingroup gui +/** + * \ingroup gui * A line edit for capturing file names that can have files dropped onto * it via drag & drop. * diff --git a/src/gui/qgsfilterlineedit.h b/src/gui/qgsfilterlineedit.h index 4749a37c2652..6a87184a1f0b 100644 --- a/src/gui/qgsfilterlineedit.h +++ b/src/gui/qgsfilterlineedit.h @@ -25,7 +25,8 @@ class QToolButton; -/** \class QgsFilterLineEdit +/** + * \class QgsFilterLineEdit * \ingroup gui * QLineEdit subclass with built in support for clearing the widget's value and * handling custom null value representations. @@ -64,40 +65,46 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit }; Q_ENUM( ClearMode ); - /** Constructor for QgsFilterLineEdit. + /** + * Constructor for QgsFilterLineEdit. * \param parent parent widget * \param nullValue string for representing null values */ QgsFilterLineEdit( QWidget *parent SIP_TRANSFERTHIS = 0, const QString &nullValue = QString() ); - /** Returns true if the widget's clear button is visible. + /** + * Returns true if the widget's clear button is visible. * \see setShowClearButton() * \since QGIS 3.0 */ bool showClearButton() const { return mClearButtonVisible; } - /** Sets whether the widget's clear button is visible. + /** + * Sets whether the widget's clear button is visible. * \param visible set to false to hide the clear button * \see showClearButton() * \since QGIS 3.0 */ void setShowClearButton( bool visible ); - /** Returns the clear mode for the widget. The clear mode defines the behavior of the + /** + * Returns the clear mode for the widget. The clear mode defines the behavior of the * widget when its value is cleared. This defaults to ClearToNull. * \see setClearMode() * \since QGIS 3.0 */ ClearMode clearMode() const { return mClearMode; } - /** Sets the clear mode for the widget. The clear mode defines the behavior of the + /** + * Sets the clear mode for the widget. The clear mode defines the behavior of the * widget when its value is cleared. This defaults to ClearToNull. * \see clearMode() * \since QGIS 3.0 */ void setClearMode( ClearMode mode ) { mClearMode = mode; } - /** Sets the string representation for null values in the widget. This does not + /** + * Sets the string representation for null values in the widget. This does not * affect the values returned for null values by value(), rather it only affects * the text that is shown to users when the widget's value is null. * \param nullValue string to show when widget's value is null @@ -105,26 +112,30 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit */ void setNullValue( const QString &nullValue ) { mNullValue = nullValue; } - /** Returns the string used for representating null values in the widget. + /** + * Returns the string used for representating null values in the widget. * \see setNullValue() * \see isNull() */ QString nullValue() const { return mNullValue; } - /** Define if a search icon shall be shown on the left of the image + /** + * Define if a search icon shall be shown on the left of the image * when no text is entered * \param visible set to false to hide the search icon * \since QGIS 3.0 */ void setShowSearchIcon( bool visible ); - /** Returns if a search icon shall be shown on the left of the image + /** + * Returns if a search icon shall be shown on the left of the image * when no text is entered * \since QGIS 3.0 */ bool showSearchIcon() const { return mSearchIconVisible; } - /** Sets the default value for the widget. The default value is a value + /** + * Sets the default value for the widget. The default value is a value * which the widget will be reset to if it is cleared and the clearMode() * is equal to ClearToDefault. * \param defaultValue default value @@ -134,7 +145,8 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit */ void setDefaultValue( const QString &defaultValue ) { mDefaultValue = defaultValue; } - /** Returns the default value for the widget. The default value is a value + /** + * Returns the default value for the widget. The default value is a value * which the widget will be reset to if it is cleared and the clearMode() * is equal to ClearToDefault. * \see setDefaultValue() @@ -172,7 +184,8 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit public slots: - /** Clears the widget and resets it to the null value. + /** + * Clears the widget and resets it to the null value. * \see nullValue() * \since QGIS 3.0 */ @@ -180,7 +193,8 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit signals: - /** Emitted when the widget is cleared + /** + * Emitted when the widget is cleared * \see clearValue() */ void cleared(); @@ -231,7 +245,8 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit /// @cond PRIVATE -/** Private QgsFilterLineEdit subclass for use as a line edit in QgsSpinBox/QgsDoubleSpinBox +/** + * Private QgsFilterLineEdit subclass for use as a line edit in QgsSpinBox/QgsDoubleSpinBox * we let QgsFilterLineEdit handle display of the clear button and detection * of clicks, but override clearValue() and let Qgs(Double)SpinBox handle the clearing * themselves. diff --git a/src/gui/qgsfloatingwidget.h b/src/gui/qgsfloatingwidget.h index 94b70b10b546..b0177c3a026b 100644 --- a/src/gui/qgsfloatingwidget.h +++ b/src/gui/qgsfloatingwidget.h @@ -21,7 +21,8 @@ class QgsFloatingWidgetEventFilter; -/** \ingroup gui +/** + * \ingroup gui * \class QgsFloatingWidget * A QWidget subclass for creating widgets which float outside of the normal Qt layout * system. Floating widgets use an "anchor widget" to determine how they are anchored @@ -53,45 +54,52 @@ class GUI_EXPORT QgsFloatingWidget: public QWidget }; Q_ENUM( AnchorPoint ); - /** Constructor for QgsFloatingWidget. + /** + * Constructor for QgsFloatingWidget. * \param parent parent widget */ QgsFloatingWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets the widget to "anchor" the floating widget to. The floating widget will be repositioned whenever the + /** + * Sets the widget to "anchor" the floating widget to. The floating widget will be repositioned whenever the * anchor widget moves or is resized so that it maintains the same relative position to the anchor widget. * \param widget anchor widget. Both the floating widget and the anchor widget must share some common parent. * \see anchorWidget() */ void setAnchorWidget( QWidget *widget ); - /** Returns the widget that the floating widget is "anchored" tto. The floating widget will be repositioned whenever the + /** + * Returns the widget that the floating widget is "anchored" tto. The floating widget will be repositioned whenever the * anchor widget moves or is resized so that it maintains the same relative position to the anchor widget. * \see setAnchorWidget() */ QWidget *anchorWidget(); - /** Returns the floating widget's anchor point, which corresponds to the point on the widget which should remain + /** + * Returns the floating widget's anchor point, which corresponds to the point on the widget which should remain * fixed in the same relative position whenever the widget's parent is resized or moved. * \see setAnchorPoint() */ AnchorPoint anchorPoint() const { return mFloatAnchorPoint; } - /** Sets the floating widget's anchor point, which corresponds to the point on the widget which should remain + /** + * Sets the floating widget's anchor point, which corresponds to the point on the widget which should remain * fixed in the same relative position whenever the widget's parent is resized or moved. * \param point anchor point * \see anchorPoint() */ void setAnchorPoint( AnchorPoint point ); - /** Returns the anchor widget's anchor point, which corresponds to the point on the anchor widget which + /** + * Returns the anchor widget's anchor point, which corresponds to the point on the anchor widget which * the floating widget should "attach" to. The floating widget should remain fixed in the same relative position * to this anchor widget whenever the widget's parent is resized or moved. * \see setAnchorWidgetPoint() */ AnchorPoint anchorWidgetPoint() const { return mAnchorWidgetAnchorPoint; } - /** Returns the anchor widget's anchor point, which corresponds to the point on the anchor widget which + /** + * Returns the anchor widget's anchor point, which corresponds to the point on the anchor widget which * the floating widget should "attach" to. The floating widget should remain fixed in the same relative position * to this anchor widget whenever the widget's parent is resized or moved. * \see setAnchorWidgetPoint() diff --git a/src/gui/qgsfocuswatcher.h b/src/gui/qgsfocuswatcher.h index dcd21972d3ea..53b75b57845d 100644 --- a/src/gui/qgsfocuswatcher.h +++ b/src/gui/qgsfocuswatcher.h @@ -20,7 +20,8 @@ #include "qgis.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsFocusWatcher * A event filter for watching for focus events on a parent object. Usually QObjects must * subclass and override methods like focusOutEvent to handle focus events. Using this class @@ -35,7 +36,8 @@ class GUI_EXPORT QgsFocusWatcher : public QObject public: - /** Constructor for QgsFocusWatcher. + /** + * Constructor for QgsFocusWatcher. * \param parent parent widget to catch focus events for. This class will automatically be * installed as an event filter for parent. */ @@ -45,7 +47,8 @@ class GUI_EXPORT QgsFocusWatcher : public QObject signals: - /** Emitted when parent object's focus changes. + /** + * Emitted when parent object's focus changes. * \param focused true if object gained focus, false if object lost focus */ void focusChanged( bool focused ); diff --git a/src/gui/qgsfontbutton.h b/src/gui/qgsfontbutton.h index 6e396e4e4f64..5054e0daa9bd 100644 --- a/src/gui/qgsfontbutton.h +++ b/src/gui/qgsfontbutton.h @@ -147,7 +147,8 @@ class GUI_EXPORT QgsFontButton : public QToolButton */ void setColor( const QColor &color ); - /** Copies the current text format to the clipboard. + /** + * Copies the current text format to the clipboard. * \see pasteFormat() */ void copyFormat(); @@ -208,7 +209,8 @@ class GUI_EXPORT QgsFontButton : public QToolButton void showSettingsDialog(); - /** Creates the drop-down menu entries + /** + * Creates the drop-down menu entries */ void prepareMenu(); @@ -251,7 +253,8 @@ class GUI_EXPORT QgsFontButton : public QToolButton */ bool fontFromMimeData( const QMimeData *mimeData, QFont &resultFont ) const; - /** Attempts to parse mimeData as a color, either via the mime data's color data or by + /** + * Attempts to parse mimeData as a color, either via the mime data's color data or by * parsing a textual representation of a color. * \returns true if mime data could be intrepreted as a color * \param mimeData mime data diff --git a/src/gui/qgsgeometryrubberband.h b/src/gui/qgsgeometryrubberband.h index f99f7098820a..8540a22eabc0 100644 --- a/src/gui/qgsgeometryrubberband.h +++ b/src/gui/qgsgeometryrubberband.h @@ -29,7 +29,8 @@ class QgsAbstractGeometry; class QgsPoint; struct QgsVertexId; -/** \ingroup gui +/** + * \ingroup gui * A rubberband class for QgsAbstractGeometry (considering curved geometries)*/ class GUI_EXPORT QgsGeometryRubberBand: public QgsMapCanvasItem { diff --git a/src/gui/qgsgradientcolorrampdialog.h b/src/gui/qgsgradientcolorrampdialog.h index abd2111a17c0..bec2a9e5e01b 100644 --- a/src/gui/qgsgradientcolorrampdialog.h +++ b/src/gui/qgsgradientcolorrampdialog.h @@ -29,7 +29,8 @@ class QwtPlotCurve; class QwtPlotMarker; class QgsGradientPlotEventFilter; -/** \ingroup gui +/** + * \ingroup gui * \class QgsGradientColorRampDialog * A dialog which allows users to modify the properties of a QgsGradientColorRamp. * \since QGIS 3.0 @@ -41,19 +42,22 @@ class GUI_EXPORT QgsGradientColorRampDialog : public QDialog, private Ui::QgsGra public: - /** Constructor for QgsGradientColorRampDialog. + /** + * Constructor for QgsGradientColorRampDialog. * \param ramp initial ramp to show in dialog * \param parent parent widget */ QgsGradientColorRampDialog( const QgsGradientColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = 0 ); ~QgsGradientColorRampDialog(); - /** Returns a color ramp representing the current settings from the dialog. + /** + * Returns a color ramp representing the current settings from the dialog. * \see setRamp() */ QgsGradientColorRamp ramp() const { return mRamp; } - /** Sets the color ramp to show in the dialog. + /** + * Sets the color ramp to show in the dialog. * \param ramp color ramp * \see ramp() */ @@ -66,12 +70,14 @@ class GUI_EXPORT QgsGradientColorRampDialog : public QDialog, private Ui::QgsGra public slots: - /** Sets the start color for the gradient ramp. + /** + * Sets the start color for the gradient ramp. * \see setColor2() */ void setColor1( const QColor &color ); - /** Sets the end color for the gradient ramp. + /** + * Sets the end color for the gradient ramp. * \see setColor1() */ void setColor2( const QColor &color ); diff --git a/src/gui/qgsgradientstopeditor.h b/src/gui/qgsgradientstopeditor.h index bc24682999b9..c50cd8004f22 100644 --- a/src/gui/qgsgradientstopeditor.h +++ b/src/gui/qgsgradientstopeditor.h @@ -22,7 +22,8 @@ #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsGradientStopEditor * An interactive editor for previewing a gradient color ramp and modifying the position of color * stops along the gradient. @@ -35,30 +36,35 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget public: - /** Constructor for QgsGradientStopEditor. + /** + * Constructor for QgsGradientStopEditor. * \param parent parent widget * \param ramp optional initial gradient ramp */ QgsGradientStopEditor( QWidget *parent SIP_TRANSFERTHIS = 0, QgsGradientColorRamp *ramp = nullptr ); - /** Sets the current ramp shown in the editor. + /** + * Sets the current ramp shown in the editor. * \param ramp color ramp * \see gradientRamp() */ void setGradientRamp( const QgsGradientColorRamp &ramp ); - /** Returns the current ramp created by the editor. + /** + * Returns the current ramp created by the editor. * \see setGradientRamp() */ QgsGradientColorRamp gradientRamp() const { return mGradient; } - /** Sets the currently selected stop. + /** + * Sets the currently selected stop. * \param index index of stop, where 0 corresponds to the first stop * \see selectedStop() */ void selectStop( int index ); - /** Returns details about the currently selected stop. + /** + * Returns details about the currently selected stop. * \see selectStop() */ QgsGradientStop selectedStop() const; @@ -68,7 +74,8 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget public slots: - /** Sets the color for the current selected stop. + /** + * Sets the color for the current selected stop. * \param color new stop color * \see setSelectedStopOffset() * \see setSelectedStopDetails() @@ -77,7 +84,8 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget */ void setSelectedStopColor( const QColor &color ); - /** Sets the offset for the current selected stop. This slot has no effect if either the + /** + * Sets the offset for the current selected stop. This slot has no effect if either the * first or last stop is selected, as they cannot be repositioned. * \param offset new stop offset * \see setSelectedStopColor() @@ -85,7 +93,8 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget */ void setSelectedStopOffset( double offset ); - /** Sets the color and offset for the current selected stop. + /** + * Sets the color and offset for the current selected stop. * \param color new stop color * \param offset new stop offset * \see setSelectedStopColor() @@ -93,19 +102,22 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget */ void setSelectedStopDetails( const QColor &color, double offset ); - /** Deletes the current selected stop. This slot has no effect if either the + /** + * Deletes the current selected stop. This slot has no effect if either the * first or last stop is selected, as they cannot be deleted. */ void deleteSelectedStop(); - /** Sets the color for the first stop. + /** + * Sets the color for the first stop. * \param color new stop color * \see setColor2() * \see setSelectedStopColor() */ void setColor1( const QColor &color ); - /** Sets the color for the last stop. + /** + * Sets the color for the last stop. * \param color new stop color * \see setColor1() * \see setSelectedStopColor() @@ -117,7 +129,8 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget //! Emitted when the gradient ramp is changed by a user void changed(); - /** Emitted when the current selected stop changes. + /** + * Emitted when the current selected stop changes. * \param stop details about newly selected stop */ void selectedStopChanged( const QgsGradientStop &stop ); @@ -137,12 +150,14 @@ class GUI_EXPORT QgsGradientStopEditor : public QWidget private: - /** Generates a checkboard pattern pixmap for use as a background to transparent colors + /** + * Generates a checkboard pattern pixmap for use as a background to transparent colors * \returns checkerboard pixmap */ QPixmap transparentBackground(); - /** Draws a stop marker on the specified painter. + /** + * Draws a stop marker on the specified painter. * \param painter destination painter * \param topMiddle coordinate corresponding to top middle point of desired marker * \param color color of marker diff --git a/src/gui/qgsgroupwmsdatadialog.h b/src/gui/qgsgroupwmsdatadialog.h index 57f6f1ce16cc..9e6c23c0ac5c 100644 --- a/src/gui/qgsgroupwmsdatadialog.h +++ b/src/gui/qgsgroupwmsdatadialog.h @@ -21,7 +21,8 @@ #include "qgis.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsGroupWmsDataDialog */ class GUI_EXPORT QgsGroupWmsDataDialog: public QDialog, private Ui::QgsGroupWMSDataDialogBase diff --git a/src/gui/qgsguiutils.h b/src/gui/qgsguiutils.h index 246562777df5..536447b96d7c 100644 --- a/src/gui/qgsguiutils.h +++ b/src/gui/qgsguiutils.h @@ -25,7 +25,8 @@ class QFont; -/** \ingroup gui +/** + * \ingroup gui * \namespace QgsGuiUtils * The QgsGuiUtils namespace contains constants and helper functions used throughout the QGIS GUI. * \note not available in Python bindings @@ -94,7 +95,8 @@ namespace QgsGuiUtils QString const &filters, QStringList &selectedFiles, QString &enc, QString &title, bool cancelAll = false ); - /** A helper function to get an image name from the user. It will nicely + /** + * A helper function to get an image name from the user. It will nicely * provide filters with all available writable image formats. * \param parent widget that should act as the parent for the file dialog * \param message the message to display to the user diff --git a/src/gui/qgshelp.h b/src/gui/qgshelp.h index 5cc24d9b3201..706144d982ce 100644 --- a/src/gui/qgshelp.h +++ b/src/gui/qgshelp.h @@ -20,7 +20,8 @@ #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsHelp * \brief Helper class for showing help topic URI for the given key. * @@ -42,14 +43,16 @@ class GUI_EXPORT QgsHelp { public: - /** Opens help topic for the given help key using default system + /** + * Opens help topic for the given help key using default system * web browser. If help topic not found, builtin error page shown. * \param key key which identified help topic * \since QGIS 3.0 */ static void openHelp( const QString &key ); - /** Returns URI of the help topic for the given key. If help topic + /** + * Returns URI of the help topic for the given key. If help topic * not found, URI of the builtin error page returned. * \param key key which identified help topic * \since QGIS 3.0 @@ -58,7 +61,8 @@ class GUI_EXPORT QgsHelp private: - /** Check if given URL accessible by issuing HTTP HEAD request. + /** + * Check if given URL accessible by issuing HTTP HEAD request. * Returns true if URL accessible, false otherwise. * \param url URL to check * \since QGIS 3.0 diff --git a/src/gui/qgshighlight.h b/src/gui/qgshighlight.h index c00ecf24aea5..17701f0ef522 100644 --- a/src/gui/qgshighlight.h +++ b/src/gui/qgshighlight.h @@ -30,7 +30,8 @@ class QgsMapLayer; class QgsVectorLayer; class QgsSymbol; -/** \ingroup gui +/** + * \ingroup gui * A class for highlight features on the map. * * The QgsHighlight class provides a transparent overlay widget @@ -40,7 +41,8 @@ class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem { public: - /** Constructor for QgsHighlight + /** + * Constructor for QgsHighlight * \param mapCanvas associated map canvas * \param geom initial geometry of highlight * \param layer associated map layer @@ -48,14 +50,16 @@ class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem */ QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry &geom, QgsMapLayer *layer ) SIP_SKIP; - /** Constructor for QgsHighlight + /** + * Constructor for QgsHighlight * \param mapCanvas associated map canvas * \param geom initial geometry of highlight * \param layer associated vector layer */ QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry &geom, QgsVectorLayer *layer ); - /** Constructor for highlighting true feature shape using feature attributes + /** + * Constructor for highlighting true feature shape using feature attributes * and renderer. * \param mapCanvas map canvas * \param feature @@ -64,22 +68,26 @@ class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem QgsHighlight( QgsMapCanvas *mapCanvas, const QgsFeature &feature, QgsVectorLayer *layer ); ~QgsHighlight(); - /** Set line/stroke to color, polygon fill to color with alpha = 63. + /** + * Set line/stroke to color, polygon fill to color with alpha = 63. * This is legacy function, use setFillColor() after setColor() if different fill color is required. */ void setColor( const QColor &color ); - /** Set polygons fill color. + /** + * Set polygons fill color. * \since QGIS 2.3 */ void setFillColor( const QColor &fillColor ); //! Set stroke width. Ignored in feature mode. void setWidth( int width ); - /** Set line / stroke buffer in millimeters. + /** + * Set line / stroke buffer in millimeters. * \since QGIS 2.3 */ void setBuffer( double buffer ) { mBuffer = buffer; } - /** Set minimum line / stroke width in millimeters. + /** + * Set minimum line / stroke width in millimeters. * \since QGIS 2.3 */ void setMinWidth( double width ) { mMinWidth = width; } diff --git a/src/gui/qgshistogramwidget.h b/src/gui/qgshistogramwidget.h index f14eaeda2142..624d2c29b1ef 100644 --- a/src/gui/qgshistogramwidget.h +++ b/src/gui/qgshistogramwidget.h @@ -38,7 +38,8 @@ class QwtPlotHistogram; // fix for qwt5/qwt6 QwtDoublePoint vs. QPointF typedef QPointF QwtDoublePoint; -/** \ingroup gui +/** + * \ingroup gui * \class QgsHistogramWidget * \brief Graphical histogram for displaying distributions of field values. * @@ -51,7 +52,8 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi public: - /** QgsHistogramWidget constructor. If layer and fieldOrExp are specified then the histogram + /** + * QgsHistogramWidget constructor. If layer and fieldOrExp are specified then the histogram * will be initially populated with the corresponding values. * \param parent parent widget * \param layer source vector layer @@ -61,20 +63,23 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi ~QgsHistogramWidget(); - /** Returns the layer currently associated with the widget. + /** + * Returns the layer currently associated with the widget. * \see setLayer * \see sourceFieldExp */ QgsVectorLayer *layer() { return mVectorLayer; } - /** Returns the source field name or expression used to calculate values displayed + /** + * Returns the source field name or expression used to calculate values displayed * in the histogram. * \see setSourceFieldExp * \see layer */ QString sourceFieldExp() const { return mSourceFieldExp; } - /** Sets the pen to use when drawing histogram bars. If set to Qt::NoPen then the + /** + * Sets the pen to use when drawing histogram bars. If set to Qt::NoPen then the * pen will be automatically calculated. If ranges have been set using setGraduatedRanges() * then the pen and brush will have no effect. * \param pen histogram pen @@ -83,13 +88,15 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi */ void setPen( const QPen &pen ) { mPen = pen; } - /** Returns the pen used when drawing histogram bars. + /** + * Returns the pen used when drawing histogram bars. * \see setPen * \see brush */ QPen pen() const { return mPen; } - /** Sets the brush used for drawing histogram bars. If ranges have been set using setGraduatedRanges() + /** + * Sets the brush used for drawing histogram bars. If ranges have been set using setGraduatedRanges() * then the pen and brush will have no effect. * \param brush histogram brush * \see brush @@ -97,46 +104,53 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi */ void setBrush( const QBrush &brush ) { mBrush = brush; } - /** Returns the brush used when drawing histogram bars. + /** + * Returns the brush used when drawing histogram bars. * \see setBrush * \see pen */ QBrush brush() const { return mBrush; } - /** Sets the graduated ranges associated with the histogram. If set, the ranges will be used to color the histogram + /** + * Sets the graduated ranges associated with the histogram. If set, the ranges will be used to color the histogram * bars and for showing vertical dividers at the histogram breaks. * \param ranges graduated range list * \see graduatedRanges */ void setGraduatedRanges( const QgsRangeList &ranges ); - /** Returns the graduated ranges associated with the histogram. If set, the ranges will be used to color the histogram + /** + * Returns the graduated ranges associated with the histogram. If set, the ranges will be used to color the histogram * bars and for showing vertical dividers at the histogram breaks. * \returns graduated range list * \see setGraduatedRanges */ QgsRangeList graduatedRanges() const { return mRanges; } - /** Returns the title for the histogram's x-axis. + /** + * Returns the title for the histogram's x-axis. * \see setXAxisTitle * \see yAxisTitle */ QString xAxisTitle() const { return mXAxisTitle; } - /** Sets the title for the histogram's x-axis. + /** + * Sets the title for the histogram's x-axis. * \param title x-axis title, or empty string to remove title * \see xAxisTitle * \see setYAxisTitle */ void setXAxisTitle( const QString &title ) { mXAxisTitle = title; } - /** Returns the title for the histogram's y-axis. + /** + * Returns the title for the histogram's y-axis. * \see setYAxisTitle * \see xAxisTitle */ QString yAxisTitle() const { return mYAxisTitle; } - /** Sets the title for the histogram's y-axis. + /** + * Sets the title for the histogram's y-axis. * \param title y-axis title, or empty string to remove title * \see yAxisTitle * \see setXAxisTitle @@ -145,22 +159,26 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi public slots: - /** Refreshes the values for the histogram by fetching them from the layer. + /** + * Refreshes the values for the histogram by fetching them from the layer. */ void refreshValues(); - /** Redraws the histogram. Calling this slot does not update the values + /** + * Redraws the histogram. Calling this slot does not update the values * for the histogram, use refreshValues() to do this. */ void refresh(); - /** Sets the vector layer associated with the histogram. + /** + * Sets the vector layer associated with the histogram. * \param layer source vector layer * \see setSourceFieldExp */ void setLayer( QgsVectorLayer *layer ); - /** Sets the source field or expression to use for values in the histogram. + /** + * Sets the source field or expression to use for values in the histogram. * \param fieldOrExp field name or expression string * \see setLayer */ @@ -168,7 +186,8 @@ class GUI_EXPORT QgsHistogramWidget : public QWidget, private Ui::QgsHistogramWi protected: - /** Updates and redraws the histogram. + /** + * Updates and redraws the histogram. */ virtual void drawHistogram(); diff --git a/src/gui/qgsidentifymenu.h b/src/gui/qgsidentifymenu.h index 48196558e335..1c2073b4189c 100644 --- a/src/gui/qgsidentifymenu.h +++ b/src/gui/qgsidentifymenu.h @@ -38,7 +38,8 @@ class CustomActionRegistry : public QgsMapLayerActionRegistry ///\endcond #endif -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsIdentifyMenu class builds a menu to be used with identify results (\see QgsMapToolIdentify). * It is customizable and can display attribute actions (\see QgsAction) as well as map layer actions (\see QgsMapLayerAction). * It can also embed custom map layer actions, defined for this menu exclusively. diff --git a/src/gui/qgskeyvaluewidget.h b/src/gui/qgskeyvaluewidget.h index 97b622fe298a..05c1796e1c4a 100644 --- a/src/gui/qgskeyvaluewidget.h +++ b/src/gui/qgskeyvaluewidget.h @@ -26,7 +26,8 @@ #ifndef SIP_RUN ///@cond PRIVATE -/** \ingroup gui +/** + * \ingroup gui * Table model to edit a QVariantMap. * \since QGIS 3.0 * \note not available in Python bindings @@ -57,7 +58,8 @@ class GUI_EXPORT QgsKeyValueModel : public QAbstractTableModel ///@endcond #endif -/** \ingroup gui +/** + * \ingroup gui * Widget allowing to edit a QVariantMap, using a table. * \since QGIS 3.0 */ diff --git a/src/gui/qgslegendfilterbutton.h b/src/gui/qgslegendfilterbutton.h index 4ee820da5206..ecb03ac8fa39 100644 --- a/src/gui/qgslegendfilterbutton.h +++ b/src/gui/qgslegendfilterbutton.h @@ -20,7 +20,8 @@ class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsLegendFilterButton * A tool button that allows enabling or disabling legend filter by contents of the map. * An additional pop down menu allows defining a boolean expression to refine the filtering. diff --git a/src/gui/qgslimitedrandomcolorrampdialog.h b/src/gui/qgslimitedrandomcolorrampdialog.h index c687a31537cd..84f623f41dfc 100644 --- a/src/gui/qgslimitedrandomcolorrampdialog.h +++ b/src/gui/qgslimitedrandomcolorrampdialog.h @@ -23,7 +23,8 @@ #include "ui_qgslimitedrandomcolorrampwidgetbase.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsLimitedRandomColorRampWidget * A widget which allows users to modify the properties of a QgsLimitedRandomColorRamp. * \since QGIS 3.0 @@ -35,18 +36,21 @@ class GUI_EXPORT QgsLimitedRandomColorRampWidget : public QgsPanelWidget, privat public: - /** Constructor for QgsLimitedRandomColorRampWidget. + /** + * Constructor for QgsLimitedRandomColorRampWidget. * \param ramp initial ramp to show in dialog * \param parent parent widget */ QgsLimitedRandomColorRampWidget( const QgsLimitedRandomColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a color ramp representing the current settings from the dialog. + /** + * Returns a color ramp representing the current settings from the dialog. * \see setRamp() */ QgsLimitedRandomColorRamp ramp() const { return mRamp; } - /** Sets the color ramp to show in the dialog. + /** + * Sets the color ramp to show in the dialog. * \param ramp color ramp * \see ramp() */ @@ -83,7 +87,8 @@ class GUI_EXPORT QgsLimitedRandomColorRampWidget : public QgsPanelWidget, privat }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsLimitedRandomColorRampDialog * A dialog which allows users to modify the properties of a QgsLimitedRandomColorRamp. * \since QGIS 3.0 @@ -95,18 +100,21 @@ class GUI_EXPORT QgsLimitedRandomColorRampDialog : public QDialog public: - /** Constructor for QgsLimitedRandomColorRampDialog. + /** + * Constructor for QgsLimitedRandomColorRampDialog. * \param ramp initial ramp to show in dialog * \param parent parent widget */ QgsLimitedRandomColorRampDialog( const QgsLimitedRandomColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a color ramp representing the current settings from the dialog. + /** + * Returns a color ramp representing the current settings from the dialog. * \see setRamp() */ QgsLimitedRandomColorRamp ramp() const { return mWidget->ramp(); } - /** Sets the color ramp to show in the dialog. + /** + * Sets the color ramp to show in the dialog. * \param ramp color ramp * \see ramp() */ diff --git a/src/gui/qgslistwidget.h b/src/gui/qgslistwidget.h index 5c78512a9078..cec3f327993e 100644 --- a/src/gui/qgslistwidget.h +++ b/src/gui/qgslistwidget.h @@ -25,7 +25,8 @@ #ifndef SIP_RUN ///@cond PRIVATE -/** \ingroup gui +/** + * \ingroup gui * Table model to edit a QVariantList. * \since QGIS 3.0 * \note not available in Python bindings @@ -57,7 +58,8 @@ class GUI_EXPORT QgsListModel : public QAbstractTableModel #endif -/** \ingroup gui +/** + * \ingroup gui * Widget allowing to edit a QVariantList, using a table. * \since QGIS 3.0 */ diff --git a/src/gui/qgslonglongvalidator.h b/src/gui/qgslonglongvalidator.h index 60ffcc7c656e..3854ef225dd8 100644 --- a/src/gui/qgslonglongvalidator.h +++ b/src/gui/qgslonglongvalidator.h @@ -25,7 +25,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsLongLongValidator */ class GUI_EXPORT QgsLongLongValidator : public QValidator diff --git a/src/gui/qgsludialog.h b/src/gui/qgsludialog.h index 65fbe4f6b6a8..4d80f5c228ce 100644 --- a/src/gui/qgsludialog.h +++ b/src/gui/qgsludialog.h @@ -23,7 +23,8 @@ #include "qgis_gui.h" #include "qgis_sip.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsLUDialog */ class GUI_EXPORT QgsLUDialog: public QDialog, private Ui::QgsLUDialogBase diff --git a/src/gui/qgsmanageconnectionsdialog.h b/src/gui/qgsmanageconnectionsdialog.h index 7430d7271f07..9ebde6031fc9 100644 --- a/src/gui/qgsmanageconnectionsdialog.h +++ b/src/gui/qgsmanageconnectionsdialog.h @@ -24,7 +24,8 @@ #include "qgis_gui.h" #include "qgis_sip.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsManageConnectionsDialog */ class GUI_EXPORT QgsManageConnectionsDialog : public QDialog, private Ui::QgsManageConnectionsDialogBase diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp index 7f7326bc5ea4..89e7df5ed2b3 100644 --- a/src/gui/qgsmapcanvas.cpp +++ b/src/gui/qgsmapcanvas.cpp @@ -68,7 +68,8 @@ email : sherman at mrcc.com #include -/** \ingroup gui +/** + * \ingroup gui * Deprecated to be deleted, stuff from here should be moved elsewhere. * \note not available in Python bindings */ diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h index 608b8c91cdc2..359f1e249a5f 100644 --- a/src/gui/qgsmapcanvas.h +++ b/src/gui/qgsmapcanvas.h @@ -66,7 +66,8 @@ class QgsSnappingUtils; class QgsRubberBand; class QgsMapCanvasAnnotationItem; -/** \ingroup gui +/** + * \ingroup gui * Map canvas is a class for displaying all GIS data types on a canvas. */ @@ -250,17 +251,20 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView // ! Clears the list of extents and sets current extent as first item void clearExtentHistory(); - /** Zoom to the extent of the selected features of current (vector) layer. + /** + * Zoom to the extent of the selected features of current (vector) layer. * \param layer optionally specify different than current layer */ void zoomToSelected( QgsVectorLayer *layer = nullptr ); - /** Set canvas extent to the bounding box of a set of features + /** + * Set canvas extent to the bounding box of a set of features \param layer the vector layer \param ids the feature ids*/ void zoomToFeatureIds( QgsVectorLayer *layer, const QgsFeatureIds &ids ); - /** Centers canvas extent to feature ids + /** + * Centers canvas extent to feature ids \param layer the vector layer \param ids the feature ids*/ void panToFeatureIds( QgsVectorLayer *layer, const QgsFeatureIds &ids ); @@ -303,7 +307,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! \brief Sets the map tool currently being used on the canvas void setMapTool( QgsMapTool *mapTool ); - /** \brief Unset the current map tool or last non zoom tool + /** + * \brief Unset the current map tool or last non zoom tool * * This is called from destructor of map tools to make sure * that this map tool won't be used any more. @@ -489,20 +494,23 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! returns last position of mouse cursor QPoint mouseLastXY(); - /** Enables a preview mode for the map canvas + /** + * Enables a preview mode for the map canvas * \param previewEnabled set to true to enable a preview mode * \see setPreviewMode * \since QGIS 2.3 */ void setPreviewModeEnabled( bool previewEnabled ); - /** Returns whether a preview mode is enabled for the map canvas + /** + * Returns whether a preview mode is enabled for the map canvas * \returns true if a preview mode is currently enabled * \see setPreviewModeEnabled * \see previewMode * \since QGIS 2.3 */ bool previewModeEnabled() const; - /** Sets a preview mode for the map canvas. This setting only has an effect if + /** + * Sets a preview mode for the map canvas. This setting only has an effect if * previewModeEnabled is true. * \param mode preview mode for the canvas * \see previewMode @@ -511,7 +519,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * \since QGIS 2.3 */ void setPreviewMode( QgsPreviewEffect::PreviewMode mode ); - /** Returns the current preview mode for the map canvas. This setting only has an effect if + /** + * Returns the current preview mode for the map canvas. This setting only has an effect if * previewModeEnabled is true. * \returns preview mode for map canvas * \see setPreviewMode @@ -519,7 +528,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * \since QGIS 2.3 */ QgsPreviewEffect::PreviewMode previewMode() const; - /** Return snapping utility class that is associated with map canvas. + /** + * Return snapping utility class that is associated with map canvas. * If no snapping utils instance has been associated previously, an internal will be created for convenience * (so map tools do not need to test for existence of the instance). * @@ -528,7 +538,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ QgsSnappingUtils *snappingUtils() const; - /** Assign an instance of snapping utils to the map canvas. + /** + * Assign an instance of snapping utils to the map canvas. * The instance is not owned by the canvas, so it is possible to use one instance in multiple canvases. * * For main canvas in QGIS, do not associate a different instance from the existing one (it is updated from @@ -537,7 +548,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void setSnappingUtils( QgsSnappingUtils *utils ); - /** Sets an expression context scope for the map canvas. This scope is injected into the expression + /** + * Sets an expression context scope for the map canvas. This scope is injected into the expression * context used for rendering the map, and can be used to apply specific variable overrides for * expression evaluation for the map canvas render. This method will overwrite the existing expression * context scope for the canvas. @@ -547,7 +559,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void setExpressionContextScope( const QgsExpressionContextScope &scope ) { mExpressionContextScope = scope; } - /** Returns a reference to the expression context scope for the map canvas. This scope is injected + /** + * Returns a reference to the expression context scope for the map canvas. This scope is injected * into the expression context used for rendering the map, and can be used to apply specific variable * overrides for expression evaluation for the map canvas render. * \since QGIS 2.12 @@ -555,18 +568,21 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ QgsExpressionContextScope &expressionContextScope() { return mExpressionContextScope; } - /** Returns a const reference to the expression context scope for the map canvas. + /** + * Returns a const reference to the expression context scope for the map canvas. * \since QGIS 2.12 * \see setExpressionContextScope() * \note not available in Python bindings */ const QgsExpressionContextScope &expressionContextScope() const { return mExpressionContextScope; } SIP_SKIP - /** Sets the segmentation tolerance applied when rendering curved geometries + /** + * Sets the segmentation tolerance applied when rendering curved geometries \param tolerance the segmentation tolerance*/ void setSegmentationTolerance( double tolerance ); - /** Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) + /** + * Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) \param type the segmentation tolerance typename*/ void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ); @@ -702,7 +718,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView signals: - /** Emits current mouse position + /** + * Emits current mouse position \note changed in 1.3 */ void xyCoordinates( const QgsPointXY &p ); @@ -730,7 +747,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void canvasColorChanged(); - /** Emitted when the canvas has rendered. + /** + * Emitted when the canvas has rendered. * Passes a pointer to the painter on which the map was drawn. This is * useful for plugins that wish to draw on the map after it has been * rendered. Passing the painter allows plugins to work when the map is @@ -762,7 +780,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView //! Emit key release event void keyReleased( QKeyEvent *e ); - /** Emit map tool changed with the old tool + /** + * Emit map tool changed with the old tool * \since QGIS 2.3 */ void mapToolSet( QgsMapTool *newTool, QgsMapTool *oldTool ); @@ -851,7 +870,8 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView #if 0 - /** Debugging member + /** + * Debugging member * invoked when a connect() is made to this object */ void connectNotify( const char *signal ) override; @@ -986,19 +1006,22 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView */ void updateMapSize(); - /** Starts zooming via rectangle + /** + * Starts zooming via rectangle * \param pos start position for rectangle * \since QGIS 2.16 */ void beginZoomRect( QPoint pos ); - /** Ends zooming via rectangle + /** + * Ends zooming via rectangle * \param pos end position for rectangle * \since QGIS 2.16 */ void endZoomRect( QPoint pos ); - /** Returns bounding box of feature list (in canvas coordinates) + /** + * Returns bounding box of feature list (in canvas coordinates) \param ids feature id list \param layer the layer \param bbox out: bounding box diff --git a/src/gui/qgsmapcanvasitem.h b/src/gui/qgsmapcanvasitem.h index ea65db3f82ba..8c722adc00ef 100644 --- a/src/gui/qgsmapcanvasitem.h +++ b/src/gui/qgsmapcanvasitem.h @@ -25,7 +25,8 @@ class QgsMapCanvas; class QgsRenderContext; class QPainter; -/** \ingroup gui +/** + * \ingroup gui * An abstract class for items that can be placed on the * map canvas. */ @@ -48,7 +49,8 @@ class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem //! schedules map canvas for repaint void updateCanvas(); - /** Sets render context parameters + /** + * Sets render context parameters \param p painter for rendering \param context out: configured context \returns true in case of success */ diff --git a/src/gui/qgsmapcanvasmap.h b/src/gui/qgsmapcanvasmap.h index eab8bfee7d13..db1617f8c178 100644 --- a/src/gui/qgsmapcanvasmap.h +++ b/src/gui/qgsmapcanvasmap.h @@ -25,7 +25,8 @@ class QgsMapCanvas; /// @cond PRIVATE -/** \ingroup gui +/** + * \ingroup gui * A rectangular graphics item representing the map on the canvas. * * \note This class is not a part of public API diff --git a/src/gui/qgsmapcanvassnappingutils.h b/src/gui/qgsmapcanvassnappingutils.h index 276c866e9c23..76a55a3034e2 100644 --- a/src/gui/qgsmapcanvassnappingutils.h +++ b/src/gui/qgsmapcanvassnappingutils.h @@ -22,7 +22,8 @@ class QgsMapCanvas; class QProgressDialog; -/** \ingroup gui +/** + * \ingroup gui * Snapping utils instance that is connected to a canvas and updates the configuration * (map settings + current layer) whenever that is changed in the canvas. * \since QGIS 2.8 diff --git a/src/gui/qgsmapcanvastracer.h b/src/gui/qgsmapcanvastracer.h index 4d619d5d80a2..54b09cff1437 100644 --- a/src/gui/qgsmapcanvastracer.h +++ b/src/gui/qgsmapcanvastracer.h @@ -23,7 +23,8 @@ class QgsMapCanvas; class QgsMessageBar; class QgsMessageBarItem; -/** \ingroup gui +/** + * \ingroup gui * Extension of QgsTracer that provides extra functionality: * - automatic updates of own configuration based on canvas settings * - reporting of issues to the user via message bar diff --git a/src/gui/qgsmaplayeractionregistry.h b/src/gui/qgsmaplayeractionregistry.h index 681c91ab5b0a..0e850ce5f7c9 100644 --- a/src/gui/qgsmaplayeractionregistry.h +++ b/src/gui/qgsmaplayeractionregistry.h @@ -27,7 +27,8 @@ class QgsFeature; -/** \ingroup gui +/** + * \ingroup gui * An action which can run on map layers */ class GUI_EXPORT QgsMapLayerAction : public QAction @@ -104,7 +105,8 @@ class GUI_EXPORT QgsMapLayerAction : public QAction Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapLayerAction::Targets ) -/** \ingroup gui +/** + * \ingroup gui * This class tracks map layer actions. * * QgsMapLayerActionRegistry is not usually directly created, but rather accessed through diff --git a/src/gui/qgsmaplayercombobox.h b/src/gui/qgsmaplayercombobox.h index bb8a0ae22d69..85dc085a43a6 100644 --- a/src/gui/qgsmaplayercombobox.h +++ b/src/gui/qgsmaplayercombobox.h @@ -26,7 +26,8 @@ class QgsMapLayer; class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsMapLayerComboBox class is a combo box which displays the list of layers * \since QGIS 2.3 */ @@ -117,12 +118,14 @@ class GUI_EXPORT QgsMapLayerComboBox : public QComboBox */ QStringList additionalItems() const; - /** Returns the current layer selected in the combo box. + /** + * Returns the current layer selected in the combo box. * \see layer */ QgsMapLayer *currentLayer() const; - /** Return the layer currently shown at the specified index within the combo box. + /** + * Return the layer currently shown at the specified index within the combo box. * \param layerIndex position of layer to return * \since QGIS 2.10 * \see currentLayer diff --git a/src/gui/qgsmaplayerconfigwidget.h b/src/gui/qgsmaplayerconfigwidget.h index 01cb0b881e63..dd07f683d9f8 100644 --- a/src/gui/qgsmaplayerconfigwidget.h +++ b/src/gui/qgsmaplayerconfigwidget.h @@ -24,7 +24,8 @@ class QgsMapCanvas; class QgsMapLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsMapLayerConfigWidget * \brief A panel widget that can be shown in the map style dock * \since QGIS 2.16 diff --git a/src/gui/qgsmaplayerconfigwidgetfactory.h b/src/gui/qgsmaplayerconfigwidgetfactory.h index 21b3ceb33773..7d8c4a31278b 100644 --- a/src/gui/qgsmaplayerconfigwidgetfactory.h +++ b/src/gui/qgsmaplayerconfigwidgetfactory.h @@ -24,7 +24,8 @@ class QgsMapLayer; class QgsMapLayerConfigWidget; class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * \class QgsMapLayerConfigWidgetFactory * \since QGIS 2.16 * Factory class for creating custom map layer property pages diff --git a/src/gui/qgsmaplayerstylemanagerwidget.h b/src/gui/qgsmaplayerstylemanagerwidget.h index 26e890ad5a74..b7cca0015661 100644 --- a/src/gui/qgsmaplayerstylemanagerwidget.h +++ b/src/gui/qgsmaplayerstylemanagerwidget.h @@ -26,7 +26,8 @@ class QgsMapLayer; class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsMapLayerStyleManagerWidget class which is used to visually manage * the layer styles. */ diff --git a/src/gui/qgsmapmouseevent.h b/src/gui/qgsmapmouseevent.h index f6da02888cdf..db8869c88f62 100644 --- a/src/gui/qgsmapmouseevent.h +++ b/src/gui/qgsmapmouseevent.h @@ -25,7 +25,8 @@ class QgsMapCanvas; class QgsMapToolAdvancedDigitizing; -/** \ingroup gui +/** + * \ingroup gui * A QgsMapMouseEvent is the result of a user interaction with the mouse on a QgsMapCanvas. * It is sent whenever the user moves, clicks, releases or double clicks the mouse. * In addition to the coordinates in pixel space it also knows the coordinates in the mapcanvas' CRS diff --git a/src/gui/qgsmapoverviewcanvas.h b/src/gui/qgsmapoverviewcanvas.h index 18c35b0297f1..0f810e9b10c8 100644 --- a/src/gui/qgsmapoverviewcanvas.h +++ b/src/gui/qgsmapoverviewcanvas.h @@ -34,7 +34,8 @@ class QgsMapRendererQImageJob; #include "qgsmapsettings.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * A widget that displays an overview map. */ class GUI_EXPORT QgsMapOverviewCanvas : public QWidget diff --git a/src/gui/qgsmaptip.h b/src/gui/qgsmaptip.h index f4a929c29b8d..80cfb6845a39 100644 --- a/src/gui/qgsmaptip.h +++ b/src/gui/qgsmaptip.h @@ -28,7 +28,8 @@ class QgsWebView; #include "qgsfeature.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * A maptip is a class to display a tip on a map canvas * when a mouse is hovered over a feature. * @@ -52,11 +53,13 @@ class GUI_EXPORT QgsMapTip : public QWidget Q_OBJECT public: - /** Default constructor + /** + * Default constructor */ QgsMapTip(); - /** Show a maptip at a given point on the map canvas + /** + * Show a maptip at a given point on the map canvas * \param thepLayer a qgis vector map layer pointer that will * be used to provide the attribute data for the map tip. * \param mapPosition a reference to the position of the cursor @@ -70,7 +73,8 @@ class GUI_EXPORT QgsMapTip : public QWidget QPoint &pixelPosition, QgsMapCanvas *mpMapCanvas ); - /** Clear the current maptip if it exists + /** + * Clear the current maptip if it exists * \param mpMapCanvas the canvas from which the tip should be cleared. */ void clear( QgsMapCanvas *mpMapCanvas = nullptr ); diff --git a/src/gui/qgsmaptool.h b/src/gui/qgsmaptool.h index d3c1c67e2ae3..970d08e4941f 100644 --- a/src/gui/qgsmaptool.h +++ b/src/gui/qgsmaptool.h @@ -53,7 +53,8 @@ class QAbstractButton; % End #endif -/** \ingroup gui +/** + * \ingroup gui * Abstract base class for all map tools. * Map tools are user interactive tools for manipulating the * map canvas. For example map pan and zoom features are @@ -95,7 +96,8 @@ class GUI_EXPORT QgsMapTool : public QObject }; Q_DECLARE_FLAGS( Flags, Flag ) - /** Returns the flags for the map tool. + /** + * Returns the flags for the map tool. * \since QGIS 2.16 */ virtual Flags flags() const { return Flags(); } @@ -126,7 +128,8 @@ class GUI_EXPORT QgsMapTool : public QObject //! gesture event for overriding. Default implementation does nothing. virtual bool gestureEvent( QGestureEvent *e ); - /** Use this to associate a QAction to this maptool. Then when the setMapTool + /** + * Use this to associate a QAction to this maptool. Then when the setMapTool * method of mapcanvas is called the action state will be set to on. * Usually this will cause e.g. a toolbutton to appear pressed in and * the previously used toolbutton to pop out. */ @@ -135,7 +138,8 @@ class GUI_EXPORT QgsMapTool : public QObject //! Return associated action with map tool or NULL if no action is associated QAction *action(); - /** Use this to associate a button to this maptool. It has the same meaning + /** + * Use this to associate a button to this maptool. It has the same meaning * as setAction() function except it works with a button instead of an QAction. */ void setButton( QAbstractButton *button ); @@ -160,18 +164,21 @@ class GUI_EXPORT QgsMapTool : public QObject */ QString toolName() { return mToolName; } - /** Get search radius in mm. Used by identify, tip etc. + /** + * Get search radius in mm. Used by identify, tip etc. * The values is currently set in identify tool options (move somewhere else?) * and defaults to Qgis::DEFAULT_SEARCH_RADIUS_MM. * \since QGIS 2.3 */ static double searchRadiusMM(); - /** Get search radius in map units for given context. Used by identify, tip etc. + /** + * Get search radius in map units for given context. Used by identify, tip etc. * The values is calculated from searchRadiusMM(). * \since QGIS 2.3 */ static double searchRadiusMU( const QgsRenderContext &context ); - /** Get search radius in map units for given canvas. Used by identify, tip etc. + /** + * Get search radius in map units for given canvas. Used by identify, tip etc. * The values is calculated from searchRadiusMM(). * \since QGIS 2.3 */ static double searchRadiusMU( QgsMapCanvas *canvas ); diff --git a/src/gui/qgsmaptooladvanceddigitizing.h b/src/gui/qgsmaptooladvanceddigitizing.h index 0aa83f0bd7f9..748a3ef95f59 100644 --- a/src/gui/qgsmaptooladvanceddigitizing.h +++ b/src/gui/qgsmaptooladvanceddigitizing.h @@ -23,7 +23,8 @@ class QgsMapMouseEvent; class QgsAdvancedDigitizingDockWidget; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsMapToolAdvancedDigitizing class is a QgsMapTool which gives event directly in map coordinates and allows filtering its events. * Events from QgsMapTool are caught and their QMouseEvent are transformed into QgsMapMouseEvent (with map coordinates). * Events are then forwarded to corresponding virtual methods which can be reimplemented in subclasses. diff --git a/src/gui/qgsmaptoolcapture.h b/src/gui/qgsmaptoolcapture.h index efa4b501509f..425204b96cde 100644 --- a/src/gui/qgsmaptoolcapture.h +++ b/src/gui/qgsmaptoolcapture.h @@ -30,7 +30,8 @@ class QgsVertexMarker; class QgsMapLayer; class QgsGeometryValidator; -/** \ingroup gui +/** + * \ingroup gui * \class QgsMapToolCapture */ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing @@ -105,7 +106,8 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing protected: - /** Converts a map point to layer coordinates + /** + * Converts a map point to layer coordinates * \param mapPoint the point in map coordinates * \param[in,out] layerPoint the point in layer coordinates * \returns @@ -116,7 +118,8 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing // TODO QGIS 3.0 returns an enum instead of a magic constant int nextPoint( const QgsPoint &mapPoint, QgsPoint &layerPoint ); - /** Converts a point to map coordinates and layer coordinates + /** + * Converts a point to map coordinates and layer coordinates * \param p the input point * \param[in,out] layerPoint the point in layer coordinates * \param[in,out] mapPoint the point in map coordinates @@ -128,7 +131,8 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing // TODO QGIS 3.0 returns an enum instead of a magic constant int nextPoint( QPoint p, QgsPoint &layerPoint, QgsPoint &mapPoint ); - /** Fetches the original point from the source layer if it has the same + /** + * Fetches the original point from the source layer if it has the same * CRS as the current layer. * \returns 0 in case of success, 1 if not applicable (CRS mismatch), 2 in case of failure * \since QGIS 2.14 @@ -136,13 +140,15 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing // TODO QGIS 3.0 returns an enum instead of a magic constant int fetchLayerPoint( const QgsPointLocator::Match &match, QgsPoint &layerPoint ); - /** Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates) + /** + * Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates) * \returns 0 in case of success, 1 if current layer is not a vector layer, 2 if coordinate transformation failed */ // TODO QGIS 3.0 returns an enum instead of a magic constant int addVertex( const QgsPointXY &point ); - /** Variant to supply more information in the case of snapping + /** + * Variant to supply more information in the case of snapping * \param mapPoint The vertex to add in map coordinates * \param match Data about the snapping match. Can be an invalid match, if point not snapped. * \since QGIS 2.14 diff --git a/src/gui/qgsmaptooledit.h b/src/gui/qgsmaptooledit.h index b876db307680..17abd6cab143 100644 --- a/src/gui/qgsmaptooledit.h +++ b/src/gui/qgsmaptooledit.h @@ -25,7 +25,8 @@ class QgsGeometryRubberBand; class QgsVectorLayer; class QKeyEvent; -/** \ingroup gui +/** + * \ingroup gui * Base class for map tools that edit vector geometry */ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool @@ -52,7 +53,8 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool //! Returns fill color for rubber bands (from global settings) static QColor digitizingFillColor(); - /** Creates a rubber band with the color/line width from + /** + * Creates a rubber band with the color/line width from * the QGIS settings. The caller takes ownership of the * returned object * \param geometryType @@ -65,7 +67,8 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool //! Returns the current vector layer of the map canvas or 0 QgsVectorLayer *currentVectorLayer(); - /** Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons. + /** + * Adds vertices to other features to keep topology up to date, e.g. to neighbouring polygons. * \param geom list of points (in layer coordinate system) * \returns 0 in case of success */ diff --git a/src/gui/qgsmaptoolemitpoint.h b/src/gui/qgsmaptoolemitpoint.h index 4206b1c7735b..672fec61d1ca 100644 --- a/src/gui/qgsmaptoolemitpoint.h +++ b/src/gui/qgsmaptoolemitpoint.h @@ -21,7 +21,8 @@ class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * A map tool that simply emits a point when clicking on the map. * Connecting a slot to its canvasClicked() signal will * let you implement custom behavior for the passed in point. diff --git a/src/gui/qgsmaptoolextent.h b/src/gui/qgsmaptoolextent.h index 71a4330ba3a2..4d88a3be4a40 100644 --- a/src/gui/qgsmaptoolextent.h +++ b/src/gui/qgsmaptoolextent.h @@ -26,7 +26,8 @@ class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * A map tool that emits an extent from a rectangle drawn onto the map canvas. * \since QGIS 3.0 */ @@ -46,18 +47,21 @@ class GUI_EXPORT QgsMapToolExtent : public QgsMapTool virtual void activate() override; virtual void deactivate() override; - /** Sets a fixed aspect ratio to be used when dragging extent onto the canvas. + /** + * Sets a fixed aspect ratio to be used when dragging extent onto the canvas. * To unset a fixed aspect ratio, set the width and height to zero. * \param ratio aspect ratio's width and height * */ void setRatio( QSize ratio ) { mRatio = ratio; } - /** Returns the current fixed aspect ratio to be used when dragging extent onto the canvas. + /** + * Returns the current fixed aspect ratio to be used when dragging extent onto the canvas. * If the aspect ratio isn't fixed, the width and height will be set to zero. * */ QSize ratio() const { return mRatio; } - /** Returns the current extent drawn onto the canvas. + /** + * Returns the current extent drawn onto the canvas. */ QgsRectangle extent() const; diff --git a/src/gui/qgsmaptoolidentify.h b/src/gui/qgsmaptoolidentify.h index 43684582505e..8fb2844d6f59 100644 --- a/src/gui/qgsmaptoolidentify.h +++ b/src/gui/qgsmaptoolidentify.h @@ -34,7 +34,8 @@ class QgsHighlight; class QgsIdentifyMenu; class QgsDistanceArea; -/** \ingroup gui +/** + * \ingroup gui \brief Map tool for identifying features in layers after selecting a point, performs the identification: @@ -100,7 +101,8 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool virtual void activate() override; virtual void deactivate() override; - /** Performs the identification. + /** + * Performs the identification. \param x x coordinates of mouseEvent \param y y coordinates of mouseEvent \param layerList Performs the identification within the given list of layers. Default value is an empty list, i.e. uses all the layers. @@ -108,7 +110,8 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool \returns a list of IdentifyResult*/ QList identify( int x, int y, const QList &layerList = QList(), IdentifyMode mode = DefaultQgsSetting ); - /** Performs the identification. + /** + * Performs the identification. To avoid being forced to specify IdentifyMode with a list of layers this has been made private and two publics methods are offered \param x x coordinates of mouseEvent @@ -134,7 +137,8 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool protected: - /** Performs the identification. + /** + * Performs the identification. To avoid being forced to specify IdentifyMode with a list of layers this has been made private and two publics methods are offered \param x x coordinates of mouseEvent @@ -155,25 +159,29 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool private: - /** Desired units for distance display. + /** + * Desired units for distance display. * \since QGIS 2.14 * \see displayAreaUnits() */ virtual QgsUnitTypes::DistanceUnit displayDistanceUnits() const; - /** Desired units for area display. + /** + * Desired units for area display. * \since QGIS 2.14 * \see displayDistanceUnits() */ virtual QgsUnitTypes::AreaUnit displayAreaUnits() const; - /** Format a distance into a suitable string for display to the user + /** + * Format a distance into a suitable string for display to the user * \since QGIS 2.14 * \see formatArea() */ QString formatDistance( double distance ) const; - /** Format a distance into a suitable string for display to the user + /** + * Format a distance into a suitable string for display to the user * \since QGIS 2.14 * \see formatDistance() */ @@ -181,11 +189,13 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool QMap< QString, QString > featureDerivedAttributes( QgsFeature *feature, QgsMapLayer *layer, const QgsPointXY &layerPoint = QgsPointXY() ); - /** Adds details of the closest vertex to derived attributes + /** + * Adds details of the closest vertex to derived attributes */ void closestVertexAttributes( const QgsAbstractGeometry &geometry, QgsVertexId vId, QgsMapLayer *layer, QMap< QString, QString > &derivedAttributes ); - /** Adds details of the closest point to derived attributes + /** + * Adds details of the closest point to derived attributes */ void closestPointAttributes( const QgsAbstractGeometry &geometry, QgsMapLayer *layer, const QgsPointXY &layerPoint, QMap< QString, QString > &derivedAttributes ); diff --git a/src/gui/qgsmaptoolidentifyfeature.h b/src/gui/qgsmaptoolidentifyfeature.h index 2771107fe6a8..e26e168d80e7 100644 --- a/src/gui/qgsmaptoolidentifyfeature.h +++ b/src/gui/qgsmaptoolidentifyfeature.h @@ -19,7 +19,8 @@ #include "qgsmaptoolidentify.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsMapToolIdentifyFeature class is a map tool to identify a feature on a chosen layer. * Once the map tool is enable, user can click on the map canvas to identify a feature. * A signal will then be emitted. diff --git a/src/gui/qgsmaptoolpan.h b/src/gui/qgsmaptoolpan.h index daec08d5c6d8..c58d945b0afe 100644 --- a/src/gui/qgsmaptoolpan.h +++ b/src/gui/qgsmaptoolpan.h @@ -21,7 +21,8 @@ class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * A map tool for panning the map. * \see QgsMapTool */ diff --git a/src/gui/qgsmaptoolzoom.h b/src/gui/qgsmaptoolzoom.h index 5ebf1d22a6fa..0a469234683d 100644 --- a/src/gui/qgsmaptoolzoom.h +++ b/src/gui/qgsmaptoolzoom.h @@ -22,7 +22,8 @@ class QgsRubberBand; -/** \ingroup gui +/** + * \ingroup gui * A map tool for zooming into the map. * \see QgsMapTool */ diff --git a/src/gui/qgsmenuheader.h b/src/gui/qgsmenuheader.h index 402ea2487419..f768c606b99b 100644 --- a/src/gui/qgsmenuheader.h +++ b/src/gui/qgsmenuheader.h @@ -22,7 +22,8 @@ #include "qgis_gui.h" #include "qgis.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsMenuHeader * Custom widget for displaying subheaders within a QMenu in a standard style. * \since QGIS 3.0 @@ -54,7 +55,8 @@ class GUI_EXPORT QgsMenuHeader : public QWidget }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsMenuHeaderWidgetAction * Custom QWidgetAction for displaying subheaders within a QMenu in a standard style. * \since QGIS 3.0 diff --git a/src/gui/qgsmessagebar.h b/src/gui/qgsmessagebar.h index 823984214a0a..4ef88e95a96a 100644 --- a/src/gui/qgsmessagebar.h +++ b/src/gui/qgsmessagebar.h @@ -38,7 +38,8 @@ class QTimer; class QgsMessageBarItem; -/** \ingroup gui +/** + * \ingroup gui * A bar for displaying non-blocking messages to the user. */ class GUI_EXPORT QgsMessageBar: public QFrame @@ -65,7 +66,8 @@ class GUI_EXPORT QgsMessageBar: public QFrame */ void pushItem( QgsMessageBarItem *item SIP_TRANSFER ); - /** Display a widget as a message on the bar after hiding the currently visible one + /** + * Display a widget as a message on the bar after hiding the currently visible one * and putting it in a stack. * \param widget message widget to display * \param level is QgsMessageBar::INFO, WARNING, CRITICAL or SUCCESS @@ -73,7 +75,8 @@ class GUI_EXPORT QgsMessageBar: public QFrame */ QgsMessageBarItem *pushWidget( QWidget *widget SIP_TRANSFER, MessageLevel level = INFO, int duration = 0 ); - /** Remove the passed widget from the bar (if previously added), + /** + * Remove the passed widget from the bar (if previously added), * then display the next one in the stack if any or hide the bar * \param item item to remove * \returns true if the widget was removed, false otherwise @@ -103,13 +106,15 @@ class GUI_EXPORT QgsMessageBar: public QFrame public slots: - /** Remove the currently displayed widget from the bar and + /** + * Remove the currently displayed widget from the bar and * display the next in the stack if any or hide the bar. * \returns true if the widget was removed, false otherwise */ bool popWidget(); - /** Remove all items from the bar's widget list + /** + * Remove all items from the bar's widget list * \returns true if all items were removed, false otherwise */ bool clearWidgets(); diff --git a/src/gui/qgsmessagebaritem.h b/src/gui/qgsmessagebaritem.h index c755ef7e78bf..faf97c783d50 100644 --- a/src/gui/qgsmessagebaritem.h +++ b/src/gui/qgsmessagebaritem.h @@ -27,7 +27,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsMessageBarItem */ class GUI_EXPORT QgsMessageBarItem : public QWidget diff --git a/src/gui/qgsmessagelogviewer.h b/src/gui/qgsmessagelogviewer.h index 87bfb774c06d..f9eb0a36758a 100644 --- a/src/gui/qgsmessagelogviewer.h +++ b/src/gui/qgsmessagelogviewer.h @@ -28,7 +28,8 @@ class QStatusBar; class QCloseEvent; -/** \ingroup gui +/** + * \ingroup gui * A generic dialog widget for displaying QGIS log messages. */ class GUI_EXPORT QgsMessageLogViewer: public QDialog, private Ui::QgsMessageLogViewer diff --git a/src/gui/qgsmessageviewer.h b/src/gui/qgsmessageviewer.h index f6865565a63a..bed37bb156b2 100644 --- a/src/gui/qgsmessageviewer.h +++ b/src/gui/qgsmessageviewer.h @@ -25,7 +25,8 @@ #include -/** \ingroup gui +/** + * \ingroup gui * A generic message view for displaying QGIS messages. */ class GUI_EXPORT QgsMessageViewer: public QDialog, public QgsMessageOutput, private Ui::QgsMessageViewer diff --git a/src/gui/qgsnewgeopackagelayerdialog.h b/src/gui/qgsnewgeopackagelayerdialog.h index 5795d17ac4eb..8f60355b515d 100644 --- a/src/gui/qgsnewgeopackagelayerdialog.h +++ b/src/gui/qgsnewgeopackagelayerdialog.h @@ -23,7 +23,8 @@ #include "qgis.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Dialog to set up parameters to create a new GeoPackage layer, and on accept() to create it and add it to the layers */ class GUI_EXPORT QgsNewGeoPackageLayerDialog: public QDialog, private Ui::QgsNewGeoPackageLayerDialogBase { diff --git a/src/gui/qgsnewhttpconnection.h b/src/gui/qgsnewhttpconnection.h index 836580a88539..7079ab89f3a2 100644 --- a/src/gui/qgsnewhttpconnection.h +++ b/src/gui/qgsnewhttpconnection.h @@ -25,7 +25,8 @@ class QgsAuthSettingsWidget; -/** \ingroup gui +/** + * \ingroup gui * \brief Dialog to allow the user to configure and save connection * information for an HTTP Server for WMS, etc. */ diff --git a/src/gui/qgsnewmemorylayerdialog.h b/src/gui/qgsnewmemorylayerdialog.h index 2c2292d7d699..8b032ec56e3d 100644 --- a/src/gui/qgsnewmemorylayerdialog.h +++ b/src/gui/qgsnewmemorylayerdialog.h @@ -25,7 +25,8 @@ class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsNewMemoryLayerDialog */ class GUI_EXPORT QgsNewMemoryLayerDialog: public QDialog, private Ui::QgsNewMemoryLayerDialogBase @@ -34,7 +35,8 @@ class GUI_EXPORT QgsNewMemoryLayerDialog: public QDialog, private Ui::QgsNewMemo public: - /** Runs the dialog and creates a new memory layer + /** + * Runs the dialog and creates a new memory layer * \param parent parent widget * \param defaultCrs default layer CRS to show in dialog * \returns new memory layer diff --git a/src/gui/qgsnewnamedialog.h b/src/gui/qgsnewnamedialog.h index 345d94d9aaae..09b8421ed485 100644 --- a/src/gui/qgsnewnamedialog.h +++ b/src/gui/qgsnewnamedialog.h @@ -23,7 +23,8 @@ class QLineEdit; #include "qgsdialog.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * New name, for example new layer name dialog. If existing names are provided, * the dialog warns users if an entered name already exists. * \since QGIS 2.10 @@ -33,7 +34,8 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog Q_OBJECT public: - /** New dialog constructor. + /** + * New dialog constructor. * \param source original data source name, e.g. original layer name of the layer to be copied * \param initial initial name * \param extensions base name extensions, e.g. raster base name band extensions or vector layer type extensions @@ -48,7 +50,8 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog const QRegExp ®exp = QRegExp(), Qt::CaseSensitivity cs = Qt::CaseSensitive, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags flags = QgsGuiUtils::ModalDialogFlags ); - /** Sets the hint string for the dialog (the text shown above the name + /** + * Sets the hint string for the dialog (the text shown above the name * input box). * \param hintString hint text * \see hintString() @@ -56,14 +59,16 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog */ void setHintString( const QString &hintString ); - /** Returns the hint string for the dialog (the text shown above the name + /** + * Returns the hint string for the dialog (the text shown above the name * input box). * \see setHintString() * \since QGIS 2.12 */ QString hintString() const; - /** Sets whether users are permitted to overwrite existing names. If true, then + /** + * Sets whether users are permitted to overwrite existing names. If true, then * the dialog will reflect that the new name will overwrite an existing name. If false, * then the dialog will not accept names which already exist. * \since QGIS 2.12 @@ -71,31 +76,36 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog */ void setOverwriteEnabled( bool enabled ); - /** Returns whether users are permitted to overwrite existing names. + /** + * Returns whether users are permitted to overwrite existing names. * \since QGIS 2.12 * \see setOverwriteEnabled() */ bool overwriteEnabled() const { return mOverwriteEnabled; } - /** Sets the string used for warning users if a conflicting name exists. + /** + * Sets the string used for warning users if a conflicting name exists. * \param string warning string. If empty a default warning string will be used. * \since QGIS 2.12 * \see conflictingNameWarning() */ void setConflictingNameWarning( const QString &string ); - /** Returns the string used for warning users if a conflicting name exists. + /** + * Returns the string used for warning users if a conflicting name exists. * \since QGIS 2.12 * \see setConflictingNameWarning() */ QString conflictingNameWarning() const { return mConflictingNameWarning; } - /** Name entered by user. + /** + * Name entered by user. * \returns new name */ QString name() const; - /** Test if name or name with at least one extension exists. + /** + * Test if name or name with at least one extension exists. * \param name name or base name * \param extensions base name extensions * \param existing existing names diff --git a/src/gui/qgsnewvectorlayerdialog.h b/src/gui/qgsnewvectorlayerdialog.h index 4992ba82eeee..d51b2c439d96 100644 --- a/src/gui/qgsnewvectorlayerdialog.h +++ b/src/gui/qgsnewvectorlayerdialog.h @@ -24,7 +24,8 @@ #include "qgis.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsNewVectorLayerDialog */ class GUI_EXPORT QgsNewVectorLayerDialog: public QDialog, private Ui::QgsNewVectorLayerDialogBase diff --git a/src/gui/qgsoptionsdialogbase.h b/src/gui/qgsoptionsdialogbase.h index 2ed8ae9d602f..17012a5bf6d8 100644 --- a/src/gui/qgsoptionsdialogbase.h +++ b/src/gui/qgsoptionsdialogbase.h @@ -39,7 +39,8 @@ class QSplitter; class QgsFilterLineEdit; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSearchHighlightOptionWidget * Container for a widget to be used to search text in the option dialog * If the widget type is handled, it is valid. @@ -52,7 +53,8 @@ class GUI_EXPORT QgsSearchHighlightOptionWidget : public QObject Q_OBJECT public: - /** Constructor + /** + * Constructor * \param widget the widget used to search text into */ explicit QgsSearchHighlightOptionWidget( QWidget *widget = 0 ); @@ -90,7 +92,8 @@ class GUI_EXPORT QgsSearchHighlightOptionWidget : public QObject }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsOptionsDialogBase * A base dialog for options and properties dialogs that offers vertical tabs. * It handles saving/restoring of geometry, splitter and current tab states, @@ -113,7 +116,8 @@ class GUI_EXPORT QgsOptionsDialogBase : public QDialog public: - /** Constructor + /** + * Constructor * \param settingsKey QgsSettings subgroup key for saving/restore ui states, e.g. "ProjectProperties". * \param parent parent object (owner) * \param fl widget flags @@ -122,7 +126,8 @@ class GUI_EXPORT QgsOptionsDialogBase : public QDialog QgsOptionsDialogBase( const QString &settingsKey, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = 0, QgsSettings *settings = nullptr ); ~QgsOptionsDialogBase(); - /** Set up the base ui connections for vertical tabs. + /** + * Set up the base ui connections for vertical tabs. * \param restoreUi Whether to restore the base ui at this time. * \param title the window title */ @@ -131,13 +136,15 @@ class GUI_EXPORT QgsOptionsDialogBase : public QDialog // set custom QgsSettings pointer if dialog used outside QGIS (in plugin) void setSettings( QgsSettings *settings ); - /** Restore the base ui. + /** + * Restore the base ui. * Sometimes useful to do at end of subclass's constructor. * \param title the window title (it does not need to be defined if previously given to initOptionsBase(); */ void restoreOptionsBaseUi( const QString &title = QString() ); - /** Determine if the options list is in icon only mode + /** + * Determine if the options list is in icon only mode */ bool iconOnly() {return mIconOnly;} diff --git a/src/gui/qgsoptionswidgetfactory.h b/src/gui/qgsoptionswidgetfactory.h index 93e696eab0a7..570c2da7b1ef 100644 --- a/src/gui/qgsoptionswidgetfactory.h +++ b/src/gui/qgsoptionswidgetfactory.h @@ -20,7 +20,8 @@ #include "qgis_gui.h" #include "qgis.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsOptionsPageWidget * Base class for widgets for pages included in the options dialog. * \since QGIS 3.0 @@ -60,7 +61,8 @@ class GUI_EXPORT QgsOptionsPageWidget : public QWidget }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsOptionsWidgetFactory * A factory class for creating custom options pages. * \since QGIS 3.0 diff --git a/src/gui/qgsorderbydialog.h b/src/gui/qgsorderbydialog.h index f28c64add45b..5a4426e7f61e 100644 --- a/src/gui/qgsorderbydialog.h +++ b/src/gui/qgsorderbydialog.h @@ -27,7 +27,8 @@ class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * This is a dialog to build and manage a list of order by clauses. * * \since QGIS 2.14 diff --git a/src/gui/qgsowssourceselect.h b/src/gui/qgsowssourceselect.h index aea0e0fdf1c9..140c01111494 100644 --- a/src/gui/qgsowssourceselect.h +++ b/src/gui/qgsowssourceselect.h @@ -39,7 +39,8 @@ class QDomDocument; class QDomElement; -/** \ingroup gui +/** + * \ingroup gui * \brief Dialog to create connections and add layers WCS etc. * * This dialog allows the user to define and save connection information @@ -81,7 +82,8 @@ class GUI_EXPORT QgsOWSSourceSelect : public QgsAbstractDataSourceWidget, protec //! Loads connections from the file void on_mLoadButton_clicked(); - /** Connects to the database using the stored connection parameters. + /** + * Connects to the database using the stored connection parameters. * Once connected, available layers are displayed. */ void on_mConnectButton_clicked(); diff --git a/src/gui/qgspanelwidget.h b/src/gui/qgspanelwidget.h index 63841cbc3276..ab65a729be03 100644 --- a/src/gui/qgspanelwidget.h +++ b/src/gui/qgspanelwidget.h @@ -20,7 +20,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \brief Base class for any widget that can be shown as a inline panel */ class GUI_EXPORT QgsPanelWidget : public QWidget @@ -95,7 +96,8 @@ class GUI_EXPORT QgsPanelWidget : public QWidget */ bool autoDelete() { return mAutoDelete; } - /** Traces through the parents of a widget to find if it is contained within a QgsPanelWidget + /** + * Traces through the parents of a widget to find if it is contained within a QgsPanelWidget * widget. * \param widget widget which may be contained within a panel widget * \returns parent panel widget if found, otherwise nullptr @@ -168,7 +170,8 @@ class GUI_EXPORT QgsPanelWidget : public QWidget }; -/** \ingroup gui +/** + * \ingroup gui * \brief Wrapper widget for existing widgets which can't have * the inheritance tree changed, e.g dialogs. * diff --git a/src/gui/qgspanelwidgetstack.h b/src/gui/qgspanelwidgetstack.h index e0a98a46c06c..3e14b0266091 100644 --- a/src/gui/qgspanelwidgetstack.h +++ b/src/gui/qgspanelwidgetstack.h @@ -25,7 +25,8 @@ class QgsPanelWidget; -/** \ingroup gui +/** + * \ingroup gui * A stack widget to manage panels in the interface. Handles the open and close events * for added panels. * Any widgets that want to have a non blocking panel based interface should use this diff --git a/src/gui/qgspasswordlineedit.h b/src/gui/qgspasswordlineedit.h index b602bf7f207e..608ac110b3e7 100644 --- a/src/gui/qgspasswordlineedit.h +++ b/src/gui/qgspasswordlineedit.h @@ -23,7 +23,8 @@ #include "qgis_gui.h" -/** \class QgsPasswordLineEdit +/** + * \class QgsPasswordLineEdit * \ingroup gui * QLineEdit subclass with built in support for showing/hiding * entered password. @@ -36,22 +37,26 @@ class GUI_EXPORT QgsPasswordLineEdit : public QLineEdit public: - /** Constructor for QgsPasswordLineEdit. + /** + * Constructor for QgsPasswordLineEdit. * \param parent parent widget * \param passwordVisible Initial state of the password's visibility */ QgsPasswordLineEdit( QWidget *parent = nullptr, bool passwordVisible = false ); - /** Define if a lock icon shall be shown on the left of the widget + /** + * Define if a lock icon shall be shown on the left of the widget * \param visible set to false to hide the lock icon */ void setShowLockIcon( bool visible ); - /** Returns if a lock icon shall be shown on the left of the widget + /** + * Returns if a lock icon shall be shown on the left of the widget */ bool showLockIcon() const { return mLockIconVisible; } - /** Set state of the password's visibility + /** + * Set state of the password's visibility */ void setPasswordVisibility( bool visible ); diff --git a/src/gui/qgspixmaplabel.h b/src/gui/qgspixmaplabel.h index a6c3e96bc2a1..ee03d8a6bb85 100644 --- a/src/gui/qgspixmaplabel.h +++ b/src/gui/qgspixmaplabel.h @@ -20,7 +20,8 @@ #include "qgis.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsPixmapLabel class shows a pixmap and adjusts its size to the space given * to the widget by the layout and keeping its aspect ratio. */ diff --git a/src/gui/qgspluginmanagerinterface.h b/src/gui/qgspluginmanagerinterface.h index bc5ecfbc2762..f9c7af3ba8b8 100644 --- a/src/gui/qgspluginmanagerinterface.h +++ b/src/gui/qgspluginmanagerinterface.h @@ -23,7 +23,8 @@ #include "qgsmessagebar.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsPluginManagerInterface */ class GUI_EXPORT QgsPluginManagerInterface : public QObject diff --git a/src/gui/qgspresetcolorrampdialog.h b/src/gui/qgspresetcolorrampdialog.h index 12f7dc985e21..54fd12f04dac 100644 --- a/src/gui/qgspresetcolorrampdialog.h +++ b/src/gui/qgspresetcolorrampdialog.h @@ -23,7 +23,8 @@ #include "ui_qgspresetcolorrampwidgetbase.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsPresetColorRampWidget * A widget which allows users to modify the properties of a QgsPresetSchemeColorRamp. * \since QGIS 3.0 @@ -35,18 +36,21 @@ class GUI_EXPORT QgsPresetColorRampWidget : public QgsPanelWidget, private Ui::Q public: - /** Constructor for QgsPresetColorRampWidget. + /** + * Constructor for QgsPresetColorRampWidget. * \param ramp initial ramp to show in dialog * \param parent parent widget */ QgsPresetColorRampWidget( const QgsPresetSchemeColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a color ramp representing the current settings from the dialog. + /** + * Returns a color ramp representing the current settings from the dialog. * \see setRamp() */ QgsPresetSchemeColorRamp ramp() const; - /** Sets the color ramp to show in the dialog. + /** + * Sets the color ramp to show in the dialog. * \param ramp color ramp * \see ramp() */ @@ -71,7 +75,8 @@ class GUI_EXPORT QgsPresetColorRampWidget : public QgsPanelWidget, private Ui::Q QgsPresetSchemeColorRamp mRamp; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsPresetColorRampDialog * A dialog which allows users to modify the properties of a QgsPresetSchemeColorRamp. * \since QGIS 3.0 @@ -83,18 +88,21 @@ class GUI_EXPORT QgsPresetColorRampDialog : public QDialog public: - /** Constructor for QgsPresetColorRampDialog. + /** + * Constructor for QgsPresetColorRampDialog. * \param ramp initial ramp to show in dialog * \param parent parent widget */ QgsPresetColorRampDialog( const QgsPresetSchemeColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a color ramp representing the current settings from the dialog. + /** + * Returns a color ramp representing the current settings from the dialog. * \see setRamp() */ QgsPresetSchemeColorRamp ramp() const { return mWidget->ramp(); } - /** Sets the color ramp to show in the dialog. + /** + * Sets the color ramp to show in the dialog. * \param ramp color ramp * \see ramp() */ diff --git a/src/gui/qgsprevieweffect.h b/src/gui/qgsprevieweffect.h index 99749f10e512..871c694869f8 100644 --- a/src/gui/qgsprevieweffect.h +++ b/src/gui/qgsprevieweffect.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * A graphics effect which can be applied to a widget to simulate various printing and * color blindness modes. */ @@ -42,14 +43,16 @@ class GUI_EXPORT QgsPreviewEffect: public QGraphicsEffect QgsPreviewEffect( QObject *parent SIP_TRANSFERTHIS ); - /** Sets the mode for the preview effect, which controls how the effect modifies a widgets appearance. + /** + * Sets the mode for the preview effect, which controls how the effect modifies a widgets appearance. * \param mode PreviewMode to use to draw the widget * \since QGIS 2.3 * \see mode */ void setMode( PreviewMode mode ); - /** Returns the mode used for the preview effect. + /** + * Returns the mode used for the preview effect. * \returns PreviewMode currently used by the effect * \since QGIS 2.3 * \see setMode diff --git a/src/gui/qgsprojectionselectionwidget.h b/src/gui/qgsprojectionselectionwidget.h index 9c4c8e731afc..fb2c90197e84 100644 --- a/src/gui/qgsprojectionselectionwidget.h +++ b/src/gui/qgsprojectionselectionwidget.h @@ -39,7 +39,8 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget Q_OBJECT public: - /** Predefined CRS options shown in widget + /** + * Predefined CRS options shown in widget */ enum CrsOption { @@ -53,18 +54,21 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget explicit QgsProjectionSelectionWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a pointer to the projection selector dialog used by the widget. + /** + * Returns a pointer to the projection selector dialog used by the widget. * Can be used to modify how the projection selector dialog behaves. * \returns projection selector dialog */ QgsProjectionSelectionDialog *dialog() { return mDialog; } - /** Returns the currently selected CRS for the widget + /** + * Returns the currently selected CRS for the widget * \returns current CRS */ QgsCoordinateReferenceSystem crs() const; - /** Sets whether a predefined CRS option should be shown in the widget. + /** + * Sets whether a predefined CRS option should be shown in the widget. * \param option CRS option to show/hide * \param visible whether the option should be shown * \see optionVisible() @@ -87,7 +91,8 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget signals: - /** Emitted when the selected CRS is changed + /** + * Emitted when the selected CRS is changed */ void crsChanged( const QgsCoordinateReferenceSystem & ); @@ -99,18 +104,21 @@ class GUI_EXPORT QgsProjectionSelectionWidget : public QWidget public slots: - /** Sets the current CRS for the widget + /** + * Sets the current CRS for the widget * \param crs new CRS */ void setCrs( const QgsCoordinateReferenceSystem &crs ); - /** Sets the layer CRS for the widget. If set, this will be added as an option + /** + * Sets the layer CRS for the widget. If set, this will be added as an option * to the preset CRSes shown in the widget. * \param crs layer CRS */ void setLayerCrs( const QgsCoordinateReferenceSystem &crs ); - /** Opens the dialog for selecting a new CRS + /** + * Opens the dialog for selecting a new CRS */ void selectCrs(); diff --git a/src/gui/qgspropertyoverridebutton.h b/src/gui/qgspropertyoverridebutton.h index e1b75634e9b5..0306b83e5e7b 100644 --- a/src/gui/qgspropertyoverridebutton.h +++ b/src/gui/qgspropertyoverridebutton.h @@ -30,7 +30,8 @@ class QgsVectorLayer; class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * \class QgsPropertyOverrideButton * A button for controlling property overrides which may apply to a widget. * diff --git a/src/gui/qgsquerybuilder.h b/src/gui/qgsquerybuilder.h index 88d56570136e..9db120b3a864 100644 --- a/src/gui/qgsquerybuilder.h +++ b/src/gui/qgsquerybuilder.h @@ -27,7 +27,8 @@ class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsQueryBuilder * \brief Query Builder for layers. * @@ -43,7 +44,8 @@ class GUI_EXPORT QgsQueryBuilder : public QDialog, private Ui::QgsQueryBuilderBa Q_OBJECT public: - /** This constructor is used when the query builder is called from the + /** + * This constructor is used when the query builder is called from the * vector layer properties dialog * \param layer existing vector layer * \param parent Parent widget @@ -80,7 +82,8 @@ class GUI_EXPORT QgsQueryBuilder : public QDialog, private Ui::QgsQueryBuilderBa void on_btnNot_clicked(); void on_btnOr_clicked(); - /** Test the constructed sql statement to see if the vector layer data provider likes it. + /** + * Test the constructed sql statement to see if the vector layer data provider likes it. * The number of rows that would be returned is displayed in a message box. * The test uses a "select count(*) from ..." query to test the SQL * statement. diff --git a/src/gui/qgsrasterformatsaveoptionswidget.h b/src/gui/qgsrasterformatsaveoptionswidget.h index aefc72d98b65..849b5a6cf997 100644 --- a/src/gui/qgsrasterformatsaveoptionswidget.h +++ b/src/gui/qgsrasterformatsaveoptionswidget.h @@ -24,7 +24,8 @@ class QgsRasterLayer; -/** \ingroup gui +/** + * \ingroup gui * A widget to select format-specific raster saving options */ class GUI_EXPORT QgsRasterFormatSaveOptionsWidget: public QWidget, private Ui::QgsRasterFormatSaveOptionsWidgetBase diff --git a/src/gui/qgsrasterlayersaveasdialog.h b/src/gui/qgsrasterlayersaveasdialog.h index d6ff4cbbe1c4..e381966edb65 100644 --- a/src/gui/qgsrasterlayersaveasdialog.h +++ b/src/gui/qgsrasterlayersaveasdialog.h @@ -26,7 +26,8 @@ class QgsRasterLayer; class QgsRasterDataProvider; class QgsRasterFormatOptionsWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRasterLayerSaveAsDialog */ class GUI_EXPORT QgsRasterLayerSaveAsDialog: public QDialog, private Ui::QgsRasterLayerSaveAsDialogBase diff --git a/src/gui/qgsrasterpyramidsoptionswidget.h b/src/gui/qgsrasterpyramidsoptionswidget.h index 5e0ec5458f69..7c5e430598a0 100644 --- a/src/gui/qgsrasterpyramidsoptionswidget.h +++ b/src/gui/qgsrasterpyramidsoptionswidget.h @@ -24,7 +24,8 @@ class QCheckBox; -/** \ingroup gui +/** + * \ingroup gui * A widget to select format-specific raster saving options */ class GUI_EXPORT QgsRasterPyramidsOptionsWidget: public QWidget, private Ui::QgsRasterPyramidsOptionsWidgetBase diff --git a/src/gui/qgsratiolockbutton.h b/src/gui/qgsratiolockbutton.h index 96a8e676a3b8..0831808d14cc 100644 --- a/src/gui/qgsratiolockbutton.h +++ b/src/gui/qgsratiolockbutton.h @@ -25,7 +25,8 @@ #include class QDoubleSpinBox; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRatioLockButton * A cross platform button subclass used to represent a locked / unlocked ratio state. * \since QGIS 3.0 @@ -37,18 +38,21 @@ class GUI_EXPORT QgsRatioLockButton : public QToolButton public: - /** Construct a new ratio lock button. + /** + * Construct a new ratio lock button. * Use \a parent to attach a parent QWidget to the button. */ QgsRatioLockButton( QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Sets whether the button state is locked. + /** + * Sets whether the button state is locked. * \param locked locked state * \see locked */ void setLocked( const bool locked ); - /** Returns whether the button state is locked. + /** + * Returns whether the button state is locked. * \returns true if the button state is locked. * \see setLocked */ @@ -80,7 +84,8 @@ class GUI_EXPORT QgsRatioLockButton : public QToolButton signals: - /** Emitted whenever the lock state changes. + /** + * Emitted whenever the lock state changes. */ void lockChanged( const bool locked ); diff --git a/src/gui/qgsrelationeditorwidget.h b/src/gui/qgsrelationeditorwidget.h index 4b194694511b..3d89a84a89f6 100644 --- a/src/gui/qgsrelationeditorwidget.h +++ b/src/gui/qgsrelationeditorwidget.h @@ -41,7 +41,8 @@ class QgsVectorLayerTools; % End #endif -/** \ingroup gui +/** + * \ingroup gui * \class QgsRelationEditorWidget */ class GUI_EXPORT QgsRelationEditorWidget : public QgsCollapsibleGroupBox diff --git a/src/gui/qgsrubberband.h b/src/gui/qgsrubberband.h index 38338476ccf1..0a1c0bf33228 100644 --- a/src/gui/qgsrubberband.h +++ b/src/gui/qgsrubberband.h @@ -27,7 +27,8 @@ class QgsVectorLayer; class QPaintEvent; -/** \ingroup gui +/** + * \ingroup gui * A class for drawing transient features (e.g. digitizing lines) on the map. * * The QgsRubberBand class provides a transparent overlay widget @@ -194,7 +195,8 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem */ void addPoint( const QgsPointXY &p, bool doUpdate = true, int geometryIndex = 0 ); - /** Ensures that a polygon geometry is closed and that the last vertex equals the + /** + * Ensures that a polygon geometry is closed and that the last vertex equals the * first vertex. * \param doUpdate set to true to update the map canvas immediately * \param geometryIndex index of the feature part (in case of multipart geometries) diff --git a/src/gui/qgsscalecombobox.h b/src/gui/qgsscalecombobox.h index 7ba99b0310fd..d8b084b14ff0 100644 --- a/src/gui/qgsscalecombobox.h +++ b/src/gui/qgsscalecombobox.h @@ -22,7 +22,8 @@ #include "qgis.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * A combobox which lets the user select map scale from predefined list * and highlights nearest to current scale value **/ diff --git a/src/gui/qgsscalevisibilitydialog.h b/src/gui/qgsscalevisibilitydialog.h index 4b49ab4160d7..c6773ee864ab 100644 --- a/src/gui/qgsscalevisibilitydialog.h +++ b/src/gui/qgsscalevisibilitydialog.h @@ -24,7 +24,8 @@ class QgsMapCanvas; class QgsScaleRangeWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsScaleVisibilityDialog * A dialog allowing users to enter a scale visibility range. */ diff --git a/src/gui/qgsscalewidget.h b/src/gui/qgsscalewidget.h index d3ec81fd6fb1..4fa7f4a7db28 100644 --- a/src/gui/qgsscalewidget.h +++ b/src/gui/qgsscalewidget.h @@ -26,7 +26,8 @@ class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * A combobox which lets the user select map scale from predefined list * and highlights nearest to current scale value **/ diff --git a/src/gui/qgssearchquerybuilder.h b/src/gui/qgssearchquerybuilder.h index 7f188517cff1..baea9da43ffe 100644 --- a/src/gui/qgssearchquerybuilder.h +++ b/src/gui/qgssearchquerybuilder.h @@ -28,7 +28,8 @@ class QgsField; class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSearchQueryBuilder * \brief Query Builder for search strings */ @@ -69,7 +70,8 @@ class GUI_EXPORT QgsSearchQueryBuilder : public QDialog, private Ui::QgsQueryBui void on_btnOr_clicked(); void on_btnClear_clicked(); - /** Test the constructed search string to see if it's correct. + /** + * Test the constructed search string to see if it's correct. * The number of rows that would be returned is displayed in a message box. */ void on_btnTest_clicked(); @@ -102,7 +104,8 @@ class GUI_EXPORT QgsSearchQueryBuilder : public QDialog, private Ui::QgsQueryBui */ void setupListViews(); - /** Get the number of records that would be returned by the current SQL + /** + * Get the number of records that would be returned by the current SQL * \returns Number of records or -1 if an error was encountered */ long countRecords( const QString &sql ); diff --git a/src/gui/qgsshortcutsmanager.h b/src/gui/qgsshortcutsmanager.h index d30437357662..8fbc3c134411 100644 --- a/src/gui/qgsshortcutsmanager.h +++ b/src/gui/qgsshortcutsmanager.h @@ -24,7 +24,8 @@ class QShortcut; -/** \ingroup gui +/** + * \ingroup gui * \class QgsShortcutsManager * Shortcuts manager is a class that contains a list of QActions and QShortcuts * that have been registered and their shortcuts can be changed. @@ -39,7 +40,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject public: - /** Constructor for QgsShortcutsManager. + /** + * Constructor for QgsShortcutsManager. * \param parent parent object * \param settingsRoot root QgsSettings path for storing settings, e.g., "/myplugin/shortcuts". Leave * as the default value to store settings alongside built in QGIS shortcuts, but care must be @@ -47,7 +49,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ QgsShortcutsManager( QObject *parent SIP_TRANSFERTHIS = nullptr, const QString &settingsRoot = "/shortcuts/" ); - /** Automatically registers all QActions and QShortcuts which are children of the + /** + * Automatically registers all QActions and QShortcuts which are children of the * passed object. * \param object parent object containing actions and shortcuts to register * \param recursive set to true to recursively add child actions and shortcuts @@ -56,7 +59,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ void registerAllChildren( QObject *object, bool recursive = false ); - /** Automatically registers all QActions which are children of the passed object. + /** + * Automatically registers all QActions which are children of the passed object. * \param object parent object containing actions to register * \param recursive set to true to recursively add child actions * \see registerAction() @@ -65,7 +69,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ void registerAllChildActions( QObject *object, bool recursive = false ); - /** Automatically registers all QShortcuts which are children of the passed object. + /** + * Automatically registers all QShortcuts which are children of the passed object. * \param object parent object containing shortcuts to register * \param recursive set to true to recursively add child shortcuts * \see registerShortcut() @@ -74,7 +79,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ void registerAllChildShortcuts( QObject *object, bool recursive = false ); - /** Registers an action with the manager so the shortcut can be configured in GUI. + /** + * Registers an action with the manager so the shortcut can be configured in GUI. * \param action action to register. The action must have a unique text string for * identification. * \param defaultShortcut default key sequence for action @@ -85,7 +91,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ bool registerAction( QAction *action, const QString &defaultShortcut = QString() ); - /** Registers a QShortcut with the manager so the shortcut can be configured in GUI. + /** + * Registers a QShortcut with the manager so the shortcut can be configured in GUI. * \param shortcut QShortcut to register. The shortcut must have a unique QObject::objectName() for * identification. * \param defaultSequence default key sequence for shortcut @@ -95,7 +102,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ bool registerShortcut( QShortcut *shortcut, const QString &defaultSequence = QString() ); - /** Removes an action from the manager. + /** + * Removes an action from the manager. * \param action action to remove * \returns true if action was previously registered in manager and has been removed, or * false if action was not previously registered in manager @@ -104,7 +112,8 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ bool unregisterAction( QAction *action ); - /** Removes a shortcut from the manager. + /** + * Removes a shortcut from the manager. * \param shortcut shortcut to remove * \returns true if shortcut was previously registered in manager and has been removed, or * false if shortcut was not previously registered in manager @@ -113,46 +122,53 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ bool unregisterShortcut( QShortcut *shortcut ); - /** Returns a list of all actions in the manager. + /** + * Returns a list of all actions in the manager. * \see listShortcuts() * \see listAll() */ QList listActions() const; - /** Returns a list of shortcuts in the manager. + /** + * Returns a list of shortcuts in the manager. * \see listActions() * \see listAll() */ QList listShortcuts() const; - /** Returns a list of both actions and shortcuts in the manager. + /** + * Returns a list of both actions and shortcuts in the manager. * \see listAction() * \see listShortcuts() */ QList listAll() const; - /** Returns the default sequence for an object (either a QAction or QShortcut). + /** + * Returns the default sequence for an object (either a QAction or QShortcut). * An empty return string indicates no shortcut. * \param object QAction or QShortcut to return default key sequence for * \see defaultKeySequence() */ QString objectDefaultKeySequence( QObject *object ) const; - /** Returns the default sequence for an action. An empty return string indicates + /** + * Returns the default sequence for an action. An empty return string indicates * no default sequence. * \param action action to return default key sequence for * \see objectDefaultKeySequence() */ QString defaultKeySequence( QAction *action ) const; - /** Returns the default sequence for a shortcut. An empty return string indicates + /** + * Returns the default sequence for a shortcut. An empty return string indicates * no default sequence. * \param shortcut shortcut to return default key sequence for * \see objectDefaultKeySequence() */ QString defaultKeySequence( QShortcut *shortcut ) const; - /** Modifies an action or shortcut's key sequence. + /** + * Modifies an action or shortcut's key sequence. * \param name name of action or shortcut to modify. Must match the action's QAction::text() or the * shortcut's QObject::objectName() * \param sequence new shortcut key sequence @@ -160,28 +176,32 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ bool setKeySequence( const QString &name, const QString &sequence ); - /** Modifies an object's (either a QAction or a QShortcut) key sequence. + /** + * Modifies an object's (either a QAction or a QShortcut) key sequence. * \param object QAction or QShortcut to modify * \param sequence new shortcut key sequence * \see setKeySequence() */ bool setObjectKeySequence( QObject *object, const QString &sequence ); - /** Modifies an action's key sequence. + /** + * Modifies an action's key sequence. * \param action action to modify * \param sequence new shortcut key sequence * \see setObjectKeySequence() */ bool setKeySequence( QAction *action, const QString &sequence ); - /** Modifies a shortcuts's key sequence. + /** + * Modifies a shortcuts's key sequence. * \param shortcut QShortcut to modify * \param sequence new shortcut key sequence * \see setObjectKeySequence() */ bool setKeySequence( QShortcut *shortcut, const QString &sequence ); - /** Returns the object (QAction or QShortcut) matching the specified key sequence, + /** + * Returns the object (QAction or QShortcut) matching the specified key sequence, * \param sequence key sequence to find * \returns object with matching sequence, or nullptr if not found * \see actionForSequence() @@ -189,27 +209,31 @@ class GUI_EXPORT QgsShortcutsManager : public QObject */ QObject *objectForSequence( const QKeySequence &sequence ) const; - /** Returns the action which is associated for a shortcut sequence, or nullptr if no action is associated. + /** + * Returns the action which is associated for a shortcut sequence, or nullptr if no action is associated. * \param sequence shortcut key sequence * \see objectForSequence() * \see shortcutForSequence() */ QAction *actionForSequence( const QKeySequence &sequence ) const; - /** Returns the shortcut which is associated for a key sequence, or nullptr if no shortcut is associated. + /** + * Returns the shortcut which is associated for a key sequence, or nullptr if no shortcut is associated. * \param sequence shortcut key sequence * \see objectForSequence() * \see actionForSequence() */ QShortcut *shortcutForSequence( const QKeySequence &sequence ) const; - /** Returns an action by its name, or nullptr if nothing found. + /** + * Returns an action by its name, or nullptr if nothing found. * \param name action name. Must match QAction's text. * \see shortcutByName() */ QAction *actionByName( const QString &name ) const; - /** Returns a shortcut by its name, or nullptr if nothing found + /** + * Returns a shortcut by its name, or nullptr if nothing found * \param name shortcut name. Must match QShortcut's QObject::objectName() property. * \see actionByName() */ diff --git a/src/gui/qgsslider.h b/src/gui/qgsslider.h index 2c10916e3fb2..48ea78f66e1f 100644 --- a/src/gui/qgsslider.h +++ b/src/gui/qgsslider.h @@ -22,7 +22,8 @@ class QPaintEvent; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSlider */ class GUI_EXPORT QgsSlider : public QSlider diff --git a/src/gui/qgssourceselectprovider.h b/src/gui/qgssourceselectprovider.h index 10b2d704d210..189f2fce05d2 100644 --- a/src/gui/qgssourceselectprovider.h +++ b/src/gui/qgssourceselectprovider.h @@ -26,7 +26,8 @@ class QString; class QWidget; -/** \ingroup gui +/** + * \ingroup gui * This is the interface for those who want to add entries to the QgsDataSourceManagerDialog * * \since QGIS 3.0 @@ -50,7 +51,8 @@ class GUI_EXPORT QgsSourceSelectProvider //! Data Provider key virtual QString providerKey() const = 0; - /** Source select provider name, this is useful to retrieve + /** + * Source select provider name, this is useful to retrieve * a particular source select in case the provider has more * than one, it should be unique among all providers. * @@ -61,7 +63,8 @@ class GUI_EXPORT QgsSourceSelectProvider //! Text for the menu item entry, it will be visible to the user so make sure it's translatable virtual QString text() const = 0; - /** Text for the tooltip menu item entry, it will be visible to the user so make sure it's translatable + /** + * Text for the tooltip menu item entry, it will be visible to the user so make sure it's translatable * * The default implementation returns an empty string. */ @@ -70,12 +73,14 @@ class GUI_EXPORT QgsSourceSelectProvider //! Creates a new instance of an QIcon for the menu item entry virtual QIcon icon() const = 0; - /** Ordering: the source select provider registry will be able to sort + /** + * Ordering: the source select provider registry will be able to sort * the source selects (ascending) using this integer value */ virtual int ordering( ) const { return OrderOtherProvider; } - /** Create a new instance of QgsAbstractDataSourceWidget (or null). + /** + * Create a new instance of QgsAbstractDataSourceWidget (or null). * Caller takes responsibility of deleting created. */ virtual QgsAbstractDataSourceWidget *createDataSourceWidget( QWidget *parent = nullptr, Qt::WindowFlags fl = Qt::Widget, QgsProviderRegistry::WidgetMode widgetMode = QgsProviderRegistry::WidgetMode::Embedded ) const = 0 SIP_FACTORY; diff --git a/src/gui/qgssourceselectproviderregistry.h b/src/gui/qgssourceselectproviderregistry.h index cc22538c62c2..57b85704f727 100644 --- a/src/gui/qgssourceselectproviderregistry.h +++ b/src/gui/qgssourceselectproviderregistry.h @@ -21,7 +21,8 @@ class QgsSourceSelectProvider; -/** \ingroup gui +/** + * \ingroup gui * This class keeps a list of source select providers that may add items to the QgsDataSourceManagerDialog * When created, it automatically adds providers from data provider plugins (e.g. PostGIS, WMS, ...) * diff --git a/src/gui/qgssqlcomposerdialog.h b/src/gui/qgssqlcomposerdialog.h index 745d35c42f47..88b645ef16ca 100644 --- a/src/gui/qgssqlcomposerdialog.h +++ b/src/gui/qgssqlcomposerdialog.h @@ -30,7 +30,8 @@ email : even.rouault at spatialys.com SIP_NO_FILE -/** \ingroup gui +/** + * \ingroup gui * SQL composer dialog * \note not available in Python bindings */ @@ -46,7 +47,8 @@ class GUI_EXPORT QgsSQLComposerDialog : public QDialog, private Ui::QgsSQLCompos //! pair (name, type) typedef QPair PairNameType; - /** \ingroup gui + /** + * \ingroup gui * Callback to do actions on table selection * \note not available in Python bindings */ @@ -58,7 +60,8 @@ class GUI_EXPORT QgsSQLComposerDialog : public QDialog, private Ui::QgsSQLCompos virtual void tableSelected( const QString &name ) = 0; }; - /** \ingroup gui + /** + * \ingroup gui * Callback to do validation check on dialog validation. * \note not available in Python bindings */ @@ -138,12 +141,14 @@ class GUI_EXPORT QgsSQLComposerDialog : public QDialog, private Ui::QgsSQLCompos //! set if multiple tables/joins are supported. Default is false void setSupportMultipleTables( bool bMultipleTables, const QString &mainTypename = QString() ); - /** Set a callback that will be called when a new table is selected, so + /** + * Set a callback that will be called when a new table is selected, so that new column names can be added typically. Ownership of the callback remains to the caller */ void setTableSelectedCallback( TableSelectedCallback *tableSelectedCallback ); - /** Set a callback that will be called when the OK button is pushed. + /** + * Set a callback that will be called when the OK button is pushed. Ownership of the callback remains to the caller */ void setSQLValidatorCallback( SQLValidatorCallback *sqlValidatorCallback ); diff --git a/src/gui/qgssublayersdialog.h b/src/gui/qgssublayersdialog.h index 20a430a64528..89f968b570d8 100644 --- a/src/gui/qgssublayersdialog.h +++ b/src/gui/qgssublayersdialog.h @@ -22,7 +22,8 @@ #include "qgis_sip.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsSublayersDialog */ class GUI_EXPORT QgsSublayersDialog : public QDialog, private Ui::QgsSublayersDialogBase diff --git a/src/gui/qgssubstitutionlistwidget.h b/src/gui/qgssubstitutionlistwidget.h index 54a37d5e6819..a77395ea43ed 100644 --- a/src/gui/qgssubstitutionlistwidget.h +++ b/src/gui/qgssubstitutionlistwidget.h @@ -25,7 +25,8 @@ #include "qgsstringutils.h" #include "qgis_gui.h" -/** \class QgsSubstitutionListWidget +/** + * \class QgsSubstitutionListWidget * \ingroup gui * A widget which allows users to specify a list of substitutions to apply to a string, with * options for exporting and importing substitution lists. @@ -39,18 +40,21 @@ class GUI_EXPORT QgsSubstitutionListWidget : public QgsPanelWidget, private Ui:: public: - /** Constructor for QgsSubstitutionListWidget. + /** + * Constructor for QgsSubstitutionListWidget. * \param parent parent widget */ QgsSubstitutionListWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets the list of substitutions to show in the widget. + /** + * Sets the list of substitutions to show in the widget. * \param substitutions substitution list * \see substitutions() */ void setSubstitutions( const QgsStringReplacementCollection &substitutions ); - /** Returns the list of substitutions currently defined by the widget. + /** + * Returns the list of substitutions currently defined by the widget. * \see setSubstitutions() */ QgsStringReplacementCollection substitutions() const; @@ -74,7 +78,8 @@ class GUI_EXPORT QgsSubstitutionListWidget : public QgsPanelWidget, private Ui:: }; -/** \class QgsSubstitutionListDialog +/** + * \class QgsSubstitutionListDialog * \ingroup gui * A dialog which allows users to specify a list of substitutions to apply to a string, with * options for exporting and importing substitution lists. @@ -88,18 +93,21 @@ class GUI_EXPORT QgsSubstitutionListDialog : public QDialog public: - /** Constructor for QgsSubstitutionListDialog. + /** + * Constructor for QgsSubstitutionListDialog. * \param parent parent widget */ QgsSubstitutionListDialog( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets the list of substitutions to show in the dialog. + /** + * Sets the list of substitutions to show in the dialog. * \param substitutions substitution list * \see substitutions() */ void setSubstitutions( const QgsStringReplacementCollection &substitutions ); - /** Returns the list of substitutions currently defined by the dialog. + /** + * Returns the list of substitutions currently defined by the dialog. * \see setSubstitutions() */ QgsStringReplacementCollection substitutions() const; diff --git a/src/gui/qgssymbolbutton.h b/src/gui/qgssymbolbutton.h index 2a68836c704b..ded5dc108c34 100644 --- a/src/gui/qgssymbolbutton.h +++ b/src/gui/qgssymbolbutton.h @@ -158,7 +158,8 @@ class GUI_EXPORT QgsSymbolButton : public QToolButton */ void setColor( const QColor &color ); - /** Copies the current symbol to the clipboard. + /** + * Copies the current symbol to the clipboard. * \see pasteSymbol() */ void copySymbol(); @@ -217,7 +218,8 @@ class GUI_EXPORT QgsSymbolButton : public QToolButton void updateSymbolFromWidget(); void cleanUpSymbolSelector( QgsPanelWidget *container ); - /** Creates the drop-down menu entries + /** + * Creates the drop-down menu entries */ void prepareMenu(); @@ -251,7 +253,8 @@ class GUI_EXPORT QgsSymbolButton : public QToolButton */ void updatePreview( const QColor &color = QColor(), QgsSymbol *tempSymbol = nullptr ); - /** Attempts to parse mimeData as a color, either via the mime data's color data or by + /** + * Attempts to parse mimeData as a color, either via the mime data's color data or by * parsing a textual representation of a color. * \returns true if mime data could be intrepreted as a color * \param mimeData mime data diff --git a/src/gui/qgstablewidgetbase.h b/src/gui/qgstablewidgetbase.h index 1a9886645e3a..aca7e1f1633d 100644 --- a/src/gui/qgstablewidgetbase.h +++ b/src/gui/qgstablewidgetbase.h @@ -21,7 +21,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * Base widget allowing to edit a collection, using a table. * * This widget includes buttons to add and remove rows. diff --git a/src/gui/qgstablewidgetitem.h b/src/gui/qgstablewidgetitem.h index db975b18b11e..fb9bf96c1441 100644 --- a/src/gui/qgstablewidgetitem.h +++ b/src/gui/qgstablewidgetitem.h @@ -19,7 +19,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * This can be used like a regular QTableWidgetItem with the difference that a * specific role can be set to sort. */ diff --git a/src/gui/qgstabwidget.h b/src/gui/qgstabwidget.h index 47b4abaac5bb..812460af76c9 100644 --- a/src/gui/qgstabwidget.h +++ b/src/gui/qgstabwidget.h @@ -19,7 +19,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * The QgsTabWidget class is the same as the QTabWidget but with additional methods to * temporarily hide/show tabs. * diff --git a/src/gui/qgstaskmanagerwidget.h b/src/gui/qgstaskmanagerwidget.h index 58df51f9b538..b16365b96217 100644 --- a/src/gui/qgstaskmanagerwidget.h +++ b/src/gui/qgstaskmanagerwidget.h @@ -43,7 +43,8 @@ class GUI_EXPORT QgsTaskManagerWidget : public QWidget public: - /** Constructor for QgsTaskManagerWidget + /** + * Constructor for QgsTaskManagerWidget * \param manager task manager associated with widget * \param parent parent widget */ @@ -78,7 +79,8 @@ class GUI_EXPORT QgsTaskManagerFloatingWidget : public QgsFloatingWidget public: - /** Constructor for QgsTaskManagerWidget + /** + * Constructor for QgsTaskManagerWidget * \param manager task manager associated with widget * \param parent parent widget */ @@ -100,7 +102,8 @@ class GUI_EXPORT QgsTaskManagerStatusBarWidget : public QToolButton public: - /** Constructor for QgsTaskManagerWidget. + /** + * Constructor for QgsTaskManagerWidget. * \param manager task manager associated with widget * \param parent parent widget */ @@ -143,7 +146,8 @@ class GUI_EXPORT QgsTaskManagerModel: public QAbstractItemModel Status = 2, }; - /** Constructor for QgsTaskManagerModel + /** + * Constructor for QgsTaskManagerModel * \param manager task manager for model * \param parent parent object */ @@ -200,7 +204,8 @@ class GUI_EXPORT QgsTaskStatusWidget : public QWidget public: - /** Constructor for QgsTaskStatusWidget + /** + * Constructor for QgsTaskStatusWidget * \param parent parent object */ QgsTaskStatusWidget( QWidget *parent = nullptr, QgsTask::TaskStatus status = QgsTask::Queued, bool canCancel = true ); diff --git a/src/gui/qgstextformatwidget.h b/src/gui/qgstextformatwidget.h index 189ccd575cb9..79f5d88cf128 100644 --- a/src/gui/qgstextformatwidget.h +++ b/src/gui/qgstextformatwidget.h @@ -29,7 +29,8 @@ class QgsMapCanvas; class QgsCharacterSelectorDialog; -/** \class QgsTextFormatWidget +/** + * \class QgsTextFormatWidget * \ingroup gui * A widget for customising text formatting settings. * @@ -52,7 +53,8 @@ class GUI_EXPORT QgsTextFormatWidget : public QWidget, protected Ui::QgsTextForm public: - /** Constructor for QgsTextFormatWidget. + /** + * Constructor for QgsTextFormatWidget. * \param format initial formatting settings to show in widget * \param mapCanvas associated map canvas * \param parent parent widget @@ -61,13 +63,15 @@ class GUI_EXPORT QgsTextFormatWidget : public QWidget, protected Ui::QgsTextForm ~QgsTextFormatWidget(); - /** Returns the current formatting settings defined by the widget. + /** + * Returns the current formatting settings defined by the widget. */ QgsTextFormat format() const; public slots: - /** Sets whether the widget should be shown in a compact dock mode. + /** + * Sets whether the widget should be shown in a compact dock mode. * \param enabled set to true to show in dock mode. */ void setDockMode( bool enabled ); @@ -86,24 +90,28 @@ class GUI_EXPORT QgsTextFormatWidget : public QWidget, protected Ui::QgsTextForm Labeling, //!< Show labeling settings in addition to text formatting settings }; - /** Constructor for QgsTextFormatWidget. + /** + * Constructor for QgsTextFormatWidget. * \param mapCanvas associated map canvas * \param parent parent widget * \param mode widget mode */ QgsTextFormatWidget( QgsMapCanvas *mapCanvas, QWidget *parent SIP_TRANSFERTHIS, Mode mode ); - /** Updates the widget's state to reflect the settings in a QgsTextFormat. + /** + * Updates the widget's state to reflect the settings in a QgsTextFormat. * \param format source format */ void updateWidgetForFormat( const QgsTextFormat &format ); - /** Sets the background color for the text preview widget. + /** + * Sets the background color for the text preview widget. * \param color background color */ void setPreviewBackground( const QColor &color ); - /** Controls whether data defined alignment buttons are enabled. + /** + * Controls whether data defined alignment buttons are enabled. * \param enable set to true to enable alignment controls */ void enableDataDefinedAlignment( bool enable ); @@ -199,7 +207,8 @@ class GUI_EXPORT QgsTextFormatWidget : public QWidget, protected Ui::QgsTextForm }; -/** \class QgsTextFormatDialog +/** + * \class QgsTextFormatDialog * \ingroup gui * A simple dialog for customising text formatting settings. * @@ -216,7 +225,8 @@ class GUI_EXPORT QgsTextFormatDialog : public QDialog public: - /** Constructor for QgsTextFormatDialog. + /** + * Constructor for QgsTextFormatDialog. * \param format initial format settings to show in dialog * \param mapCanvas optional associated map canvas * \param parent parent widget @@ -226,7 +236,8 @@ class GUI_EXPORT QgsTextFormatDialog : public QDialog virtual ~QgsTextFormatDialog(); - /** Returns the current formatting settings defined by the widget. + /** + * Returns the current formatting settings defined by the widget. */ QgsTextFormat format() const; @@ -235,7 +246,8 @@ class GUI_EXPORT QgsTextFormatDialog : public QDialog QgsTextFormatWidget *mFormatWidget = nullptr; }; -/** \class QgsTextFormatPanelWidget +/** + * \class QgsTextFormatPanelWidget * \ingroup gui * A panel widget for customising text formatting settings. * @@ -252,14 +264,16 @@ class GUI_EXPORT QgsTextFormatPanelWidget : public QgsPanelWidgetWrapper public: - /** Constructor for QgsTextFormatPanelWidget. + /** + * Constructor for QgsTextFormatPanelWidget. * \param format initial format settings to show in dialog * \param mapCanvas optional associated map canvas * \param parent parent widget */ QgsTextFormatPanelWidget( const QgsTextFormat &format, QgsMapCanvas *mapCanvas = nullptr, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns the current formatting settings defined by the widget. + /** + * Returns the current formatting settings defined by the widget. */ QgsTextFormat format() const; diff --git a/src/gui/qgstextpreview.h b/src/gui/qgstextpreview.h index 81642deed2f5..e5d72a92d04c 100644 --- a/src/gui/qgstextpreview.h +++ b/src/gui/qgstextpreview.h @@ -21,7 +21,8 @@ #include #include "qgis_gui.h" -/** \class QgsTextPreview +/** + * \class QgsTextPreview * \ingroup gui * A widget for previewing text formatting settings. * @@ -45,20 +46,23 @@ class GUI_EXPORT QgsTextPreview : public QLabel public: - /** Constructor for QgsTextPreview + /** + * Constructor for QgsTextPreview * \param parent parent widget */ QgsTextPreview( QWidget *parent = nullptr ); void paintEvent( QPaintEvent *e ) override; - /** Sets the text format for previewing in the widget. + /** + * Sets the text format for previewing in the widget. * \param format text format * \see format() */ void setFormat( const QgsTextFormat &format ); - /** Returns the text format used for previewing text in the widget. + /** + * Returns the text format used for previewing text in the widget. * \see setFormat() */ QgsTextFormat format() const { return mFormat; } @@ -79,14 +83,16 @@ class GUI_EXPORT QgsTextPreview : public QLabel */ double scale() const { return mScale; } - /** Sets the map unit type for previewing format sizes in map units. + /** + * Sets the map unit type for previewing format sizes in map units. * \param unit map units * \see mapUnits() * \see setScale() */ void setMapUnits( QgsUnitTypes::DistanceUnit unit ); - /** Returns the map unit type used for previewing format sizes in map units. + /** + * Returns the map unit type used for previewing format sizes in map units. * \see setMapUnits() * \see scale() */ diff --git a/src/gui/qgstreewidgetitem.h b/src/gui/qgstreewidgetitem.h index 3fdfbedc497b..ea03c0bd5f70 100644 --- a/src/gui/qgstreewidgetitem.h +++ b/src/gui/qgstreewidgetitem.h @@ -24,7 +24,8 @@ #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsTreeWidgetItem * QTreeWidgetItem subclass with custom handling for item sorting. * @@ -36,58 +37,67 @@ class GUI_EXPORT QgsTreeWidgetItem : public QTreeWidgetItem { public: - /** Constructor for QgsTreeWidgetItem + /** + * Constructor for QgsTreeWidgetItem * \param view parent QTreeWidget view * \param type item type */ explicit QgsTreeWidgetItem( QTreeWidget *view SIP_TRANSFERTHIS, int type = Type ); - /** Constructor for QgsTreeWidgetItem + /** + * Constructor for QgsTreeWidgetItem * \param type item type */ explicit QgsTreeWidgetItem( int type = Type ); - /** Constructor for QgsTreeWidgetItem + /** + * Constructor for QgsTreeWidgetItem * \param strings list of strings containing text for each column in the item * \param type item type */ QgsTreeWidgetItem( const QStringList &strings, int type = Type ); - /** Constructor for QgsTreeWidgetItem + /** + * Constructor for QgsTreeWidgetItem * \param view parent QTreeWidget view * \param strings list of strings containing text for each column in the item * \param type item type */ QgsTreeWidgetItem( QTreeWidget *view SIP_TRANSFERTHIS, const QStringList &strings, int type = Type ); - /** Constructor for QgsTreeWidgetItem + /** + * Constructor for QgsTreeWidgetItem * \param view parent QTreeWidget view * \param after QTreeWidgetItem to place insert item after in the view * \param type item type */ QgsTreeWidgetItem( QTreeWidget *view SIP_TRANSFERTHIS, QTreeWidgetItem *after, int type = Type ); - /** Constructor for QgsTreeWidgetItem + /** + * Constructor for QgsTreeWidgetItem * \param parent QTreeWidgetItem item * \param type item type */ explicit QgsTreeWidgetItem( QTreeWidgetItem *parent SIP_TRANSFERTHIS, int type = Type ); - /** Constructor for QgsTreeWidgetItem + /** + * Constructor for QgsTreeWidgetItem * \param parent QTreeWidgetItem item * \param strings list of strings containing text for each column in the item * \param type item type */ QgsTreeWidgetItem( QTreeWidgetItem *parent SIP_TRANSFERTHIS, const QStringList &strings, int type = Type ); - /** Constructor for QgsTreeWidgetItem + /** + * Constructor for QgsTreeWidgetItem * \param parent QTreeWidgetItem item * \param after QTreeWidgetItem to place insert item after in the view * \param type item type */ QgsTreeWidgetItem( QTreeWidgetItem *parent SIP_TRANSFERTHIS, QTreeWidgetItem *after, int type = Type ); - /** Sets the custom sort data for a specified column. If set, this value will be used when + /** + * Sets the custom sort data for a specified column. If set, this value will be used when * sorting the item instead of the item's display text. If not set, the item's display * text will be used when sorting. * \param column column index @@ -96,14 +106,16 @@ class GUI_EXPORT QgsTreeWidgetItem : public QTreeWidgetItem */ void setSortData( int column, const QVariant &value ); - /** Returns the custom sort data for a specified column. If set, this value will be used when + /** + * Returns the custom sort data for a specified column. If set, this value will be used when * sorting the item instead of the item's display text. If not set, the item's display * text will be used when sorting. * \see setSortData() */ QVariant sortData( int column ) const; - /** Sets a the item to display always on top of other items in the widget, regardless of the + /** + * Sets a the item to display always on top of other items in the widget, regardless of the * sort column and sort or display value for the item. * \param priority priority for sorting always on top items. Items with a lower priority will * be placed above items with a higher priority. @@ -111,7 +123,8 @@ class GUI_EXPORT QgsTreeWidgetItem : public QTreeWidgetItem */ void setAlwaysOnTopPriority( int priority ); - /** Returns the item's priority when it is set to show always on top. Items with a lower priority will + /** + * Returns the item's priority when it is set to show always on top. Items with a lower priority will * be placed above items with a higher priority. * \returns priority, or -1 if item is not set to show always on top * \see setAlwaysOnTopPriority() @@ -140,7 +153,8 @@ class GUI_EXPORT QgsTreeWidgetItem : public QTreeWidgetItem }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsTreeWidgetItemObject * Custom QgsTreeWidgetItem with extra signals when item is edited. * \since QGIS 3.0 @@ -151,7 +165,8 @@ class GUI_EXPORT QgsTreeWidgetItemObject: public QObject, public QgsTreeWidgetIt public: - /** Constructor for QgsTreeWidgetItemObject + /** + * Constructor for QgsTreeWidgetItemObject * \param type item type */ explicit QgsTreeWidgetItemObject( int type = Type ); diff --git a/src/gui/qgsunitselectionwidget.h b/src/gui/qgsunitselectionwidget.h index 4a1fa24283cd..95a66b5fe926 100644 --- a/src/gui/qgsunitselectionwidget.h +++ b/src/gui/qgsunitselectionwidget.h @@ -29,7 +29,8 @@ class QgsMapCanvas; -/** \class QgsMapUnitScaleWidget +/** + * \class QgsMapUnitScaleWidget * \ingroup gui * A widget which allows the user to choose the minimum and maximum scale of an object in map units * and millimeters. This widget is designed to allow users to edit the properties of a @@ -45,19 +46,22 @@ class GUI_EXPORT QgsMapUnitScaleWidget : public QgsPanelWidget, private Ui::QgsM public: - /** Constructor for QgsMapUnitScaleWidget. + /** + * Constructor for QgsMapUnitScaleWidget. * \param parent parent widget */ QgsMapUnitScaleWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a QgsMapUnitScale representing the settings shown in the + /** + * Returns a QgsMapUnitScale representing the settings shown in the * widget. * \see setMapUnitScale() * \see mapUnitScaleChanged() */ QgsMapUnitScale mapUnitScale() const; - /** Updates the widget to reflect the settings from the specified + /** + * Updates the widget to reflect the settings from the specified * QgsMapUnitScale object. * \param scale map unit scale to show in widget * \see mapUnitScale() @@ -65,7 +69,8 @@ class GUI_EXPORT QgsMapUnitScaleWidget : public QgsPanelWidget, private Ui::QgsM */ void setMapUnitScale( const QgsMapUnitScale &scale ); - /** Sets the map canvas associated with the widget. This allows the + /** + * Sets the map canvas associated with the widget. This allows the * widget to retrieve the current map scale from the canvas. * \param canvas map canvas */ @@ -73,7 +78,8 @@ class GUI_EXPORT QgsMapUnitScaleWidget : public QgsPanelWidget, private Ui::QgsM signals: - /** Emitted when the settings in the widget are modified. + /** + * Emitted when the settings in the widget are modified. * \param scale QgsMapUnitScale reflecting new settings from the widget */ void mapUnitScaleChanged( const QgsMapUnitScale &scale ); @@ -89,7 +95,8 @@ class GUI_EXPORT QgsMapUnitScaleWidget : public QgsPanelWidget, private Ui::QgsM }; -/** \class QgsMapUnitScaleDialog +/** + * \class QgsMapUnitScaleDialog * \ingroup gui * A dialog which allows the user to choose the minimum and maximum scale of an object in map units * and millimeters. This dialog is designed to allow users to edit the properties of a @@ -104,25 +111,29 @@ class GUI_EXPORT QgsMapUnitScaleDialog : public QDialog public: - /** Constructor for QgsMapUnitScaleDialog. + /** + * Constructor for QgsMapUnitScaleDialog. * \param parent parent widget */ QgsMapUnitScaleDialog( QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Returns a QgsMapUnitScale representing the settings shown in the + /** + * Returns a QgsMapUnitScale representing the settings shown in the * dialog. * \see setMapUnitScale() */ QgsMapUnitScale getMapUnitScale() const; - /** Updates the dialog to reflect the settings from the specified + /** + * Updates the dialog to reflect the settings from the specified * QgsMapUnitScale object. * \param scale map unit scale to show in dialog * \see mapUnitScale() */ void setMapUnitScale( const QgsMapUnitScale &scale ); - /** Sets the map canvas associated with the dialog. This allows the dialog to retrieve the current + /** + * Sets the map canvas associated with the dialog. This allows the dialog to retrieve the current * map scale from the canvas. * \param canvas map canvas * \since QGIS 2.12 @@ -135,7 +146,8 @@ class GUI_EXPORT QgsMapUnitScaleDialog : public QDialog }; -/** \class QgsUnitSelectionWidget +/** + * \class QgsUnitSelectionWidget * \ingroup gui * A widget displaying a combobox allowing the user to choose between various display units, * such as millimeters or map unit. If the user chooses map units, a button appears allowing @@ -149,18 +161,21 @@ class GUI_EXPORT QgsUnitSelectionWidget : public QWidget, private Ui::QgsUnitSel public: - /** Constructor for QgsUnitSelectionWidget. + /** + * Constructor for QgsUnitSelectionWidget. * \param parent parent widget */ QgsUnitSelectionWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets the units which the user can choose from in the combobox. + /** + * Sets the units which the user can choose from in the combobox. * \param units list of strings for custom units to display in the widget * \param mapUnitIdx specifies which entry corresponds to the map units, or -1 if none */ void setUnits( const QStringList &units, int mapUnitIdx ); - /** Sets the units which the user can choose from in the combobox. Clears any existing units. + /** + * Sets the units which the user can choose from in the combobox. Clears any existing units. * \param units list of valid units * \since QGIS 2.9 */ @@ -169,19 +184,22 @@ class GUI_EXPORT QgsUnitSelectionWidget : public QWidget, private Ui::QgsUnitSel //! Get the selected unit index int getUnit() const { return mUnitCombo->currentIndex(); } - /** Returns the current predefined selected unit (if applicable). + /** + * Returns the current predefined selected unit (if applicable). * \returns selected output unit, or QgsUnitTypes::RenderUnknownUnit if the widget was populated with custom unit types * \since QGIS 2.9 */ QgsUnitTypes::RenderUnit unit() const; - /** Sets the selected unit index + /** + * Sets the selected unit index * \param unitIndex index of unit to set as current * \note available in Python bindings as setUnitIndex */ void setUnit( int unitIndex ) SIP_PYNAME( setUnitIndex ); - /** Sets the selected unit + /** + * Sets the selected unit * \param unit predefined unit to set as current */ void setUnit( QgsUnitTypes::RenderUnit unit ); @@ -192,7 +210,8 @@ class GUI_EXPORT QgsUnitSelectionWidget : public QWidget, private Ui::QgsUnitSel //! Sets the map unit scale void setMapUnitScale( const QgsMapUnitScale &scale ) { mMapUnitScale = scale; } - /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current + /** + * Sets the map canvas associated with the widget. This allows the widget to retrieve the current * map scale from the canvas. * \param canvas map canvas * \since QGIS 2.12 diff --git a/src/gui/qgsuserinputdockwidget.h b/src/gui/qgsuserinputdockwidget.h index 4a7e6a07112f..278b22e94654 100644 --- a/src/gui/qgsuserinputdockwidget.h +++ b/src/gui/qgsuserinputdockwidget.h @@ -28,7 +28,8 @@ class QFrame; class QBoxLayout; -/** \ingroup gui +/** + * \ingroup gui * \brief The QgsUserInputDockWidget class is a dock widget that shall be used to display widgets for user inputs. * It can be used by map tools, plugins, etc. * Several widgets can be displayed at once, they will be separated by a separator. Widgets will be either layout horizontally or vertically. @@ -40,7 +41,8 @@ class GUI_EXPORT QgsUserInputDockWidget : public QgsDockWidget public: QgsUserInputDockWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Add a widget to be displayed in the dock. + /** + * Add a widget to be displayed in the dock. * \param widget widget to add. Ownership is not transferred. */ void addUserInputWidget( QWidget *widget ); diff --git a/src/gui/qgsvariableeditorwidget.h b/src/gui/qgsvariableeditorwidget.h index 5a988a2c5b54..8786cc6fe1bc 100644 --- a/src/gui/qgsvariableeditorwidget.h +++ b/src/gui/qgsvariableeditorwidget.h @@ -30,7 +30,8 @@ class QgsExpressionContext; class QgsVariableEditorTree; class VariableEditorDelegate; -/** \ingroup gui +/** + * \ingroup gui * \class QgsVariableEditorWidget * A tree based widget for editing expression context scope variables. The widget allows editing * variables from a QgsExpressionContextScope, and can optionally also show inherited @@ -46,14 +47,16 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget public: - /** Constructor for QgsVariableEditorWidget. + /** + * Constructor for QgsVariableEditorWidget. * \param parent parent widget */ QgsVariableEditorWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); ~QgsVariableEditorWidget(); - /** Overwrites the QgsExpressionContext for the widget. Setting a context + /** + * Overwrites the QgsExpressionContext for the widget. Setting a context * allows the widget to show all inherited variables for the context, * and highlight any overridden variables within scopes. * \param context expression context @@ -61,13 +64,15 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget */ void setContext( QgsExpressionContext *context ); - /** Returns the current expression context for the widget. QgsVariableEditorWidget widgets + /** + * Returns the current expression context for the widget. QgsVariableEditorWidget widgets * are created with an empty context by default. * \see setContext() */ QgsExpressionContext *context() const { return mContext.get(); } - /** Sets the editable scope for the widget. Only variables from the editable scope can + /** + * Sets the editable scope for the widget. Only variables from the editable scope can * be modified by users. * \param scopeIndex index of current editable scope. Set to -1 to disable * editing and make the widget read-only. @@ -75,13 +80,15 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget */ void setEditableScopeIndex( int scopeIndex ); - /** Returns the current editable scope for the widget. + /** + * Returns the current editable scope for the widget. * \returns editable scope, or 0 if no editable scope is set * \see setEditableScopeIndex() */ QgsExpressionContextScope *editableScope() const; - /** Sets the setting group for the widget. QgsVariableEditorWidget widgets with + /** + * Sets the setting group for the widget. QgsVariableEditorWidget widgets with * the same setting group will synchronise their settings, e.g., the size * of columns in the tree widget. * \param group setting group @@ -89,7 +96,8 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget */ void setSettingGroup( const QString &group ) { mSettingGroup = group; } - /** Returns the setting group for the widget. QgsVariableEditorWidget widgets with + /** + * Returns the setting group for the widget. QgsVariableEditorWidget widgets with * the same setting group will synchronise their settings, e.g., the size * of columns in the tree widget. * \returns setting group name @@ -97,7 +105,8 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget */ QString settingGroup() const { return mSettingGroup; } - /** Returns a map variables set within the editable scope. Read only variables are not + /** + * Returns a map variables set within the editable scope. Read only variables are not * returned. This method can be used to retrieve the variables edited an added by * users via the widget. */ @@ -105,7 +114,8 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget public slots: - /** Reloads all scopes from the editor's current context. This method should be called + /** + * Reloads all scopes from the editor's current context. This method should be called * after adding or removing scopes from the attached context. * \see context() */ @@ -113,7 +123,8 @@ class GUI_EXPORT QgsVariableEditorWidget : public QWidget signals: - /** Emitted when the user has modified a scope using the widget. + /** + * Emitted when the user has modified a scope using the widget. */ void scopeChanged(); diff --git a/src/gui/qgsvertexmarker.h b/src/gui/qgsvertexmarker.h index 14be90294ac4..0a7ea4739c26 100644 --- a/src/gui/qgsvertexmarker.h +++ b/src/gui/qgsvertexmarker.h @@ -22,7 +22,8 @@ class QPainter; -/** \ingroup gui +/** + * \ingroup gui * A class for marking vertices of features using e.g. circles or 'x'. */ class GUI_EXPORT QgsVertexMarker : public QgsMapCanvasItem diff --git a/src/gui/raster/qgshillshaderendererwidget.h b/src/gui/raster/qgshillshaderendererwidget.h index 84255ff60789..d8026a8694aa 100644 --- a/src/gui/raster/qgshillshaderendererwidget.h +++ b/src/gui/raster/qgshillshaderendererwidget.h @@ -66,12 +66,14 @@ class GUI_EXPORT QgsHillshadeRendererWidget: public QgsRasterRendererWidget, pri */ double azimuth() const; - /** Returns the angle of the light source over the raster. + /** + * Returns the angle of the light source over the raster. * \see setAltitude() */ double altitude() const; - /** Returns the Z scaling factor. + /** + * Returns the Z scaling factor. * \see setZFactor() */ double zFactor() const; @@ -105,7 +107,8 @@ class GUI_EXPORT QgsHillshadeRendererWidget: public QgsRasterRendererWidget, pri */ void setZFactor( double zfactor ); - /** Sets whether to render using a multi-directional hillshade algorithm. + /** + * Sets whether to render using a multi-directional hillshade algorithm. * \param isMultiDirectional set to true to use multi directional rendering * \see multiDirectional() */ diff --git a/src/gui/raster/qgsmultibandcolorrendererwidget.h b/src/gui/raster/qgsmultibandcolorrendererwidget.h index 4f99a4cfd8aa..906caecf60e8 100644 --- a/src/gui/raster/qgsmultibandcolorrendererwidget.h +++ b/src/gui/raster/qgsmultibandcolorrendererwidget.h @@ -29,7 +29,8 @@ class QgsRasterLayer; class QLineEdit; class QgsRasterMinMaxWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsMultiBandColorRendererWidget */ class GUI_EXPORT QgsMultiBandColorRendererWidget: public QgsRasterRendererWidget, private Ui::QgsMultiBandColorRendererWidgetBase diff --git a/src/gui/raster/qgspalettedrendererwidget.h b/src/gui/raster/qgspalettedrendererwidget.h index a175de167d65..3ed21355d245 100644 --- a/src/gui/raster/qgspalettedrendererwidget.h +++ b/src/gui/raster/qgspalettedrendererwidget.h @@ -32,7 +32,8 @@ class QgsRasterLayer; #ifndef SIP_RUN /// @cond PRIVATE -/** \class QgsPalettedRendererClassGatherer +/** + * \class QgsPalettedRendererClassGatherer * Calculated raster stats for paletted renderer in a thread */ class QgsPalettedRendererClassGatherer: public QThread @@ -103,7 +104,8 @@ class QgsPalettedRendererClassGatherer: public QThread signals: - /** Emitted when classes have been collected + /** + * Emitted when classes have been collected */ void collectedClasses(); @@ -178,7 +180,8 @@ class QgsPalettedRendererModel : public QAbstractItemModel ///@endcond PRIVATE #endif -/** \ingroup gui +/** + * \ingroup gui * \class QgsPalettedRendererWidget */ class GUI_EXPORT QgsPalettedRendererWidget: public QgsRasterRendererWidget, private Ui::QgsPalettedRendererWidgetBase diff --git a/src/gui/raster/qgsrasterhistogramwidget.h b/src/gui/raster/qgsrasterhistogramwidget.h index 007d91f256e4..ad0749756d93 100644 --- a/src/gui/raster/qgsrasterhistogramwidget.h +++ b/src/gui/raster/qgsrasterhistogramwidget.h @@ -33,7 +33,8 @@ class QwtPlotZoomer; // fix for qwt5/qwt6 QwtDoublePoint vs. QPointF typedef QPointF QwtDoublePoint SIP_SKIP; -/** \ingroup gui +/** + * \ingroup gui * Histogram widget */ @@ -82,7 +83,8 @@ class GUI_EXPORT QgsRasterHistogramWidget : public QgsMapLayerConfigWidget, priv //! Called when a selection has been made using the plot picker. void histoPickerSelected( QPointF ); - /** Called when a selection has been made using the plot picker (for qwt5 only). + /** + * Called when a selection has been made using the plot picker (for qwt5 only). \note not available in Python bindings */ void histoPickerSelectedQwt5( QwtDoublePoint ) SIP_SKIP; diff --git a/src/gui/raster/qgsrasterminmaxwidget.h b/src/gui/raster/qgsrasterminmaxwidget.h index ad14742cd60b..17a48be78a78 100644 --- a/src/gui/raster/qgsrasterminmaxwidget.h +++ b/src/gui/raster/qgsrasterminmaxwidget.h @@ -30,7 +30,8 @@ class QgsMapCanvas; class QgsRasterLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRasterMinMaxWidget */ class GUI_EXPORT QgsRasterMinMaxWidget: public QWidget, private Ui::QgsRasterMinMaxWidgetBase @@ -39,14 +40,16 @@ class GUI_EXPORT QgsRasterMinMaxWidget: public QWidget, private Ui::QgsRasterMin public: QgsRasterMinMaxWidget( QgsRasterLayer *layer, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets the extent to use for minimum and maximum value calculation. + /** + * Sets the extent to use for minimum and maximum value calculation. * \param extent extent in raster layer's CRS * \note if a map canvas is set using setMapCanvas(), its extent will take * precedence over any extent set using this method. */ void setExtent( const QgsRectangle &extent ) { mExtent = extent; } - /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current + /** + * Sets the map canvas associated with the widget. This allows the widget to retrieve the current * map extent from the canvas. If a canvas is set it will take precedence over any extent * set from calling setExtent(). * \param canvas map canvas @@ -55,7 +58,8 @@ class GUI_EXPORT QgsRasterMinMaxWidget: public QWidget, private Ui::QgsRasterMin */ void setMapCanvas( QgsMapCanvas *canvas ); - /** Returns the map canvas associated with the widget. + /** + * Returns the map canvas associated with the widget. * \see setMapCanvas() * \see canvasExtent() * \since QGIS 2.16 @@ -64,7 +68,8 @@ class GUI_EXPORT QgsRasterMinMaxWidget: public QWidget, private Ui::QgsRasterMin void setBands( const QList &bands ); - /** Return the extent selected by the user. + /** + * Return the extent selected by the user. * Either an empty extent for 'full' or the current visible extent. */ QgsRectangle extent(); diff --git a/src/gui/raster/qgsrasterrendererwidget.h b/src/gui/raster/qgsrasterrendererwidget.h index a0993317ea32..20f368f339da 100644 --- a/src/gui/raster/qgsrasterrendererwidget.h +++ b/src/gui/raster/qgsrasterrendererwidget.h @@ -29,7 +29,8 @@ class QgsRasterRenderer; class QgsMapCanvas; class QgsRasterMinMaxWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRasterRendererWidget */ class GUI_EXPORT QgsRasterRendererWidget: public QWidget @@ -49,7 +50,8 @@ class GUI_EXPORT QgsRasterRendererWidget: public QWidget void setRasterLayer( QgsRasterLayer *layer ) { mRasterLayer = layer; } const QgsRasterLayer *rasterLayer() const { return mRasterLayer; } - /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current + /** + * Sets the map canvas associated with the widget. This allows the widget to retrieve the current * map extent and other properties from the canvas. * \param canvas map canvas * \see mapCanvas() @@ -57,7 +59,8 @@ class GUI_EXPORT QgsRasterRendererWidget: public QWidget */ virtual void setMapCanvas( QgsMapCanvas *canvas ); - /** Returns the map canvas associated with the widget. + /** + * Returns the map canvas associated with the widget. * \see setMapCanvas() * \see canvasExtent() * \since QGIS 2.16 diff --git a/src/gui/raster/qgsrastertransparencywidget.h b/src/gui/raster/qgsrastertransparencywidget.h index 362c757454c5..00e4f8260bfa 100644 --- a/src/gui/raster/qgsrastertransparencywidget.h +++ b/src/gui/raster/qgsrastertransparencywidget.h @@ -29,7 +29,8 @@ class QgsMapToolEmitPoint; class QgsPointXY; -/** \ingroup gui +/** + * \ingroup gui * \brief Widget to control a layers transparency and related options */ class GUI_EXPORT QgsRasterTransparencyWidget : public QgsMapLayerConfigWidget, private Ui::QgsRasterTransparencyWidget diff --git a/src/gui/raster/qgsrendererrasterpropertieswidget.h b/src/gui/raster/qgsrendererrasterpropertieswidget.h index 6e102ab8efed..d9424c44db3a 100644 --- a/src/gui/raster/qgsrendererrasterpropertieswidget.h +++ b/src/gui/raster/qgsrendererrasterpropertieswidget.h @@ -28,7 +28,8 @@ class QgsRasterLayer; class QgsMapCanvas; class QgsRasterRendererWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRendererRasterPropertiesWidget */ class GUI_EXPORT QgsRendererRasterPropertiesWidget : public QgsMapLayerConfigWidget, private Ui::QgsRendererRasterPropsWidgetBase @@ -45,7 +46,8 @@ class GUI_EXPORT QgsRendererRasterPropertiesWidget : public QgsMapLayerConfigWid */ QgsRendererRasterPropertiesWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent = nullptr ); - /** Sets the map canvas associated with the dialog. This allows the widget to retrieve the current + /** + * Sets the map canvas associated with the dialog. This allows the widget to retrieve the current * map scale and other properties from the canvas. * \param canvas map canvas * \since QGIS 2.12 diff --git a/src/gui/raster/qgssinglebandgrayrendererwidget.h b/src/gui/raster/qgssinglebandgrayrendererwidget.h index 8e4d038fa4a2..1c94b4b464fb 100644 --- a/src/gui/raster/qgssinglebandgrayrendererwidget.h +++ b/src/gui/raster/qgssinglebandgrayrendererwidget.h @@ -25,7 +25,8 @@ class QgsRasterMinMaxWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSingleBandGrayRendererWidget */ class GUI_EXPORT QgsSingleBandGrayRendererWidget: public QgsRasterRendererWidget, private Ui::QgsSingleBandGrayRendererWidgetBase diff --git a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h index 3ff24d405b53..cec9d183327a 100644 --- a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h +++ b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h @@ -27,7 +27,8 @@ class QgsRasterMinMaxWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSingleBandPseudoColorRendererWidget */ class GUI_EXPORT QgsSingleBandPseudoColorRendererWidget: public QgsRasterRendererWidget, private Ui::QgsSingleBandPseudoColorRendererWidgetBase @@ -49,7 +50,8 @@ class GUI_EXPORT QgsSingleBandPseudoColorRendererWidget: public QgsRasterRendere public slots: - /** Executes the single band pseudo raster classficiation + /** + * Executes the single band pseudo raster classficiation */ void classify(); //! called when new min/max values are loaded @@ -66,7 +68,8 @@ class GUI_EXPORT QgsSingleBandPseudoColorRendererWidget: public QgsRasterRendere void populateColormapTreeWidget( const QList &colorRampItems ); - /** Generate labels from the values in the color map. + /** + * Generate labels from the values in the color map. * Skip labels which were manually edited (black text). * Text of generated labels is made gray */ diff --git a/src/gui/symbology/qgs25drendererwidget.h b/src/gui/symbology/qgs25drendererwidget.h index 3c412b516516..e38f639d00dc 100644 --- a/src/gui/symbology/qgs25drendererwidget.h +++ b/src/gui/symbology/qgs25drendererwidget.h @@ -23,7 +23,8 @@ class Qgs25DRenderer; -/** \ingroup gui +/** + * \ingroup gui * \class Qgs25DRendererWidget */ class GUI_EXPORT Qgs25DRendererWidget : public QgsRendererWidget, protected Ui::Qgs25DRendererWidgetBase @@ -32,14 +33,16 @@ class GUI_EXPORT Qgs25DRendererWidget : public QgsRendererWidget, protected Ui:: public: - /** Static creation method + /** + * Static creation method * \param layer the layer where this renderer is applied * \param style * \param renderer the mask renderer (will not take ownership) */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer SIP_TRANSFER ) SIP_FACTORY; - /** Constructor + /** + * Constructor * \param layer the layer where this renderer is applied * \param style * \param renderer the mask renderer (will not take ownership) diff --git a/src/gui/symbology/qgsarrowsymbollayerwidget.h b/src/gui/symbology/qgsarrowsymbollayerwidget.h index c55941db69fa..735f66f82ba3 100644 --- a/src/gui/symbology/qgsarrowsymbollayerwidget.h +++ b/src/gui/symbology/qgsarrowsymbollayerwidget.h @@ -22,7 +22,8 @@ class QgsArrowSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsArrowSymbolLayerWidget */ class GUI_EXPORT QgsArrowSymbolLayerWidget: public QgsSymbolLayerWidget, private Ui::QgsArrowSymbolLayerWidgetBase @@ -31,13 +32,15 @@ class GUI_EXPORT QgsArrowSymbolLayerWidget: public QgsSymbolLayerWidget, private public: - /** Constructor + /** + * Constructor * \param layer the layer where this symbol layer is applied * \param parent the parent widget */ QgsArrowSymbolLayerWidget( const QgsVectorLayer *layer, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Static creation method + /** + * Static creation method * \param layer the layer where this symbol layer is applied */ static QgsSymbolLayerWidget *create( const QgsVectorLayer *layer ) SIP_FACTORY { return new QgsArrowSymbolLayerWidget( layer ); } diff --git a/src/gui/symbology/qgsbrushstylecombobox.h b/src/gui/symbology/qgsbrushstylecombobox.h index d24ca1333326..e2a6eaa9bb70 100644 --- a/src/gui/symbology/qgsbrushstylecombobox.h +++ b/src/gui/symbology/qgsbrushstylecombobox.h @@ -20,7 +20,8 @@ #include "qgis_gui.h" #include "qgis_sip.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsBrushStyleComboBox */ class GUI_EXPORT QgsBrushStyleComboBox : public QComboBox diff --git a/src/gui/symbology/qgscategorizedsymbolrendererwidget.h b/src/gui/symbology/qgscategorizedsymbolrendererwidget.h index a0ef8dec5303..d34cfce25c4d 100644 --- a/src/gui/symbology/qgscategorizedsymbolrendererwidget.h +++ b/src/gui/symbology/qgscategorizedsymbolrendererwidget.h @@ -66,7 +66,8 @@ class GUI_EXPORT QgsCategorizedSymbolRendererModel : public QAbstractItemModel QString mMimeFormat; }; -/** \ingroup gui +/** + * \ingroup gui * View style which shows drop indicator line between items */ class QgsCategorizedSymbolRendererViewStyle: public QProxyStyle @@ -83,7 +84,8 @@ class QgsCategorizedSymbolRendererViewStyle: public QProxyStyle #endif -/** \ingroup gui +/** + * \ingroup gui * \class QgsCategorizedSymbolRendererWidget */ class GUI_EXPORT QgsCategorizedSymbolRendererWidget : public QgsRendererWidget, private Ui::QgsCategorizedSymbolRendererWidget, private QgsExpressionContextGenerator @@ -97,7 +99,8 @@ class GUI_EXPORT QgsCategorizedSymbolRendererWidget : public QgsRendererWidget, virtual QgsFeatureRenderer *renderer() override; - /** Replaces category symbols with the symbols from a style that have a matching + /** + * Replaces category symbols with the symbols from a style that have a matching * name. * \param style style containing symbols to match with * \returns number of symbols matched @@ -114,7 +117,8 @@ class GUI_EXPORT QgsCategorizedSymbolRendererWidget : public QgsRendererWidget, void addCategory(); void addCategories(); - /** Applies the color ramp passed on by the color ramp button + /** + * Applies the color ramp passed on by the color ramp button */ void applyColorRamp(); @@ -125,7 +129,8 @@ class GUI_EXPORT QgsCategorizedSymbolRendererWidget : public QgsRendererWidget, void rowsMoved(); - /** Replaces category symbols with the symbols from the users' symbol library that have a + /** + * Replaces category symbols with the symbols from the users' symbol library that have a * matching name. * \see matchToSymbolsFromXml * \see matchToSymbols @@ -133,7 +138,8 @@ class GUI_EXPORT QgsCategorizedSymbolRendererWidget : public QgsRendererWidget, */ void matchToSymbolsFromLibrary(); - /** Prompts for selection of an xml file, then replaces category symbols with the symbols + /** + * Prompts for selection of an xml file, then replaces category symbols with the symbols * from the XML file with a matching name. * \see matchToSymbolsFromLibrary * \see matchToSymbols diff --git a/src/gui/symbology/qgscptcitycolorrampdialog.h b/src/gui/symbology/qgscptcitycolorrampdialog.h index c46cf5e56410..cfd2fbcc2892 100644 --- a/src/gui/symbology/qgscptcitycolorrampdialog.h +++ b/src/gui/symbology/qgscptcitycolorrampdialog.h @@ -33,7 +33,8 @@ class TreeFilterProxyModel; class ListFilterProxyModel; class UngroupProxyModel; -/** \ingroup gui +/** + * \ingroup gui * \class QgsCptCityColorRampDialog * A dialog which allows users to modify the properties of a QgsCptCityColorRamp. * \since QGIS 3.0 @@ -45,31 +46,36 @@ class GUI_EXPORT QgsCptCityColorRampDialog : public QDialog, private Ui::QgsCptC public: - /** Constructor for QgsCptCityColorRampDialog. + /** + * Constructor for QgsCptCityColorRampDialog. * \param ramp initial ramp to show in dialog * \param parent parent widget */ QgsCptCityColorRampDialog( const QgsCptCityColorRamp &ramp, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Returns a color ramp representing the current settings from the dialog. + /** + * Returns a color ramp representing the current settings from the dialog. * \see setRamp() */ QgsCptCityColorRamp ramp() const { return mRamp; } - /** Sets the color ramp to show in the dialog. + /** + * Sets the color ramp to show in the dialog. * \param ramp color ramp * \see ramp() */ void setRamp( const QgsCptCityColorRamp &ramp ); - /** Returns the name of the ramp currently selected in the dialog. + /** + * Returns the name of the ramp currently selected in the dialog. */ QString selectedName() const { return QFileInfo( mRamp.schemeName() ).baseName() + mRamp.variantName(); } - /** Returns true if the ramp should be converted to a QgsGradientColorRamp. + /** + * Returns true if the ramp should be converted to a QgsGradientColorRamp. */ bool saveAsGradientRamp() const; @@ -122,7 +128,8 @@ class GUI_EXPORT QgsCptCityColorRampDialog : public QDialog, private Ui::QgsCptC #ifndef SIP_RUN /// @cond PRIVATE -/** \ingroup gui +/** + * \ingroup gui * \class TreeFilterProxyModel */ class TreeFilterProxyModel : public QSortFilterProxyModel diff --git a/src/gui/symbology/qgsdashspacedialog.h b/src/gui/symbology/qgsdashspacedialog.h index 10233e63228a..29dc10b53a7d 100644 --- a/src/gui/symbology/qgsdashspacedialog.h +++ b/src/gui/symbology/qgsdashspacedialog.h @@ -20,7 +20,8 @@ #include "qgis_gui.h" #include "qgis_sip.h" -/** \ingroup gui +/** + * \ingroup gui * A dialog to enter a custom dash space pattern for lines */ class GUI_EXPORT QgsDashSpaceDialog: public QDialog, private Ui::QgsDashSpaceDialogBase diff --git a/src/gui/symbology/qgsdatadefinedsizelegendwidget.h b/src/gui/symbology/qgsdatadefinedsizelegendwidget.h index ff1de939a6f9..42dd3235aa58 100644 --- a/src/gui/symbology/qgsdatadefinedsizelegendwidget.h +++ b/src/gui/symbology/qgsdatadefinedsizelegendwidget.h @@ -37,7 +37,8 @@ class QgsMarkerSymbol; class QgsProperty; class QgsVectorLayer; -/** \ingroup gui +/** + * \ingroup gui * Widget for configuration of appearance of legend for marker symbols with data-defined size. * * \since QGIS 3.0 diff --git a/src/gui/symbology/qgsellipsesymbollayerwidget.h b/src/gui/symbology/qgsellipsesymbollayerwidget.h index 8662f6ca11d6..5c3f9e2b7b10 100644 --- a/src/gui/symbology/qgsellipsesymbollayerwidget.h +++ b/src/gui/symbology/qgsellipsesymbollayerwidget.h @@ -22,7 +22,8 @@ class QgsEllipseSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsEllipseSymbolLayerWidget */ class GUI_EXPORT QgsEllipseSymbolLayerWidget: public QgsSymbolLayerWidget, private Ui::WidgetEllipseBase diff --git a/src/gui/symbology/qgsgraduatedhistogramwidget.h b/src/gui/symbology/qgsgraduatedhistogramwidget.h index c6bdcd59b5e7..be32aa029d07 100644 --- a/src/gui/symbology/qgsgraduatedhistogramwidget.h +++ b/src/gui/symbology/qgsgraduatedhistogramwidget.h @@ -24,7 +24,8 @@ class QwtPlotPicker; class QgsGraduatedHistogramEventFilter; -/** \ingroup gui +/** + * \ingroup gui * \class QgsGraduatedHistogramWidget * \brief Graphical histogram for displaying distribution of field values and * editing range breaks for a QgsGraduatedSymbolRenderer renderer. @@ -38,12 +39,14 @@ class GUI_EXPORT QgsGraduatedHistogramWidget : public QgsHistogramWidget public: - /** QgsGraduatedHistogramWidget constructor + /** + * QgsGraduatedHistogramWidget constructor * \param parent parent widget */ QgsGraduatedHistogramWidget( QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Sets the QgsGraduatedSymbolRenderer renderer associated with the histogram. + /** + * Sets the QgsGraduatedSymbolRenderer renderer associated with the histogram. * The histogram will fetch the ranges from the renderer before every refresh. * \param renderer associated QgsGraduatedSymbolRenderer */ @@ -51,7 +54,8 @@ class GUI_EXPORT QgsGraduatedHistogramWidget : public QgsHistogramWidget signals: - /** Emitted when the user modifies the graduated ranges using the histogram widget. + /** + * Emitted when the user modifies the graduated ranges using the histogram widget. * \param rangesAdded true if the user has added ranges, false if the user has just * modified existing range breaks */ diff --git a/src/gui/symbology/qgsgraduatedsymbolrendererwidget.h b/src/gui/symbology/qgsgraduatedsymbolrendererwidget.h index 7b5aedad0ef7..b64b66d9f66b 100644 --- a/src/gui/symbology/qgsgraduatedsymbolrendererwidget.h +++ b/src/gui/symbology/qgsgraduatedsymbolrendererwidget.h @@ -79,7 +79,8 @@ class QgsGraduatedSymbolRendererViewStyle: public QProxyStyle ///@endcond #endif -/** \ingroup gui +/** + * \ingroup gui * \class QgsGraduatedSymbolRendererWidget */ class GUI_EXPORT QgsGraduatedSymbolRendererWidget : public QgsRendererWidget, private Ui::QgsGraduatedSymbolRendererWidget, private QgsExpressionContextGenerator diff --git a/src/gui/symbology/qgsheatmaprendererwidget.h b/src/gui/symbology/qgsheatmaprendererwidget.h index c1f08c244ae6..4dea70686196 100644 --- a/src/gui/symbology/qgsheatmaprendererwidget.h +++ b/src/gui/symbology/qgsheatmaprendererwidget.h @@ -23,7 +23,8 @@ class QMenu; class QgsHeatmapRenderer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsHeatmapRendererWidget */ class GUI_EXPORT QgsHeatmapRendererWidget : public QgsRendererWidget, private Ui::QgsHeatmapRendererWidgetBase, private QgsExpressionContextGenerator @@ -32,14 +33,16 @@ class GUI_EXPORT QgsHeatmapRendererWidget : public QgsRendererWidget, private Ui public: - /** Static creation method + /** + * Static creation method * \param layer the layer where this renderer is applied * \param style * \param renderer the mask renderer (will not take ownership) */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) SIP_FACTORY; - /** Constructor + /** + * Constructor * \param layer the layer where this renderer is applied * \param style * \param renderer the mask renderer (will not take ownership) diff --git a/src/gui/symbology/qgsinvertedpolygonrendererwidget.h b/src/gui/symbology/qgsinvertedpolygonrendererwidget.h index 51a26b279bce..5e6259ee02cd 100644 --- a/src/gui/symbology/qgsinvertedpolygonrendererwidget.h +++ b/src/gui/symbology/qgsinvertedpolygonrendererwidget.h @@ -23,7 +23,8 @@ class QMenu; -/** \ingroup gui +/** + * \ingroup gui * A widget used represent options of a QgsInvertedPolygonRenderer * * \since QGIS 2.4 @@ -34,14 +35,16 @@ class GUI_EXPORT QgsInvertedPolygonRendererWidget : public QgsRendererWidget, pr public: - /** Static creation method + /** + * Static creation method * \param layer the layer where this renderer is applied * \param style * \param renderer the mask renderer (will not take ownership) */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) SIP_FACTORY; - /** Constructor + /** + * Constructor * \param layer the layer where this renderer is applied * \param style * \param renderer the mask renderer (will not take ownership) diff --git a/src/gui/symbology/qgslayerpropertieswidget.h b/src/gui/symbology/qgslayerpropertieswidget.h index 5cff6fc8a723..6cb3fc2b52a3 100644 --- a/src/gui/symbology/qgslayerpropertieswidget.h +++ b/src/gui/symbology/qgslayerpropertieswidget.h @@ -34,7 +34,8 @@ class SymbolLayerItem; #include #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsLayerPropertiesWidget */ class GUI_EXPORT QgsLayerPropertiesWidget : public QgsPanelWidget, public QgsExpressionContextGenerator, private Ui::LayerPropertiesWidget @@ -44,14 +45,16 @@ class GUI_EXPORT QgsLayerPropertiesWidget : public QgsPanelWidget, public QgsExp public: QgsLayerPropertiesWidget( QgsSymbolLayer *layer, const QgsSymbol *symbol, const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \param context symbol widget context * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \see setContext() * \since QGIS 3.0 */ diff --git a/src/gui/symbology/qgsnullsymbolrendererwidget.h b/src/gui/symbology/qgsnullsymbolrendererwidget.h index 4ce0e8bd04e7..0a2e6a4fd110 100644 --- a/src/gui/symbology/qgsnullsymbolrendererwidget.h +++ b/src/gui/symbology/qgsnullsymbolrendererwidget.h @@ -23,7 +23,8 @@ class QgsNullSymbolRenderer; class QMenu; -/** \ingroup gui +/** + * \ingroup gui * \class QgsNullSymbolRendererWidget * \brief Blank widget for customising QgsNullSymbolRenderer. * \since QGIS 2.16 diff --git a/src/gui/symbology/qgspenstylecombobox.h b/src/gui/symbology/qgspenstylecombobox.h index 5ce6e951cbb6..d22c608b7e4c 100644 --- a/src/gui/symbology/qgspenstylecombobox.h +++ b/src/gui/symbology/qgspenstylecombobox.h @@ -20,7 +20,8 @@ #include "qgis_gui.h" #include "qgis_sip.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsPenStyleComboBox */ class GUI_EXPORT QgsPenStyleComboBox : public QComboBox @@ -39,7 +40,8 @@ class GUI_EXPORT QgsPenStyleComboBox : public QComboBox }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsPenJoinStyleComboBox */ class GUI_EXPORT QgsPenJoinStyleComboBox : public QComboBox @@ -54,7 +56,8 @@ class GUI_EXPORT QgsPenJoinStyleComboBox : public QComboBox void setPenJoinStyle( Qt::PenJoinStyle style ); }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsPenCapStyleComboBox */ class GUI_EXPORT QgsPenCapStyleComboBox : public QComboBox diff --git a/src/gui/symbology/qgspointclusterrendererwidget.h b/src/gui/symbology/qgspointclusterrendererwidget.h index 4d11872165d5..d987b4614774 100644 --- a/src/gui/symbology/qgspointclusterrendererwidget.h +++ b/src/gui/symbology/qgspointclusterrendererwidget.h @@ -26,7 +26,8 @@ class QgsPointClusterRenderer; -/** \class QgsPointClusterRendererWidget +/** + * \class QgsPointClusterRendererWidget * \ingroup gui * A widget which allows configuration of the properties for a QgsPointClusterRenderer. * \since QGIS 3.0 @@ -38,7 +39,8 @@ class GUI_EXPORT QgsPointClusterRendererWidget: public QgsRendererWidget, public public: - /** Returns a new QgsPointClusterRendererWidget. + /** + * Returns a new QgsPointClusterRendererWidget. * \param layer associated vector layer * \param style style collection * \param renderer source QgsPointClusterRenderer renderer @@ -46,7 +48,8 @@ class GUI_EXPORT QgsPointClusterRendererWidget: public QgsRendererWidget, public */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) SIP_FACTORY; - /** Constructor for QgsPointClusterRendererWidget. + /** + * Constructor for QgsPointClusterRendererWidget. * \param layer associated vector layer * \param style style collection * \param renderer source QgsPointClusterRenderer renderer diff --git a/src/gui/symbology/qgspointdisplacementrendererwidget.h b/src/gui/symbology/qgspointdisplacementrendererwidget.h index e339f97fc354..7a33fdec11de 100644 --- a/src/gui/symbology/qgspointdisplacementrendererwidget.h +++ b/src/gui/symbology/qgspointdisplacementrendererwidget.h @@ -26,7 +26,8 @@ class QgsPointDisplacementRenderer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsPointDisplacementRendererWidget */ class GUI_EXPORT QgsPointDisplacementRendererWidget: public QgsRendererWidget, public QgsExpressionContextGenerator, private Ui::QgsPointDisplacementRendererWidgetBase diff --git a/src/gui/symbology/qgsrendererpropertiesdialog.h b/src/gui/symbology/qgsrendererpropertiesdialog.h index f345331fcd80..eaaad558a069 100644 --- a/src/gui/symbology/qgsrendererpropertiesdialog.h +++ b/src/gui/symbology/qgsrendererpropertiesdialog.h @@ -34,7 +34,8 @@ class QgsPaintEffect; class QgsRendererWidget; class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRendererPropertiesDialog */ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRendererPropsDialogBase @@ -43,7 +44,8 @@ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRe public: - /** Constructor for QgsRendererPropertiesDialog. + /** + * Constructor for QgsRendererPropertiesDialog. * \param layer associated layer * \param style style collection * \param embedded set to true to indicate that the dialog will be embedded in another widget, rather @@ -53,7 +55,8 @@ class GUI_EXPORT QgsRendererPropertiesDialog : public QDialog, private Ui::QgsRe QgsRendererPropertiesDialog( QgsVectorLayer *layer, QgsStyle *style, bool embedded = false, QWidget *parent SIP_TRANSFERTHIS = 0 ); ~QgsRendererPropertiesDialog(); - /** Sets the map canvas associated with the dialog. This allows the widget to retrieve the current + /** + * Sets the map canvas associated with the dialog. This allows the widget to retrieve the current * map scale and other properties from the canvas. * \param canvas map canvas * \since QGIS 2.12 diff --git a/src/gui/symbology/qgsrendererwidget.h b/src/gui/symbology/qgsrendererwidget.h index 33ceb5a0f8c6..4541a660b7e0 100644 --- a/src/gui/symbology/qgsrendererwidget.h +++ b/src/gui/symbology/qgsrendererwidget.h @@ -30,7 +30,8 @@ class QgsStyle; class QgsFeatureRenderer; class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui Base class for renderer settings widgets WORKFLOW: @@ -52,20 +53,23 @@ class GUI_EXPORT QgsRendererWidget : public QgsPanelWidget //! show a dialog with renderer's symbol level settings void showSymbolLevelsDialog( QgsFeatureRenderer *r ); - /** Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. * \param context symbol widget context * \see context() * \since QGIS 3.0 */ virtual void setContext( const QgsSymbolWidgetContext &context ); - /** Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; - /** Returns the vector layer associated with the widget. + /** + * Returns the vector layer associated with the widget. * \since QGIS 2.12 */ const QgsVectorLayer *vectorLayer() const { return mLayer; } @@ -94,7 +98,8 @@ class GUI_EXPORT QgsRendererWidget : public QgsPanelWidget //! Context in which widget is shown QgsSymbolWidgetContext mContext; - /** Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods + /** + * Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods and by connecting the slot contextMenuViewCategories(const QPoint&)*/ virtual QList selectedSymbols() { return QList(); } virtual void refreshSymbolView() {} @@ -148,7 +153,8 @@ class QgsFields; #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui Utility classes for "en masse" size definition */ class GUI_EXPORT QgsDataDefinedValueDialog : public QDialog, public Ui::QgsDataDefinedValueBaseDialog, private QgsExpressionContextGenerator @@ -158,27 +164,31 @@ class GUI_EXPORT QgsDataDefinedValueDialog : public QDialog, public Ui::QgsDataD public: - /** Constructor + /** + * Constructor * \param symbolList must not be empty * \param layer must not be null * \param label value label */ QgsDataDefinedValueDialog( const QList &symbolList, QgsVectorLayer *layer, const QString &label ); - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \param context symbol widget context * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; - /** Returns the vector layer associated with the widget. + /** + * Returns the vector layer associated with the widget. * \since QGIS 2.12 */ const QgsVectorLayer *vectorLayer() const { return mLayer; } @@ -210,7 +220,8 @@ class GUI_EXPORT QgsDataDefinedValueDialog : public QDialog, public Ui::QgsDataD QgsExpressionContext createExpressionContext() const override; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsDataDefinedSizeDialog */ class GUI_EXPORT QgsDataDefinedSizeDialog : public QgsDataDefinedValueDialog @@ -240,7 +251,8 @@ class GUI_EXPORT QgsDataDefinedSizeDialog : public QgsDataDefinedValueDialog std::shared_ptr< QgsMarkerSymbol > mAssistantSymbol; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsDataDefinedRotationDialog */ class GUI_EXPORT QgsDataDefinedRotationDialog : public QgsDataDefinedValueDialog @@ -261,7 +273,8 @@ class GUI_EXPORT QgsDataDefinedRotationDialog : public QgsDataDefinedValueDialog void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ) override; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsDataDefinedWidthDialog */ class GUI_EXPORT QgsDataDefinedWidthDialog : public QgsDataDefinedValueDialog diff --git a/src/gui/symbology/qgsrulebasedrendererwidget.h b/src/gui/symbology/qgsrulebasedrendererwidget.h index bee496653501..2b95950aa852 100644 --- a/src/gui/symbology/qgsrulebasedrendererwidget.h +++ b/src/gui/symbology/qgsrulebasedrendererwidget.h @@ -36,7 +36,8 @@ struct QgsRuleBasedRendererCount SIP_SKIP QHash duplicateCountMap; }; -/** \ingroup gui +/** + * \ingroup gui Tree model for the rules: (invalid) == root node @@ -97,7 +98,8 @@ class GUI_EXPORT QgsRuleBasedRendererModel : public QAbstractItemModel #include "ui_qgsrulebasedrendererv2widget.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsRuleBasedRendererWidget */ class GUI_EXPORT QgsRuleBasedRendererWidget : public QgsRendererWidget, private Ui::QgsRuleBasedRendererWidget @@ -175,7 +177,8 @@ class GUI_EXPORT QgsRuleBasedRendererWidget : public QgsRendererWidget, private #include "ui_qgsrendererrulepropsdialogbase.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsRendererRulePropsWidget */ class GUI_EXPORT QgsRendererRulePropsWidget : public QgsPanelWidget, private Ui::QgsRendererRulePropsWidget @@ -237,7 +240,8 @@ class GUI_EXPORT QgsRendererRulePropsWidget : public QgsPanelWidget, private Ui: QgsSymbolWidgetContext mContext; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRendererRulePropsDialog */ class GUI_EXPORT QgsRendererRulePropsDialog : public QDialog @@ -246,7 +250,8 @@ class GUI_EXPORT QgsRendererRulePropsDialog : public QDialog public: - /** Constructor for QgsRendererRulePropsDialog + /** + * Constructor for QgsRendererRulePropsDialog * \param rule associated rule based renderer rule * \param layer source vector layer * \param style style collection diff --git a/src/gui/symbology/qgssinglesymbolrendererwidget.h b/src/gui/symbology/qgssinglesymbolrendererwidget.h index 1a0a3a51604b..b8a1f0c5825a 100644 --- a/src/gui/symbology/qgssinglesymbolrendererwidget.h +++ b/src/gui/symbology/qgssinglesymbolrendererwidget.h @@ -24,7 +24,8 @@ class QgsSymbolSelectorWidget; class QMenu; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSingleSymbolRendererWidget */ class GUI_EXPORT QgsSingleSymbolRendererWidget : public QgsRendererWidget diff --git a/src/gui/symbology/qgssmartgroupeditordialog.h b/src/gui/symbology/qgssmartgroupeditordialog.h index 71b447165375..6790a1dcfa36 100644 --- a/src/gui/symbology/qgssmartgroupeditordialog.h +++ b/src/gui/symbology/qgssmartgroupeditordialog.h @@ -20,7 +20,8 @@ #include "qgis_sip.h" #include "qgis_gui.h" -/** \ingroup gui +/** + * \ingroup gui * \class QgsSmartGroupCondition */ class GUI_EXPORT QgsSmartGroupCondition : public QWidget, private Ui::QgsSmartGroupConditionWidget @@ -63,7 +64,8 @@ class GUI_EXPORT QgsSmartGroupCondition : public QWidget, private Ui::QgsSmartGr #include "qgsstyle.h" //for QgsSmartConditionMap -/** \ingroup gui +/** + * \ingroup gui * \class QgsSmartGroupEditorDialog */ class GUI_EXPORT QgsSmartGroupEditorDialog : public QDialog, private Ui::QgsSmartGroupEditorDialogBase diff --git a/src/gui/symbology/qgsstyleexportimportdialog.h b/src/gui/symbology/qgsstyleexportimportdialog.h index ba0ff0f98de1..98035e927caf 100644 --- a/src/gui/symbology/qgsstyleexportimportdialog.h +++ b/src/gui/symbology/qgsstyleexportimportdialog.h @@ -33,7 +33,8 @@ class QgsStyle; class QgsStyleGroupSelectionDialog; -/** \ingroup gui +/** + * \ingroup gui * \class QgsStyleExportImportDialog */ class GUI_EXPORT QgsStyleExportImportDialog : public QDialog, private Ui::QgsStyleExportImportDialogBase diff --git a/src/gui/symbology/qgsstylegroupselectiondialog.h b/src/gui/symbology/qgsstylegroupselectiondialog.h index 558a6cf6d3a5..573cf66734d0 100644 --- a/src/gui/symbology/qgsstylegroupselectiondialog.h +++ b/src/gui/symbology/qgsstylegroupselectiondialog.h @@ -25,7 +25,8 @@ class QgsStyle; -/** \ingroup gui +/** + * \ingroup gui * \class QgsStyleGroupSelectionDialog */ class GUI_EXPORT QgsStyleGroupSelectionDialog : public QDialog, private Ui::SymbolsGroupSelectionDialogBase diff --git a/src/gui/symbology/qgsstylemanagerdialog.h b/src/gui/symbology/qgsstylemanagerdialog.h index b9f2269ef01e..e78a91e42aec 100644 --- a/src/gui/symbology/qgsstylemanagerdialog.h +++ b/src/gui/symbology/qgsstylemanagerdialog.h @@ -27,7 +27,8 @@ class QgsStyle; -/** \ingroup gui +/** + * \ingroup gui * \class QgsStyleManagerDialog */ class GUI_EXPORT QgsStyleManagerDialog : public QDialog, private Ui::QgsStyleManagerDialogBase diff --git a/src/gui/symbology/qgsstylesavedialog.h b/src/gui/symbology/qgsstylesavedialog.h index a7272a7f4367..4e9ebe4aae52 100644 --- a/src/gui/symbology/qgsstylesavedialog.h +++ b/src/gui/symbology/qgsstylesavedialog.h @@ -25,7 +25,8 @@ #include "qgis_gui.h" #include "qgis_sip.h" -/** \ingroup gui +/** + * \ingroup gui * \brief a dialog for setting properties of a newly saved style. * \since QGIS 3.0 */ @@ -35,7 +36,8 @@ class GUI_EXPORT QgsStyleSaveDialog: public QDialog, private Ui::QgsStyleSaveDia public: - /** Constructor for QgsSymbolSaveDialog + /** + * Constructor for QgsSymbolSaveDialog * \param parent parent widget * \param type the QgsStyle entity type being saved */ diff --git a/src/gui/symbology/qgssvgselectorwidget.h b/src/gui/symbology/qgssvgselectorwidget.h index 4970107358c3..e52e67fe0de3 100644 --- a/src/gui/symbology/qgssvgselectorwidget.h +++ b/src/gui/symbology/qgssvgselectorwidget.h @@ -42,7 +42,8 @@ class QTreeView; #ifndef SIP_RUN ///@cond PRIVATE -/** \ingroup gui +/** + * \ingroup gui * \class QgsSvgSelectorLoader * Recursively loads SVG images from a path in a background thread. * \since QGIS 2.18 @@ -53,25 +54,29 @@ class GUI_EXPORT QgsSvgSelectorLoader : public QThread public: - /** Constructor for QgsSvgSelectorLoader + /** + * Constructor for QgsSvgSelectorLoader * \param parent parent object */ QgsSvgSelectorLoader( QObject *parent = nullptr ); ~QgsSvgSelectorLoader(); - /** Starts the loader finding and generating previews for SVG images. foundSvgs() will be + /** + * Starts the loader finding and generating previews for SVG images. foundSvgs() will be * emitted as the loader encounters SVG images. * \brief run */ virtual void run() override; - /** Cancels the current loading operation. Waits until the thread has finished operation + /** + * Cancels the current loading operation. Waits until the thread has finished operation * before returning. */ virtual void stop(); - /** Sets the root path containing SVG images to load. If no path is set, the default SVG + /** + * Sets the root path containing SVG images to load. If no path is set, the default SVG * search paths will be used instead. */ void setPath( const QString &path ) @@ -81,7 +86,8 @@ class GUI_EXPORT QgsSvgSelectorLoader : public QThread signals: - /** Emitted when the loader has found a block of SVG images. This signal is emitted with blocks + /** + * Emitted when the loader has found a block of SVG images. This signal is emitted with blocks * of SVG images to prevent spamming any connected model. * \param svgs list of SVGs and preview images found. */ @@ -102,7 +108,8 @@ class GUI_EXPORT QgsSvgSelectorLoader : public QThread }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSvgGroupLoader * Recursively loads SVG paths in a background thread. * \since QGIS 2.18 @@ -113,24 +120,28 @@ class GUI_EXPORT QgsSvgGroupLoader : public QThread public: - /** Constructor for QgsSvgGroupLoader + /** + * Constructor for QgsSvgGroupLoader * \param parent parent object */ QgsSvgGroupLoader( QObject *parent = nullptr ); ~QgsSvgGroupLoader(); - /** Starts the loader finding folders for SVG images. + /** + * Starts the loader finding folders for SVG images. * \brief run */ virtual void run() override; - /** Cancels the current loading operation. Waits until the thread has finished operation + /** + * Cancels the current loading operation. Waits until the thread has finished operation * before returning. */ virtual void stop(); - /** Sets the root path containing child paths to find. If no path is set, the default SVG + /** + * Sets the root path containing child paths to find. If no path is set, the default SVG * search paths will be used instead. */ void setParentPaths( const QStringList &parentPaths ) @@ -140,7 +151,8 @@ class GUI_EXPORT QgsSvgGroupLoader : public QThread signals: - /** Emitted when the loader has found a block of SVG images. This signal is emitted with blocks + /** + * Emitted when the loader has found a block of SVG images. This signal is emitted with blocks * of SVG images to prevent spamming any connected model. * \param svgs list of SVGs and preview images found. */ @@ -159,7 +171,8 @@ class GUI_EXPORT QgsSvgGroupLoader : public QThread ///@endcond #endif -/** \ingroup gui +/** + * \ingroup gui * \class QgsSvgSelectorListModel * A model for displaying SVG files with a preview icon. Population of the model is performed in * a background thread to ensure that initial creation of the model is responsive and does @@ -171,14 +184,16 @@ class GUI_EXPORT QgsSvgSelectorListModel : public QAbstractListModel public: - /** Constructor for QgsSvgSelectorListModel. All SVGs in folders from the application SVG + /** + * Constructor for QgsSvgSelectorListModel. All SVGs in folders from the application SVG * search paths will be shown. * \param parent parent object * \param iconSize desired size of SVG icons to create */ QgsSvgSelectorListModel( QObject *parent SIP_TRANSFERTHIS, int iconSize = 30 ); - /** Constructor for creating a model for SVG files in a specific path. + /** + * Constructor for creating a model for SVG files in a specific path. * \param parent parent object * \param path initial path, which is recursively searched * \param iconSize desired size of SVG icons to create @@ -199,7 +214,8 @@ class GUI_EXPORT QgsSvgSelectorListModel : public QAbstractListModel private slots: - /** Called to add SVG files to the model. + /** + * Called to add SVG files to the model. * \param svgs list of SVG files to add to model. */ void addSvgs( const QStringList &svgs ); @@ -207,7 +223,8 @@ class GUI_EXPORT QgsSvgSelectorListModel : public QAbstractListModel }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSvgSelectorGroupsModel * A model for displaying SVG search paths. Population of the model is performed in * a background thread to ensure that initial creation of the model is responsive and does @@ -230,7 +247,8 @@ class GUI_EXPORT QgsSvgSelectorGroupsModel : public QStandardItemModel void addPath( const QString &parentPath, const QString &path ); }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSvgSelectorWidget */ class GUI_EXPORT QgsSvgSelectorWidget : public QWidget, private Ui::WidgetSvgSelector @@ -269,7 +287,8 @@ class GUI_EXPORT QgsSvgSelectorWidget : public QWidget, private Ui::WidgetSvgSel }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSvgSelectorDialog */ class GUI_EXPORT QgsSvgSelectorDialog : public QDialog diff --git a/src/gui/symbology/qgssymbollayerwidget.h b/src/gui/symbology/qgssymbollayerwidget.h index b665b03acf91..9b3dc4722e75 100644 --- a/src/gui/symbology/qgssymbollayerwidget.h +++ b/src/gui/symbology/qgssymbollayerwidget.h @@ -27,7 +27,8 @@ class QgsVectorLayer; class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSymbolLayerWidget */ class GUI_EXPORT QgsSymbolLayerWidget : public QWidget, protected QgsExpressionContextGenerator @@ -43,20 +44,23 @@ class GUI_EXPORT QgsSymbolLayerWidget : public QWidget, protected QgsExpressionC virtual void setSymbolLayer( QgsSymbolLayer *layer ) = 0; virtual QgsSymbolLayer *symbolLayer() = 0; - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \param context symbol widget context * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; - /** Returns the vector layer associated with the widget. + /** + * Returns the vector layer associated with the widget. * \since QGIS 2.12 */ const QgsVectorLayer *vectorLayer() const { return mVectorLayer; } @@ -107,7 +111,8 @@ class GUI_EXPORT QgsSymbolLayerWidget : public QWidget, protected QgsExpressionC class QgsSimpleLineSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSimpleLineSymbolLayerWidget */ class GUI_EXPORT QgsSimpleLineSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetSimpleLine @@ -157,7 +162,8 @@ class GUI_EXPORT QgsSimpleLineSymbolLayerWidget : public QgsSymbolLayerWidget, p class QgsSimpleMarkerSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSimpleMarkerSymbolLayerWidget */ class GUI_EXPORT QgsSimpleMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetSimpleMarker @@ -207,7 +213,8 @@ class GUI_EXPORT QgsSimpleMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, class QgsSimpleFillSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSimpleFillSymbolLayerWidget */ class GUI_EXPORT QgsSimpleFillSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetSimpleFill @@ -244,7 +251,8 @@ class GUI_EXPORT QgsSimpleFillSymbolLayerWidget : public QgsSymbolLayerWidget, p class QgsFilledMarkerSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsFilledMarkerSymbolLayerWidget * \brief Widget for configuring QgsFilledMarkerSymbolLayer symbol layers. * \since QGIS 2.16 @@ -255,13 +263,15 @@ class GUI_EXPORT QgsFilledMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, public: - /** Constructor for QgsFilledMarkerSymbolLayerWidget. + /** + * Constructor for QgsFilledMarkerSymbolLayerWidget. * \param vl associated vector layer * \param parent parent widget */ QgsFilledMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = 0 ); - /** Creates a new QgsFilledMarkerSymbolLayerWidget. + /** + * Creates a new QgsFilledMarkerSymbolLayerWidget. * \param vl associated vector layer */ static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsFilledMarkerSymbolLayerWidget( vl ); } @@ -296,7 +306,8 @@ class GUI_EXPORT QgsFilledMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, class QgsGradientFillSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsGradientFillSymbolLayerWidget */ class GUI_EXPORT QgsGradientFillSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetGradientFill @@ -316,7 +327,8 @@ class GUI_EXPORT QgsGradientFillSymbolLayerWidget : public QgsSymbolLayerWidget, void setColor( const QColor &color ); void setColor2( const QColor &color ); - /** Applies the color ramp passed on by the color ramp button + /** + * Applies the color ramp passed on by the color ramp button */ void applyColorRamp(); @@ -339,7 +351,8 @@ class GUI_EXPORT QgsGradientFillSymbolLayerWidget : public QgsSymbolLayerWidget, class QgsShapeburstFillSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsShapeburstFillSymbolLayerWidget */ class GUI_EXPORT QgsShapeburstFillSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetShapeburstFill @@ -378,7 +391,8 @@ class GUI_EXPORT QgsShapeburstFillSymbolLayerWidget : public QgsSymbolLayerWidge class QgsMarkerLineSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsMarkerLineSymbolLayerWidget */ class GUI_EXPORT QgsMarkerLineSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetMarkerLine @@ -417,7 +431,8 @@ class GUI_EXPORT QgsMarkerLineSymbolLayerWidget : public QgsSymbolLayerWidget, p class QgsSvgMarkerSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSvgMarkerSymbolLayerWidget */ class GUI_EXPORT QgsSvgMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetSvgMarker @@ -477,7 +492,8 @@ class GUI_EXPORT QgsSvgMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, pr class QgsRasterFillSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsRasterFillSymbolLayerWidget */ class GUI_EXPORT QgsRasterFillSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetRasterFill @@ -517,7 +533,8 @@ class GUI_EXPORT QgsRasterFillSymbolLayerWidget : public QgsSymbolLayerWidget, p class QgsSVGFillSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSVGFillSymbolLayerWidget */ class GUI_EXPORT QgsSVGFillSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetSVGFill @@ -537,7 +554,8 @@ class GUI_EXPORT QgsSVGFillSymbolLayerWidget : public QgsSymbolLayerWidget, priv QgsSVGFillSymbolLayer *mLayer = nullptr; void insertIcons(); - /** Enables or disables svg fill color, stroke color and stroke width based on whether the + /** + * Enables or disables svg fill color, stroke color and stroke width based on whether the * svg file supports custom parameters. * \param resetValues set to true to overwrite existing layer fill color, stroke color and stroke width * with default values from svg file @@ -565,7 +583,8 @@ class GUI_EXPORT QgsSVGFillSymbolLayerWidget : public QgsSymbolLayerWidget, priv class QgsLinePatternFillSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsLinePatternFillSymbolLayerWidget */ class GUI_EXPORT QgsLinePatternFillSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetLinePatternFill @@ -597,7 +616,8 @@ class GUI_EXPORT QgsLinePatternFillSymbolLayerWidget : public QgsSymbolLayerWidg class QgsPointPatternFillSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsPointPatternFillSymbolLayerWidget */ class GUI_EXPORT QgsPointPatternFillSymbolLayerWidget: public QgsSymbolLayerWidget, private Ui::WidgetPointPatternFill @@ -632,7 +652,8 @@ class GUI_EXPORT QgsPointPatternFillSymbolLayerWidget: public QgsSymbolLayerWidg class QgsFontMarkerSymbolLayer; class CharacterWidget; -/** \ingroup gui +/** + * \ingroup gui * \class QgsFontMarkerSymbolLayerWidget */ class GUI_EXPORT QgsFontMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetFontMarker @@ -652,7 +673,8 @@ class GUI_EXPORT QgsFontMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, p void setFontFamily( const QFont &font ); void setColor( const QColor &color ); - /** Set stroke color. + /** + * Set stroke color. * \since QGIS 2.16 */ void setColorStroke( const QColor &color ); void setSize( double size ); @@ -688,7 +710,8 @@ class GUI_EXPORT QgsFontMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, p class QgsCentroidFillSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsCentroidFillSymbolLayerWidget */ class GUI_EXPORT QgsCentroidFillSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::WidgetCentroidFill @@ -719,7 +742,8 @@ class GUI_EXPORT QgsCentroidFillSymbolLayerWidget : public QgsSymbolLayerWidget, class QgsGeometryGeneratorSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsGeometryGeneratorSymbolLayerWidget */ class GUI_EXPORT QgsGeometryGeneratorSymbolLayerWidget : public QgsSymbolLayerWidget, private Ui::GeometryGeneratorWidgetBase diff --git a/src/gui/symbology/qgssymbollevelsdialog.h b/src/gui/symbology/qgssymbollevelsdialog.h index b5ed6c3e3bf2..d16e1762995f 100644 --- a/src/gui/symbology/qgssymbollevelsdialog.h +++ b/src/gui/symbology/qgssymbollevelsdialog.h @@ -27,7 +27,8 @@ #include "ui_qgssymbollevelsdialogbase.h" #include "qgis_gui.h" -/** \class QgsSymbolLevelsWidget +/** + * \class QgsSymbolLevelsWidget * \ingroup gui * A widget which allows the user to modify the rendering order of symbol layers. * \see QgsSymbolLevelsDialog @@ -43,7 +44,8 @@ class GUI_EXPORT QgsSymbolLevelsWidget : public QgsPanelWidget, private Ui::QgsS //! Returns whether the level ordering is enabled bool usingLevels() const; - /** Sets whether the level ordering is always forced on and hide the checkbox (used by rule-based renderer) + /** + * Sets whether the level ordering is always forced on and hide the checkbox (used by rule-based renderer) * \param enabled toggle level ordering */ void setForceOrderingEnabled( bool enabled ); @@ -79,7 +81,8 @@ class GUI_EXPORT QgsSymbolLevelsWidget : public QgsPanelWidget, private Ui::QgsS #endif }; -/** \class QgsSymbolLevelsDialog +/** + * \class QgsSymbolLevelsDialog * \ingroup gui * A dialog which allows the user to modify the rendering order of symbol layers. * \see QgsSymbolLevelsWidget diff --git a/src/gui/symbology/qgssymbolselectordialog.h b/src/gui/symbology/qgssymbolselectordialog.h index 8e51c7d39a1f..7d44464ba36c 100644 --- a/src/gui/symbology/qgssymbolselectordialog.h +++ b/src/gui/symbology/qgssymbolselectordialog.h @@ -81,7 +81,8 @@ class DataDefinedRestorer: public QObject class QgsSymbolSelectorDialog; -/** \ingroup gui +/** + * \ingroup gui * Symbol selector widget that can be used to select and build a symbol */ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::QgsSymbolSelectorDialogBase @@ -104,14 +105,16 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs //! return menu for "advanced" button - create it if doesn't exist and show the advanced button QMenu *advancedMenu(); - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \param context symbol widget context * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \see setContext() * \since QGIS 3.0 */ @@ -249,7 +252,8 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs QgsSymbolWidgetContext mContext; }; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSymbolSelectorDialog */ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog @@ -263,14 +267,16 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog //! return menu for "advanced" button - create it if doesn't exist and show the advanced button QMenu *advancedMenu(); - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \param context symbol widget context * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \see setContext() * \since QGIS 3.0 */ diff --git a/src/gui/symbology/qgssymbolslistwidget.h b/src/gui/symbology/qgssymbolslistwidget.h index e4b366dd081d..7b434c4700b5 100644 --- a/src/gui/symbology/qgssymbolslistwidget.h +++ b/src/gui/symbology/qgssymbolslistwidget.h @@ -29,7 +29,8 @@ class QgsStyle; class QMenu; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSymbolsListWidget */ class GUI_EXPORT QgsSymbolsListWidget : public QWidget, private Ui::SymbolsListWidget, private QgsExpressionContextGenerator @@ -42,20 +43,23 @@ class GUI_EXPORT QgsSymbolsListWidget : public QWidget, private Ui::SymbolsListW virtual ~QgsSymbolsListWidget(); - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \param context symbol widget context * \see context() * \since QGIS 3.0 */ void setContext( const QgsSymbolWidgetContext &context ); - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + /** + * Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \see setContext() * \since QGIS 3.0 */ QgsSymbolWidgetContext context() const; - /** Returns the vector layer associated with the widget. + /** + * Returns the vector layer associated with the widget. * \since QGIS 2.12 */ const QgsVectorLayer *layer() const { return mLayer; } diff --git a/src/gui/symbology/qgssymbolwidgetcontext.h b/src/gui/symbology/qgssymbolwidgetcontext.h index bcfbae5b9648..97f2f3153021 100644 --- a/src/gui/symbology/qgssymbolwidgetcontext.h +++ b/src/gui/symbology/qgssymbolwidgetcontext.h @@ -24,7 +24,8 @@ class QgsMapCanvas; -/** \ingroup gui +/** + * \ingroup gui * \class QgsSymbolWidgetContext * Contains settings which reflect the context in which a symbol (or renderer) widget is shown, e.g., the * map canvas and relevant expression contexts. @@ -40,26 +41,30 @@ class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three */ QgsSymbolWidgetContext() = default; - /** Copy constructor. + /** + * Copy constructor. * \param other source QgsSymbolWidgetContext */ QgsSymbolWidgetContext( const QgsSymbolWidgetContext &other ); QgsSymbolWidgetContext &operator=( const QgsSymbolWidgetContext &other ); - /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current + /** + * Sets the map canvas associated with the widget. This allows the widget to retrieve the current * map scale and other properties from the canvas. * \param canvas map canvas * \see mapCanvas() */ void setMapCanvas( QgsMapCanvas *canvas ); - /** Returns the map canvas associated with the widget. + /** + * Returns the map canvas associated with the widget. * \see setMapCanvas() */ QgsMapCanvas *mapCanvas() const; - /** Sets the optional expression context used for the widget. This expression context is used for + /** + * Sets the optional expression context used for the widget. This expression context is used for * evaluating data defined symbol properties and for populating based expression widgets in * the layer widget. * \param context expression context pointer. Ownership is not transferred. @@ -68,25 +73,29 @@ class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three */ void setExpressionContext( QgsExpressionContext *context ); - /** Returns the expression context used for the widget, if set. This expression context is used for + /** + * Returns the expression context used for the widget, if set. This expression context is used for * evaluating data defined symbol properties and for populating based expression widgets in * the layer widget. * \see setExpressionContext() */ QgsExpressionContext *expressionContext() const; - /** Sets a list of additional expression context scopes to show as available within the layer. + /** + * Sets a list of additional expression context scopes to show as available within the layer. * \param scopes list of additional scopes which will be added in order to the end of the default expression context * \see setExpressionContext() */ void setAdditionalExpressionContextScopes( const QList< QgsExpressionContextScope > &scopes ); - /** Returns the list of additional expression context scopes to show as available within the layer. + /** + * Returns the list of additional expression context scopes to show as available within the layer. * \see setAdditionalExpressionContextScopes() */ QList< QgsExpressionContextScope > additionalExpressionContextScopes() const; - /** Returns list of scopes: global, project, atlas, map, layer. + /** + * Returns list of scopes: global, project, atlas, map, layer. * Ownership is transferred to the caller. * \since QGIS 3.0 */ diff --git a/src/gui/symbology/qgsvectorfieldsymbollayerwidget.h b/src/gui/symbology/qgsvectorfieldsymbollayerwidget.h index 2045079d5916..e14f40b9f94b 100644 --- a/src/gui/symbology/qgsvectorfieldsymbollayerwidget.h +++ b/src/gui/symbology/qgsvectorfieldsymbollayerwidget.h @@ -22,7 +22,8 @@ class QgsVectorFieldSymbolLayer; -/** \ingroup gui +/** + * \ingroup gui * \class QgsVectorFieldSymbolLayerWidget */ class GUI_EXPORT QgsVectorFieldSymbolLayerWidget: public QgsSymbolLayerWidget, private Ui::WidgetVectorFieldBase diff --git a/src/plugins/coordinate_capture/coordinatecapture.h b/src/plugins/coordinate_capture/coordinatecapture.h index 25768e327c38..62d81488b685 100644 --- a/src/plugins/coordinate_capture/coordinatecapture.h +++ b/src/plugins/coordinate_capture/coordinatecapture.h @@ -97,7 +97,8 @@ class CoordinateCapture: public QObject, public QgisPlugin //! Called when mouse clicks on the canvas. Will populate text box with coords. void mouseClicked( const QgsPointXY &point ); - /** Called when mouse moved over the canvas. If the tracking button is toggled, + /** + * Called when mouse moved over the canvas. If the tracking button is toggled, * the text box coords will be updated. */ void mouseMoved( const QgsPointXY &point ); //! Called when mouse is clicked on the canvas diff --git a/src/plugins/georeferencer/qgsresidualplotitem.h b/src/plugins/georeferencer/qgsresidualplotitem.h index 2df2a1ea1675..107baed83d05 100644 --- a/src/plugins/georeferencer/qgsresidualplotitem.h +++ b/src/plugins/georeferencer/qgsresidualplotitem.h @@ -20,7 +20,8 @@ #include "qgsgcplist.h" #include "qgsrectangle.h" -/** A composer item to visualise the distribution of georeference residuals. For the visualisation, +/** + * A composer item to visualise the distribution of georeference residuals. For the visualisation, the length of the residual arrows are scaled*/ class QgsResidualPlotItem: public QgsComposerItem { diff --git a/src/plugins/gps_importer/qgsgpsplugin.h b/src/plugins/gps_importer/qgsgpsplugin.h index ae21d6b08c11..397a053f6b1b 100644 --- a/src/plugins/gps_importer/qgsgpsplugin.h +++ b/src/plugins/gps_importer/qgsgpsplugin.h @@ -28,14 +28,16 @@ class QgisInterface; class QgsVectorLayer; class QAction; -/** A plugin with various GPS tools. +/** + * A plugin with various GPS tools. */ class QgsGPSPlugin: public QObject, public QgisPlugin { Q_OBJECT public: - /** Constructor for a plugin. The QgisInterface pointer + /** + * Constructor for a plugin. The QgisInterface pointer * is passed by QGIS when it attempts to instantiate the plugin. * \param qI Pointer to the QgisInterface object. */ diff --git a/src/plugins/grass/qgsgrassmodule.h b/src/plugins/grass/qgsgrassmodule.h index 52745c3c4870..8f7b71db9317 100644 --- a/src/plugins/grass/qgsgrassmodule.h +++ b/src/plugins/grass/qgsgrassmodule.h @@ -27,7 +27,8 @@ class QDomNode; class QDomElement; -/** \class QgsGrassModule +/** + * \class QgsGrassModule * \brief Interface to GRASS modules. * */ @@ -62,7 +63,8 @@ class QgsGrassModule : public QWidget, private Ui::QgsGrassModuleBase //! Returns module label for module description path static QString label( QString path ); - /** \brief Returns pixmap representing the module + /** + * \brief Returns pixmap representing the module * \param path module path without .qgm extension */ static QPixmap pixmap( QString path, int height ); @@ -126,7 +128,8 @@ class QgsGrassModule : public QWidget, private Ui::QgsGrassModuleBase private: - /** Set progress bar or busy indicator if percent is 100 + /** + * Set progress bar or busy indicator if percent is 100 * \param percent progress to show in % * \param force to set progress for 100% */ void setProgress( int percent, bool force = false ); diff --git a/src/plugins/grass/qgsgrassmoduleinput.h b/src/plugins/grass/qgsgrassmoduleinput.h index d3cf6b44f61f..47841ab05f43 100644 --- a/src/plugins/grass/qgsgrassmoduleinput.h +++ b/src/plugins/grass/qgsgrassmoduleinput.h @@ -222,7 +222,8 @@ class QgsGrassModuleInputSelectedView : public QTreeView }; -/** \class QgsGrassModuleInput +/** + * \class QgsGrassModuleInput * \brief Class representing raster or vector module input */ class QgsGrassModuleInput : public QgsGrassModuleGroupBoxItem @@ -231,7 +232,8 @@ class QgsGrassModuleInput : public QgsGrassModuleGroupBoxItem public: - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file */ diff --git a/src/plugins/grass/qgsgrassmoduleoptions.h b/src/plugins/grass/qgsgrassmoduleoptions.h index 97322834d31e..1d0d18444efd 100644 --- a/src/plugins/grass/qgsgrassmoduleoptions.h +++ b/src/plugins/grass/qgsgrassmoduleoptions.h @@ -37,7 +37,8 @@ class QgsGrassModule; class QgisInterface; class QgsMapCanvas; -/** \class QgsGrassModuleOptions +/** + * \class QgsGrassModuleOptions * \brief Widget with GRASS options.QgsGrassTools * */ @@ -132,7 +133,8 @@ class QgsGrassModuleOptions QStringList mErrors; }; -/** \class QgsGrassModuleStandardOptions +/** + * \class QgsGrassModuleStandardOptions * \brief Widget with GRASS standard options. * */ @@ -176,12 +178,14 @@ class QgsGrassModuleStandardOptions: public QWidget, public QgsGrassModuleOption private: - /** Read and parse module options (--interface-description). + /** + * Read and parse module options (--interface-description). * \param errors - list to which possible errors are added */ QDomDocument readInterfaceDescription( const QString &xname, QStringList &errors ); - /** Get region for currently selected map. It will show warning dialog if region could not be read. + /** + * Get region for currently selected map. It will show warning dialog if region could not be read. * \returns true if region was successfully read */ bool getCurrentMapRegion( QgsGrassModuleInput *param, struct Cell_head *window ); diff --git a/src/plugins/grass/qgsgrassmoduleparam.h b/src/plugins/grass/qgsgrassmoduleparam.h index 5b8d69cd9719..092aa8784d2f 100644 --- a/src/plugins/grass/qgsgrassmoduleparam.h +++ b/src/plugins/grass/qgsgrassmoduleparam.h @@ -46,7 +46,8 @@ extern "C" } /****************** QgsGrassModuleCheckBox ************************/ -/** \class QgsGrassModuleCheckBox +/** + * \class QgsGrassModuleCheckBox * \brief Checkbox with elided text */ class QgsGrassModuleCheckBox : public QCheckBox @@ -55,7 +56,8 @@ class QgsGrassModuleCheckBox : public QCheckBox public: - /** \brief Constructor + /** + * \brief Constructor */ QgsGrassModuleCheckBox( const QString &text, QWidget *parent = 0 ); @@ -75,14 +77,16 @@ class QgsGrassModuleCheckBox : public QCheckBox QString mTip; }; -/** \class QgsGrassModuleItem +/** + * \class QgsGrassModuleItem * \brief GRASS module option */ class QgsGrassModuleParam { public: - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file * \param gnode option node in GRASS module XML description file @@ -113,7 +117,8 @@ class QgsGrassModuleParam QStringList errors() { return mErrors; } - /** Get gisprompt attribute + /** + * Get gisprompt attribute * @paream name gisprompt tag attribute name (age, element, prompt) */ static QString getDescPrompt( QDomElement descDomElement, const QString &name ); @@ -121,7 +126,8 @@ class QgsGrassModuleParam //! Find element in GRASS module description by key, if not found, returned element is null static QDomNode nodeByKey( QDomElement descDocElement, QString key ); - /** Find list of elements in GRASS module description by option type. + /** + * Find list of elements in GRASS module description by option type. * Option type is identified by gisprompt prompt. Only few types are supported */ static QList nodesByType( QDomElement descDomElement, STD_OPT optionType, const QString &age = QString() ); @@ -162,7 +168,8 @@ class QgsGrassModuleParam /****************** QgsGrassModuleGroupBoxItem ************************/ -/** \class QgsGrassModuleGroupBoxItem +/** + * \class QgsGrassModuleGroupBoxItem * \brief GRASS module option box */ class QgsGrassModuleGroupBoxItem : public QGroupBox, public QgsGrassModuleParam @@ -171,7 +178,8 @@ class QgsGrassModuleGroupBoxItem : public QGroupBox, public QgsGrassModuleParam public: - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file * \param gnode option node in GRASS module XML description file @@ -189,7 +197,8 @@ class QgsGrassModuleGroupBoxItem : public QGroupBox, public QgsGrassModuleParam /****************** QgsGrassModuleMultiParam ************************/ -/** \class QgsGrassModuleMultiParam +/** + * \class QgsGrassModuleMultiParam * \brief GRASS module multiple params box */ class QgsGrassModuleMultiParam : public QgsGrassModuleGroupBoxItem @@ -224,7 +233,8 @@ class QgsGrassModuleMultiParam : public QgsGrassModuleGroupBoxItem /****************** QgsGrassModuleOption ************************/ -/** \class QgsGrassModuleOption +/** + * \class QgsGrassModuleOption * \brief GRASS option */ class QgsGrassModuleOption : public QgsGrassModuleMultiParam @@ -233,7 +243,8 @@ class QgsGrassModuleOption : public QgsGrassModuleMultiParam public: - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file */ @@ -327,7 +338,8 @@ class QgsGrassModuleOption : public QgsGrassModuleMultiParam }; /********************** QgsGrassModuleFlag ************************/ -/** \class QgsGrassModuleFlag +/** + * \class QgsGrassModuleFlag * \brief GRASS flag */ class QgsGrassModuleFlag : public QgsGrassModuleCheckBox, public QgsGrassModuleParam @@ -336,7 +348,8 @@ class QgsGrassModuleFlag : public QgsGrassModuleCheckBox, public QgsGrassModuleP public: - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file */ @@ -351,7 +364,8 @@ class QgsGrassModuleFlag : public QgsGrassModuleCheckBox, public QgsGrassModuleP /*********************** QgsGrassModuleGdalInput **********************/ -/** \class QgsGrassModuleGdalInput +/** + * \class QgsGrassModuleGdalInput * \brief GDAL/OGR module input */ class QgsGrassModuleGdalInput : public QgsGrassModuleGroupBoxItem @@ -361,7 +375,8 @@ class QgsGrassModuleGdalInput : public QgsGrassModuleGroupBoxItem public: enum Type { Gdal, Ogr }; - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file */ @@ -411,7 +426,8 @@ class QgsGrassModuleGdalInput : public QgsGrassModuleGroupBoxItem /*********************** QgsGrassModuleField **********************/ -/** \class QgsGrassModuleField +/** + * \class QgsGrassModuleField * \brief GRASS column, not existing column of input vector, may be output column or input column from a table not linked to layer */ class QgsGrassModuleField : public QgsGrassModuleOption @@ -420,7 +436,8 @@ class QgsGrassModuleField : public QgsGrassModuleOption public: - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file */ @@ -431,7 +448,8 @@ class QgsGrassModuleField : public QgsGrassModuleOption /*********************** QgsGrassModuleVectorField **********************/ -/** \class QgsGrassModuleVectorField +/** + * \class QgsGrassModuleVectorField * \brief GRASS vector attribute column. */ class QgsGrassModuleVectorField : public QgsGrassModuleMultiParam @@ -440,7 +458,8 @@ class QgsGrassModuleVectorField : public QgsGrassModuleMultiParam public: - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file */ @@ -485,7 +504,8 @@ class QgsGrassModuleVectorField : public QgsGrassModuleMultiParam /*********************** QgsGrassModuleSelection **********************/ -/** \class QgsGrassModuleSelection +/** + * \class QgsGrassModuleSelection * \brief List of categories taken from current layer selection. */ class QgsGrassModuleSelection : public QgsGrassModuleGroupBoxItem @@ -501,7 +521,8 @@ class QgsGrassModuleSelection : public QgsGrassModuleGroupBoxItem Expression // expression builder - possible? }; - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file */ @@ -556,7 +577,8 @@ class QgsGrassModuleSelection : public QgsGrassModuleGroupBoxItem /*********************** QgsGrassModuleFile **********************/ -/** \class QgsGrassModuleFile +/** + * \class QgsGrassModuleFile * \brief Input/output file. */ class QgsGrassModuleFile : public QgsGrassModuleGroupBoxItem @@ -565,7 +587,8 @@ class QgsGrassModuleFile : public QgsGrassModuleGroupBoxItem public: - /** \brief Constructor + /** + * \brief Constructor * \param qdesc option element in QGIS module description XML file * \param gdesc GRASS module XML description file */ diff --git a/src/plugins/grass/qgsgrassnewmapset.h b/src/plugins/grass/qgsgrassnewmapset.h index 98d8e4d3c6ec..b49972d1107f 100644 --- a/src/plugins/grass/qgsgrassnewmapset.h +++ b/src/plugins/grass/qgsgrassnewmapset.h @@ -30,7 +30,8 @@ extern "C" } -/** \class QgsGrassNewMapset +/** + * \class QgsGrassNewMapset * \brief GRASS vector edit. * */ diff --git a/src/plugins/grass/qgsgrassregion.h b/src/plugins/grass/qgsgrassregion.h index cd4ea2fcb99e..42eb3cbe1daf 100644 --- a/src/plugins/grass/qgsgrassregion.h +++ b/src/plugins/grass/qgsgrassregion.h @@ -37,7 +37,8 @@ extern "C" #include } -/** \class QgsGrassRegion +/** + * \class QgsGrassRegion * \brief GRASS attributes. * */ diff --git a/src/plugins/grass/qgsgrassselect.h b/src/plugins/grass/qgsgrassselect.h index 8f9b9557e9a4..cfdf5d3df0a0 100644 --- a/src/plugins/grass/qgsgrassselect.h +++ b/src/plugins/grass/qgsgrassselect.h @@ -17,7 +17,8 @@ #define QGSGRASSSELECT_H #include "ui_qgsgrassselectbase.h" -/** \class QgsGrassSelect +/** + * \class QgsGrassSelect * \brief Dialog to select GRASS layer. * */ diff --git a/src/plugins/grass/qgsgrasstools.h b/src/plugins/grass/qgsgrasstools.h index 777e38723e62..7a295cc4a147 100644 --- a/src/plugins/grass/qgsgrasstools.h +++ b/src/plugins/grass/qgsgrasstools.h @@ -34,7 +34,8 @@ class QgsMapCanvas; class QgsGrassRegion; class QgsGrassToolsTreeFilterProxyModel; -/** \class QgsGrassTools +/** + * \class QgsGrassTools * \brief Interface to GRASS modules. * */ diff --git a/src/plugins/grass/qgsgrassutils.h b/src/plugins/grass/qgsgrassutils.h index 6f383f40fb65..263fa3ea87b4 100644 --- a/src/plugins/grass/qgsgrassutils.h +++ b/src/plugins/grass/qgsgrassutils.h @@ -23,7 +23,8 @@ class QLabel; class QPushButton; class QgisInterface; -/** \class QgsGrassUtils +/** + * \class QgsGrassUtils * \brief Various utilities. */ class QgsGrassUtils @@ -48,7 +49,8 @@ class QgsGrassUtils static QString htmlBrowserPath(); }; -/** \class QgsGrassElementDialog +/** + * \class QgsGrassElementDialog * \brief Get name for new element */ class QgsGrassElementDialog: public QObject diff --git a/src/plugins/qgisplugin.h b/src/plugins/qgisplugin.h index 72b23ccac3b1..238be3451266 100644 --- a/src/plugins/qgisplugin.h +++ b/src/plugins/qgisplugin.h @@ -13,7 +13,8 @@ * * ***************************************************************************/ -/** QGIS - Plugin API +/** + * QGIS - Plugin API * * \section about About QGis Plugins * Plugins provide additional functionality to QGis. Plugins must @@ -43,7 +44,8 @@ class QgisInterface; //#include "qgisplugingui.h" -/** \ingroup plugins +/** + * \ingroup plugins * \class QgisPlugin * \brief Abstract base class from which all plugins must inherit * \note not available in Python bindings diff --git a/src/plugins/qgsapplydialog.h b/src/plugins/qgsapplydialog.h index fdf0cbfd16f3..9f23d51ae68f 100644 --- a/src/plugins/qgsapplydialog.h +++ b/src/plugins/qgsapplydialog.h @@ -19,7 +19,8 @@ #include -/** \ingroup plugins +/** + * \ingroup plugins * \brief Interface class for dialogs that have an apply operation (e.g. for symbology) * \note not available in Python bindings */ diff --git a/src/providers/arcgisrest/qgsarcgisservicesourceselect.h b/src/providers/arcgisrest/qgsarcgisservicesourceselect.h index 653ee16f080b..93594d406ce7 100644 --- a/src/providers/arcgisrest/qgsarcgisservicesourceselect.h +++ b/src/providers/arcgisrest/qgsarcgisservicesourceselect.h @@ -83,14 +83,16 @@ class QgsArcGisServiceSourceSelect : public QgsAbstractDataSourceWidget, protect //! A layer is added from the dialog virtual void addServiceLayer( QString uri, QString typeName ) = 0; - /** Returns the best suited CRS from a set of authority ids + /** + * Returns the best suited CRS from a set of authority ids 1. project CRS if contained in the set 2. WGS84 if contained in the set 3. the first entry in the set else \returns the authority id of the crs or an empty string in case of error*/ QString getPreferredCrs( const QSet &crsSet ) const; - /** Store a pointer to map canvas to retrieve extent and CRS + /** + * Store a pointer to map canvas to retrieve extent and CRS * Used to select an appropriate CRS and possibly to retrieve data only in the current extent */ QgsMapCanvas *mMapCanvas = nullptr; diff --git a/src/providers/db2/qgsdb2newconnection.h b/src/providers/db2/qgsdb2newconnection.h index 2b4037f47bd4..56493a78c1bf 100644 --- a/src/providers/db2/qgsdb2newconnection.h +++ b/src/providers/db2/qgsdb2newconnection.h @@ -21,7 +21,8 @@ #include "qgsguiutils.h" #include "qgshelp.h" -/** \class QgsDb2NewConnection +/** + * \class QgsDb2NewConnection * \brief Dialog to allow the user to configure and save connection * information for an DB2 database */ diff --git a/src/providers/db2/qgsdb2sourceselect.h b/src/providers/db2/qgsdb2sourceselect.h index b7693afb6a41..ecbded96e41d 100644 --- a/src/providers/db2/qgsdb2sourceselect.h +++ b/src/providers/db2/qgsdb2sourceselect.h @@ -81,7 +81,8 @@ class QgsDb2GeomColumnTypeThread : public QThread }; -/** \class QgsDb2SourceSelect +/** + * \class QgsDb2SourceSelect * \brief Dialog to create connections and add tables from Db2. * * This dialog allows the user to define and save connection information @@ -118,7 +119,8 @@ class QgsDb2SourceSelect : public QgsAbstractDataSourceWidget, private Ui::QgsDb //! Triggered when the provider's connections need to be refreshed void refresh() override; - /** Connects to the database using the stored connection parameters. + /** + * Connects to the database using the stored connection parameters. * Once connected, available layers are displayed. */ void on_btnConnect_clicked(); diff --git a/src/providers/db2/qgsdb2tablemodel.h b/src/providers/db2/qgsdb2tablemodel.h index 97acbb759cc3..a05a561dfd6d 100644 --- a/src/providers/db2/qgsdb2tablemodel.h +++ b/src/providers/db2/qgsdb2tablemodel.h @@ -40,7 +40,8 @@ struct QgsDb2LayerProperty class QIcon; -/** A model that holds the tables of a database in a hierarchy where the +/** + * A model that holds the tables of a database in a hierarchy where the schemas are the root elements that contain the individual tables as children. The tables have the following columns: Type, Schema, Tablename, Geometry Column, Sql*/ class QgsDb2TableModel : public QStandardItemModel @@ -55,7 +56,8 @@ class QgsDb2TableModel : public QStandardItemModel //! Sets an sql statement that belongs to a cell specified by a model index void setSql( const QModelIndex &index, const QString &sql ); - /** Sets one or more geometry types to a row. In case of several types, additional rows are inserted. + /** + * Sets one or more geometry types to a row. In case of several types, additional rows are inserted. This is for tables where the type is detected later by thread*/ void setGeometryTypesForTable( QgsDb2LayerProperty layerProperty ); diff --git a/src/providers/delimitedtext/qgsdelimitedtextfile.h b/src/providers/delimitedtext/qgsdelimitedtextfile.h index 5ec71748c973..8c1987ce9307 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextfile.h +++ b/src/providers/delimitedtext/qgsdelimitedtextfile.h @@ -98,12 +98,14 @@ class QgsDelimitedTextFile : public QObject virtual ~QgsDelimitedTextFile(); - /** Set the filename + /** + * Set the filename * \param filename the name of the file */ void setFileName( const QString &filename ); - /** Return the filename + /** + * Return the filename * \returns filename the name of the file */ QString fileName() @@ -111,41 +113,49 @@ class QgsDelimitedTextFile : public QObject return mFileName; } - /** Set the file encoding (defuault is UTF-8) + /** + * Set the file encoding (defuault is UTF-8) * \param encoding the encoding to use for the fileName() */ void setEncoding( const QString &encoding ); - /** Return the file encoding + /** + * Return the file encoding * \returns encoding The file encoding */ QString encoding() { return mEncoding; } - /** Decode the parser settings from a url as a string + /** + * Decode the parser settings from a url as a string * \param url The url from which the delimiter and delimiterType items are read */ bool setFromUrl( const QString &url ); - /** Decode the parser settings from a url + /** + * Decode the parser settings from a url * \param url The url from which the delimiter and delimiterType items are read */ bool setFromUrl( const QUrl &url ); - /** Encode the parser settings into a QUrl + /** + * Encode the parser settings into a QUrl * \returns url The url into which the delimiter and delimiterType items are set */ QUrl url(); - /** Set the parser for parsing CSV files + /** + * Set the parser for parsing CSV files */ void setTypeWhitespace(); - /** Set the parser for parsing based on a reqular expression delimiter + /** + * Set the parser for parsing based on a reqular expression delimiter * \param regexp A string defining the regular expression */ void setTypeRegexp( const QString ®exp ); - /** Set the parser to use a character type delimiter. + /** + * Set the parser to use a character type delimiter. * \param delim The field delimiter character set * \param quote The quote character, used to define quoted fields * \param escape The escape character used to escape quote or delim @@ -153,12 +163,14 @@ class QgsDelimitedTextFile : public QObject */ void setTypeCSV( const QString &delim = QString( "," ), const QString "e = QString( "\"" ), const QString &escape = QString( "\"" ) ); - /** Set the number of header lines to skip + /** + * Set the number of header lines to skip * \param skiplines The maximum lines to skip */ void setSkipLines( int skiplines ); - /** Return the number of header lines to skip + /** + * Return the number of header lines to skip * \returns skiplines The maximum lines to skip */ int skipLines() @@ -166,12 +178,14 @@ class QgsDelimitedTextFile : public QObject return mSkipLines; } - /** Set reading field names from the first record + /** + * Set reading field names from the first record * \param useheaders Field names will be read if true */ void setUseHeader( bool useheader = true ); - /** Return the option for reading field names from the first record + /** + * Return the option for reading field names from the first record * \returns useheaders Field names will be read if true */ bool useHeader() @@ -179,12 +193,14 @@ class QgsDelimitedTextFile : public QObject return mUseHeader; } - /** Set the option for dicarding empty fields + /** + * Set the option for dicarding empty fields * \param useheaders Empty fields will be discarded if true */ void setDiscardEmptyFields( bool discardEmptyFields = true ); - /** Return the option for discarding empty fields + /** + * Return the option for discarding empty fields * \returns useheaders Empty fields will be discarded if true */ bool discardEmptyFields() @@ -192,12 +208,14 @@ class QgsDelimitedTextFile : public QObject return mDiscardEmptyFields; } - /** Set the option for trimming whitespace from fields + /** + * Set the option for trimming whitespace from fields * \param trimFields Fields will be trimmed if true */ void setTrimFields( bool trimFields = true ); - /** Return the option for trimming empty fields + /** + * Return the option for trimming empty fields * \returns useheaders Empty fields will be trimmed if true */ bool trimFields() @@ -205,18 +223,21 @@ class QgsDelimitedTextFile : public QObject return mTrimFields; } - /** Set the maximum number of fields that will be read from a record + /** + * Set the maximum number of fields that will be read from a record * By default the maximum number is unlimited (0) * \param maxFields The maximum number of fields that will be read */ void setMaxFields( int maxFields ); - /** Return the maximum number of fields that will be read + /** + * Return the maximum number of fields that will be read * \returns maxFields The maximum number of fields that will be read */ int maxFields() { return mMaxFields; } - /** Set the field names + /** + * Set the field names * Field names are set from QStringList. Names may be modified * to ensure that they are unique, not empty, and do not conflict * with default field name (field_##) @@ -224,7 +245,8 @@ class QgsDelimitedTextFile : public QObject */ void setFieldNames( const QStringList &names ); - /** Return the field names read from the header, or default names + /** + * Return the field names read from the header, or default names * field_## if none defined. Will open and read the head of the file * if required, then reset. Note that if header record record has * not been read then the field names are empty until records have @@ -234,7 +256,8 @@ class QgsDelimitedTextFile : public QObject */ QStringList &fieldNames(); - /** Return the index of a names field + /** + * Return the index of a names field * \param name The name of the field to find. This will also accept an * integer string ("1" = first field). * \returns index The zero based index of the field name, or -1 if the field @@ -242,7 +265,8 @@ class QgsDelimitedTextFile : public QObject */ int fieldIndex( const QString &name ); - /** Reads the next record from the stream splits into string fields. + /** + * Reads the next record from the stream splits into string fields. * \param fields The string list to populate with the fields * \returns status The result of trying to parse a record. RecordOk * if read successfully, RecordEOF if reached the end of the @@ -251,7 +275,8 @@ class QgsDelimitedTextFile : public QObject */ Status nextRecord( QStringList &fields ); - /** Return the line number of the start of the last record read + /** + * Return the line number of the start of the last record read * \returns linenumber The line number of the start of the record */ int recordId() @@ -259,48 +284,56 @@ class QgsDelimitedTextFile : public QObject return mRecordLineNumber; } - /** Set the index of the next record to return. + /** + * Set the index of the next record to return. * \param nextRecordId The id to set the next record to * \returns valid True if the next record can be located */ bool setNextRecordId( long nextRecordId ); - /** Number record number of records visited. After scanning the file + /** + * Number record number of records visited. After scanning the file * serves as a record count. * \returns maxRecordNumber The maximum record number */ long recordCount() { return mMaxRecordNumber; } - /** Reset the file to reread from the beginning + /** + * Reset the file to reread from the beginning */ Status reset(); - /** Return a string defining the type of the delimiter as a string + /** + * Return a string defining the type of the delimiter as a string * \returns type The delimiter type as a string */ QString type(); - /** Check that provider is valid (filename and definition valid) + /** + * Check that provider is valid (filename and definition valid) * * \returns valid True if the provider is valid */ bool isValid(); - /** Encode characters - used to convert delimiter/quote/escape characters to + /** + * Encode characters - used to convert delimiter/quote/escape characters to * encoded form (e.g., replace tab with \t) * \param string The unencoded string * \returns encstring The encoded string */ static QString encodeChars( QString string ); - /** Encode characters - used to encoded character strings to + /** + * Encode characters - used to encoded character strings to * decoded form (e.g., replace \t with tab) * \param string The unencoded string * \returns decstring The decoded string */ static QString decodeChars( QString string ); - /** Set to use or not use a QFileWatcher to notify of changes to the file + /** + * Set to use or not use a QFileWatcher to notify of changes to the file * \param useWatcher True to use a watcher, false otherwise */ @@ -308,29 +341,34 @@ class QgsDelimitedTextFile : public QObject signals: - /** Signal sent when the file is updated by another process + /** + * Signal sent when the file is updated by another process */ void fileUpdated(); public slots: - /** Slot used by watcher to notify of file updates + /** + * Slot used by watcher to notify of file updates */ void updateFile(); private: - /** Open the file + /** + * Open the file * * \returns valid True if the file is successfully opened */ bool open(); - /** Close the text file + /** + * Close the text file */ void close(); - /** Reset the status if the definition is changing (e.g., clear + /** + * Reset the status if the definition is changing (e.g., clear * existing field names, etc... */ void resetDefinition(); @@ -340,17 +378,20 @@ class QgsDelimitedTextFile : public QObject //! Parse quote delimited fields, where quote and escape are different Status parseQuoted( QString &buffer, QStringList &fields ); - /** Return the next line from the data file. If skipBlank is true then + /** + * Return the next line from the data file. If skipBlank is true then * blank lines will be skipped - this is for compatibility with previous * delimited text parser implementation. */ Status nextLine( QString &buffer, bool skipBlank = false ); - /** Set the next line to read from the file. + /** + * Set the next line to read from the file. */ bool setNextLineNumber( long nextLineNumber ); - /** Utility routine to add a field to a record, accounting for trimming + /** + * Utility routine to add a field to a record, accounting for trimming * and discarding, and maximum field count */ void appendField( QStringList &record, QString field, bool quoted = false ); diff --git a/src/providers/delimitedtext/qgsdelimitedtextprovider.cpp b/src/providers/delimitedtext/qgsdelimitedtextprovider.cpp index 198293e03309..8ad6ddb1daed 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextprovider.cpp +++ b/src/providers/delimitedtext/qgsdelimitedtextprovider.cpp @@ -1149,7 +1149,8 @@ QGISEXTERN QgsDelimitedTextProvider *classFactory( const QString *uri ) return new QgsDelimitedTextProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/delimitedtext/qgsdelimitedtextprovider.h b/src/providers/delimitedtext/qgsdelimitedtextprovider.h index ce24d3e40347..2f02bf5c4719 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextprovider.h +++ b/src/providers/delimitedtext/qgsdelimitedtextprovider.h @@ -96,21 +96,24 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider virtual QgsFields fields() const override; - /** Returns a bitmask containing the supported capabilities + /** + * Returns a bitmask containing the supported capabilities * Note, some capabilities may change depending on whether * a spatial filter is active on this provider, so it may * be prudent to check this value per intended operation. */ virtual QgsVectorDataProvider::Capabilities capabilities() const override; - /** Creates a spatial index on the data + /** + * Creates a spatial index on the data * \returns indexCreated Returns true if a spatial index is created */ virtual bool createSpatialIndex() override; /* Implementation of functions from QgsDataProvider */ - /** Return a provider name + /** + * Return a provider name * * Essentially just returns the provider key. Should be used to build file * dialogs so that providers can be shown with their supported types. Thus @@ -125,7 +128,8 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider */ QString name() const override; - /** Return description + /** + * Return description * * Return a terse string describing what the provider is. * diff --git a/src/providers/gdal/qgsgdalprovider.cpp b/src/providers/gdal/qgsgdalprovider.cpp index 0565fb142a84..5a130a3106ec 100644 --- a/src/providers/gdal/qgsgdalprovider.cpp +++ b/src/providers/gdal/qgsgdalprovider.cpp @@ -1861,7 +1861,8 @@ QGISEXTERN QgsGdalProvider *classFactory( const QString *uri ) return new QgsGdalProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/gdal/qgsgdalprovider.h b/src/providers/gdal/qgsgdalprovider.h index eb9bc6283e48..93ef80712501 100644 --- a/src/providers/gdal/qgsgdalprovider.h +++ b/src/providers/gdal/qgsgdalprovider.h @@ -35,7 +35,8 @@ class QgsRasterPyramid; -/** \ingroup core +/** + * \ingroup core * A call back function for showing progress of gdal operations. */ int CPL_STDCALL progressCallback( double dfComplete, @@ -173,7 +174,8 @@ class QgsGdalProvider : public QgsRasterDataProvider, QgsGdalProviderBase //! \brief Whether this raster has overviews / pyramids or not bool mHasPyramids = false; - /** \brief Gdal data types used to represent data in in QGIS, + /** + * \brief Gdal data types used to represent data in in QGIS, * may be longer than source data type to keep nulls * indexed from 0 */ diff --git a/src/providers/gdal/qgsgdalsourceselect.h b/src/providers/gdal/qgsgdalsourceselect.h index 0ed51537078a..ebae2d649993 100644 --- a/src/providers/gdal/qgsgdalsourceselect.h +++ b/src/providers/gdal/qgsgdalsourceselect.h @@ -21,7 +21,8 @@ #include "qgsabstractdatasourcewidget.h" -/** \class QgsGdalSourceSelect +/** + * \class QgsGdalSourceSelect * \brief Dialog to select GDAL supported rasters */ class QgsGdalSourceSelect : public QgsAbstractDataSourceWidget, private Ui::QgsGdalSourceSelectBase diff --git a/src/providers/geonode/qgsgeonodeprovider.cpp b/src/providers/geonode/qgsgeonodeprovider.cpp index 60481aa93a67..c9acd48eab80 100644 --- a/src/providers/geonode/qgsgeonodeprovider.cpp +++ b/src/providers/geonode/qgsgeonodeprovider.cpp @@ -18,7 +18,8 @@ #include "qgis.h" -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/geonode/qgsgeonodesourceselect.h b/src/providers/geonode/qgsgeonodesourceselect.h index af08bc545222..5159e8ab450d 100644 --- a/src/providers/geonode/qgsgeonodesourceselect.h +++ b/src/providers/geonode/qgsgeonodesourceselect.h @@ -55,7 +55,8 @@ class QgsGeoNodeSourceSelect: public QgsAbstractDataSourceWidget, private Ui::Qg private: - /** Stores the available CRS for a server connections. + /** + * Stores the available CRS for a server connections. The first string is the typename, the corresponding list stores the CRS for the typename in the form 'EPSG:XXXX'*/ QMap mAvailableCRS; diff --git a/src/providers/gpx/gpsdata.h b/src/providers/gpx/gpsdata.h index 3ae4c7677f63..7090dd3ab42d 100644 --- a/src/providers/gpx/gpsdata.h +++ b/src/providers/gpx/gpsdata.h @@ -36,7 +36,8 @@ # endif #endif -/** This is the parent class for all GPS data classes (except tracksegment). +/** + * This is the parent class for all GPS data classes (except tracksegment). It contains the variables that all GPS objects can have. */ class QgsGPSObject @@ -49,7 +50,8 @@ class QgsGPSObject }; -/** This is the parent class for all GPS point classes. It contains common data +/** + * This is the parent class for all GPS point classes. It contains common data members and common initialization code for all point classes. */ class QgsGPSPoint : public QgsGPSObject @@ -62,7 +64,8 @@ class QgsGPSPoint : public QgsGPSObject }; -/** This is the parent class for all GPS object types that can have a nonempty +/** + * This is the parent class for all GPS object types that can have a nonempty bounding box (Route, Track). It contains common data members for all those classes. */ class QgsGPSExtended : public QgsGPSObject @@ -89,7 +92,8 @@ class QgsWaypoint : public QgsGPSPoint }; -/** This class represents a GPS route. +/** + * This class represents a GPS route. */ class QgsRoute : public QgsGPSExtended { @@ -100,7 +104,8 @@ class QgsRoute : public QgsGPSExtended }; -/** This class represents a GPS track segment, which is a contiguous part of +/** + * This class represents a GPS track segment, which is a contiguous part of a track. See the GPX specification for a better explanation. */ class QgsTrackSegment @@ -110,7 +115,8 @@ class QgsTrackSegment }; -/** This class represents a GPS tracklog. It consists of 0 or more track +/** + * This class represents a GPS tracklog. It consists of 0 or more track segments. */ class QgsTrack : public QgsGPSExtended @@ -122,7 +128,8 @@ class QgsTrack : public QgsGPSExtended }; -/** This class represents a set of GPS data, for example a GPS layer in QGIS. +/** + * This class represents a set of GPS data, for example a GPS layer in QGIS. */ class QgsGPSData { @@ -136,11 +143,13 @@ class QgsGPSData typedef QList::iterator TrackIterator; - /** This constructor initializes the extent to a nonsense value. Don't try + /** + * This constructor initializes the extent to a nonsense value. Don't try to use a GPSData object in QGIS without parsing a datafile into it. */ QgsGPSData(); - /** This function returns a pointer to a dynamically allocated QgsRectangle + /** + * This function returns a pointer to a dynamically allocated QgsRectangle which is the bounding box for this dataset. You'll have to deallocate it yourself. */ QgsRectangle getExtent() const; @@ -166,19 +175,23 @@ class QgsGPSData //! This function returns an iterator that points to the first track. TrackIterator tracksBegin(); - /** This function returns an iterator that points to the end of the + /** + * This function returns an iterator that points to the end of the waypoint list. */ WaypointIterator waypointsEnd(); - /** This function returns an iterator that points to the end of the + /** + * This function returns an iterator that points to the end of the route list. */ RouteIterator routesEnd(); - /** This function returns an iterator that points to the end of the + /** + * This function returns an iterator that points to the end of the track list. */ TrackIterator tracksEnd(); - /** This function tries to add a new waypoint. An iterator to the new + /** + * This function tries to add a new waypoint. An iterator to the new waypoint will be returned (it will be waypointsEnd() if the waypoint couldn't be added. */ WaypointIterator addWaypoint( double lat, double lon, const QString &name = "", @@ -186,13 +199,15 @@ class QgsGPSData WaypointIterator addWaypoint( const QgsWaypoint &wpt ); - /** This function tries to add a new route. It returns an iterator to the + /** + * This function tries to add a new route. It returns an iterator to the new route. */ RouteIterator addRoute( const QString &name = "" ); RouteIterator addRoute( const QgsRoute &rte ); - /** This function tries to add a new track. An iterator to the new track + /** + * This function tries to add a new track. An iterator to the new track will be returned. */ TrackIterator addTrack( const QString &name = "" ); @@ -207,11 +222,13 @@ class QgsGPSData //! This function removes the tracks whose IDs are in the list. void removeTracks( const QgsFeatureIds &ids ); - /** This function will write the contents of this GPSData object as XML to + /** + * This function will write the contents of this GPSData object as XML to the given text stream. */ void writeXml( QTextStream &stream ); - /** This function returns a pointer to the GPSData object associated with + /** + * This function returns a pointer to the GPSData object associated with the file @c file name. If the file does not exist or can't be parsed, NULL will be returned. If the file is already used by another layer, a pointer to the same GPSData object will be returned. And if the file @@ -222,7 +239,8 @@ class QgsGPSData in memory forever and you will get an ugly memory leak. */ static QgsGPSData *getData( const QString &fileName ); - /** Call this function when you're done with a GPSData pointer that you + /** + * Call this function when you're done with a GPSData pointer that you got earlier using getData(). Do NOT call this function if you haven't called getData() earlier with the same @c file name, that can cause data that is still in use to be deleted. */ @@ -244,7 +262,8 @@ class QgsGPSData //! This is used internally to store GPS data objects (one per file). typedef QMap > DataMap; - /** This is the static container that maps file names to GPSData objects and + /** + * This is the static container that maps file names to GPSData objects and does reference counting, so several providers can use the same GPSData object. */ static DataMap dataObjects; @@ -260,15 +279,18 @@ class QgsGPXHandler : mData( data ) { } - /** This function is called when expat encounters a new start element in + /** + * This function is called when expat encounters a new start element in the XML stream. */ bool startElement( const XML_Char *qName, const XML_Char **attr ); - /** This function is called when expat encounters character data in the + /** + * This function is called when expat encounters character data in the XML stream. */ void characters( const XML_Char *chars, int len ); - /** This function is called when expat encounters a new end element in + /** + * This function is called when expat encounters a new end element in the XML stream. */ bool endElement( const std::string &qName ); diff --git a/src/providers/gpx/qgsgpxprovider.cpp b/src/providers/gpx/qgsgpxprovider.cpp index 54bc39bf9695..7bad6e8dd022 100644 --- a/src/providers/gpx/qgsgpxprovider.cpp +++ b/src/providers/gpx/qgsgpxprovider.cpp @@ -553,7 +553,8 @@ QGISEXTERN QgsGPXProvider *classFactory( const QString *uri ) } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/grass/qgsgrass.h b/src/providers/grass/qgsgrass.h index d9bcbb5ab9c8..081f957aa2b2 100644 --- a/src/providers/grass/qgsgrass.h +++ b/src/providers/grass/qgsgrass.h @@ -83,11 +83,13 @@ class GRASS_LIB_EXPORT QgsGrassObject QString name() const { return mName; } void setName( const QString &name ) { mName = name; } - /** Return full name (map@mapset) + /** + * Return full name (map@mapset) * \returns full name or empty string if map name is empty */ QString fullName() const; - /** Parse full name in map@mapset form and set map and mapset. If mapset is not + /** + * Parse full name in map@mapset form and set map and mapset. If mapset is not * specified, mapset is set to the current mapset. */ void setFullName( const QString &fullName ); Type type() const { return mType; } @@ -120,7 +122,8 @@ class GRASS_LIB_EXPORT QgsGrassObject Type mType = None; }; -/** QString gisdbase() +/** + * QString gisdbase() Methods for C library initialization and error handling. */ class GRASS_LIB_EXPORT QgsGrass : public QObject @@ -172,7 +175,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Get info about the mode - /** QgsGrass may be running in active or passive mode. + /** + * QgsGrass may be running in active or passive mode. * Active mode means that GISRC is set up and GISRC file is available, * in that case default GISDBASE, LOCATION and MAPSET may be read by GetDefaul*() functions. * Passive mode means, that GISRC is not available. */ @@ -197,7 +201,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Get default path to MAPSET (gisdbase/location/mapset) or empty string if not in active mode static QString getDefaultMapsetPath(); - /** Init or reset GRASS library + /** + * Init or reset GRASS library * * \param gisdbase full path to GRASS GISDBASE. * \param location location name (not path!). @@ -212,12 +217,14 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject */ static void setMapset( const QString &gisdbase, const QString &location, const QString &mapset ); - /** Set mapset according to object gisdbase, location and mapset + /** + * Set mapset according to object gisdbase, location and mapset * \param grassObject */ static void setMapset( const QgsGrassObject &grassObject ); - /** Check if mapset is in search pat set by g.mapsets + /** + * Check if mapset is in search pat set by g.mapsets * \returns true if in search path */ bool isMapsetInSearchPath( const QString &mapset ); @@ -251,14 +258,16 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Test is current user is owner of mapset static bool isOwner( const QString &gisdbase, const QString &location, const QString &mapset ); - /** Open existing GRASS mapset. + /** + * Open existing GRASS mapset. * Emits signal mapsetChanged(). * \returns Empty string or error message */ static QString openMapset( const QString &gisdbase, const QString &location, const QString &mapset ); - /** \brief Close mapset if it was opened from QGIS. + /** + * \brief Close mapset if it was opened from QGIS. * Delete GISRC, lock and temporary directory. * Emits signal mapsetChanged(). * \param showError show error dialog on error @@ -322,7 +331,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Set region extent static void setRegion( struct Cell_head *window, const QgsRectangle &rect ); - /** Init region, set extent, rows and cols and adjust. + /** + * Init region, set extent, rows and cols and adjust. * Returns error if adjustment failed. */ static QString setRegion( struct Cell_head *window, const QgsRectangle &rect, int rows, int cols ); @@ -341,13 +351,15 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static bool defaultRegion( const QString &gisdbase, const QString &location, struct Cell_head *window ); - /** Read mapset current region (WIND) + /** + * Read mapset current region (WIND) * \throws QgsGrass::Exception */ static void region( const QString &gisdbase, const QString &location, const QString &mapset, struct Cell_head *window ); - /** Read default mapset current region (WIND) + /** + * Read default mapset current region (WIND) * \throws QgsGrass::Exception */ static void region( struct Cell_head *window ); @@ -356,7 +368,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static bool writeRegion( const QString &gisbase, const QString &location, const QString &mapset, const struct Cell_head *window ); - /** Write current mapset region + /** + * Write current mapset region * throws QgsGrass::Exception * Emits regionChanged */ void writeRegion( const struct Cell_head *window ); @@ -373,7 +386,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static void extendRegion( struct Cell_head *source, struct Cell_head *target ); - /** Initialize GRASS library. This has to be called before any other function is used. + /** + * Initialize GRASS library. This has to be called before any other function is used. * \returns true if successfully initialized */ static bool init( void ); @@ -389,13 +403,15 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject // ! Get current gisrc path static QString gisrcFilePath(); - /** Find a module trying to append .bat, .py and .exe on Windows. The module may be a full path + /** + * Find a module trying to append .bat, .py and .exe on Windows. The module may be a full path * without extension or just a module name in which case it is searched in grassModulesPaths(). * \param module module name or path to module without extension * \returns full path including extension or empty string */ static QString findModule( QString module ); - /** Start a GRASS module in any gisdbase/location/mapset. + /** + * Start a GRASS module in any gisdbase/location/mapset. * \param mapset if empty a first mapset owned by user will be used, if no mapset is owned * by user, exception is thrown. * \param qgisModule append GRASS major version (for modules built in qgis) @@ -411,7 +427,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject const QStringList &arguments, int timeOut = 30000, bool qgisModule = true ); - /** \brief Get info string from qgis.g.info module + /** + * \brief Get info string from qgis.g.info module * \param info info type * \param gisdbase GISBASE path * \param location location name @@ -475,12 +492,14 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject // ! Delete map static bool deleteObject( const QgsGrassObject &object ); - /** Ask user confirmation to delete a map + /** + * Ask user confirmation to delete a map * \returns true if confirmed */ static bool deleteObjectDialog( const QgsGrassObject &object ); - /** Create new vector map + /** + * Create new vector map * \param object GRASS object specifying location/mapset/map * \param error */ static void createVectorMap( const QgsGrassObject &object, QString &error ); @@ -495,19 +514,22 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Returns true if object is link to external data (created by r.external) static bool isExternal( const QgsGrassObject &object ); - /** Adjust cell header, G_adjust_Cell_head wrapper + /** + * Adjust cell header, G_adjust_Cell_head wrapper * \throws QgsGrass::Exception */ static void adjustCellHead( struct Cell_head *cellhd, int row_flag, int col_flag ); //! Get map of vector types / names static QMap vectorTypeMap(); - /** Get GRASS vector type from name + /** + * Get GRASS vector type from name * \param point,centroid,line,boundary,area,face,kernel * \returns type GV_POINT, GV_CENTROID, GV_LINE, GV_BOUNDARY, GV_AREA, GV_FACE,GV_KERNEL */ static int vectorType( const QString &name ); - /** Get name for vector primitive type + /** + * Get name for vector primitive type * \param type GV_POINT, GV_CENTROID, GV_LINE, GV_BOUNDARY, GV_AREA, GV_FACE, GV_KERNEL */ static QString vectorTypeName( int type ); @@ -585,11 +607,13 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Show warning dialog with exception message static void warning( QgsGrass::Exception &e ); - /** Set mute mode, if set, warning() does not open dialog but prints only + /** + * Set mute mode, if set, warning() does not open dialog but prints only * debug message and sets the error which returns errorMessage() */ static void setMute() { sMute = true; } - /** Allocate struct Map_info. Call to this function may result in G_fatal_error + /** + * Allocate struct Map_info. Call to this function may result in G_fatal_error * and must be surrounded by G_TRY/G_CATCH. */ static struct Map_info *vectNewMapStruct(); // Free struct Map_info @@ -600,7 +624,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject void emitNewLayer( const QString &uri, const QString &name ) { emit newLayer( uri, name ); } - /** Parse single line of output from GRASS modules run with GRASS_MESSAGE_FORMAT=gui + /** + * Parse single line of output from GRASS modules run with GRASS_MESSAGE_FORMAT=gui * \param input input string read from module stderr * \param text parsed text * \param html html formatted parsed text, e.g. + icons @@ -635,7 +660,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Emitted when modules debug mode changed void modulesDebugChanged(); - /** Emitted when current region changed + /** + * Emitted when current region changed * TODO: currently only emitted when writeRegion is called, add file system watcher * to get also changes done outside QGIS or by modules. */ @@ -644,7 +670,8 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject //! Emitted when region pen changed void regionPenChanged(); - /** Request from browser to open a new layer for editing, the plugin should connect + /** + * Request from browser to open a new layer for editing, the plugin should connect * to this signal and add the layer to canvas and start editing. */ void newLayer( QString uri, QString name ); diff --git a/src/providers/grass/qgsgrassfeatureiterator.h b/src/providers/grass/qgsgrassfeatureiterator.h index 3ff5dd05d7be..b2e0b75400a9 100644 --- a/src/providers/grass/qgsgrassfeatureiterator.h +++ b/src/providers/grass/qgsgrassfeatureiterator.h @@ -101,7 +101,8 @@ class GRASS_LIB_EXPORT QgsGrassFeatureIterator : public QObject, public QgsAbstr public slots: - /** Cancel iterator, iterator will be closed on next occasion, probably when next getFeature() gets called. + /** + * Cancel iterator, iterator will be closed on next occasion, probably when next getFeature() gets called. * This function can be called directly from other threads (setting bool is atomic) */ void cancel(); @@ -122,13 +123,15 @@ class GRASS_LIB_EXPORT QgsGrassFeatureIterator : public QObject, public QgsAbstr void setFeatureGeometry( QgsFeature &feature, int id, int type ); - /** Set feature attributes. + /** + * Set feature attributes. * \param feature * \param cat category number */ void setFeatureAttributes( int cat, QgsFeature *feature, QgsGrassVectorMap::TopoSymbol symbol ); - /** Set feature attributes. + /** + * Set feature attributes. * \param feature * \param cat category number * \param attlist a list containing the index number of the fields to set diff --git a/src/providers/grass/qgsgrassgislib.h b/src/providers/grass/qgsgrassgislib.h index 194626b77a15..d842da314279 100644 --- a/src/providers/grass/qgsgrassgislib.h +++ b/src/providers/grass/qgsgrassgislib.h @@ -119,7 +119,8 @@ class GRASS_LIB_EXPORT QgsGrassGisLib //! Get no data value for GRASS data type double noDataValueForGrassType( RASTER_MAP_TYPE grassType ); - /** Grass does not seem to have any function to init Cell_head, + /** + * Grass does not seem to have any function to init Cell_head, * initialization is done in G__read_Cell_head_array */ void initCellHead( struct Cell_head *cellhd ); diff --git a/src/providers/grass/qgsgrassprovider.h b/src/providers/grass/qgsgrassprovider.h index 5cb486e73084..a31cce93504d 100644 --- a/src/providers/grass/qgsgrassprovider.h +++ b/src/providers/grass/qgsgrassprovider.h @@ -80,11 +80,13 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider QVariant minimumValue( int index ) const override; - /** Returns the maximum value of an attribute + /** + * Returns the maximum value of an attribute * \param index the index of the attribute */ QVariant maxValue( int index ); - /** Update (reload) non static members (marked !UPDATE!) from the static layer and the map. + /** + * Update (reload) non static members (marked !UPDATE!) from the static layer and the map. * This method MUST be called whenever lastUpdate of the map is later then mapLastUpdate * of the instance. */ @@ -114,19 +116,22 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider // ----------------------------------- Edit ---------------------------------- - /** Is the layer editable? I.e. the layer is valid and current user is owner of the mapset + /** + * Is the layer editable? I.e. the layer is valid and current user is owner of the mapset * \returns true the layer editable * \returns false the is not editable */ bool isGrassEditable(); - /** Returns true if the layer is currently edited (opened in update mode) + /** + * Returns true if the layer is currently edited (opened in update mode) * \returns true in update mode * \returns false not edited */ bool isEdited(); - /** Returns true if the layer is currently froze, i.e. a module + /** + * Returns true if the layer is currently froze, i.e. a module * from GRASS Tools is writing to this vector * \returns true in update mode * \returns false not edited @@ -143,7 +148,8 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider //! Thaw vector. void thaw(); - /** Close editing. Rebuild topology, GMAP.update = false + /** + * Close editing. Rebuild topology, GMAP.update = false * \param newMap set to true if a new map was created * and it is not yet used as layer * \returns true success @@ -151,17 +157,20 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider */ bool closeEdit( bool newMap = false, QgsVectorLayer *vectorLayer = 0 ); - /** Get current number of lines. + /** + * Get current number of lines. * \returns number of lines */ int numLines( void ); - /** Get current number of nodes. + /** + * Get current number of nodes. * \returns number of nodes */ int numNodes( void ); - /** Read line + /** + * Read line * \param Points pointer to existing structure or NULL * \param Cats pointer to existing structure or NULL * \param line line number @@ -170,108 +179,126 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider */ int readLine( struct line_pnts *Points, struct line_cats *Cats, int line ); - /** Read node coordinates + /** + * Read node coordinates * \param line line number * \returns true node is alive * \returns false node is dead */ bool nodeCoor( int node, double *x, double *y ); - /** Read line nodes + /** + * Read line nodes * \param line line number * \returns true line is alive * \returns false line is dead */ bool lineNodes( int line, int *node1, int *node2 ); - /** Read boundary areas + /** + * Read boundary areas * \param line line number * \returns true line is alive * \returns false line is dead */ bool lineAreas( int line, int *left, int *right ); - /** Get isle area + /** + * Get isle area * \param isle number * \returns area number */ int isleArea( int isle ); - /** Get centroid area + /** + * Get centroid area * \param centroid line number * \returns area number (negative for island) */ int centroidArea( int centroid ); - /** Get number of lines at node + /** + * Get number of lines at node * \param node node number * \returns number of lines at node (including dead lines) */ int nodeNLines( int node ); - /** Get line number of line at node for given line index + /** + * Get line number of line at node for given line index * \param node node number * \param idx line index * \returns line number */ int nodeLine( int node, int idx ); - /** True if line is alive + /** + * True if line is alive * \param line line number * \returns true alive * \returns false dead */ int lineAlive( int line ); - /** True if node is alive + /** + * True if node is alive * \param node node number * \returns true alive * \returns false dead */ int nodeAlive( int node ); - /** Write a new line into vector. + /** + * Write a new line into vector. * \returns line number * \returns -1 error */ int writeLine( int type, struct line_pnts *Points, struct line_cats *Cats ); - /** Rewrite line. + /** + * Rewrite line. * \returns line number * \returns -1 error */ int rewriteLine( int lid, int type, struct line_pnts *Points, struct line_cats *Cats ); - /** Delete line + /** + * Delete line * \returns 0 OK * \returns -1 error */ int deleteLine( int line ); - /** Number of updated lines + /** + * Number of updated lines */ int numUpdatedLines( void ); - /** Number of updated nodes + /** + * Number of updated nodes */ int numUpdatedNodes( void ); - /** Get updated line + /** + * Get updated line */ int updatedLine( int idx ); - /** Get updated node + /** + * Get updated node */ int updatedNode( int idx ); - /** Find nearest line + /** + * Find nearest line * \param threshold maximum distance * \returns line number * \returns 0 nothing found */ int findLine( double x, double y, int type, double threshold ); - /** Find nearest node + /** + * Find nearest node * \param threshold maximum distance * \returns node number * \returns 0 nothing found @@ -280,25 +307,29 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider // TODO is it used? - /** Read attributes from DB + /** + * Read attributes from DB * \param field * \param cat * \returns vector of attributes */ QgsAttributeMap *attributes( int field, int cat ); - /** Key (cat) column name + /** + * Key (cat) column name * \param field * \returns Key column name or empty string */ QString key( int field ); - /** Get number of db links + /** + * Get number of db links * \returns number of links */ int numDbLinks( void ); - /** Get db link field + /** + * Get db link field * \param link * \returns field number or 0 */ @@ -319,12 +350,14 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider //! Returns GRASS layer number int grassLayer(); - /** Returns GRASS layer number for given layer name or -1 if cannot + /** + * Returns GRASS layer number for given layer name or -1 if cannot * get layer number */ static int grassLayer( const QString & ); - /** Returns GRASS layer type (GV_POINT, GV_LINES, GV_AREA) for + /** + * Returns GRASS layer type (GV_POINT, GV_LINES, GV_AREA) for * given layer name or -1 if cannot get layer type */ static int grassLayerType( const QString & ); @@ -404,7 +437,8 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider // create QgsFeatureId from GRASS geometry object id and cat static QgsFeatureId makeFeatureId( int grassId, int cat ); - /** Get attribute by category(key) and attribute number. + /** + * Get attribute by category(key) and attribute number. * \param layerId * \param category (key) * \param column column number ( < nColumns ) diff --git a/src/providers/grass/qgsgrassprovidermodule.cpp b/src/providers/grass/qgsgrassprovidermodule.cpp index ab30394f18e1..1223253e90ec 100644 --- a/src/providers/grass/qgsgrassprovidermodule.cpp +++ b/src/providers/grass/qgsgrassprovidermodule.cpp @@ -1271,7 +1271,8 @@ QGISEXTERN QgsGrassProvider *classFactory( const QString *uri ) return new QgsGrassProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/grass/qgsgrassrasterprovider.h b/src/providers/grass/qgsgrassrasterprovider.h index 7ac519d9b7fe..067fa35b5f80 100644 --- a/src/providers/grass/qgsgrassrasterprovider.h +++ b/src/providers/grass/qgsgrassrasterprovider.h @@ -104,7 +104,8 @@ class GRASS_LIB_EXPORT QgsGrassRasterProvider : public QgsRasterDataProvider QgsRasterInterface *clone() const override; - /** Return a provider name + /** + * Return a provider name * * Essentially just returns the provider key. Should be used to build file * dialogs so that providers can be shown with their supported types. Thus @@ -121,7 +122,8 @@ class GRASS_LIB_EXPORT QgsGrassRasterProvider : public QgsRasterDataProvider QString name() const override; - /** Return description + /** + * Return description * * Return a terse string describing what the provider is. * @@ -136,7 +138,8 @@ class GRASS_LIB_EXPORT QgsGrassRasterProvider : public QgsRasterDataProvider virtual QgsCoordinateReferenceSystem crs() const override; - /** Return the extent for this data layer + /** + * Return the extent for this data layer */ virtual QgsRectangle extent() const override; @@ -165,7 +168,8 @@ class GRASS_LIB_EXPORT QgsGrassRasterProvider : public QgsRasterDataProvider QString lastError() override; - /** Returns a bitmask containing the supported capabilities + /** + * Returns a bitmask containing the supported capabilities Note, some capabilities may change depending on which sublayers are visible on this provider, so it may be prudent to check this value per intended operation. diff --git a/src/providers/grass/qgsgrassvector.h b/src/providers/grass/qgsgrassvector.h index 645acf9fb1cb..1056e0dc9c10 100644 --- a/src/providers/grass/qgsgrassvector.h +++ b/src/providers/grass/qgsgrassvector.h @@ -88,14 +88,16 @@ class GRASS_LIB_EXPORT QgsGrassVector : public QObject //! Get list of layers. The layers exist until the vector is deleted or reloaded QList layers() const { return mLayers; } - /** Get numbers of primitives + /** + * Get numbers of primitives * \returns type/count pairs */ QMap typeCounts() const {return mTypeCounts; } //! Get total number of primitives of given type. Types may be combined by bitwise or) int typeCount( int type ) const; - /** Maximum layer number (field). + /** + * Maximum layer number (field). * \returns max layer number or 0 if no layer exists */ int maxLayerNumber() const; diff --git a/src/providers/grass/qgsgrassvectormap.h b/src/providers/grass/qgsgrassvectormap.h index 9fce196fad24..717374c9bb10 100644 --- a/src/providers/grass/qgsgrassvectormap.h +++ b/src/providers/grass/qgsgrassvectormap.h @@ -62,7 +62,8 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject // number of instances using this map int userCount() const; - /** Get current number of lines. + /** + * Get current number of lines. * \returns number of lines */ int numLines(); int numAreas(); @@ -88,7 +89,8 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject QHash &newCats() { return mNewCats; } QMap > &undoCommands() { return mUndoCommands; } - /** Get geometry of line. + /** + * Get geometry of line. * \returns geometry (point,line or polygon(GV_FACE)) or 0 */ QgsAbstractGeometry *lineGeometry( int id ); QgsAbstractGeometry *nodeGeometry( int id ); @@ -113,26 +115,31 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject bool closeEdit( bool newMap ); void clearUndoCommands(); - /** Get layer, layer is created and loaded if not yet. + /** + * Get layer, layer is created and loaded if not yet. * \param field * \returns pointer to layer or 0 if layer doe not exist */ QgsGrassVectorMapLayer *openLayer( int field ); - /** Close layer and release cached data if there are no more users and close map + /** + * Close layer and release cached data if there are no more users and close map * if there are no more map users. * \param layer */ void closeLayer( QgsGrassVectorMapLayer *layer ); - /** Update map. Close and reopen vector and refresh layers. + /** + * Update map. Close and reopen vector and refresh layers. * Instances of QgsGrassProvider are not updated and should call update() method */ void update(); - /** The map is outdated. The map was for example rewritten by GRASS module outside QGIS. + /** + * The map is outdated. The map was for example rewritten by GRASS module outside QGIS. * This function checks internal timestamp stored in QGIS. */ bool mapOutdated(); - /** The attributes are outdated. The table was for example updated by GRASS module outside QGIS. + /** + * The attributes are outdated. The table was for example updated by GRASS module outside QGIS. * This function checks internal timestamp stored in QGIS. */ bool attributesOutdated(); @@ -140,7 +147,8 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject //! Map description for debugging QString toString(); - /** Get topology symbol code + /** + * Get topology symbol code * \param lid line or area number * \param type geometry type */ TopoSymbol topoSymbol( int lid ); @@ -151,7 +159,8 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject signals: - /** Ask all iterators to cancel iteration when possible. Connected to iterators with + /** + * Ask all iterators to cancel iteration when possible. Connected to iterators with * Qt::DirectConnection (non blocking) */ void cancelIterators(); @@ -226,7 +235,8 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapStore // This is only used for editing test to have an independent map static void setStore( QgsGrassVectorMapStore *store ) { sStore = store; } - /** Open map. + /** + * Open map. * \param grassObject * \returns map, the map may be invalide */ QgsGrassVectorMap *openMap( const QgsGrassObject &grassObject ); diff --git a/src/providers/grass/qgsgrassvectormaplayer.h b/src/providers/grass/qgsgrassvectormaplayer.h index af6f6348ea10..1e32d8b0536d 100644 --- a/src/providers/grass/qgsgrassvectormaplayer.h +++ b/src/providers/grass/qgsgrassvectormaplayer.h @@ -56,12 +56,14 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapLayer : public QObject //! Current number of cats in cat index, changing during editing int cidxFieldNumCats(); - /** Original fields before editing started + topo field if edited. + /** + * Original fields before editing started + topo field if edited. * Does not reflect add/delete column. * Original fields must be returned by provider fields() */ QgsFields &fields() { return mFields; } - /** Current fields, as modified during editing, it contains cat field, without topo field. + /** + * Current fields, as modified during editing, it contains cat field, without topo field. * This fields are used by layers which are not editied to reflect current state of editing. */ QgsFields &tableFields() { return mTableFields; } @@ -69,7 +71,8 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapLayer : public QObject QMap > &attributes() { return mAttributes; } - /** Get attribute for index corresponding to current fields(), + /** + * Get attribute for index corresponding to current fields(), * if there is no table, returns cat */ QVariant attribute( int cat, int index ); @@ -97,55 +100,65 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapLayer : public QObject //------------------------------- Database utils --------------------------------- void setMapset(); - /** Execute SQL statement + /** + * Execute SQL statement * \param sql */ void executeSql( const QString &sql, QString &error ); - /** Update attributes + /** + * Update attributes * \param cat * \param index ields index */ void changeAttributeValue( int cat, const QgsField &field, const QVariant &value, QString &error ); - /** Insert new attributes to the table (it does not check if attributes already exists) + /** + * Insert new attributes to the table (it does not check if attributes already exists) * \param cat */ void insertAttributes( int cat, const QgsFeature &feature, QString &error ); - /** Restore previously deleted table record using data from mAttributes, if exists. + /** + * Restore previously deleted table record using data from mAttributes, if exists. * If there the cat is not in mAttributes, nothing is inserted (to keep previous state). * \param cat */ void reinsertAttributes( int cat, QString &error ); - /** Update existing record by values from feature. + /** + * Update existing record by values from feature. * \param cat * \param nullValues override all values, if false, only non empty values are used for update */ void updateAttributes( int cat, QgsFeature &feature, QString &error, bool nullValues = false ); - /** Delete attributes from the table + /** + * Delete attributes from the table * \param cat */ void deleteAttribute( int cat, QString &error ); - /** Check if a database row exists + /** + * Check if a database row exists * \param cat * \param error set to error if happens * \returns true if cat is orphan */ bool recordExists( int cat, QString &error ); - /** Check if a database row exists and it is orphan (no more lines with that category) + /** + * Check if a database row exists and it is orphan (no more lines with that category) * \param cat * \param error set to error if happens * \returns true if cat is orphan */ bool isOrphan( int cat, QString &error ); - /** Create table and link vector to this table + /** + * Create table and link vector to this table * \param fields fields to be created without cat (id) field */ void createTable( const QgsFields &fields, QString &error ); - /** Add column to table + /** + * Add column to table * \param field */ void addColumn( const QgsField &field, QString &error ); diff --git a/src/providers/mssql/qgsmssqlnewconnection.h b/src/providers/mssql/qgsmssqlnewconnection.h index 4f2fd6df203f..7df6ae91596f 100644 --- a/src/providers/mssql/qgsmssqlnewconnection.h +++ b/src/providers/mssql/qgsmssqlnewconnection.h @@ -21,7 +21,8 @@ #include "qgshelp.h" -/** \class QgsMssqlNewConnection +/** + * \class QgsMssqlNewConnection * \brief Dialog to allow the user to configure and save connection * information for an MSSQL database */ diff --git a/src/providers/mssql/qgsmssqlprovider.cpp b/src/providers/mssql/qgsmssqlprovider.cpp index 1f03a9f39b2c..7c99523ef969 100644 --- a/src/providers/mssql/qgsmssqlprovider.cpp +++ b/src/providers/mssql/qgsmssqlprovider.cpp @@ -1931,7 +1931,8 @@ QGISEXTERN QgsMssqlProvider *classFactory( const QString *uri ) return new QgsMssqlProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/mssql/qgsmssqlsourceselect.h b/src/providers/mssql/qgsmssqlsourceselect.h index 3122567e2a7f..687943d19eca 100644 --- a/src/providers/mssql/qgsmssqlsourceselect.h +++ b/src/providers/mssql/qgsmssqlsourceselect.h @@ -51,7 +51,8 @@ class QgsMssqlSourceSelectDelegate : public QItemDelegate -/** \class QgsMssqlSourceSelect +/** + * \class QgsMssqlSourceSelect * \brief Dialog to create connections and add tables from MSSQL. * * This dialog allows the user to define and save connection information @@ -90,7 +91,8 @@ class QgsMssqlSourceSelect : public QgsAbstractDataSourceWidget, private Ui::Qgs void addButtonClicked() override; void buildQuery(); - /** Connects to the database using the stored connection parameters. + /** + * Connects to the database using the stored connection parameters. * Once connected, available layers are displayed. */ void on_btnConnect_clicked(); diff --git a/src/providers/mssql/qgsmssqltablemodel.h b/src/providers/mssql/qgsmssqltablemodel.h index 4bb63b504a81..231dfbe7c5fc 100644 --- a/src/providers/mssql/qgsmssqltablemodel.h +++ b/src/providers/mssql/qgsmssqltablemodel.h @@ -39,7 +39,8 @@ struct QgsMssqlLayerProperty class QIcon; -/** A model that holds the tables of a database in a hierarchy where the +/** + * A model that holds the tables of a database in a hierarchy where the schemas are the root elements that contain the individual tables as children. The tables have the following columns: Type, Schema, Tablename, Geometry Column, Sql*/ class QgsMssqlTableModel : public QStandardItemModel @@ -54,7 +55,8 @@ class QgsMssqlTableModel : public QStandardItemModel //! Sets an sql statement that belongs to a cell specified by a model index void setSql( const QModelIndex &index, const QString &sql ); - /** Sets one or more geometry types to a row. In case of several types, additional rows are inserted. + /** + * Sets one or more geometry types to a row. In case of several types, additional rows are inserted. This is for tables where the type is detected later by thread*/ void setGeometryTypesForTable( QgsMssqlLayerProperty layerProperty ); diff --git a/src/providers/ogr/qgsgeopackagedataitems.h b/src/providers/ogr/qgsgeopackagedataitems.h index 2c4a6052b95b..ddd9c924dabf 100644 --- a/src/providers/ogr/qgsgeopackagedataitems.h +++ b/src/providers/ogr/qgsgeopackagedataitems.h @@ -31,7 +31,8 @@ class QgsGeoPackageAbstractLayerItem : public QgsLayerItem protected: QgsGeoPackageAbstractLayerItem( QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, LayerType layerType, const QString &providerKey ); - /** Subclasses need to implement this function with + /** + * Subclasses need to implement this function with * the real deletion implementation */ virtual bool executeDeleteLayer( QString &errCause ); diff --git a/src/providers/ogr/qgsogrdataitems.h b/src/providers/ogr/qgsogrdataitems.h index 18665602df04..ce600fbf62a4 100644 --- a/src/providers/ogr/qgsogrdataitems.h +++ b/src/providers/ogr/qgsogrdataitems.h @@ -85,13 +85,15 @@ class QgsOgrDataCollectionItem : public QgsDataCollectionItem QVector createChildren() override; - /** Utility function to store DB connections + /** + * Utility function to store DB connections * \param path to the DB * \param ogrDriverName the OGR/GDAL driver name (e.g. "GPKG") */ static bool storeConnection( const QString &path, const QString &ogrDriverName ); - /** Utility function to create and store a new DB connection + /** + * Utility function to create and store a new DB connection * \param name is the translatable name of the managed layers (e.g. "GeoPackage") * \param extensions is a string with file extensions (e.g. "GeoPackage Database (*.gpkg *.GPKG)") * \param ogrDriverName the OGR/GDAL driver name (e.g. "GPKG") diff --git a/src/providers/ogr/qgsogrdbsourceselect.h b/src/providers/ogr/qgsogrdbsourceselect.h index 45528ede2591..cfbdb758765f 100644 --- a/src/providers/ogr/qgsogrdbsourceselect.h +++ b/src/providers/ogr/qgsogrdbsourceselect.h @@ -36,7 +36,8 @@ class QgsOgrDbSourceSelect: public QgsAbstractDataSourceWidget, private Ui::QgsD public: - /** Construct a DB Source Select with \a theOgrDriverName specified (i.e. "GPKG", "SQLite" etc.) + /** + * Construct a DB Source Select with \a theOgrDriverName specified (i.e. "GPKG", "SQLite" etc.) * and \a theName as string for describing the layers managed by the source select (e.g. : "GeoPackage" etc.) * The \a extensions is a string dscribing the accepted file extensions (e.g. : "GeoPackage Database (*.gpkg *.GPKG)") */ @@ -71,7 +72,8 @@ class QgsOgrDbSourceSelect: public QgsAbstractDataSourceWidget, private Ui::QgsD void refresh() override; void addButtonClicked() override; - /** Connects to the database using the stored connection parameters. + /** + * Connects to the database using the stored connection parameters. * Once connected, available layers are displayed. */ void on_btnConnect_clicked(); diff --git a/src/providers/ogr/qgsogrprovider.cpp b/src/providers/ogr/qgsogrprovider.cpp index 5e91f46e4e62..22b4ee0f3664 100644 --- a/src/providers/ogr/qgsogrprovider.cpp +++ b/src/providers/ogr/qgsogrprovider.cpp @@ -2663,7 +2663,8 @@ QGISEXTERN QgsOgrProvider *classFactory( const QString *uri ) -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { @@ -2689,7 +2690,8 @@ QGISEXTERN bool isProvider() return true; } -/** Creates an empty data source +/** + * Creates an empty data source @param uri location to store the file(s) @param format data format (e.g. "ESRI Shapefile" @param vectortype point/line/polygon or multitypes diff --git a/src/providers/ogr/qgsogrprovider.h b/src/providers/ogr/qgsogrprovider.h index babd356cb3fd..cd31e8b45143 100644 --- a/src/providers/ogr/qgsogrprovider.h +++ b/src/providers/ogr/qgsogrprovider.h @@ -186,7 +186,8 @@ class QgsOgrProvider : public QgsVectorDataProvider mutable OGREnvelope *mExtent = nullptr; bool mForceRecomputeExtent = false; - /** This member variable receives the same value as extent_ + /** + * This member variable receives the same value as extent_ in the method QgsOgrProvider::extent(). The purpose is to prevent a memory leak*/ mutable QgsRectangle mExtentRect; OGRLayerH ogrLayer = nullptr; @@ -204,7 +205,8 @@ class QgsOgrProvider : public QgsVectorDataProvider //! was a sub layer requested? bool mIsSubLayer = false; - /** Optional geometry type for layers with multiple geometries, + /** + * Optional geometry type for layers with multiple geometries, * otherwise wkbUnknown. This type is always flatten (2D) and single, it means * that 2D, 25D, single and multi types are mixed in one sublayer */ OGRwkbGeometryType mOgrGeometryTypeFilter = wkbUnknown; @@ -272,7 +274,8 @@ class QgsOgrProviderUtils static OGRLayerH setSubsetString( OGRLayerH layer, GDALDatasetH ds, QTextCodec *encoding, const QString &subsetString, bool &origFidAdded ); static QByteArray quotedIdentifier( QByteArray field, const QString &driverName ); - /** Quote a value for placement in a SQL string. + /** + * Quote a value for placement in a SQL string. */ static QString quotedValue( const QVariant &value ); diff --git a/src/providers/oracle/qgsoracleconn.h b/src/providers/oracle/qgsoracleconn.h index c52c1b3cbd95..7bc33a44c531 100644 --- a/src/providers/oracle/qgsoracleconn.h +++ b/src/providers/oracle/qgsoracleconn.h @@ -116,11 +116,13 @@ class QgsOracleConn : public QObject static QgsOracleConn *connectDb( const QgsDataSourceUri &uri ); void disconnect(); - /** Double quote a Oracle identifier for placement in a SQL string. + /** + * Double quote a Oracle identifier for placement in a SQL string. */ static QString quotedIdentifier( QString ident ); - /** Quote a value for placement in a SQL string. + /** + * Quote a value for placement in a SQL string. */ static QString quotedValue( const QVariant &value, QVariant::Type type = QVariant::Invalid ); diff --git a/src/providers/oracle/qgsoraclenewconnection.h b/src/providers/oracle/qgsoraclenewconnection.h index 6709c2e01443..48bdd7d40950 100644 --- a/src/providers/oracle/qgsoraclenewconnection.h +++ b/src/providers/oracle/qgsoraclenewconnection.h @@ -20,7 +20,8 @@ #include "qgsguiutils.h" #include "qgshelp.h" -/** \class QgsOracleNewConnection +/** + * \class QgsOracleNewConnection * \brief Dialog to allow the user to configure and save connection * information for a Oracle database */ diff --git a/src/providers/oracle/qgsoracleprovider.cpp b/src/providers/oracle/qgsoracleprovider.cpp index 7ceba8f26664..8f6140c86185 100644 --- a/src/providers/oracle/qgsoracleprovider.cpp +++ b/src/providers/oracle/qgsoracleprovider.cpp @@ -3030,7 +3030,8 @@ QGISEXTERN QgsOracleProvider *classFactory( const QString *uri ) return new QgsOracleProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/oracle/qgsoracleprovider.h b/src/providers/oracle/qgsoracleprovider.h index 4279144f865e..112328ad5e79 100644 --- a/src/providers/oracle/qgsoracleprovider.h +++ b/src/providers/oracle/qgsoracleprovider.h @@ -89,7 +89,8 @@ class QgsOracleProvider : public QgsVectorDataProvider virtual QgsCoordinateReferenceSystem crs() const override; QgsWkbTypes::Type wkbType() const override; - /** Return the number of layers for the current data source + /** + * Return the number of layers for the current data source * \note Should this be subLayerCount() instead? */ size_t layerCount() const; @@ -115,14 +116,16 @@ class QgsOracleProvider : public QgsVectorDataProvider virtual QgsRectangle extent() const override; virtual void updateExtents() override; - /** Determine the fields making up the primary key + /** + * Determine the fields making up the primary key */ bool determinePrimaryKey(); QgsFields fields() const override; QString dataComment() const override; - /** Reset the layer + /** + * Reset the layer */ void rewind(); @@ -178,7 +181,8 @@ class QgsOracleProvider : public QgsVectorDataProvider QgsField field( int index ) const; - /** Load the field list + /** + * Load the field list */ bool loadFields(); @@ -330,7 +334,8 @@ class QgsOracleUtils }; -/** Data shared between provider class and its feature sources. Ideally there should +/** + * Data shared between provider class and its feature sources. Ideally there should * be as few members as possible because there could be simultaneous reads/writes * from different threads and therefore locking has to be involved. */ class QgsOracleSharedData diff --git a/src/providers/oracle/qgsoraclesourceselect.h b/src/providers/oracle/qgsoraclesourceselect.h index b8d53f5464de..5dd159400265 100644 --- a/src/providers/oracle/qgsoraclesourceselect.h +++ b/src/providers/oracle/qgsoraclesourceselect.h @@ -75,7 +75,8 @@ class QgsOracleSourceSelectDelegate : public QItemDelegate }; -/** \class QgsOracleSourceSelect +/** + * \class QgsOracleSourceSelect * \brief Dialog to create connections and add tables from Oracle. * * This dialog allows the user to define and save connection information @@ -106,7 +107,8 @@ class QgsOracleSourceSelect : public QgsAbstractDataSourceWidget, private Ui::Qg void addButtonClicked() override; void buildQuery(); - /** Connects to the database using the stored connection parameters. + /** + * Connects to the database using the stored connection parameters. * Once connected, available layers are displayed. */ void on_btnConnect_clicked(); diff --git a/src/providers/oracle/qgsoracletablemodel.h b/src/providers/oracle/qgsoracletablemodel.h index c393c082d5b9..cea47adce5c4 100644 --- a/src/providers/oracle/qgsoracletablemodel.h +++ b/src/providers/oracle/qgsoracletablemodel.h @@ -23,7 +23,8 @@ class QIcon; -/** A model that holds the tables of a database in a hierarchy where the +/** + * A model that holds the tables of a database in a hierarchy where the schemas are the root elements that contain the individual tables as children. The tables have the following columns: Type, Owner, Tablename, Geometry Column, Sql*/ class QgsOracleTableModel : public QStandardItemModel diff --git a/src/providers/postgres/qgspgnewconnection.h b/src/providers/postgres/qgspgnewconnection.h index c8de2f514c87..9a01e60e6281 100644 --- a/src/providers/postgres/qgspgnewconnection.h +++ b/src/providers/postgres/qgspgnewconnection.h @@ -20,7 +20,8 @@ #include "qgsguiutils.h" #include "qgshelp.h" -/** \class QgsPgNewConnection +/** + * \class QgsPgNewConnection * \brief Dialog to allow the user to configure and save connection * information for a PostgreSQL database */ diff --git a/src/providers/postgres/qgspgsourceselect.h b/src/providers/postgres/qgspgsourceselect.h index 3dcf7595b95f..7074c50c99bb 100644 --- a/src/providers/postgres/qgspgsourceselect.h +++ b/src/providers/postgres/qgspgsourceselect.h @@ -52,7 +52,8 @@ class QgsPgSourceSelectDelegate : public QItemDelegate }; -/** \class QgsPgSourceSelect +/** + * \class QgsPgSourceSelect * \brief Dialog to create connections and add tables from PostgresQL. * * This dialog allows the user to define and save connection information @@ -88,7 +89,8 @@ class QgsPgSourceSelect : public QgsAbstractDataSourceWidget, private Ui::QgsDbS void addButtonClicked() override; void buildQuery(); - /** Connects to the database using the stored connection parameters. + /** + * Connects to the database using the stored connection parameters. * Once connected, available layers are displayed. */ void on_btnConnect_clicked(); diff --git a/src/providers/postgres/qgspgtablemodel.h b/src/providers/postgres/qgspgtablemodel.h index 679e11c43dd7..767625a0a8de 100644 --- a/src/providers/postgres/qgspgtablemodel.h +++ b/src/providers/postgres/qgspgtablemodel.h @@ -23,7 +23,8 @@ class QIcon; -/** A model that holds the tables of a database in a hierarchy where the +/** + * A model that holds the tables of a database in a hierarchy where the schemas are the root elements that contain the individual tables as children. The tables have the following columns: Type, Schema, Tablename, Geometry Column, Sql*/ class QgsPgTableModel : public QStandardItemModel diff --git a/src/providers/postgres/qgspostgresconn.h b/src/providers/postgres/qgspostgresconn.h index 59c1dda8db04..e2f6d83f42b5 100644 --- a/src/providers/postgres/qgspostgresconn.h +++ b/src/providers/postgres/qgspostgresconn.h @@ -261,15 +261,18 @@ class QgsPostgresConn : public QObject // cancel running query bool cancel(); - /** Double quote a PostgreSQL identifier for placement in a SQL string. + /** + * Double quote a PostgreSQL identifier for placement in a SQL string. */ static QString quotedIdentifier( const QString &ident ); - /** Quote a value for placement in a SQL string. + /** + * Quote a value for placement in a SQL string. */ static QString quotedValue( const QVariant &value ); - /** Get the list of supported layers + /** + * Get the list of supported layers * \param layers list to store layers in * \param searchGeometryColumnsOnly only look for geometry columns which are * contained in the geometry_columns metatable @@ -284,7 +287,8 @@ class QgsPostgresConn : public QObject bool allowGeometrylessTables = false, const QString &schema = QString() ); - /** Get the list of database schemas + /** + * Get the list of database schemas * \param schemas list to store schemas in * \returns true if schemas where fetched successfully * \since QGIS 2.7 @@ -293,7 +297,8 @@ class QgsPostgresConn : public QObject void retrieveLayerTypes( QgsPostgresLayerProperty &layerProperty, bool useEstimatedMetadata ); - /** Gets information about the spatial tables + /** + * Gets information about the spatial tables * \param searchGeometryColumnsOnly only look for geometry columns which are * contained in the geometry_columns metatable * \param searchPublicOnly diff --git a/src/providers/postgres/qgspostgresprovider.cpp b/src/providers/postgres/qgspostgresprovider.cpp index 035df3811324..85f317cd4335 100644 --- a/src/providers/postgres/qgspostgresprovider.cpp +++ b/src/providers/postgres/qgspostgresprovider.cpp @@ -4354,7 +4354,8 @@ QGISEXTERN QgsPostgresProvider *classFactory( const QString *uri ) return new QgsPostgresProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/postgres/qgspostgresprovider.h b/src/providers/postgres/qgspostgresprovider.h index ef3adfefde15..a919830bc07e 100644 --- a/src/providers/postgres/qgspostgresprovider.h +++ b/src/providers/postgres/qgspostgresprovider.h @@ -63,7 +63,8 @@ class QgsPostgresProvider : public QgsVectorDataProvider }; Q_ENUM( Relkind ); - /** Import a vector layer into the database + /** + * Import a vector layer into the database * \param options options for provider, specified via a map of option name * to value. Valid options are lowercaseFieldNames (set to true to convert * field names to lowercase), dropStringConstraints (set to true to remove @@ -97,7 +98,8 @@ class QgsPostgresProvider : public QgsVectorDataProvider virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request ) const override; QgsWkbTypes::Type wkbType() const override; - /** Return the number of layers for the current data source + /** + * Return the number of layers for the current data source * \note Should this be subLayerCount() instead? */ size_t layerCount() const; @@ -173,7 +175,8 @@ class QgsPostgresProvider : public QgsVectorDataProvider virtual bool supportsSubsetString() const override { return true; } QgsVectorDataProvider::Capabilities capabilities() const override; - /** The Postgres provider does its own transforms so we return + /** + * The Postgres provider does its own transforms so we return * true for the following three functions to indicate that transforms * should not be handled by the QgsCoordinateTransform object. See the * documentation on QgsVectorDataProvider for details on these functions. @@ -198,7 +201,8 @@ class QgsPostgresProvider : public QgsVectorDataProvider virtual QList discoverRelations( const QgsVectorLayer *self, const QList &layers ) const override; virtual QgsAttrPalIndexNameHash palAttributeIndexNames() const override; - /** Returns true if the data source has metadata, false otherwise. For + /** + * Returns true if the data source has metadata, false otherwise. For * example, if the kind of relation for the layer is a view or a * materialized view, then no metadata are associated with the data * source. @@ -247,7 +251,8 @@ class QgsPostgresProvider : public QgsVectorDataProvider QString geomParam( int offset ) const; - /** Get parametrized primary key clause + /** + * Get parametrized primary key clause * \param offset specifies offset to use for the pk value parameter * \param alias specifies an optional alias given to the subject table */ @@ -260,31 +265,36 @@ class QgsPostgresProvider : public QgsVectorDataProvider QgsField field( int index ) const; - /** Load the field list + /** + * Load the field list */ bool loadFields(); - /** Set the default widget type for the fields + /** + * Set the default widget type for the fields */ void setEditorWidgets(); //! Convert a QgsField to work with PG static bool convertField( QgsField &field, const QMap *options = nullptr ); - /** Parses the enum_range of an attribute and inserts the possible values into a stringlist + /** + * Parses the enum_range of an attribute and inserts the possible values into a stringlist \param enumValues the stringlist where the values are appended \param attributeName the name of the enum attribute \returns true in case of success and fals in case of error (e.g. if the type is not an enum type)*/ bool parseEnumRange( QStringList &enumValues, const QString &attributeName ) const; - /** Parses the possible enum values of a domain type (given in the check constraint of the domain type) + /** + * Parses the possible enum values of a domain type (given in the check constraint of the domain type) * \param enumValues Reference to list that receives enum values * \param attributeName Name of the domain type attribute * \returns true in case of success and false in case of error (e.g. if the attribute is not a domain type or does not have a check constraint) */ bool parseDomainCheckConstraint( QStringList &enumValues, const QString &attributeName ) const; - /** Return the type of primary key for a PK field + /** + * Return the type of primary key for a PK field * * \param fld the field to determine PK type of * \returns the PrimaryKeyType @@ -477,7 +487,8 @@ class QgsPostgresUtils } }; -/** Data shared between provider class and its feature sources. Ideally there should +/** + * Data shared between provider class and its feature sources. Ideally there should * be as few members as possible because there could be simultaneous reads/writes * from different threads and therefore locking has to be involved. */ class QgsPostgresSharedData diff --git a/src/providers/spatialite/qgsspatialiteconnection.h b/src/providers/spatialite/qgsspatialiteconnection.h index cc99914fd1cb..00c7467bf3d6 100644 --- a/src/providers/spatialite/qgsspatialiteconnection.h +++ b/src/providers/spatialite/qgsspatialiteconnection.h @@ -85,7 +85,8 @@ class QgsSpatiaLiteConnection : public QObject //! Checks if geometry_columns and spatial_ref_sys exist and have expected layout int checkHasMetadataTables( sqlite3 *handle ); - /** Inserts information about the spatial tables into mTables + /** + * Inserts information about the spatial tables into mTables \returns true if querying of tables was successful, false on error */ bool getTableInfo( sqlite3 *handle, bool loadGeometrylessTables ); diff --git a/src/providers/spatialite/qgsspatialiteprovider.cpp b/src/providers/spatialite/qgsspatialiteprovider.cpp index 56e002090c85..8b434e398cdd 100644 --- a/src/providers/spatialite/qgsspatialiteprovider.cpp +++ b/src/providers/spatialite/qgsspatialiteprovider.cpp @@ -5243,7 +5243,8 @@ QGISEXTERN QgsSpatiaLiteProvider *classFactory( const QString *uri ) return new QgsSpatiaLiteProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/spatialite/qgsspatialiteprovider.h b/src/providers/spatialite/qgsspatialiteprovider.h index ed643739c9be..fb6a828bc10e 100644 --- a/src/providers/spatialite/qgsspatialiteprovider.h +++ b/src/providers/spatialite/qgsspatialiteprovider.h @@ -84,7 +84,8 @@ class QgsSpatiaLiteProvider: public QgsVectorDataProvider virtual bool supportsSubsetString() const override { return true; } QgsWkbTypes::Type wkbType() const override; - /** Return the number of layers for the current data source + /** + * Return the number of layers for the current data source * * \note Should this be subLayerCount() instead? */ @@ -112,7 +113,8 @@ class QgsSpatiaLiteProvider: public QgsVectorDataProvider QVariant defaultValue( int fieldId ) const override; bool createAttributeIndex( int field ) override; - /** The SpatiaLite provider does its own transforms so we return + /** + * The SpatiaLite provider does its own transforms so we return * true for the following three functions to indicate that transforms * should not be handled by the QgsCoordinateTransform object. See the * documentation on QgsVectorDataProvider for details on these functions. diff --git a/src/providers/spatialite/qgsspatialitesourceselect.h b/src/providers/spatialite/qgsspatialitesourceselect.h index ba9990692e39..6d1122245697 100644 --- a/src/providers/spatialite/qgsspatialitesourceselect.h +++ b/src/providers/spatialite/qgsspatialitesourceselect.h @@ -35,7 +35,8 @@ class QStringList; class QTableWidgetItem; class QPushButton; -/** \class QgsSpatiaLiteSourceSelect +/** + * \class QgsSpatiaLiteSourceSelect * \brief Dialog to create connections and add tables from SpatiaLite. * * This dialog allows the user to define and save connection information @@ -69,7 +70,8 @@ class QgsSpatiaLiteSourceSelect: public QgsAbstractDataSourceWidget, private Ui: //! Triggered when the provider's connections need to be refreshed void refresh() override; - /** Connects to the database using the stored connection parameters. + /** + * Connects to the database using the stored connection parameters. * Once connected, available layers are displayed. */ void on_btnConnect_clicked(); diff --git a/src/providers/spatialite/qgsspatialitetablemodel.h b/src/providers/spatialite/qgsspatialitetablemodel.h index 854030510fe2..66d4aedfe60c 100644 --- a/src/providers/spatialite/qgsspatialitetablemodel.h +++ b/src/providers/spatialite/qgsspatialitetablemodel.h @@ -19,7 +19,8 @@ class QIcon; #include "qgis.h" -/** A model that holds the tables of a database in a hierarchy where the +/** + * A model that holds the tables of a database in a hierarchy where the SQLite DB is the root elements that contain the individual tables as children. The tables have the following columns: Type, Tablename, Geometry Column*/ class QgsSpatiaLiteTableModel: public QStandardItemModel @@ -32,7 +33,8 @@ class QgsSpatiaLiteTableModel: public QStandardItemModel //! Sets an sql statement that belongs to a cell specified by a model index void setSql( const QModelIndex &index, const QString &sql ); - /** Sets one or more geometry types to a row. In case of several types, additional rows are inserted. + /** + * Sets one or more geometry types to a row. In case of several types, additional rows are inserted. This is for tables where the type is detected later by thread*/ void setGeometryTypesForTable( const QString &table, const QString &attribute, const QString &type ); //! Returns the number of tables in the model diff --git a/src/providers/virtual/qgsvirtuallayerprovider.cpp b/src/providers/virtual/qgsvirtuallayerprovider.cpp index 080e63b3a504..c2d49bb63ec0 100644 --- a/src/providers/virtual/qgsvirtuallayerprovider.cpp +++ b/src/providers/virtual/qgsvirtuallayerprovider.cpp @@ -618,7 +618,8 @@ QGISEXTERN QgsVirtualLayerProvider *classFactory( const QString *uri ) return new QgsVirtualLayerProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/wcs/qgswcscapabilities.h b/src/providers/wcs/qgswcscapabilities.h index 1d277fe4d3cf..6029d653a0a2 100644 --- a/src/providers/wcs/qgswcscapabilities.h +++ b/src/providers/wcs/qgswcscapabilities.h @@ -125,7 +125,8 @@ class QgsWcsCapabilities : public QObject */ static QString prepareUri( QString uri ); - /** \brief Returns the GetCoverage full url + /** + * \brief Returns the GetCoverage full url * \param version optional version, e.g. 1.0.0 or 1.1.0 */ QString getCapabilitiesUrl( const QString &version ) const; @@ -141,7 +142,8 @@ class QgsWcsCapabilities : public QObject //! Send request to server bool sendRequest( QString const &url ); - /** Get additional coverage info from server. Version 1.0 GetCapabilities + /** + * Get additional coverage info from server. Version 1.0 GetCapabilities * response does not contain all info (CRS, formats). */ bool describeCoverage( QString const &identifier, bool forceRefresh = false ); @@ -192,11 +194,13 @@ class QgsWcsCapabilities : public QObject //! Get first child of specified name, NS is ignored static QDomElement firstChild( const QDomElement &element, const QString &name ); - /** Find sub elements by path which is string of dot separated tag names. + /** + * Find sub elements by path which is string of dot separated tag names. * NS is ignored. Example path: domainSet.spatialDomain.RectifiedGrid */ static QList domElements( const QDomElement &element, const QString &path ); - /** Find first sub element by path which is string of dot separated tag names. + /** + * Find first sub element by path which is string of dot separated tag names. * NS is ignored. Example path: domainSet.spatialDomain.RectifiedGrid */ static QDomElement domElement( const QDomElement &element, const QString &path ); @@ -318,7 +322,8 @@ class QgsWcsCapabilities : public QObject */ QString mError; - /** The mime type of the message + /** + * The mime type of the message */ QString mErrorFormat; diff --git a/src/providers/wcs/qgswcsprovider.h b/src/providers/wcs/qgswcsprovider.h index 5587d59237e8..a0d833ab8f3e 100644 --- a/src/providers/wcs/qgswcsprovider.h +++ b/src/providers/wcs/qgswcsprovider.h @@ -153,7 +153,8 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase bool isValid() const override; - /** Returns the base url + /** + * Returns the base url */ virtual QString baseUrl() const; @@ -285,7 +286,8 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase //! Number of bands int mBandCount = 0; - /** \brief Gdal data types used to represent data in in QGIS, + /** + * \brief Gdal data types used to represent data in in QGIS, may be longer than source data type to keep nulls indexed from 0 */ QList mGdalDataType; diff --git a/src/providers/wfs/qgswfsdataitems.h b/src/providers/wfs/qgswfsdataitems.h index b7882ee4e417..5fe961d6eb25 100644 --- a/src/providers/wfs/qgswfsdataitems.h +++ b/src/providers/wfs/qgswfsdataitems.h @@ -83,11 +83,13 @@ class QgsWfsLayerItem : public QgsLayerItem private slots: - /** Get style of the active data item (geonode layer item) and copy it to the clipboard. + /** + * Get style of the active data item (geonode layer item) and copy it to the clipboard. */ void copyStyle(); - /** Paste style on the clipboard to the active data item (geonode layer item) and push it to the source. + /** + * Paste style on the clipboard to the active data item (geonode layer item) and push it to the source. */ // void pasteStyle(); }; diff --git a/src/providers/wfs/qgswfsdatasourceuri.h b/src/providers/wfs/qgswfsdatasourceuri.h index 316114f11214..57f1d6268509 100644 --- a/src/providers/wfs/qgswfsdatasourceuri.h +++ b/src/providers/wfs/qgswfsdatasourceuri.h @@ -66,7 +66,8 @@ struct QgsWFSAuthorization QString mAuthCfg; }; -/** Utility class that wraps a QgsDataSourceUri with conveniency +/** + * Utility class that wraps a QgsDataSourceUri with conveniency * methods with the parameters used for a WFS URI. */ class QgsWFSDataSourceURI diff --git a/src/providers/wfs/qgswfsfeatureiterator.h b/src/providers/wfs/qgswfsfeatureiterator.h index 7accde8e945c..d1708fa1a50b 100644 --- a/src/providers/wfs/qgswfsfeatureiterator.h +++ b/src/providers/wfs/qgswfsfeatureiterator.h @@ -78,7 +78,8 @@ class QgsWFSProgressDialog: public QProgressDialog QPushButton *mHide = nullptr; }; -/** This class runs one (or several if paging is needed) GetFeature request, +/** + * This class runs one (or several if paging is needed) GetFeature request, process the results as soon as they arrived and notify them to the serializer to fill the case, and to the iterator that subscribed Instances of this class may be run in a dedicated thread (QgsWFSThreadedFeatureDownloader) @@ -92,7 +93,8 @@ class QgsWFSFeatureDownloader: public QgsWfsRequest explicit QgsWFSFeatureDownloader( QgsWFSSharedData *shared ); ~QgsWFSFeatureDownloader(); - /** Start the download. + /** + * Start the download. * \param serializeFeatures whether to notify the sharedData serializer. * \param maxFeatures user-defined limit of features to download. Overrides * the one defined in the URI. Typically by the QgsWFSProvider, @@ -142,7 +144,8 @@ class QgsWFSFeatureDownloader: public QgsWfsRequest //! Progress dialog QgsWFSProgressDialog *mProgressDialog = nullptr; - /** If the progress dialog should be shown immediately, or if it should be + /** + * If the progress dialog should be shown immediately, or if it should be let to QProgressDialog logic to decide when to show it */ bool mProgressDialogShowImmediately; bool mSupportsPaging; @@ -183,7 +186,8 @@ class QgsWFSThreadedFeatureDownloader: public QThread class QgsWFSFeatureSource; -/** Feature iterator. The iterator will internally both subscribe to a live +/** + * Feature iterator. The iterator will internally both subscribe to a live downloader to receive 'fresh' features, and to a iterator on the features already cached. It will actually start by consuming cache features for initial feedback, and then process the live downloaded features. */ diff --git a/src/providers/wfs/qgswfsprovider.h b/src/providers/wfs/qgswfsprovider.h index c84caca53a84..155b47ca636d 100644 --- a/src/providers/wfs/qgswfsprovider.h +++ b/src/providers/wfs/qgswfsprovider.h @@ -32,7 +32,8 @@ class QgsRectangle; class QgsWFSSharedData; -/** \ingroup WFSProvider +/** + * \ingroup WFSProvider * * A provider reading/write features from/into a WFS server. * @@ -145,13 +146,15 @@ class QgsWFSProvider : public QgsVectorDataProvider QString mProcessSQLErrorMsg; QString mProcessSQLWarningMsg; - /** Collects information about the field types. Is called internally from QgsWFSProvider ctor. + /** + * Collects information about the field types. Is called internally from QgsWFSProvider ctor. The method gives back the name of the geometry attribute and the thematic attributes with their types*/ bool describeFeatureType( QString &geometryAttribute, QgsFields &fields, QgsWkbTypes::Type &geomType ); - /** For a given typename, reads the name of the geometry attribute, the + /** + * For a given typename, reads the name of the geometry attribute, the thematic attributes and their types from a dom document. Returns true in case of success*/ bool readAttributesFromSchema( QDomDocument &schemaDoc, const QString &prefixedTypename, @@ -160,7 +163,8 @@ class QgsWFSProvider : public QgsVectorDataProvider //helper methods for WFS-T - /** Sends the transaction document to the server using HTTP POST + /** + * Sends the transaction document to the server using HTTP POST \returns true if transmission to the server succeeded, otherwise false note: true does not automatically mean that the transaction succeeded*/ bool sendTransactionDocument( const QDomDocument &doc, QDomDocument &serverResponse ); diff --git a/src/providers/wfs/qgswfsrequest.h b/src/providers/wfs/qgswfsrequest.h index 128b6f9af0e5..6544012053ad 100644 --- a/src/providers/wfs/qgswfsrequest.h +++ b/src/providers/wfs/qgswfsrequest.h @@ -103,7 +103,8 @@ class QgsWfsRequest : public QObject //! base service URL QUrl baseURL() const { return mUri.baseURL(); } - /** Return (translated) error message, composed with a + /** + * Return (translated) error message, composed with a (possibly translated, but sometimes coming from server) reason */ virtual QString errorMessageWithReason( const QString &reason ) = 0; diff --git a/src/providers/wfs/qgswfsshareddata.h b/src/providers/wfs/qgswfsshareddata.h index 844ab0c41988..0b6376beac3e 100644 --- a/src/providers/wfs/qgswfsshareddata.h +++ b/src/providers/wfs/qgswfsshareddata.h @@ -21,7 +21,8 @@ #include "qgswfscapabilities.h" #include "qgsogcutils.h" -/** This class holds data, and logic, shared between QgsWFSProvider, QgsWFSFeatureIterator +/** + * This class holds data, and logic, shared between QgsWFSProvider, QgsWFSFeatureIterator * and QgsWFSFeatureDownloader. It manages the on-disk cache, as a SpatiaLite * database. * @@ -51,22 +52,26 @@ class QgsWFSSharedData : public QObject explicit QgsWFSSharedData( const QString &uri ); ~QgsWFSSharedData(); - /** Used by a QgsWFSFeatureIterator to start a downloader and get the + /** + * Used by a QgsWFSFeatureIterator to start a downloader and get the generation counter. */ int registerToCache( QgsWFSFeatureIterator *iterator, const QgsRectangle &rect = QgsRectangle() ); - /** Used by the rewind() method of an iterator so as to get the up-to-date + /** + * Used by the rewind() method of an iterator so as to get the up-to-date generation counter. */ int getUpdatedCounter(); - /** Used by the background downloader to serialize downloaded features into + /** + * Used by the background downloader to serialize downloaded features into the cache. Also used by a WFS-T insert operation */ void serializeFeatures( QVector &featureList ); //! Called by QgsWFSFeatureDownloader::run() at the end of the download process. void endOfDownload( bool success, int featureCount, bool truncatedResponse, bool interrupted, const QString &errorMsg ); - /** Used by QgsWFSProvider::reloadData(). The effect is to invalid + /** + * Used by QgsWFSProvider::reloadData(). The effect is to invalid all the caching state, so that a new request results in fresh download */ void invalidateCache(); @@ -171,7 +176,8 @@ class QgsWFSSharedData : public QObject //! Create GML parser QgsGmlStreamingParser *createParser(); - /** If the server (typically MapServer WFS 1.1) honours EPSG axis order, but returns + /** + * If the server (typically MapServer WFS 1.1) honours EPSG axis order, but returns EPSG:XXXX srsName and not EPSG urns */ bool mGetFeatureEPSGDotHonoursEPSGOrder; @@ -198,7 +204,8 @@ class QgsWFSSharedData : public QObject //! Whether the downloader has finished (or been canceled) bool mDownloadFinished; - /** The generation counter. When a iterator is built or rewind, it gets the + /** + * The generation counter. When a iterator is built or rewind, it gets the current value of the generation counter to query the features in the cache whose generation counter is <= the current value. That way the iterator can consume first cached features, and then deal with the features that are @@ -235,11 +242,13 @@ class QgsWFSSharedData : public QObject //! Whether we have already tried fetching one feature after realizing that the capabilities extent is wrong bool mTryFetchingOneFeature; - /** Returns the set of gmlIds that have already been downloaded and + /** + * Returns the set of gmlIds that have already been downloaded and cached, so as to avoid to cache duplicates. */ QSet getExistingCachedGmlIds( const QVector &featureList ); - /** Returns the set of md5 of features that have already been downloaded and + /** + * Returns the set of md5 of features that have already been downloaded and cached, so as to avoid to cache duplicates. */ QSet getExistingCachedMD5( const QVector &featureList ); @@ -264,7 +273,8 @@ class QgsWFSFeatureHitsRequest: public QgsWfsRequest virtual QString errorMessageWithReason( const QString &reason ) override; }; -/** Utility class to issue a GetFeature requets with maxfeatures/count=1 +/** + * Utility class to issue a GetFeature requets with maxfeatures/count=1 * Used by QgsWFSSharedData::endOfDownload() when capabilities extent are likely wrong */ class QgsWFSSingleFeatureRequest: public QgsWfsRequest { diff --git a/src/providers/wfs/qgswfssourceselect.h b/src/providers/wfs/qgswfssourceselect.h index acdfe2d7188f..0b5bb6fddadf 100644 --- a/src/providers/wfs/qgswfssourceselect.h +++ b/src/providers/wfs/qgswfssourceselect.h @@ -71,7 +71,8 @@ class QgsWFSSourceSelect: public QgsAbstractDataSourceWidget, private Ui::QgsWFS QgsWFSSourceSelect(); //default constructor is forbidden QgsProjectionSelectionDialog *mProjectionSelector = nullptr; - /** Stores the available CRS for a server connections. + /** + * Stores the available CRS for a server connections. The first string is the typename, the corresponding list stores the CRS for the typename in the form 'EPSG:XXXX'*/ QMap mAvailableCRS; @@ -85,7 +86,8 @@ class QgsWFSSourceSelect: public QgsAbstractDataSourceWidget, private Ui::QgsWFS QModelIndex mSQLIndex; QgsSQLComposerDialog *mSQLComposerDialog = nullptr; - /** Returns the best suited CRS from a set of authority ids + /** + * Returns the best suited CRS from a set of authority ids 1. project CRS if contained in the set 2. WGS84 if contained in the set 3. the first entry in the set else diff --git a/src/providers/wfs/qgswfsutils.h b/src/providers/wfs/qgswfsutils.h index 369fe040836e..ba5023422e6b 100644 --- a/src/providers/wfs/qgswfsutils.h +++ b/src/providers/wfs/qgswfsutils.h @@ -22,7 +22,8 @@ #include #include -/** Utility class to deal mostly with the management of the temporary directory +/** + * Utility class to deal mostly with the management of the temporary directory that holds the on-disk cache. */ class QgsWFSUtils { diff --git a/src/providers/wms/qgstilecache.h b/src/providers/wms/qgstilecache.h index 9a08ba60d15b..eaf331f06441 100644 --- a/src/providers/wms/qgstilecache.h +++ b/src/providers/wms/qgstilecache.h @@ -23,7 +23,8 @@ class QImage; class QUrl; -/** A simple tile cache implementation. Tiles are cached according to their URL. +/** + * A simple tile cache implementation. Tiles are cached according to their URL. * There is a small in-memory cache and a secondary caching in the local disk. * The in-memory cache is there to save CPU time otherwise wasted to read and * uncompress data saved on the disk. diff --git a/src/providers/wms/qgswmscapabilities.h b/src/providers/wms/qgswmscapabilities.h index afc68553be82..e32381e62e91 100644 --- a/src/providers/wms/qgswmscapabilities.h +++ b/src/providers/wms/qgswmscapabilities.h @@ -762,7 +762,8 @@ class QgsWmsCapabilities -/** Class that handles download of capabilities. +/** + * Class that handles download of capabilities. */ class QgsWmsCapabilitiesDownload : public QObject { diff --git a/src/providers/wms/qgswmsprovider.cpp b/src/providers/wms/qgswmsprovider.cpp index 2db5ab309055..e14b04178798 100644 --- a/src/providers/wms/qgswmsprovider.cpp +++ b/src/providers/wms/qgswmsprovider.cpp @@ -3510,7 +3510,8 @@ QGISEXTERN QgsWmsProvider *classFactory( const QString *uri ) return new QgsWmsProvider( *uri ); } -/** Required key function (used to map the plugin to a data store type) +/** + * Required key function (used to map the plugin to a data store type) */ QGISEXTERN QString providerKey() { diff --git a/src/providers/wms/qgswmsprovider.h b/src/providers/wms/qgswmsprovider.h index b6ec1ee3ae4c..b5b358f50c70 100644 --- a/src/providers/wms/qgswmsprovider.h +++ b/src/providers/wms/qgswmsprovider.h @@ -154,7 +154,8 @@ class QgsWmsProvider : public QgsRasterDataProvider #if 0 - /** Returns true if layer has tile set profiles + /** + * Returns true if layer has tile set profiles */ virtual bool hasTiles() const; #endif @@ -339,7 +340,8 @@ class QgsWmsProvider : public QgsRasterDataProvider //! Get tiles from a different resolution to cover the missing areas void fetchOtherResTiles( QgsTileMode tileMode, const QgsRectangle &viewExtent, int imageWidth, QList &missing, double tres, int resOffset, QList &otherResTiles ); - /** Return the full url to request legend graphic + /** + * Return the full url to request legend graphic * The visibleExtent isi only used if provider supports contextual * legends according to the QgsWmsSettings * \since QGIS 2.8 @@ -429,7 +431,8 @@ class QgsWmsProvider : public QgsRasterDataProvider QString mError; - /** The mime type of the message + /** + * The mime type of the message */ QString mErrorFormat; diff --git a/src/providers/wms/qgswmssourceselect.h b/src/providers/wms/qgswmssourceselect.h index f3d05a088a12..66e35dc39a3b 100644 --- a/src/providers/wms/qgswmssourceselect.h +++ b/src/providers/wms/qgswmssourceselect.h @@ -69,7 +69,8 @@ class QgsWMSSourceSelect : public QgsAbstractDataSourceWidget, private Ui::QgsWM //! Loads connections from the file void on_btnLoad_clicked(); - /** Connects to the database using the stored connection parameters. + /** + * Connects to the database using the stored connection parameters. * Once connected, available layers are displayed. */ void on_btnConnect_clicked(); diff --git a/src/server/qgsaccesscontrol.h b/src/server/qgsaccesscontrol.h index 774c9a355b82..e732182b32e4 100644 --- a/src/server/qgsaccesscontrol.h +++ b/src/server/qgsaccesscontrol.h @@ -64,73 +64,85 @@ class SERVER_EXPORT QgsAccessControl : public QgsFeatureFilterProvider delete mPluginsAccessControls; } - /** Resolve features' filter of layers + /** + * Resolve features' filter of layers * \param layers to filter */ void resolveFilterFeatures( const QList &layers ); - /** Filter the features of the layer + /** + * Filter the features of the layer * \param layer the layer to control * \param filterFeatures the request to fill */ void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures ) const; - /** Return a clone of the object + /** + * Return a clone of the object * \returns A clone */ QgsFeatureFilterProvider *clone() const SIP_FACTORY; - /** Return an additional subset string (typically SQL) filter + /** + * Return an additional subset string (typically SQL) filter * \param layer the layer to control * \returns the subset string to use */ QString extraSubsetString( const QgsVectorLayer *layer ) const; - /** Return the layer read right + /** + * Return the layer read right * \param layer the layer to control * \returns true if it can be read */ bool layerReadPermission( const QgsMapLayer *layer ) const; - /** Return the layer insert right + /** + * Return the layer insert right * \param layer the layer to control * \returns true if we can insert on it */ bool layerInsertPermission( const QgsVectorLayer *layer ) const; - /** Return the layer update right + /** + * Return the layer update right * \param layer the layer to control * \returns true if we can do an update */ bool layerUpdatePermission( const QgsVectorLayer *layer ) const; - /** Return the layer delete right + /** + * Return the layer delete right * \param layer the layer to control * \returns true if we can do a delete */ bool layerDeletePermission( const QgsVectorLayer *layer ) const; - /** Return the authorized layer attributes + /** + * Return the authorized layer attributes * \param layer the layer to control * \param attributes the list of attribute * \returns the list of visible attributes */ QStringList layerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const; - /** Are we authorized to modify the following geometry + /** + * Are we authorized to modify the following geometry * \param layer the layer to control * \param feature the concerned feature * \returns true if we are allowed to edit the feature */ bool allowToEdit( const QgsVectorLayer *layer, const QgsFeature &feature ) const; - /** Fill the capabilities caching key + /** + * Fill the capabilities caching key * \param cacheKey the list to fill with a cache variant * \returns false if we can't create a cache */ bool fillCacheKey( QStringList &cacheKey ) const; - /** Register an access control filter + /** + * Register an access control filter * \param accessControl the access control to add * \param priority the priority used to define the order */ diff --git a/src/server/qgsaccesscontrolfilter.h b/src/server/qgsaccesscontrolfilter.h index 2718e0054aaa..61f1ee73b248 100644 --- a/src/server/qgsaccesscontrolfilter.h +++ b/src/server/qgsaccesscontrolfilter.h @@ -53,7 +53,8 @@ class SERVER_EXPORT QgsAccessControlFilter public: - /** Constructor + /** + * Constructor * QgsServerInterface passed to plugins constructors * and must be passed to QgsAccessControlFilter instances. */ @@ -73,39 +74,45 @@ class SERVER_EXPORT QgsAccessControlFilter //! Return the QgsServerInterface instance const QgsServerInterface *serverInterface() const { return mServerInterface; } - /** Return an additional expression filter + /** + * Return an additional expression filter * \param layer the layer to control * \returns the filter expression */ virtual QString layerFilterExpression( const QgsVectorLayer *layer ) const; - /** Return an additional subset string (typically SQL) filter + /** + * Return an additional subset string (typically SQL) filter * \param layer the layer to control * \returns the subset string */ virtual QString layerFilterSubsetString( const QgsVectorLayer *layer ) const; - /** Return the layer permissions + /** + * Return the layer permissions * \param layer the layer to control * \returns the permission to use on the layer */ virtual LayerPermissions layerPermissions( const QgsMapLayer *layer ) const; - /** Return the authorized layer attributes + /** + * Return the authorized layer attributes * \param layer the layer to control * \param attributes the current list of visible attribute * \returns the new list of visible attributes */ virtual QStringList authorizedLayerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const; - /** Are we authorized to modify the following geometry + /** + * Are we authorized to modify the following geometry * \param layer the layer to control * \param feature the concerned feature * \returns true if we are allowed to edit */ virtual bool allowToEdit( const QgsVectorLayer *layer, const QgsFeature &feature ) const; - /** Cache key to used to create the capabilities cache + /** + * Cache key to used to create the capabilities cache * \returns the cache key, "" for no cache */ virtual QString cacheKey() const; diff --git a/src/server/qgsbufferserverresponse.h b/src/server/qgsbufferserverresponse.h index 1016ab1ac26c..cb263598f04e 100644 --- a/src/server/qgsbufferserverresponse.h +++ b/src/server/qgsbufferserverresponse.h @@ -66,12 +66,14 @@ class SERVER_EXPORT QgsBufferServerResponse: public QgsServerResponse */ bool headersSent() const override; - /** Set the http status code + /** + * Set the http status code * \param code HTTP status code value */ void setStatusCode( int code ) override; - /** Return the http status code + /** + * Return the http status code */ int statusCode() const override { return mStatusCode; } diff --git a/src/server/qgscapabilitiescache.h b/src/server/qgscapabilitiescache.h index 7d46397f05da..6d4c3dcb82db 100644 --- a/src/server/qgscapabilitiescache.h +++ b/src/server/qgscapabilitiescache.h @@ -24,7 +24,8 @@ #include #include "qgis_server.h" -/** \ingroup server +/** + * \ingroup server * A cache for capabilities xml documents (by configuration file path) */ class SERVER_EXPORT QgsCapabilitiesCache : public QObject @@ -33,20 +34,23 @@ class SERVER_EXPORT QgsCapabilitiesCache : public QObject public: QgsCapabilitiesCache(); - /** Returns cached capabilities document (or 0 if document for configuration file not in cache) + /** + * Returns cached capabilities document (or 0 if document for configuration file not in cache) * \param configFilePath the progect file path * \param key key used to separate different version in different cache */ const QDomDocument *searchCapabilitiesDocument( const QString &configFilePath, const QString &key ); - /** Inserts new capabilities document (creates a copy of the document, does not take ownership) + /** + * Inserts new capabilities document (creates a copy of the document, does not take ownership) * \param configFilePath the project file path * \param key key used to separate different version in different cache * \param doc the DOM document */ void insertCapabilitiesDocument( const QString &configFilePath, const QString &key, const QDomDocument *doc ); - /** Remove capabilities document + /** + * Remove capabilities document * \param path the project file path * \since QGIS 2.16 */ diff --git a/src/server/qgsconfigcache.h b/src/server/qgsconfigcache.h index c383b02e5671..fe856ede47c0 100644 --- a/src/server/qgsconfigcache.h +++ b/src/server/qgsconfigcache.h @@ -40,7 +40,8 @@ class SERVER_EXPORT QgsConfigCache : public QObject void removeEntry( const QString &path ); - /** If the project is not cached yet, then the project is read thank to the + /** + * If the project is not cached yet, then the project is read thank to the * path. If the project is not available, then a nullptr is returned. * \param path the filename of the QGIS project * \returns the project or nullptr if an error happened diff --git a/src/server/qgsfilterrestorer.h b/src/server/qgsfilterrestorer.h index ff89335820c4..ca60b0712697 100644 --- a/src/server/qgsfilterrestorer.h +++ b/src/server/qgsfilterrestorer.h @@ -28,7 +28,8 @@ class QgsMapLayer; class QgsAccessControl; -/** RAII class to restore layer filters on destruction +/** + * RAII class to restore layer filters on destruction */ class SERVER_EXPORT QgsOWSServerFilterRestorer { @@ -46,7 +47,8 @@ class SERVER_EXPORT QgsOWSServerFilterRestorer void restoreLayerFilters( const QHash &filterMap ); - /** Returns a reference to the object's hash of layers to original subsetString filters. + /** + * Returns a reference to the object's hash of layers to original subsetString filters. * Original layer subsetString filters MUST be inserted into this hash before modifying them. */ QHash &originalFilters() { return mOriginalLayerFilters; } @@ -56,7 +58,8 @@ class SERVER_EXPORT QgsOWSServerFilterRestorer static void applyAccessControlLayerFilters( const QgsAccessControl *accessControl, QgsMapLayer *mapLayer, QHash &originalLayerFilters ); - /** Applies filters from access control on layer. + /** + * Applies filters from access control on layer. * \param accessControl The access control instance * \param mapLayer The layer on which the filter has to be applied * \since QGIS 3.0 diff --git a/src/server/qgsftptransaction.h b/src/server/qgsftptransaction.h index 2d1285e15875..4d511730201b 100644 --- a/src/server/qgsftptransaction.h +++ b/src/server/qgsftptransaction.h @@ -17,7 +17,8 @@ #include -/** A class for synchronous ftp access (using QFtp in background) +/** + * A class for synchronous ftp access (using QFtp in background) * * \deprecated because of QFtp removal in Qt5. */ @@ -28,7 +29,8 @@ class QgsFtpTransaction: public QObject Q_DECL_DEPRECATED QgsFtpTransaction(); ~QgsFtpTransaction(); - /** Transfers the file with the given Url and stores it into ba + /** + * Transfers the file with the given Url and stores it into ba \param ftpUrl url of the file to access \param pointer to buffer to store file contents \returns 0 in case of success*/ diff --git a/src/server/qgshttptransaction.h b/src/server/qgshttptransaction.h index 85cfb5805b4b..afca877b4b99 100644 --- a/src/server/qgshttptransaction.h +++ b/src/server/qgshttptransaction.h @@ -30,7 +30,8 @@ class QTimer; // needs porting to Qt5 - until then don't include in api docs ///@cond PRIVATE -/** \ingroup server +/** + * \ingroup server * HTTP request/response manager that is redirect-aware. * This class extends the Qt QHttp concept by being able to recognise * and respond to redirection responses (e.g. HTTP code 302) @@ -90,7 +91,8 @@ class QgsHttpTransaction : public QObject */ QString errorString(); - /** Apply proxy settings from QSettings to a http object + /** + * Apply proxy settings from QSettings to a http object \returns true if proxy settings was applied, false else*/ static bool applyProxySettings( QHttp &http, const QString &url ); diff --git a/src/server/qgsinterpolationlayerbuilder.h b/src/server/qgsinterpolationlayerbuilder.h index e4c0ec913978..913847c41b2b 100644 --- a/src/server/qgsinterpolationlayerbuilder.h +++ b/src/server/qgsinterpolationlayerbuilder.h @@ -32,7 +32,8 @@ class QgsInterpolationLayerBuilder: public QgsMSLayerBuilder explicit QgsInterpolationLayerBuilder( QgsVectorLayer *vl ); - /** Creates a maplayer from xml tag + /** + * Creates a maplayer from xml tag \param elem xml element containing description of datasource \param filesToRemove list to append files that should be removed after the request \param layersToRemove list to append layers that should be removed after the request diff --git a/src/server/qgsmapserviceexception.h b/src/server/qgsmapserviceexception.h index bbd7f68db186..8943f61f43ec 100644 --- a/src/server/qgsmapserviceexception.h +++ b/src/server/qgsmapserviceexception.h @@ -23,7 +23,8 @@ #include "qgsserverexception.h" #include "qgis_server.h" -/** \ingroup server +/** + * \ingroup server * \class QgsMapServiceException * \brief Exception class for WMS service exceptions (for compatibility only). * diff --git a/src/server/qgsmslayerbuilder.h b/src/server/qgsmslayerbuilder.h index 82e3ab7c199b..a98167be2fa0 100644 --- a/src/server/qgsmslayerbuilder.h +++ b/src/server/qgsmslayerbuilder.h @@ -30,7 +30,8 @@ class QTemporaryFile; #include -/** Abstract base class for layer builders. +/** + * Abstract base class for layer builders. Provides the possibility to create QGIS maplayers from xml tag*/ class QgsMSLayerBuilder @@ -39,7 +40,8 @@ class QgsMSLayerBuilder QgsMSLayerBuilder() = default; virtual ~QgsMSLayerBuilder() = default; - /** Creates a maplayer from xml tag + /** + * Creates a maplayer from xml tag \param elem xml element containing description of datasource \param layerName sld name of the maplayer \param filesToRemove list to append files that should be removed after the request @@ -51,12 +53,14 @@ class QgsMSLayerBuilder //! Tries to create a suitable layer name from a URL. virtual QString layerNameFromUri( const QString &uri ) const; - /** Helper function that creates a new temporary file with random name under /tmp/qgis_wms_serv/ + /** + * Helper function that creates a new temporary file with random name under /tmp/qgis_wms_serv/ and returns the path of the file (Unix). On Windows, it is created in the current working directory and returns the filename only*/ QString createTempFile() const; - /** Resets the former symbology of a raster layer. This is important for single band layers (e.g. dems) + /** + * Resets the former symbology of a raster layer. This is important for single band layers (e.g. dems) coming from the cash*/ void clearRasterSymbology( QgsRasterLayer *rl ) const; }; diff --git a/src/server/qgsmslayercache.h b/src/server/qgsmslayercache.h index a18ca515c939..15a4287d0764 100644 --- a/src/server/qgsmslayercache.h +++ b/src/server/qgsmslayercache.h @@ -50,7 +50,8 @@ struct QgsMSLayerCacheEntry } }; -/** A singleton class that caches layer objects for the +/** + * A singleton class that caches layer objects for the QGIS mapserver*/ class QgsMSLayerCache: public QObject { @@ -66,14 +67,16 @@ class QgsMSLayerCache: public QObject */ void setMaxCacheLayers( int maxCacheLayers ); - /** Inserts a new layer into the cash + /** + * Inserts a new layer into the cash \param url the layer datasource \param layerName the layer name (to distinguish between different layers in a request using the same datasource \param configFile path of the config file (to invalidate entries if file changes). Can be empty (e.g. layers from sld) \param tempFiles some layers have temporary files. The cash makes sure they are removed when removing the layer from the cash*/ void insertLayer( const QString &url, const QString &layerName, QgsMapLayer *layer, const QString &configFile = QString(), const QList &tempFiles = QList() ); - /** Searches for the layer with the given url. + /** + * Searches for the layer with the given url. \returns a pointer to the layer or 0 if no such layer*/ QgsMapLayer *searchLayer( const QString &url, const QString &layerName, const QString &configFile = QString() ); @@ -91,7 +94,8 @@ class QgsMSLayerCache: public QObject //! Protected singleton constructor QgsMSLayerCache(); - /** Goes through the list and removes entries and layers + /** + * Goes through the list and removes entries and layers depending on their time stamps and the number of other layers*/ void updateEntries(); @@ -102,7 +106,8 @@ class QgsMSLayerCache: public QObject private: - /** Cash entries with pair url/layer name as a key. The layer name is necessary for cases where the same + /** + * Cash entries with pair url/layer name as a key. The layer name is necessary for cases where the same url is used several time in a request. It ensures that different layer instances are created for different layer names*/ QMultiHash, QgsMSLayerCacheEntry> mEntries; diff --git a/src/server/qgsremotedatasourcebuilder.h b/src/server/qgsremotedatasourcebuilder.h index 259e189d2a74..d7536d1b3cf4 100644 --- a/src/server/qgsremotedatasourcebuilder.h +++ b/src/server/qgsremotedatasourcebuilder.h @@ -38,7 +38,8 @@ class QgsRemoteDataSourceBuilder: public QgsMSLayerBuilder //! Saves the vector data into a temporary file and creates a vector layer. Returns a 0 pointer in case of error QgsVectorLayer *vectorLayerFromRemoteVDS( const QDomElement &remoteVDSElem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const; - /** Loads data from http or ftp + /** + * Loads data from http or ftp \returns 0 in case of success*/ int loadData( const QString &url, QByteArray &data ) const; }; diff --git a/src/server/qgsrequesthandler.h b/src/server/qgsrequesthandler.h index b42d16b726cb..4cc6bc4a7075 100644 --- a/src/server/qgsrequesthandler.h +++ b/src/server/qgsrequesthandler.h @@ -48,7 +48,8 @@ class SERVER_EXPORT QgsRequestHandler { public: - /** Constructor + /** + * Constructor * * Note that QgsServerRequest and QgsServerResponse MUST live in the same scope */ @@ -57,7 +58,8 @@ class SERVER_EXPORT QgsRequestHandler //! Allow plugins to return a QgsMapServiceException void setServiceException( const QgsServerException &ex ); - /** Send out HTTP headers and flush output buffer + /** + * Send out HTTP headers and flush output buffer * * This method is intended only for streaming * partial content. @@ -115,7 +117,8 @@ class SERVER_EXPORT QgsRequestHandler //! Return response http status code int statusCode() const; - /** Return the parsed parameters as a key-value pair, to modify + /** + * Return the parsed parameters as a key-value pair, to modify * a parameter setParameter( const QString &key, const QString &value) * and removeParameter(const QString &key) must be used */ @@ -130,7 +133,8 @@ class SERVER_EXPORT QgsRequestHandler //! Remove a request parameter void removeParameter( const QString &key ); - /** Parses the input and creates a request neutral Parameter/Value map + /** + * Parses the input and creates a request neutral Parameter/Value map * \note not available in Python bindings */ void parseInput() SIP_SKIP; diff --git a/src/server/qgssentdatasourcebuilder.h b/src/server/qgssentdatasourcebuilder.h index b876f6a521b9..1230af97f5da 100644 --- a/src/server/qgssentdatasourcebuilder.h +++ b/src/server/qgssentdatasourcebuilder.h @@ -32,7 +32,8 @@ class QgsSentDataSourceBuilder: public QgsMSLayerBuilder public: QgsSentDataSourceBuilder() = default; - /** Creates a maplayer from xml tag + /** + * Creates a maplayer from xml tag \param elem xml element containing description of datasource \param filesToRemove list to append files that should be removed after the request \param layersToRemove list to append layers that should be removed after the request diff --git a/src/server/qgsserver.h b/src/server/qgsserver.h index 5e6a3061afe3..6f4ffd908bf9 100644 --- a/src/server/qgsserver.h +++ b/src/server/qgsserver.h @@ -46,25 +46,29 @@ class QgsServerResponse; class QgsProject; -/** \ingroup server +/** + * \ingroup server * The QgsServer class provides OGC web services. */ class SERVER_EXPORT QgsServer { public: - /** Creates the server instance + /** + * Creates the server instance */ QgsServer(); - /** Set environment variable + /** + * Set environment variable * \param var environment variable name * \param val value * \since QGIS 2.14 */ void putenv( const QString &var, const QString &val ); - /** Handles the request. + /** + * Handles the request. * The query string is normally read from environment * but can be also passed in args and in this case overrides the environment * variable diff --git a/src/server/qgsserverexception.h b/src/server/qgsserverexception.h index 08fed8737928..91508f2b1a56 100644 --- a/src/server/qgsserverexception.h +++ b/src/server/qgsserverexception.h @@ -26,7 +26,8 @@ #include "qgis_sip.h" -/** \ingroup server +/** + * \ingroup server * \class QgsServerException * \brief Exception base class for server exceptions. * @@ -48,7 +49,8 @@ class SERVER_EXPORT QgsServerException */ int responseCode() const { return mResponseCode; } - /** Format the exception for sending to client + /** + * Format the exception for sending to client * * \param responseFormat QString to store the content type of the response format. * \returns QByteArray the fermatted response. @@ -61,7 +63,8 @@ class SERVER_EXPORT QgsServerException int mResponseCode; }; -/** \ingroup server +/** + * \ingroup server * \class QgsOgcServiceException * \brief Exception base class for service exceptions. * diff --git a/src/server/qgsserverfilter.h b/src/server/qgsserverfilter.h index 04cebb0908ba..010250a18b59 100644 --- a/src/server/qgsserverfilter.h +++ b/src/server/qgsserverfilter.h @@ -45,7 +45,8 @@ class SERVER_EXPORT QgsServerFilter public: - /** Constructor + /** + * Constructor * QgsServerInterface passed to plugins constructors * and must be passed to QgsServerFilter instances. */ @@ -56,17 +57,20 @@ class SERVER_EXPORT QgsServerFilter //! Return the QgsServerInterface instance QgsServerInterface *serverInterface() { return mServerInterface; } - /** Method called when the QgsRequestHandler is ready and populated with + /** + * Method called when the QgsRequestHandler is ready and populated with * parameters, just before entering the main switch for core services.*/ virtual void requestReady(); - /** Method called when the QgsRequestHandler processing has done and + /** + * Method called when the QgsRequestHandler processing has done and * the response is ready, just after the main switch for core services * and before final sending response to FCGI stdout. */ virtual void responseComplete(); - /** Method called when the QgsRequestHandler sends its data to FCGI stdout. + /** + * Method called when the QgsRequestHandler sends its data to FCGI stdout. * This normally occurs at the end of core services processing just after * the responseComplete() plugin hook. For streaming services (like WFS on * getFeature requests, sendResponse() might have been called several times diff --git a/src/server/qgsserverinterface.h b/src/server/qgsserverinterface.h index f89658de8919..255560b8cc50 100644 --- a/src/server/qgsserverinterface.h +++ b/src/server/qgsserverinterface.h @@ -108,7 +108,8 @@ class SERVER_EXPORT QgsServerInterface */ virtual QgsServerFiltersMap filters() = 0; - /** Register an access control filter + /** + * Register an access control filter * \param accessControl the access control to register * \param priority the priority used to order them */ diff --git a/src/server/qgsserverinterfaceimpl.h b/src/server/qgsserverinterfaceimpl.h index a2098acbddae..f97c22d8ba8a 100644 --- a/src/server/qgsserverinterfaceimpl.h +++ b/src/server/qgsserverinterfaceimpl.h @@ -56,7 +56,8 @@ class QgsServerInterfaceImpl : public QgsServerInterface // void registerAccessControl( QgsAccessControlFilter *accessControl, int priority = 0 ) override; - /** Gets the helper over all the registered access control filters + /** + * Gets the helper over all the registered access control filters * \returns the access control helper */ QgsAccessControl *accessControls() const override { return mAccessControls; } diff --git a/src/server/qgsserverprojectutils.h b/src/server/qgsserverprojectutils.h index ff1d7dab8bd3..e5ac911cb5bd 100644 --- a/src/server/qgsserverprojectutils.h +++ b/src/server/qgsserverprojectutils.h @@ -28,7 +28,8 @@ #endif -/** \ingroup server +/** + * \ingroup server * The QgsServerProjectUtils namespace provides a way to retrieve specific * entries from a QgsProject. * \since QGIS 3.0 @@ -36,235 +37,274 @@ namespace QgsServerProjectUtils { - /** Returns if owsService capabilities are enabled. + /** + * Returns if owsService capabilities are enabled. * \param project the QGIS project * \returns if owsService capabilities are enabled. */ SERVER_EXPORT bool owsServiceCapabilities( const QgsProject &project ); - /** Returns the owsService title defined in project. + /** + * Returns the owsService title defined in project. * \param project the QGIS project * \returns the owsService title if defined in project. */ SERVER_EXPORT QString owsServiceTitle( const QgsProject &project ); - /** Returns the owsService abstract defined in project. + /** + * Returns the owsService abstract defined in project. * \param project the QGIS project * \returns the owsService abstract if defined in project. */ SERVER_EXPORT QString owsServiceAbstract( const QgsProject &project ); - /** Returns the owsService keywords defined in project. + /** + * Returns the owsService keywords defined in project. * \param project the QGIS project * \returns the owsService keywords if defined in project. */ SERVER_EXPORT QStringList owsServiceKeywords( const QgsProject &project ); - /** Returns the owsService online resource defined in project. + /** + * Returns the owsService online resource defined in project. * \param project the QGIS project * \returns the owsService online resource if defined in project. */ SERVER_EXPORT QString owsServiceOnlineResource( const QgsProject &project ); - /** Returns the owsService contact organization defined in project. + /** + * Returns the owsService contact organization defined in project. * \param project the QGIS project * \returns the owsService contact organization if defined in project. */ SERVER_EXPORT QString owsServiceContactOrganization( const QgsProject &project ); - /** Returns the owsService contact position defined in project. + /** + * Returns the owsService contact position defined in project. * \param project the QGIS project * \returns the owsService contact position if defined in project. */ SERVER_EXPORT QString owsServiceContactPosition( const QgsProject &project ); - /** Returns the owsService contact person defined in project. + /** + * Returns the owsService contact person defined in project. * \param project the QGIS project * \returns the owsService contact person if defined in project. */ SERVER_EXPORT QString owsServiceContactPerson( const QgsProject &project ); - /** Returns the owsService contact mail defined in project. + /** + * Returns the owsService contact mail defined in project. * \param project the QGIS project * \returns the owsService contact mail if defined in project. */ SERVER_EXPORT QString owsServiceContactMail( const QgsProject &project ); - /** Returns the owsService contact phone defined in project. + /** + * Returns the owsService contact phone defined in project. * \param project the QGIS project * \returns the owsService contact phone if defined in project. */ SERVER_EXPORT QString owsServiceContactPhone( const QgsProject &project ); - /** Returns the owsService fees defined in project. + /** + * Returns the owsService fees defined in project. * \param project the QGIS project * \returns the owsService fees if defined in project. */ SERVER_EXPORT QString owsServiceFees( const QgsProject &project ); - /** Returns the owsService access constraints defined in project. + /** + * Returns the owsService access constraints defined in project. * \param project the QGIS project * \returns the owsService access constraints if defined in project. */ SERVER_EXPORT QString owsServiceAccessConstraints( const QgsProject &project ); - /** Returns the maximum width for WMS images defined in a QGIS project. + /** + * Returns the maximum width for WMS images defined in a QGIS project. * \param project the QGIS project * \returns width if defined in project, -1 otherwise. */ SERVER_EXPORT int wmsMaxWidth( const QgsProject &project ); - /** Returns the maximum height for WMS images defined in a QGIS project. + /** + * Returns the maximum height for WMS images defined in a QGIS project. * \param project the QGIS project * \returns height if defined in project, -1 otherwise. */ SERVER_EXPORT int wmsMaxHeight( const QgsProject &project ); - /** Returns the quality for WMS images defined in a QGIS project. + /** + * Returns the quality for WMS images defined in a QGIS project. * \param project the QGIS project * \returns quality if defined in project, -1 otherwise. */ SERVER_EXPORT int wmsImageQuality( const QgsProject &project ); - /** Returns if layer ids are used as name in WMS. + /** + * Returns if layer ids are used as name in WMS. * \param project the QGIS project * \returns if layer ids are used as name. */ SERVER_EXPORT bool wmsUseLayerIds( const QgsProject &project ); - /** Returns if the info format is SIA20145. + /** + * Returns if the info format is SIA20145. * \param project the QGIS project * \returns if the info format is SIA20145. */ SERVER_EXPORT bool wmsInfoFormatSia2045( const QgsProject &project ); - /** Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request. + /** + * Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request. * \param project the QGIS project * \returns if the geometry is displayed as Well Known Text in GetFeatureInfo request. */ SERVER_EXPORT bool wmsFeatureInfoAddWktGeometry( const QgsProject &project ); - /** Returns if the geometry has to be segmentize in GetFeatureInfo request. + /** + * Returns if the geometry has to be segmentize in GetFeatureInfo request. * \param project the QGIS project * \returns if the geometry has to be segmentize in GetFeatureInfo request. */ SERVER_EXPORT bool wmsFeatureInfoSegmentizeWktGeometry( const QgsProject &project ); - /** Returns the geometry precision for GetFeatureInfo request. + /** + * Returns the geometry precision for GetFeatureInfo request. * \param project the QGIS project * \returns the geometry precision for GetFeatureInfo request. */ SERVER_EXPORT int wmsFeatureInfoPrecision( const QgsProject &project ); - /** Returns the document element name for XML GetFeatureInfo request. + /** + * Returns the document element name for XML GetFeatureInfo request. * \param project the QGIS project * \returns the document element name for XML GetFeatureInfo request. */ SERVER_EXPORT QString wmsFeatureInfoDocumentElement( const QgsProject &project ); - /** Returns the document element namespace for XML GetFeatureInfo request. + /** + * Returns the document element namespace for XML GetFeatureInfo request. * \param project the QGIS project * \returns the document element namespace for XML GetFeatureInfo request. */ SERVER_EXPORT QString wmsFeatureInfoDocumentElementNs( const QgsProject &project ); - /** Returns the schema URL for XML GetFeatureInfo request. + /** + * Returns the schema URL for XML GetFeatureInfo request. * \param project the QGIS project * \returns the schema URL for XML GetFeatureInfo request. */ SERVER_EXPORT QString wmsFeatureInfoSchema( const QgsProject &project ); - /** Returns the mapping between layer name and wms layer name for GetFeatureInfo request. + /** + * Returns the mapping between layer name and wms layer name for GetFeatureInfo request. * \param project the QGIS project * \returns the mapping between layer name and wms layer name for GetFeatureInfo request. */ SERVER_EXPORT QHash wmsFeatureInfoLayerAliasMap( const QgsProject &project ); - /** Returns if Inspire is activated. + /** + * Returns if Inspire is activated. * \param project the QGIS project * \returns if Inspire is activated. */ SERVER_EXPORT bool wmsInspireActivate( const QgsProject &project ); - /** Returns the Inspire language. + /** + * Returns the Inspire language. * \param project the QGIS project * \returns the Inspire language if defined in project. */ SERVER_EXPORT QString wmsInspireLanguage( const QgsProject &project ); - /** Returns the Inspire metadata URL. + /** + * Returns the Inspire metadata URL. * \param project the QGIS project * \returns the Inspire metadata URL if defined in project. */ SERVER_EXPORT QString wmsInspireMetadataUrl( const QgsProject &project ); - /** Returns the Inspire metadata URL type. + /** + * Returns the Inspire metadata URL type. * \param project the QGIS project * \returns the Inspire metadata URL type if defined in project. */ SERVER_EXPORT QString wmsInspireMetadataUrlType( const QgsProject &project ); - /** Returns the Inspire temporal reference. + /** + * Returns the Inspire temporal reference. * \param project the QGIS project * \returns the Inspire temporal reference if defined in project. */ SERVER_EXPORT QString wmsInspireTemporalReference( const QgsProject &project ); - /** Returns the Inspire metadata date. + /** + * Returns the Inspire metadata date. * \param project the QGIS project * \returns the Inspire metadata date if defined in project. */ SERVER_EXPORT QString wmsInspireMetadataDate( const QgsProject &project ); - /** Returns the restricted composer list. + /** + * Returns the restricted composer list. * \param project the QGIS project * \returns the restricted composer list if defined in project. */ SERVER_EXPORT QStringList wmsRestrictedComposers( const QgsProject &project ); - /** Returns the WMS service url defined in a QGIS project. + /** + * Returns the WMS service url defined in a QGIS project. * \param project the QGIS project * \returns url if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wmsServiceUrl( const QgsProject &project ); - /** Returns the WMS root layer name defined in a QGIS project. + /** + * Returns the WMS root layer name defined in a QGIS project. * \param project the QGIS project * \returns root layer name if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wmsRootName( const QgsProject &project ); - /** Returns the restricted layer name list. + /** + * Returns the restricted layer name list. * \param project the QGIS project * \returns the restricted layer name list if defined in project. */ SERVER_EXPORT QStringList wmsRestrictedLayers( const QgsProject &project ); - /** Returns the WMS output CRS list. + /** + * Returns the WMS output CRS list. * \param project the QGIS project * \returns the WMS output CRS list. */ SERVER_EXPORT QStringList wmsOutputCrsList( const QgsProject &project ); - /** Returns the WMS Extent restriction. + /** + * Returns the WMS Extent restriction. * \param project the QGIS project * \returns the WMS Extent restriction. */ SERVER_EXPORT QgsRectangle wmsExtent( const QgsProject &project ); - /** Returns the WFS service url defined in a QGIS project. + /** + * Returns the WFS service url defined in a QGIS project. * \param project the QGIS project * \returns url if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wfsServiceUrl( const QgsProject &project ); - /** Returns the Layer ids list defined in a QGIS project as published in WFS. + /** + * Returns the Layer ids list defined in a QGIS project as published in WFS. * @param project the QGIS project * @return the Layer ids list. */ SERVER_EXPORT QStringList wfsLayerIds( const QgsProject &project ); - /** Returns the Layer precision defined in a QGIS project for the WFS GetFeature. + /** + * Returns the Layer precision defined in a QGIS project for the WFS GetFeature. * @param project the QGIS project * @param layerId the layer id in the project * @return the layer precision for WFS GetFeature. @@ -272,31 +312,36 @@ namespace QgsServerProjectUtils SERVER_EXPORT int wfsLayerPrecision( const QgsProject &project, const QString &layerId ); - /** Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities. + /** + * Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities. * @param project the QGIS project * @return the Layer ids list. */ SERVER_EXPORT QStringList wfstUpdateLayerIds( const QgsProject &project ); - /** Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities. + /** + * Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities. * @param project the QGIS project * @return the Layer ids list. */ SERVER_EXPORT QStringList wfstInsertLayerIds( const QgsProject &project ); - /** Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities. + /** + * Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities. * @param project the QGIS project * @return the Layer ids list. */ SERVER_EXPORT QStringList wfstDeleteLayerIds( const QgsProject &project ); - /** Returns the WCS service url defined in a QGIS project. + /** + * Returns the WCS service url defined in a QGIS project. * \param project the QGIS project * \returns url if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wcsServiceUrl( const QgsProject &project ); - /** Returns the Layer ids list defined in a QGIS project as published in WCS. + /** + * Returns the Layer ids list defined in a QGIS project as published in WCS. * \param project the QGIS project * \returns the Layer ids list. */ diff --git a/src/server/qgsserverresponse.h b/src/server/qgsserverresponse.h index bcab01591b16..8c98c6313247 100644 --- a/src/server/qgsserverresponse.h +++ b/src/server/qgsserverresponse.h @@ -78,12 +78,14 @@ class SERVER_EXPORT QgsServerResponse virtual bool headersSent() const = 0; - /** Set the http status code + /** + * Set the http status code * \param code HTTP status code value */ virtual void setStatusCode( int code ) = 0; - /** Return the http status code + /** + * Return the http status code */ virtual int statusCode() const = 0; diff --git a/src/server/qgsserversettings.h b/src/server/qgsserversettings.h index 6332c9ad7556..017207383269 100644 --- a/src/server/qgsserversettings.h +++ b/src/server/qgsserversettings.h @@ -62,7 +62,8 @@ class SERVER_EXPORT QgsServerSettingsEnv : public QObject }; #endif -/** \ingroup server +/** + * \ingroup server * QgsServerSettings provides a way to retrieve settings by prioritizing * according to environment variables, ini file and default values. * \since QGIS 3.0 @@ -81,34 +82,41 @@ class SERVER_EXPORT QgsServerSettings QVariant val; }; - /** Constructor. + /** + * Constructor. */ QgsServerSettings(); - /** Load settings according to current environment variables. + /** + * Load settings according to current environment variables. */ void load(); - /** Load setting for a specific environment variable name. + /** + * Load setting for a specific environment variable name. * \returns true if loading is successful, false in case of an invalid name. */ bool load( const QString &envVarName ); - /** Log a summary of settings currently loaded. + /** + * Log a summary of settings currently loaded. */ void logSummary() const; - /** Returns the ini file loaded by QSetting. + /** + * Returns the ini file loaded by QSetting. * \returns the path of the ini file or an empty string if none is loaded. */ QString iniFile() const; - /** Returns parallel rendering setting. + /** + * Returns parallel rendering setting. * \returns true if parallel rendering is activated, false otherwise. */ bool parallelRendering() const; - /** Returns the maximum number of threads to use. + /** + * Returns the maximum number of threads to use. * \returns the number of threads. */ int maxThreads() const; @@ -119,27 +127,32 @@ class SERVER_EXPORT QgsServerSettings */ int maxCacheLayers() const; - /** Returns the log level. + /** + * Returns the log level. * \returns the log level. */ QgsMessageLog::MessageLevel logLevel() const; - /** Returns the QGS project file to use. + /** + * Returns the QGS project file to use. * \returns the path of the QGS project or an empty string if none is defined. */ QString projectFile() const; - /** Returns the log file. + /** + * Returns the log file. * \returns the path of the log file or an empty string if none is defined. */ QString logFile() const; - /** Returns the cache size. + /** + * Returns the cache size. * \returns the cache size. */ qint64 cacheSize() const; - /** Returns the cache directory. + /** + * Returns the cache directory. * \returns the directory. */ QString cacheDirectory() const; diff --git a/src/server/services/wcs/qgswcsdescribecoverage.h b/src/server/services/wcs/qgswcsdescribecoverage.h index 10ee9d23818d..c0ce0924ded9 100644 --- a/src/server/services/wcs/qgswcsdescribecoverage.h +++ b/src/server/services/wcs/qgswcsdescribecoverage.h @@ -32,7 +32,8 @@ namespace QgsWcs QDomDocument createDescribeCoverageDocument( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request ); - /** Output WCS DescribeCoverage response + /** + * Output WCS DescribeCoverage response */ void writeDescribeCoverage( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response ); diff --git a/src/server/services/wcs/qgswcsgetcapabilities.h b/src/server/services/wcs/qgswcsgetcapabilities.h index 67b0f0a52be9..4138043d49c5 100644 --- a/src/server/services/wcs/qgswcsgetcapabilities.h +++ b/src/server/services/wcs/qgswcsgetcapabilities.h @@ -41,7 +41,8 @@ namespace QgsWcs const QgsProject *project, const QString &version, const QgsServerRequest &request ); - /** Output WCS GetCapabilities response + /** + * Output WCS GetCapabilities response */ void writeGetCapabilities( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wcs/qgswcsgetcoverage.h b/src/server/services/wcs/qgswcsgetcoverage.h index dbd73305341d..082c9ee035f8 100644 --- a/src/server/services/wcs/qgswcsgetcoverage.h +++ b/src/server/services/wcs/qgswcsgetcoverage.h @@ -24,7 +24,8 @@ namespace QgsWcs { - /** Output WCS GetCoverage response + /** + * Output WCS GetCoverage response */ void writeGetCoverage( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response ); diff --git a/src/server/services/wcs/qgswcsserviceexception.h b/src/server/services/wcs/qgswcsserviceexception.h index 1ff133d74c91..dbeb98e8e47a 100644 --- a/src/server/services/wcs/qgswcsserviceexception.h +++ b/src/server/services/wcs/qgswcsserviceexception.h @@ -25,7 +25,8 @@ namespace QgsWcs { - /** \ingroup server + /** + * \ingroup server * \class QgsserviceException * \brief Exception class for WFS service exceptions. */ @@ -45,7 +46,8 @@ namespace QgsWcs }; - /** \ingroup server + /** + * \ingroup server * \class QgsSecurityAccessException * \brief Exception thrown when data access violates access controls */ @@ -57,7 +59,8 @@ namespace QgsWcs {} }; - /** \ingroup server + /** + * \ingroup server * \class QgsRequestNotWellFormedException * \brief Exception thrown in case of malformed request */ diff --git a/src/server/services/wfs/qgswfsdescribefeaturetype.h b/src/server/services/wfs/qgswfsdescribefeaturetype.h index 84e261c0cd50..e14f19caaeb1 100644 --- a/src/server/services/wfs/qgswfsdescribefeaturetype.h +++ b/src/server/services/wfs/qgswfsdescribefeaturetype.h @@ -37,7 +37,8 @@ namespace QgsWfs QDomDocument createDescribeFeatureTypeDocument( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request ); - /** Output WFS GetCapabilities response + /** + * Output WFS GetCapabilities response */ void writeDescribeFeatureType( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response ); diff --git a/src/server/services/wfs/qgswfsgetfeature.h b/src/server/services/wfs/qgswfsgetfeature.h index 1bddc625646e..1a89edc71aba 100644 --- a/src/server/services/wfs/qgswfsgetfeature.h +++ b/src/server/services/wfs/qgswfsgetfeature.h @@ -47,19 +47,23 @@ namespace QgsWfs QString geometryName; }; - /** Transform Query element to getFeatureQuery + /** + * Transform Query element to getFeatureQuery */ getFeatureQuery parseQueryElement( QDomElement &queryElem ); - /** Transform RequestBody root element to getFeatureRequest + /** + * Transform RequestBody root element to getFeatureRequest */ getFeatureRequest parseGetFeatureRequestBody( QDomElement &docElem ); - /** Transform parameters to getFeatureRequest + /** + * Transform parameters to getFeatureRequest */ getFeatureRequest parseGetFeatureParameters( QgsServerRequest::Parameters parameters ); - /** Output WFS GetFeature response + /** + * Output WFS GetFeature response */ void writeGetFeature( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wfs/qgswfsserviceexception.h b/src/server/services/wfs/qgswfsserviceexception.h index e66da0beb842..8b9eb1ef7f99 100644 --- a/src/server/services/wfs/qgswfsserviceexception.h +++ b/src/server/services/wfs/qgswfsserviceexception.h @@ -25,7 +25,8 @@ namespace QgsWfs { - /** \ingroup server + /** + * \ingroup server * \class QgsserviceException * \brief Exception class for WFS service exceptions. */ @@ -45,7 +46,8 @@ namespace QgsWfs }; - /** \ingroup server + /** + * \ingroup server * \class QgsSecurityAccessException * \brief Exception thrown when data access violates access controls */ @@ -57,7 +59,8 @@ namespace QgsWfs {} }; - /** \ingroup server + /** + * \ingroup server * \class QgsRequestNotWellFormedException * \brief Exception thrown in case of malformed request */ diff --git a/src/server/services/wfs/qgswfstransaction.h b/src/server/services/wfs/qgswfstransaction.h index b787732be0aa..8fe7c991c252 100644 --- a/src/server/services/wfs/qgswfstransaction.h +++ b/src/server/services/wfs/qgswfstransaction.h @@ -79,29 +79,35 @@ namespace QgsWfs QList< transactionDelete > deletes; }; - /** Transform Insert element to transactionInsert + /** + * Transform Insert element to transactionInsert */ transactionInsert parseInsertActionElement( QDomElement &actionElem ); - /** Transform Update element to transactionUpdate + /** + * Transform Update element to transactionUpdate */ transactionUpdate parseUpdateActionElement( QDomElement &actionElem ); - /** Transform Delete element to transactionDelete + /** + * Transform Delete element to transactionDelete */ transactionDelete parseDeleteActionElement( QDomElement &actionElem ); - /** Transform RequestBody root element to getFeatureRequest + /** + * Transform RequestBody root element to getFeatureRequest */ transactionRequest parseTransactionRequestBody( QDomElement &docElem ); transactionRequest parseTransactionParameters( QgsServerRequest::Parameters parameters ); - /** Transform GML feature nodes to features + /** + * Transform GML feature nodes to features */ QgsFeatureList featuresFromGML( QDomNodeList featureNodeList, QgsVectorDataProvider *provider ); - /** Perform the transaction + /** + * Perform the transaction */ void performTransaction( transactionRequest &aRequest, QgsServerInterface *serverIface, const QgsProject *project ); diff --git a/src/server/services/wfs/qgswfsutils.h b/src/server/services/wfs/qgswfsutils.h index f07b82b5a2a1..99589815dc44 100644 --- a/src/server/services/wfs/qgswfsutils.h +++ b/src/server/services/wfs/qgswfsutils.h @@ -37,7 +37,8 @@ namespace QgsWfs { - /** Return the highest version supported by this implementation + /** + * Return the highest version supported by this implementation */ QString implementationVersion(); @@ -46,7 +47,8 @@ namespace QgsWfs */ QString serviceUrl( const QgsServerRequest &request, const QgsProject *project ); - /** Transform a Filter element to a feature request + /** + * Transform a Filter element to a feature request */ QgsFeatureRequest parseFilterElement( const QString &typeName, QDomElement &filterElem ); diff --git a/src/server/services/wms/qgsdxfwriter.h b/src/server/services/wms/qgsdxfwriter.h index 7031628cd2ce..d1b3a84fbc2f 100644 --- a/src/server/services/wms/qgsdxfwriter.h +++ b/src/server/services/wms/qgsdxfwriter.h @@ -18,7 +18,8 @@ email : david dot marteau at 3liz dot com namespace QgsWms { - /** Output GetMap response in DXF format + /** + * Output GetMap response in DXF format */ void writeAsDxf( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wms/qgslayerrestorer.h b/src/server/services/wms/qgslayerrestorer.h index 199ab05a45a9..116049d8f691 100644 --- a/src/server/services/wms/qgslayerrestorer.h +++ b/src/server/services/wms/qgslayerrestorer.h @@ -22,7 +22,8 @@ #include "qgsmaplayer.h" -/** RAII class to restore layer configuration on destruction (opacity, +/** + * RAII class to restore layer configuration on destruction (opacity, * filters, ...) * \since QGIS 3.0 */ diff --git a/src/server/services/wms/qgsmaprendererjobproxy.h b/src/server/services/wms/qgsmaprendererjobproxy.h index 985758336fad..75d691b1869d 100644 --- a/src/server/services/wms/qgsmaprendererjobproxy.h +++ b/src/server/services/wms/qgsmaprendererjobproxy.h @@ -24,7 +24,8 @@ namespace QgsWms { - /** \ingroup server + /** + * \ingroup server * thiss class provides a proxy for sequential or parallel map render job by * reading qsettings. * \since QGIS 3.0 @@ -33,7 +34,8 @@ namespace QgsWms { public: - /** Constructor. + /** + * Constructor. * \param accessControl Does not take ownership of QgsAccessControl */ QgsMapRendererJobProxy( @@ -42,13 +44,15 @@ namespace QgsWms , QgsAccessControl *accessControl ); - /** Sequential or parallel map rendering according to qsettings. + /** + * Sequential or parallel map rendering according to qsettings. * \param mapSettings passed to MapRendererJob * \param the rendered image */ void render( const QgsMapSettings &mapSettings, QImage *image ); - /** Take ownership of the painter used for rendering. + /** + * Take ownership of the painter used for rendering. * \returns painter */ QPainter *takePainter(); diff --git a/src/server/services/wms/qgswmsdescribelayer.h b/src/server/services/wms/qgswmsdescribelayer.h index 73dde5acf046..620529a2b3f0 100644 --- a/src/server/services/wms/qgswmsdescribelayer.h +++ b/src/server/services/wms/qgswmsdescribelayer.h @@ -22,7 +22,8 @@ namespace QgsWms { - /** Output GetMap response in DXF format + /** + * Output GetMap response in DXF format */ void writeDescribeLayer( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wms/qgswmsgetcapabilities.h b/src/server/services/wms/qgswmsgetcapabilities.h index 830b7f9dc1a6..8cf888a1ec35 100644 --- a/src/server/services/wms/qgswmsgetcapabilities.h +++ b/src/server/services/wms/qgswmsgetcapabilities.h @@ -64,7 +64,8 @@ namespace QgsWms QDomElement getServiceElement( QDomDocument &doc, const QgsProject *project, const QString &version, const QgsServerRequest &request ); - /** Output GetCapabilities response + /** + * Output GetCapabilities response */ void writeGetCapabilities( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wms/qgswmsgetcontext.h b/src/server/services/wms/qgswmsgetcontext.h index 5fdc47cb20f4..9556cf83169a 100644 --- a/src/server/services/wms/qgswmsgetcontext.h +++ b/src/server/services/wms/qgswmsgetcontext.h @@ -22,7 +22,8 @@ namespace QgsWms { - /** Output GetContext response + /** + * Output GetContext response */ void writeGetContext( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wms/qgswmsgetfeatureinfo.h b/src/server/services/wms/qgswmsgetfeatureinfo.h index de9cda70dfbb..55133a8e51fd 100644 --- a/src/server/services/wms/qgswmsgetfeatureinfo.h +++ b/src/server/services/wms/qgswmsgetfeatureinfo.h @@ -22,7 +22,8 @@ namespace QgsWms { - /** Output GetFeatureInfo response + /** + * Output GetFeatureInfo response */ void writeGetFeatureInfo( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wms/qgswmsgetlegendgraphics.h b/src/server/services/wms/qgswmsgetlegendgraphics.h index d32cc0df1ea2..0f64da08a9df 100644 --- a/src/server/services/wms/qgswmsgetlegendgraphics.h +++ b/src/server/services/wms/qgswmsgetlegendgraphics.h @@ -22,7 +22,8 @@ namespace QgsWms { - /** Output GetLegendGRaphics response + /** + * Output GetLegendGRaphics response */ void writeGetLegendGraphics( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wms/qgswmsgetmap.h b/src/server/services/wms/qgswmsgetmap.h index b83ecd6f00e1..dbe20b88c407 100644 --- a/src/server/services/wms/qgswmsgetmap.h +++ b/src/server/services/wms/qgswmsgetmap.h @@ -22,7 +22,8 @@ namespace QgsWms { - /** Output GetMap response in DXF format + /** + * Output GetMap response in DXF format */ void writeGetMap( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wms/qgswmsgetprint.h b/src/server/services/wms/qgswmsgetprint.h index adf243ac213a..8113196165b8 100644 --- a/src/server/services/wms/qgswmsgetprint.h +++ b/src/server/services/wms/qgswmsgetprint.h @@ -22,7 +22,8 @@ namespace QgsWms { - /** Output GetPrint response + /** + * Output GetPrint response */ void writeGetPrint( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, diff --git a/src/server/services/wms/qgswmsgetschemaextension.h b/src/server/services/wms/qgswmsgetschemaextension.h index 3600a6beba50..7d0b73a7a280 100644 --- a/src/server/services/wms/qgswmsgetschemaextension.h +++ b/src/server/services/wms/qgswmsgetschemaextension.h @@ -22,13 +22,15 @@ namespace QgsWms { - /** Output GetSchemaExtension response + /** + * Output GetSchemaExtension response */ void writeGetSchemaExtension( QgsServerInterface *serverIface, const QString &version, const QgsServerRequest &request, QgsServerResponse &response ); - /** Returns the schemaExtension for WMS 1.3.0 capabilities + /** + * Returns the schemaExtension for WMS 1.3.0 capabilities */ QDomDocument getSchemaExtension( QgsServerInterface *serverIface, const QString &version, const QgsServerRequest &request ); diff --git a/src/server/services/wms/qgswmsgetstyles.h b/src/server/services/wms/qgswmsgetstyles.h index b03a980bf88c..aea8234a228e 100644 --- a/src/server/services/wms/qgswmsgetstyles.h +++ b/src/server/services/wms/qgswmsgetstyles.h @@ -22,7 +22,8 @@ namespace QgsWms { - /** Output GetStyles response + /** + * Output GetStyles response */ void writeGetStyles( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response ); @@ -36,12 +37,14 @@ namespace QgsWms //GetStyle for compatibility with earlier QGIS versions - /** Output GetStyle response + /** + * Output GetStyle response */ void writeGetStyle( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response ); - /** Returns an SLD file with the style of the requested layer + /** + * Returns an SLD file with the style of the requested layer */ QDomDocument getStyle( QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request ); diff --git a/src/server/services/wms/qgswmsparameters.h b/src/server/services/wms/qgswmsparameters.h index eff5b3c569d6..16ebd463bacb 100644 --- a/src/server/services/wms/qgswmsparameters.h +++ b/src/server/services/wms/qgswmsparameters.h @@ -30,7 +30,8 @@ #include "qgsgeometry.h" #include "qgsprojectversion.h" -/** QgsWmsParameters provides an interface to retrieve and manipulate WMS +/** + * QgsWmsParameters provides an interface to retrieve and manipulate WMS * parameters received from the client. * \since QGIS 3.0 */ @@ -163,35 +164,42 @@ namespace QgsWms QVariant mValue; }; - /** Constructor. + /** + * Constructor. * \param map of parameters where keys are parameters' names. */ QgsWmsParameters( const QgsServerRequest::Parameters ¶meters ); - /** Constructor. + /** + * Constructor. */ QgsWmsParameters(); - /** Loads new parameters. + /** + * Loads new parameters. * \param map of parameters */ void load( const QgsServerRequest::Parameters ¶meters ); - /** Dumps parameters. + /** + * Dumps parameters. */ void dump() const; - /** Returns CRS or an empty string if none is defined. + /** + * Returns CRS or an empty string if none is defined. * \returns crs parameter as string */ QString crs() const; - /** Returns WIDTH parameter or an empty string if not defined. + /** + * Returns WIDTH parameter or an empty string if not defined. * \returns width parameter */ QString width() const; - /** Returns WIDTH parameter as an int or its default value if not + /** + * Returns WIDTH parameter as an int or its default value if not * defined. An exception is raised if WIDTH is defined and cannot be * converted. * \returns width parameter @@ -199,12 +207,14 @@ namespace QgsWms */ int widthAsInt() const; - /** Returns HEIGHT parameter or an empty string if not defined. + /** + * Returns HEIGHT parameter or an empty string if not defined. * \returns height parameter */ QString height() const; - /** Returns HEIGHT parameter as an int or its default value if not + /** + * Returns HEIGHT parameter as an int or its default value if not * defined. An exception is raised if HEIGHT is defined and cannot be * converted. * \returns height parameter @@ -212,55 +222,65 @@ namespace QgsWms */ int heightAsInt() const; - /** Returns VERSION parameter as a string or an empty string if not + /** + * Returns VERSION parameter as a string or an empty string if not * defined. * \returns version */ QString version() const; - /** Returns VERSION parameter if defined or its default value. + /** + * Returns VERSION parameter if defined or its default value. * \returns version */ QgsProjectVersion versionAsNumber() const; - /** Returns BBOX if defined or an empty string. + /** + * Returns BBOX if defined or an empty string. * \returns bbox parameter */ QString bbox() const; - /** Returns BBOX as a rectangle if defined and valid. An exception is + /** + * Returns BBOX as a rectangle if defined and valid. An exception is * raised if the BBOX string cannot be converted into a rectangle. * \returns bbox as rectangle * \throws QgsBadRequestException */ QgsRectangle bboxAsRectangle() const; - /** Returns SLD if defined or an empty string. + /** + * Returns SLD if defined or an empty string. * \returns sld */ QString sld() const; - /** Returns the list of feature selection found in SELECTION parameter. + /** + * Returns the list of feature selection found in SELECTION parameter. * \returns the list of selection */ QStringList selections() const; - /** Returns the list of filters found in FILTER parameter. + /** + * Returns the list of filters found in FILTER parameter. * \returns the list of filter */ QStringList filters() const; - /** Returns the filter geometry found in FILTER_GEOM parameter. + /** + * Returns the filter geometry found in FILTER_GEOM parameter. * \returns the filter geometry as Well Known Text. */ QString filterGeom() const; - /** Returns the list of opacities found in OPACITIES parameter. + /** + * Returns the list of opacities found in OPACITIES parameter. * \returns the list of opacities in string */ QStringList opacities() const; - /** Returns the list of opacities found in OPACITIES parameter as + /** + * Returns the list of opacities found in OPACITIES parameter as * integers. If an opacity cannot be converted into an integer, then an * exception is raised * \returns a list of opacities as integers @@ -268,60 +288,71 @@ namespace QgsWms */ QList opacitiesAsInt() const; - /** Returns nickname of layers found in LAYER and LAYERS parameters. + /** + * Returns nickname of layers found in LAYER and LAYERS parameters. * \returns nickname of layers */ QStringList allLayersNickname() const; - /** Returns nickname of layers found in QUERY_LAYERS parameter. + /** + * Returns nickname of layers found in QUERY_LAYERS parameter. * \returns nickname of layers */ QStringList queryLayersNickname() const; - /** Returns styles found in STYLE and STYLES parameters. + /** + * Returns styles found in STYLE and STYLES parameters. * \returns name of styles */ QStringList allStyles() const; - /** Returns parameters for each layer found in LAYER/LAYERS. + /** + * Returns parameters for each layer found in LAYER/LAYERS. * \returns layer parameters */ QList layersParameters() const; - /** Returns FORMAT parameter as a string. + /** + * Returns FORMAT parameter as a string. * \returns FORMAT parameter as string */ QString formatAsString() const; - /** Returns format. If the FORMAT parameter is not used, then the + /** + * Returns format. If the FORMAT parameter is not used, then the * default value is PNG. * \returns format */ Format format() const; - /** Returns INFO_FORMAT parameter as a string. + /** + * Returns INFO_FORMAT parameter as a string. * \returns INFO_FORMAT parameter as string */ QString infoFormatAsString() const; - /** Returns infoFormat. If the INFO_FORMAT parameter is not used, then the + /** + * Returns infoFormat. If the INFO_FORMAT parameter is not used, then the * default value is text/plain. * \returns infoFormat */ Format infoFormat() const; - /** Returns the infoFormat version for GML. If the INFO_FORMAT is not GML, + /** + * Returns the infoFormat version for GML. If the INFO_FORMAT is not GML, * then the default value is -1. * \returns infoFormat version */ int infoFormatVersion() const; - /** Returns I parameter or an empty string if not defined. + /** + * Returns I parameter or an empty string if not defined. * \returns i parameter */ QString i() const; - /** Returns I parameter as an int or its default value if not + /** + * Returns I parameter as an int or its default value if not * defined. An exception is raised if I is defined and cannot be * converted. * \returns i parameter @@ -329,12 +360,14 @@ namespace QgsWms */ int iAsInt() const; - /** Returns J parameter or an empty string if not defined. + /** + * Returns J parameter or an empty string if not defined. * \returns j parameter */ QString j() const; - /** Returns J parameter as an int or its default value if not + /** + * Returns J parameter as an int or its default value if not * defined. An exception is raised if J is defined and cannot be * converted. * \returns j parameter @@ -342,12 +375,14 @@ namespace QgsWms */ int jAsInt() const; - /** Returns X parameter or an empty string if not defined. + /** + * Returns X parameter or an empty string if not defined. * \returns x parameter */ QString x() const; - /** Returns X parameter as an int or its default value if not + /** + * Returns X parameter as an int or its default value if not * defined. An exception is raised if X is defined and cannot be * converted. * \returns x parameter @@ -355,12 +390,14 @@ namespace QgsWms */ int xAsInt() const; - /** Returns Y parameter or an empty string if not defined. + /** + * Returns Y parameter or an empty string if not defined. * \returns y parameter */ QString y() const; - /** Returns Y parameter as an int or its default value if not + /** + * Returns Y parameter as an int or its default value if not * defined. An exception is raised if Y is defined and cannot be * converted. * \returns j parameter @@ -368,160 +405,187 @@ namespace QgsWms */ int yAsInt() const; - /** Returns RULE parameter or an empty string if none is defined + /** + * Returns RULE parameter or an empty string if none is defined * \returns RULE parameter or an empty string if none is defined */ QString rule() const; - /** Returns RULELABEL parameter or an empty string if none is defined + /** + * Returns RULELABEL parameter or an empty string if none is defined * \returns RULELABEL parameter or an empty string if none is defined */ QString ruleLabel() const; - /** Returns RULELABEL as a bool. An exception is raised if an invalid + /** + * Returns RULELABEL as a bool. An exception is raised if an invalid * parameter is found. * \returns ruleLabel * \throws QgsBadRequestException */ bool ruleLabelAsBool() const; - /** Returns SHOWFEATURECOUNT parameter or an empty string if none is defined + /** + * Returns SHOWFEATURECOUNT parameter or an empty string if none is defined * \returns SHOWFEATURECOUNT parameter or an empty string if none is defined */ QString showFeatureCount() const; - /** Returns SHOWFEATURECOUNT as a bool. An exception is raised if an invalid + /** + * Returns SHOWFEATURECOUNT as a bool. An exception is raised if an invalid * parameter is found. * \returns showFeatureCount * \throws QgsBadRequestException */ bool showFeatureCountAsBool() const; - /** Returns FEATURE_COUNT parameter or an empty string if none is defined + /** + * Returns FEATURE_COUNT parameter or an empty string if none is defined * \returns FEATURE_COUNT parameter or an empty string if none is defined */ QString featureCount() const; - /** Returns FEATURE_COUNT as an integer. An exception is raised if an invalid + /** + * Returns FEATURE_COUNT as an integer. An exception is raised if an invalid * parameter is found. * \returns FeatureCount * \throws QgsBadRequestException */ int featureCountAsInt() const; - /** Returns SCALE parameter or an empty string if none is defined + /** + * Returns SCALE parameter or an empty string if none is defined * \returns SCALE parameter or an empty string if none is defined */ QString scale() const; - /** Returns SCALE as a double. An exception is raised if an invalid + /** + * Returns SCALE as a double. An exception is raised if an invalid * parameter is found. * \returns scale * \throws QgsBadRequestException */ double scaleAsDouble() const; - /** Returns BOXSPACE parameter or an empty string if not defined. + /** + * Returns BOXSPACE parameter or an empty string if not defined. * \returns BOXSPACE parameter or an empty string if not defined. */ QString boxSpace() const; - /** Returns BOXSPACE as a double or its default value if not defined. + /** + * Returns BOXSPACE as a double or its default value if not defined. * An exception is raised if an invalid parameter is found. * \returns boxSpace * \throws QgsBadRequestException */ double boxSpaceAsDouble() const; - /** Returns LAYERSPACE parameter or an empty string if not defined. + /** + * Returns LAYERSPACE parameter or an empty string if not defined. * \returns LAYERSPACE parameter or an empty string if not defined. */ QString layerSpace() const; - /** Returns LAYERSPACE as a double or its default value if not defined. + /** + * Returns LAYERSPACE as a double or its default value if not defined. * An exception is raised if an invalid parameter is found. * \returns layerSpace * \throws QgsBadRequestException */ double layerSpaceAsDouble() const; - /** Returns LAYERTITLESPACE parameter or an empty string if not defined. + /** + * Returns LAYERTITLESPACE parameter or an empty string if not defined. * \returns LAYERTITLESPACE parameter or an empty string if not defined. */ QString layerTitleSpace() const; - /** Returns LAYERTITLESPACE as a double. An exception is raised if an invalid + /** + * Returns LAYERTITLESPACE as a double. An exception is raised if an invalid * parameter is found. * \returns layerTitleSpace * \throws QgsBadRequestException */ double layerTitleSpaceAsDouble() const; - /** Returns SYMBOLSPACE parameter or an empty string if not defined. + /** + * Returns SYMBOLSPACE parameter or an empty string if not defined. * \returns SYMBOLSPACE parameter or an empty string if not defined. */ QString symbolSpace() const; - /** Returns SYMBOLSPACE as a double or its default value if not defined. + /** + * Returns SYMBOLSPACE as a double or its default value if not defined. * An exception is raised if an invalid parameter is found. * \returns symbolSpace * \throws QgsBadRequestException */ double symbolSpaceAsDouble() const; - /** Returns ICONLABELSPACE parameter or an empty string if not defined. + /** + * Returns ICONLABELSPACE parameter or an empty string if not defined. * \returns ICONLABELSPACE parameter or an empty string if not defined. */ QString iconLabelSpace() const; - /** Returns ICONLABELSPACE as a double or its default value if not + /** + * Returns ICONLABELSPACE as a double or its default value if not * defined. An exception is raised if an invalid parameter is found. * \returns iconLabelSpace * \throws QgsBadRequestException */ double iconLabelSpaceAsDouble() const; - /** Returns SYMBOLWIDTH parameter or an empty string if not defined. + /** + * Returns SYMBOLWIDTH parameter or an empty string if not defined. * \returns SYMBOLWIDTH parameter or an empty string if not defined. */ QString symbolWidth() const; - /** Returns SYMBOLWIDTH as a double or its default value if not defined. + /** + * Returns SYMBOLWIDTH as a double or its default value if not defined. * An exception is raised if an invalid parameter is found. * \returns symbolWidth * \throws QgsBadRequestException */ double symbolWidthAsDouble() const; - /** Returns SYMBOLHEIGHT parameter or an empty string if not defined. + /** + * Returns SYMBOLHEIGHT parameter or an empty string if not defined. * \returns SYMBOLHEIGHT parameter or an empty string if not defined. */ QString symbolHeight() const; - /** Returns SYMBOLHEIGHT as a double or its default value if not defined. + /** + * Returns SYMBOLHEIGHT as a double or its default value if not defined. * An exception is raised if an invalid parameter is found. * \returns symbolHeight * \throws QgsBadRequestException */ double symbolHeightAsDouble() const; - /** Returns the layer font (built thanks to the LAYERFONTFAMILY, + /** + * Returns the layer font (built thanks to the LAYERFONTFAMILY, * LAYERFONTSIZE, LAYERFONTBOLD, ... parameters). * \returns layerFont */ QFont layerFont() const; - /** Returns LAYERFONTFAMILY parameter or an empty string if not defined. + /** + * Returns LAYERFONTFAMILY parameter or an empty string if not defined. * \returns LAYERFONTFAMILY parameter or an empty string if not defined. */ QString layerFontFamily() const; - /** Returns LAYERFONTBOLD parameter or an empty string if not defined. + /** + * Returns LAYERFONTBOLD parameter or an empty string if not defined. * \returns LAYERFONTBOLD parameter or an empty string if not defined. */ QString layerFontBold() const; - /** Returns LAYERFONTBOLD as a boolean or its default value if not + /** + * Returns LAYERFONTBOLD as a boolean or its default value if not * defined. An exception is raised if an * invalid parameter is found. * \returns layerFontBold @@ -529,216 +593,253 @@ namespace QgsWms */ bool layerFontBoldAsBool() const; - /** Returns LAYERFONTITALIC parameter or an empty string if not defined. + /** + * Returns LAYERFONTITALIC parameter or an empty string if not defined. * \returns LAYERFONTITALIC parameter or an empty string if not defined. */ QString layerFontItalic() const; - /** Returns LAYERFONTITALIC as a boolean or its default value if not + /** + * Returns LAYERFONTITALIC as a boolean or its default value if not * defined. An exception is raised if an invalid parameter is found. * \returns layerFontItalic * \throws QgsBadRequestException */ bool layerFontItalicAsBool() const; - /** Returns LAYERFONTSIZE parameter or an empty string if not defined. + /** + * Returns LAYERFONTSIZE parameter or an empty string if not defined. * \returns LAYERFONTSIZE parameter or an empty string if not defined. */ QString layerFontSize() const; - /** Returns LAYERFONTSIZE as a double. An exception is raised if an invalid + /** + * Returns LAYERFONTSIZE as a double. An exception is raised if an invalid * parameter is found. * \returns layerFontSize * \throws QgsBadRequestException */ double layerFontSizeAsDouble() const; - /** Returns LAYERFONTCOLOR parameter or an empty string if not defined. + /** + * Returns LAYERFONTCOLOR parameter or an empty string if not defined. * \returns LAYERFONTCOLOR parameter or an empty string if not defined. */ QString layerFontColor() const; - /** Returns LAYERFONTCOLOR as a color or its defined value if not + /** + * Returns LAYERFONTCOLOR as a color or its defined value if not * defined. An exception is raised if an invalid parameter is found. * \returns layerFontColor * \throws QgsBadRequestException */ QColor layerFontColorAsColor() const; - /** Returns the item font (built thanks to the ITEMFONTFAMILY, + /** + * Returns the item font (built thanks to the ITEMFONTFAMILY, * ITEMFONTSIZE, ITEMFONTBOLD, ... parameters). * \returns itemFont */ QFont itemFont() const; - /** Returns ITEMFONTFAMILY parameter or an empty string if not defined. + /** + * Returns ITEMFONTFAMILY parameter or an empty string if not defined. * \returns ITEMFONTFAMILY parameter or an empty string if not defined. */ QString itemFontFamily() const; - /** Returns ITEMFONTBOLD parameter or an empty string if not defined. + /** + * Returns ITEMFONTBOLD parameter or an empty string if not defined. * \returns ITEMFONTBOLD parameter or an empty string if not defined. */ QString itemFontBold() const; - /** Returns ITEMFONTBOLD as a boolean or its default value if not + /** + * Returns ITEMFONTBOLD as a boolean or its default value if not * defined. An exception is raised if an invalid parameter is found. * \returns itemFontBold * \throws QgsBadRequestException */ bool itemFontBoldAsBool() const; - /** Returns ITEMFONTITALIC parameter or an empty string if not defined. + /** + * Returns ITEMFONTITALIC parameter or an empty string if not defined. * \returns ITEMFONTITALIC parameter or an empty string if not defined. */ QString itemFontItalic() const; - /** Returns ITEMFONTITALIC as a boolean or its default value if not + /** + * Returns ITEMFONTITALIC as a boolean or its default value if not * defined. An exception is raised if an invalid parameter is found. * \returns itemFontItalic * \throws QgsBadRequestException */ bool itemFontItalicAsBool() const; - /** Returns ITEMFONTSIZE parameter or an empty string if not defined. + /** + * Returns ITEMFONTSIZE parameter or an empty string if not defined. * \returns ITEMFONTSIZE parameter or an empty string if not defined. */ QString itemFontSize() const; - /** Returns ITEMFONTSIZE as a double. An exception is raised if an + /** + * Returns ITEMFONTSIZE as a double. An exception is raised if an * invalid parameter is found. * \returns itemFontSize * \throws QgsBadRequestException */ double itemFontSizeAsDouble() const; - /** Returns ITEMFONTCOLOR parameter or an empty string if not defined. + /** + * Returns ITEMFONTCOLOR parameter or an empty string if not defined. * \returns ITEMFONTCOLOR parameter or an empty string if not defined. */ QString itemFontColor() const; - /** Returns ITEMFONTCOLOR as a color. An exception is raised if an + /** + * Returns ITEMFONTCOLOR as a color. An exception is raised if an * invalid parameter is found. * \returns itemFontColor * \throws QgsBadRequestException */ QColor itemFontColorAsColor() const; - /** Returns LAYERTITLE parameter or an empty string if not defined. + /** + * Returns LAYERTITLE parameter or an empty string if not defined. * \returns LAYERTITLE parameter or an empty string if not defined. */ QString layerTitle() const; - /** Returns LAYERTITLE as a bool or its default value if not defined. An + /** + * Returns LAYERTITLE as a bool or its default value if not defined. An * exception is raised if an invalid parameter is found. * \returns layerTitle * \throws QgsBadRequestException */ bool layerTitleAsBool() const; - /** Returns legend settings + /** + * Returns legend settings * \returns legend settings */ QgsLegendSettings legendSettings() const; - /** Returns parameters for each highlight layer. + /** + * Returns parameters for each highlight layer. * \returns parameters for each highlight layer */ QList highlightLayersParameters() const; - /** Returns HIGHLIGHT_GEOM as a list of string in WKT. + /** + * Returns HIGHLIGHT_GEOM as a list of string in WKT. * \returns highlight geometries */ QStringList highlightGeom() const; - /** Returns HIGHLIGHT_GEOM as a list of geometries. An exception is + /** + * Returns HIGHLIGHT_GEOM as a list of geometries. An exception is * raised if an invalid geometry is found. * \returns highlight geometries * \throws QgsBadRequestException */ QList highlightGeomAsGeom() const; - /** Returns HIGHLIGHT_SYMBOL as a list of string. + /** + * Returns HIGHLIGHT_SYMBOL as a list of string. * \returns highlight sld symbols */ QStringList highlightSymbol() const; - /** Returns HIGHLIGHT_LABELSTRING as a list of string. + /** + * Returns HIGHLIGHT_LABELSTRING as a list of string. * \returns highlight label string */ QStringList highlightLabelString() const; - /** Returns HIGHLIGHT_LABELCOLOR as a list of string. + /** + * Returns HIGHLIGHT_LABELCOLOR as a list of string. * \returns highlight label color */ QStringList highlightLabelColor() const; - /** Returns HIGHLIGHT_LABELCOLOR as a list of color. An exception is + /** + * Returns HIGHLIGHT_LABELCOLOR as a list of color. An exception is * raised if an invalid color is found. * \returns highlight label color * \throws QgsBadRequestException */ QList highlightLabelColorAsColor() const; - /** Returns HIGHLIGHT_LABELSIZE as a list of string. + /** + * Returns HIGHLIGHT_LABELSIZE as a list of string. * \returns highlight label size */ QStringList highlightLabelSize() const; - /** Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised + /** + * Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised * if an invalid size is found. * \returns highlight label size * \throws QgsBadRequestException */ QList highlightLabelSizeAsInt() const; - /** Returns HIGHLIGHT_LABELWEIGHT as a list of string. + /** + * Returns HIGHLIGHT_LABELWEIGHT as a list of string. * \returns highlight label weight */ QStringList highlightLabelWeight() const; - /** Returns HIGHLIGHT_LABELWEIGHT as a list of int. An exception is + /** + * Returns HIGHLIGHT_LABELWEIGHT as a list of int. An exception is * raised if an invalid weight is found. * \returns highlight label weight * \throws QgsBadRequestException */ QList highlightLabelWeightAsInt() const; - /** Returns HIGHLIGHT_LABELFONT + /** + * Returns HIGHLIGHT_LABELFONT * \returns highlight label font */ QStringList highlightLabelFont() const; - /** Returns HIGHLIGHT_LABELBUFFERSIZE + /** + * Returns HIGHLIGHT_LABELBUFFERSIZE * \returns highlight label buffer size */ QStringList highlightLabelBufferSize() const; - /** Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float. An exception is + /** + * Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float. An exception is * raised if an invalid size is found. * \returns highlight label buffer size * \throws QgsBadRequestException */ QList highlightLabelBufferSizeAsFloat() const; - /** Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string. + /** + * Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string. * \returns highlight label buffer color */ QStringList highlightLabelBufferColor() const; - /** Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors. An axception + /** + * Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors. An axception * is raised if an invalid color is found. * \returns highlight label buffer color * \throws QgsBadRequestException */ QList highlightLabelBufferColorAsColor() const; - /** Returns WMS_PRECISION parameter or an empty string if not defined. + /** + * Returns WMS_PRECISION parameter or an empty string if not defined. * \returns wms precision parameter */ QString wmsPrecision() const; - /** Returns WMS_PRECISION parameter as an int or its default value if not + /** + * Returns WMS_PRECISION parameter as an int or its default value if not * defined. An exception is raised if WMS_PRECISION is defined and cannot be * converted. * \returns wms precision parameter @@ -746,12 +847,14 @@ namespace QgsWms */ int wmsPrecisionAsInt() const; - /** Returns TRANSPARENT parameter or an empty string if not defined. + /** + * Returns TRANSPARENT parameter or an empty string if not defined. * \returns TRANSPARENT parameter */ QString transparent() const; - /** Returns TRANSPARENT parameter as a bool or its default value if not + /** + * Returns TRANSPARENT parameter as a bool or its default value if not * defined. An exception is raised if TRANSPARENT is defined and cannot * be converted. * \returns transparent parameter @@ -759,12 +862,14 @@ namespace QgsWms */ bool transparentAsBool() const; - /** Returns BGCOLOR parameter or an empty string if not defined. + /** + * Returns BGCOLOR parameter or an empty string if not defined. * \returns BGCOLOR parameter */ QString backgroundColor() const; - /** Returns BGCOLOR parameter as a QColor or its default value if not + /** + * Returns BGCOLOR parameter as a QColor or its default value if not * defined. An exception is raised if BGCOLOR is defined and cannot * be converted. * \returns background color parameter @@ -772,12 +877,14 @@ namespace QgsWms */ QColor backgroundColorAsColor() const; - /** Returns DPI parameter or an empty string if not defined. + /** + * Returns DPI parameter or an empty string if not defined. * \returns DPI parameter */ QString dpi() const; - /** Returns DPI parameter as an int or its default value if not + /** + * Returns DPI parameter as an int or its default value if not * defined. An exception is raised if DPI is defined and cannot * be converted. * \returns dpi parameter @@ -785,12 +892,14 @@ namespace QgsWms */ int dpiAsInt() const; - /** Returns TEMPLATE parameter or an empty string if not defined. + /** + * Returns TEMPLATE parameter or an empty string if not defined. * \returns TEMPLATE parameter */ QString composerTemplate() const; - /** Returns the requested parameters for a composer map parameter. + /** + * Returns the requested parameters for a composer map parameter. * An exception is raised if parameters are defined and cannot be * converted like EXTENT, SCALE, ROTATION, GRID_INTERVAL_X and * GRID_INTERVAL_Y. diff --git a/src/server/services/wms/qgswmsrenderer.h b/src/server/services/wms/qgswmsrenderer.h index 001e80df420f..afedb9a76a2b 100644 --- a/src/server/services/wms/qgswmsrenderer.h +++ b/src/server/services/wms/qgswmsrenderer.h @@ -57,7 +57,8 @@ class QPaintDevice; class QPainter; class QStandardItem; -/** This class handles requestsi that share rendering: +/** + * This class handles requestsi that share rendering: * * This includes * - getfeatureinfo @@ -76,40 +77,47 @@ namespace QgsWms { public: - /** Constructor. Does _NOT_ take ownership of + /** + * Constructor. Does _NOT_ take ownership of QgsConfigParser and QgsCapabilitiesCache*/ QgsRenderer( QgsServerInterface *serverIface, const QgsProject *project, const QgsServerRequest::Parameters ¶meters ); - /** Returns the map legend as an image (or a null pointer in case of error). The caller takes ownership + /** + * Returns the map legend as an image (or a null pointer in case of error). The caller takes ownership of the image object*/ QImage *getLegendGraphics(); typedef QSet SymbolSet; typedef QHash HitTest; - /** Returns the map as an image (or a null pointer in case of error). The caller takes ownership + /** + * Returns the map as an image (or a null pointer in case of error). The caller takes ownership of the image object). If an instance to existing hit test structure is passed, instead of rendering it will fill the structure with symbols that would be used for rendering */ QImage *getMap( HitTest *hitTest = nullptr ); - /** Identical to getMap( HitTest* hitTest ) and updates the map settings actually used. + /** + * Identical to getMap( HitTest* hitTest ) and updates the map settings actually used. \since QGIS 3.0 */ QImage *getMap( QgsMapSettings &mapSettings, HitTest *hitTest = nullptr ); - /** Returns the map as DXF data + /** + * Returns the map as DXF data \param options: extracted from the FORMAT_OPTIONS parameter \returns the map as DXF data \since QGIS 3.0*/ QgsDxfExport getDxf( const QMap &options ); - /** Returns printed page as binary + /** + * Returns printed page as binary \param formatString out: format of the print output (e.g. pdf, svg, png, ...) \returns printed page as binary or 0 in case of error*/ QByteArray getPrint( const QString &formatString ); - /** Creates an xml document that describes the result of the getFeatureInfo request. + /** + * Creates an xml document that describes the result of the getFeatureInfo request. * May throw an exception */ QByteArray getFeatureInfo( const QString &version = "1.3.0" ); @@ -178,7 +186,8 @@ namespace QgsWms // Returns default dots per mm qreal dotsPerMm() const; - /** Creates a QImage from the HEIGHT and WIDTH parameters + /** + * Creates a QImage from the HEIGHT and WIDTH parameters * \param width image width (or -1 if width should be taken from WIDTH wms parameter) * \param height image height (or -1 if height should be taken from HEIGHT wms parameter) * \param useBbox flag to indicate if the BBOX has to be used to adapt aspect ratio @@ -187,7 +196,8 @@ namespace QgsWms */ QImage *createImage( int width = -1, int height = -1, bool useBbox = true ) const; - /** Configures mapSettings to the parameters + /** + * Configures mapSettings to the parameters * HEIGHT, WIDTH, BBOX, CRS. * \param paintDevice the device that is used for painting (for dpi) * may throw an exception @@ -197,7 +207,8 @@ namespace QgsWms QDomDocument featureInfoDocument( QList &layers, const QgsMapSettings &mapSettings, const QImage *outputImage, const QString &version ) const; - /** Appends feature info xml for the layer to the layer element of the feature info dom document + /** + * Appends feature info xml for the layer to the layer element of the feature info dom document \param featureBBox the bounding box of the selected features in output CRS \returns true in case of success*/ bool featureInfoFromVectorLayer( QgsVectorLayer *layer, @@ -223,13 +234,15 @@ namespace QgsWms //! Record which symbols within one layer would be rendered with the given renderer context void runHitTestLayer( QgsVectorLayer *vl, SymbolSet &usedSymbols, QgsRenderContext &context ) const; - /** Tests if a filter sql string is allowed (safe) + /** + * Tests if a filter sql string is allowed (safe) \returns true in case of success, false if string seems unsafe*/ bool testFilterStringSafety( const QString &filter ) const; //! Helper function for filter safety test. Groups stringlist to merge entries starting/ending with quotes static void groupStringList( QStringList &list, const QString &groupString ); - /** Checks WIDTH/HEIGHT values against MaxWidth and MaxHeight + /** + * Checks WIDTH/HEIGHT values against MaxWidth and MaxHeight \returns true if width/height values are okay*/ bool checkMaximumWidthHeight() const; diff --git a/src/server/services/wms/qgswmsserviceexception.h b/src/server/services/wms/qgswmsserviceexception.h index b24a8ff6272f..b7b5d1d6c312 100644 --- a/src/server/services/wms/qgswmsserviceexception.h +++ b/src/server/services/wms/qgswmsserviceexception.h @@ -25,7 +25,8 @@ namespace QgsWms { - /** \ingroup server + /** + * \ingroup server * \class QgsserviceException * \brief Exception class for WMS service exceptions. * @@ -49,7 +50,8 @@ namespace QgsWms }; - /** \ingroup server + /** + * \ingroup server * \class QgsSecurityException * \brief Exception thrown when data access violates access controls */ @@ -61,7 +63,8 @@ namespace QgsWms {} }; - /** \ingroup server + /** + * \ingroup server * \class QgsBadRequestException * \brief Exception thrown in case of malformed request */ diff --git a/src/server/services/wms/qgswmsutils.h b/src/server/services/wms/qgswmsutils.h index b8277c4ed112..e61388b224a1 100644 --- a/src/server/services/wms/qgswmsutils.h +++ b/src/server/services/wms/qgswmsutils.h @@ -47,20 +47,24 @@ namespace QgsWms JPEG }; - /** Return the highest version supported by this implementation + /** + * Return the highest version supported by this implementation */ QString ImplementationVersion(); - /** Return WMS service URL + /** + * Return WMS service URL */ QUrl serviceUrl( const QgsServerRequest &request, const QgsProject *project ); - /** Parse image format parameter + /** + * Parse image format parameter * \returns OutputFormat */ ImageOutputFormat parseImageFormat( const QString &format ); - /** Write image response + /** + * Write image response */ void writeImage( QgsServerResponse &response, QImage &img, const QString &formatStr, int imageQuality = -1 ); @@ -74,7 +78,8 @@ namespace QgsWms */ QgsRectangle parseBbox( const QString &bboxstr ); - /** Reads the layers and style lists from the parameters LAYERS and STYLES + /** + * Reads the layers and style lists from the parameters LAYERS and STYLES */ void readLayersAndStyles( const QgsServerRequest::Parameters ¶meters, QStringList &layersList, QStringList &stylesList ); diff --git a/tests/bench/main.cpp b/tests/bench/main.cpp index 78b8cd8d4254..381a84494434 100644 --- a/tests/bench/main.cpp +++ b/tests/bench/main.cpp @@ -61,7 +61,8 @@ typedef SInt32 SRefCon; #include "qgslogger.h" -/** Print usage text +/** + * Print usage text */ void usage( std::string const &appName ) { diff --git a/tests/code_layout/sipifyheader.h b/tests/code_layout/sipifyheader.h index 3a7f19f715a3..889425c2265d 100644 --- a/tests/code_layout/sipifyheader.h +++ b/tests/code_layout/sipifyheader.h @@ -54,7 +54,8 @@ typedef QMap SIP_PYALTERNATIVETYPE( 'QMap >' ) QgsChangedAttributesMap; typedef QMap >> SIP_PYALTERNATIVETYPE( 'QMap>' ) QgsChangedAttributesMap; -/** \ingroup core +/** + * \ingroup core * A super QGIS class */ #ifndef SIP_RUN // following will be hidden @@ -84,7 +85,8 @@ typedef QVector QgsSuperClass; } #endif -/** \ingroup core +/** + * \ingroup core * Documentation goes here * * Here's some comment mentioning another class QgsAutoAwesomemater::makeAwesome. diff --git a/tests/src/analysis/testqgszonalstatistics.cpp b/tests/src/analysis/testqgszonalstatistics.cpp index f33d5a4711e5..e2cdd0f78d7c 100644 --- a/tests/src/analysis/testqgszonalstatistics.cpp +++ b/tests/src/analysis/testqgszonalstatistics.cpp @@ -23,7 +23,8 @@ #include "qgszonalstatistics.h" #include "qgsproject.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the zonal statistics class */ class TestQgsZonalStatistics : public QObject diff --git a/tests/src/app/testqgisappclipboard.cpp b/tests/src/app/testqgisappclipboard.cpp index 991ce3c57731..9ac8451864a4 100644 --- a/tests/src/app/testqgisappclipboard.cpp +++ b/tests/src/app/testqgisappclipboard.cpp @@ -31,7 +31,8 @@ #include "qgspoint.h" #include "qgssettings.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgisApp clipboard. */ class TestQgisAppClipboard : public QObject diff --git a/tests/src/app/testqgisapppython.cpp b/tests/src/app/testqgisapppython.cpp index d7beb20fb41c..e2cc4d7f32e2 100644 --- a/tests/src/app/testqgisapppython.cpp +++ b/tests/src/app/testqgisapppython.cpp @@ -23,7 +23,8 @@ #include #include "qgspythonutils.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgisApp python support. */ class TestQgisAppPython : public QObject diff --git a/tests/src/app/testqgsattributetable.cpp b/tests/src/app/testqgsattributetable.cpp index 00defb6c3c10..d6638884f4fa 100644 --- a/tests/src/app/testqgsattributetable.cpp +++ b/tests/src/app/testqgsattributetable.cpp @@ -29,7 +29,8 @@ #include "qgstest.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the attribute table dialog */ class TestQgsAttributeTable : public QObject diff --git a/tests/src/app/testqgsfieldcalculator.cpp b/tests/src/app/testqgsfieldcalculator.cpp index 9c52833088e2..08e6b26f8ec8 100644 --- a/tests/src/app/testqgsfieldcalculator.cpp +++ b/tests/src/app/testqgsfieldcalculator.cpp @@ -25,7 +25,8 @@ #include "qgsmapcanvas.h" #include "qgsunittypes.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the field calculator */ class TestQgsFieldCalculator : public QObject diff --git a/tests/src/app/testqgsmeasuretool.cpp b/tests/src/app/testqgsmeasuretool.cpp index f5682473ba5f..1c3a0b3e4cb9 100644 --- a/tests/src/app/testqgsmeasuretool.cpp +++ b/tests/src/app/testqgsmeasuretool.cpp @@ -25,7 +25,8 @@ #include "qgsmapcanvas.h" #include "qgsunittypes.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the measure tool */ class TestQgsMeasureTool : public QObject diff --git a/tests/src/app/testqgsnodetool.cpp b/tests/src/app/testqgsnodetool.cpp index e1ec08bc468a..b6c7ccf3259d 100644 --- a/tests/src/app/testqgsnodetool.cpp +++ b/tests/src/app/testqgsnodetool.cpp @@ -42,7 +42,8 @@ namespace QTest } } -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the node tool */ class TestQgsNodeTool : public QObject diff --git a/tests/src/app/testqgsvectorlayersaveasdialog.cpp b/tests/src/app/testqgsvectorlayersaveasdialog.cpp index a74047d626b6..9b750863c972 100644 --- a/tests/src/app/testqgsvectorlayersaveasdialog.cpp +++ b/tests/src/app/testqgsvectorlayersaveasdialog.cpp @@ -25,7 +25,8 @@ #include "qgsmapcanvas.h" #include "qgsgui.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the save as dialog */ class TestQgsVectorLayerSaveAsDialog : public QObject diff --git a/tests/src/core/testcontrastenhancements.cpp b/tests/src/core/testcontrastenhancements.cpp index f9e1bf813e30..bcebafa86f4b 100644 --- a/tests/src/core/testcontrastenhancements.cpp +++ b/tests/src/core/testcontrastenhancements.cpp @@ -25,7 +25,8 @@ #include #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the ContrastEnhancements contrast enhancement classes. */ class TestContrastEnhancements: public QObject diff --git a/tests/src/core/testqgis.cpp b/tests/src/core/testqgis.cpp index 7d94bcdd0ebc..c2d140a097c0 100644 --- a/tests/src/core/testqgis.cpp +++ b/tests/src/core/testqgis.cpp @@ -22,7 +22,8 @@ //qgis includes... #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * Includes unit tests for the Qgis namespace */ class TestQgis : public QObject diff --git a/tests/src/core/testqgs25drenderer.cpp b/tests/src/core/testqgs25drenderer.cpp index 726d7bb3f572..9d912cd3b6ca 100644 --- a/tests/src/core/testqgs25drenderer.cpp +++ b/tests/src/core/testqgs25drenderer.cpp @@ -34,7 +34,8 @@ #include "qgscomposermap.h" #include "qgsmultirenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for 25d renderer. */ class TestQgs25DRenderer : public QObject diff --git a/tests/src/core/testqgsauthconfig.cpp b/tests/src/core/testqgsauthconfig.cpp index 90aeae6e8d08..c1628b76f328 100644 --- a/tests/src/core/testqgsauthconfig.cpp +++ b/tests/src/core/testqgsauthconfig.cpp @@ -22,7 +22,8 @@ #include "qgsauthcrypto.h" #include "qgsauthconfig.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * Unit tests for QgsAuthConfig */ class TestQgsAuthConfig: public QObject diff --git a/tests/src/core/testqgsauthcrypto.cpp b/tests/src/core/testqgsauthcrypto.cpp index b125919e96fb..30b7ad9883ad 100644 --- a/tests/src/core/testqgsauthcrypto.cpp +++ b/tests/src/core/testqgsauthcrypto.cpp @@ -21,7 +21,8 @@ #include "qgsapplication.h" #include "qgsauthcrypto.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * Unit tests for QgsAuthCrypto */ class TestQgsAuthCrypto: public QObject diff --git a/tests/src/core/testqgsauthmanager.cpp b/tests/src/core/testqgsauthmanager.cpp index e43e5b362828..dd537d02a1da 100644 --- a/tests/src/core/testqgsauthmanager.cpp +++ b/tests/src/core/testqgsauthmanager.cpp @@ -29,7 +29,8 @@ #include "qgsauthconfig.h" #include "qgssettings.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * Unit tests for QgsAuthManager */ class TestQgsAuthManager: public QObject diff --git a/tests/src/core/testqgsblendmodes.cpp b/tests/src/core/testqgsblendmodes.cpp index 66b725494a54..6cd3a526a67c 100644 --- a/tests/src/core/testqgsblendmodes.cpp +++ b/tests/src/core/testqgsblendmodes.cpp @@ -33,7 +33,8 @@ //qgis test includes #include "qgsmultirenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for layer blend modes */ class TestQgsBlendModes : public QObject diff --git a/tests/src/core/testqgscadutils.cpp b/tests/src/core/testqgscadutils.cpp index fbaf15d697e9..df7d28ec058e 100644 --- a/tests/src/core/testqgscadutils.cpp +++ b/tests/src/core/testqgscadutils.cpp @@ -22,7 +22,8 @@ #include "qgssnappingutils.h" #include "qgsvectorlayer.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsCadUtils class. */ class TestQgsCadUtils : public QObject diff --git a/tests/src/core/testqgscentroidfillsymbol.cpp b/tests/src/core/testqgscentroidfillsymbol.cpp index f8be98f4fbf4..c70a7c6240e3 100644 --- a/tests/src/core/testqgscentroidfillsymbol.cpp +++ b/tests/src/core/testqgscentroidfillsymbol.cpp @@ -34,7 +34,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for line fill symbol types. */ class TestQgsCentroidFillSymbol : public QObject diff --git a/tests/src/core/testqgscurve.cpp b/tests/src/core/testqgscurve.cpp index c7cedff17149..8000d71ce649 100644 --- a/tests/src/core/testqgscurve.cpp +++ b/tests/src/core/testqgscurve.cpp @@ -26,7 +26,8 @@ #include "qgspoint.h" #include "qgstest.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the operations on curve geometries */ class TestQgsCurve : public QObject diff --git a/tests/src/core/testqgsdatadefinedsizelegend.cpp b/tests/src/core/testqgsdatadefinedsizelegend.cpp index d25bed713fe5..adfb290f14c6 100644 --- a/tests/src/core/testqgsdatadefinedsizelegend.cpp +++ b/tests/src/core/testqgsdatadefinedsizelegend.cpp @@ -48,7 +48,8 @@ static QgsRenderContext _createRenderContext( double mupp, double dpi, double sc } -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for legend rendering when using data-defined size of markers. */ class TestQgsDataDefinedSizeLegend : public QObject diff --git a/tests/src/core/testqgsdataitem.cpp b/tests/src/core/testqgsdataitem.cpp index 97b9878259b1..2aef3f6f87fb 100644 --- a/tests/src/core/testqgsdataitem.cpp +++ b/tests/src/core/testqgsdataitem.cpp @@ -25,7 +25,8 @@ #include "qgslogger.h" #include "qgssettings.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsDataItem class. */ class TestQgsDataItem : public QObject diff --git a/tests/src/core/testqgsdiagram.cpp b/tests/src/core/testqgsdiagram.cpp index ad3ac94e1515..054f75469623 100644 --- a/tests/src/core/testqgsdiagram.cpp +++ b/tests/src/core/testqgsdiagram.cpp @@ -39,7 +39,8 @@ #include "qgspallabeling.h" #include "qgsproject.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * Unit tests for the diagram renderer */ class TestQgsDiagram : public QObject diff --git a/tests/src/core/testqgsellipsemarker.cpp b/tests/src/core/testqgsellipsemarker.cpp index a5db2b07f17a..6b9389d67318 100644 --- a/tests/src/core/testqgsellipsemarker.cpp +++ b/tests/src/core/testqgsellipsemarker.cpp @@ -36,7 +36,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for ellipse marker symbol types. */ class TestQgsEllipseMarkerSymbol : public QObject diff --git a/tests/src/core/testqgsfilledmarker.cpp b/tests/src/core/testqgsfilledmarker.cpp index b3f38579af25..644ceeced8cc 100644 --- a/tests/src/core/testqgsfilledmarker.cpp +++ b/tests/src/core/testqgsfilledmarker.cpp @@ -36,7 +36,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for QgsFilledMarkerSymbolLayer. */ class TestQgsFilledMarkerSymbol : public QObject diff --git a/tests/src/core/testqgsfontmarker.cpp b/tests/src/core/testqgsfontmarker.cpp index a7d842f77c4c..998483e5a532 100644 --- a/tests/src/core/testqgsfontmarker.cpp +++ b/tests/src/core/testqgsfontmarker.cpp @@ -36,7 +36,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for font marker symbol types. */ class TestQgsFontMarkerSymbol : public QObject diff --git a/tests/src/core/testqgsgeometry.cpp b/tests/src/core/testqgsgeometry.cpp index 0a0680ccf4d3..0bae440156f9 100644 --- a/tests/src/core/testqgsgeometry.cpp +++ b/tests/src/core/testqgsgeometry.cpp @@ -49,7 +49,8 @@ //qgs unit test utility class #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the different geometry operations on vector features. */ class TestQgsGeometry : public QObject diff --git a/tests/src/core/testqgsgeonodeconnection.cpp b/tests/src/core/testqgsgeonodeconnection.cpp index ca3f712229fd..4224738d5c7c 100644 --- a/tests/src/core/testqgsgeonodeconnection.cpp +++ b/tests/src/core/testqgsgeonodeconnection.cpp @@ -21,7 +21,8 @@ #include "qgslogger.h" #include "qgsmessagelog.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsGeoConnection class. */ diff --git a/tests/src/core/testqgsgml.cpp b/tests/src/core/testqgsgml.cpp index a458d19d1c80..a8c565694b02 100644 --- a/tests/src/core/testqgsgml.cpp +++ b/tests/src/core/testqgsgml.cpp @@ -23,7 +23,8 @@ #include "qgsapplication.h" #include "qgslogger.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for GML parsing */ class TestQgsGML : public QObject diff --git a/tests/src/core/testqgsgradients.cpp b/tests/src/core/testqgsgradients.cpp index 490eb48433b6..9416fce6b29d 100644 --- a/tests/src/core/testqgsgradients.cpp +++ b/tests/src/core/testqgsgradients.cpp @@ -34,7 +34,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for gradient fill types. */ class TestQgsGradients : public QObject diff --git a/tests/src/core/testqgshistogram.cpp b/tests/src/core/testqgshistogram.cpp index 3a17fac51466..d9ca3a613294 100644 --- a/tests/src/core/testqgshistogram.cpp +++ b/tests/src/core/testqgshistogram.cpp @@ -21,7 +21,8 @@ #include "qgsvectordataprovider.h" #include "qgshistogram.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for QgsHistogram */ class TestQgsHistogram : public QObject diff --git a/tests/src/core/testqgsinvertedpolygonrenderer.cpp b/tests/src/core/testqgsinvertedpolygonrenderer.cpp index 567456977002..eeae6e01a340 100644 --- a/tests/src/core/testqgsinvertedpolygonrenderer.cpp +++ b/tests/src/core/testqgsinvertedpolygonrenderer.cpp @@ -32,7 +32,8 @@ //qgis test includes #include "qgsmultirenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the different renderers for vector layers. */ class TestQgsInvertedPolygon : public QObject diff --git a/tests/src/core/testqgslinefillsymbol.cpp b/tests/src/core/testqgslinefillsymbol.cpp index 9e22c0ce8a4f..a9b62706ccb2 100644 --- a/tests/src/core/testqgslinefillsymbol.cpp +++ b/tests/src/core/testqgslinefillsymbol.cpp @@ -36,7 +36,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for line fill symbol types. */ class TestQgsLineFillSymbol : public QObject diff --git a/tests/src/core/testqgsmaplayer.cpp b/tests/src/core/testqgsmaplayer.cpp index 1ff55a672016..e7cd69deb431 100644 --- a/tests/src/core/testqgsmaplayer.cpp +++ b/tests/src/core/testqgsmaplayer.cpp @@ -44,7 +44,8 @@ class TestSignalReceiver : public QObject } }; -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsMapLayer class. */ class TestQgsMapLayer : public QObject diff --git a/tests/src/core/testqgsmaprendererjob.cpp b/tests/src/core/testqgsmaprendererjob.cpp index 6e838d980e99..aab59674fadc 100644 --- a/tests/src/core/testqgsmaprendererjob.cpp +++ b/tests/src/core/testqgsmaprendererjob.cpp @@ -42,7 +42,8 @@ //qgs unit test utility class #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsMapRendererJob class. * It will do some performance testing too * @@ -68,7 +69,8 @@ class TestQgsMapRendererJob : public QObject //! This method tests render performance void performanceTest(); - /** This unit test checks if rendering of adjacent tiles (e.g. to render images for tile caches) + /** + * This unit test checks if rendering of adjacent tiles (e.g. to render images for tile caches) * does not result in border effects */ void testFourAdjacentTiles_data(); diff --git a/tests/src/core/testqgsmaprotation.cpp b/tests/src/core/testqgsmaprotation.cpp index 2ddbeab42fea..cc4c68a806f1 100644 --- a/tests/src/core/testqgsmaprotation.cpp +++ b/tests/src/core/testqgsmaprotation.cpp @@ -34,7 +34,8 @@ //qgis unit test includes #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the map rotation feature */ class TestQgsMapRotation : public QObject diff --git a/tests/src/core/testqgsmaptopixelgeometrysimplifier.cpp b/tests/src/core/testqgsmaptopixelgeometrysimplifier.cpp index 3b58c8ad74b6..b143e91b49a8 100644 --- a/tests/src/core/testqgsmaptopixelgeometrysimplifier.cpp +++ b/tests/src/core/testqgsmaptopixelgeometrysimplifier.cpp @@ -41,7 +41,8 @@ //qgs unit test utility class #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsMapToPixelGeometrySimplifier class */ class TestQgsMapToPixelGeometrySimplifier : public QObject diff --git a/tests/src/core/testqgsmarkerlinesymbol.cpp b/tests/src/core/testqgsmarkerlinesymbol.cpp index a47153802c65..0e3c9d9552f9 100644 --- a/tests/src/core/testqgsmarkerlinesymbol.cpp +++ b/tests/src/core/testqgsmarkerlinesymbol.cpp @@ -36,7 +36,8 @@ //qgis unit test includes #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the Marker Line symbol */ class TestQgsMarkerLineSymbol : public QObject diff --git a/tests/src/core/testqgsogcutils.cpp b/tests/src/core/testqgsogcutils.cpp index ecb1c923d1ea..99679e90cbf3 100644 --- a/tests/src/core/testqgsogcutils.cpp +++ b/tests/src/core/testqgsogcutils.cpp @@ -22,7 +22,8 @@ #include #include "qgsapplication.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for OGC utilities */ class TestQgsOgcUtils : public QObject diff --git a/tests/src/core/testqgspainteffect.cpp b/tests/src/core/testqgspainteffect.cpp index 816568bcaa11..108d51aabe58 100644 --- a/tests/src/core/testqgspainteffect.cpp +++ b/tests/src/core/testqgspainteffect.cpp @@ -83,7 +83,8 @@ class DummyPaintEffect : public QgsPaintEffect -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for paint effects */ class TestQgsPaintEffect: public QObject diff --git a/tests/src/core/testqgspointpatternfillsymbol.cpp b/tests/src/core/testqgspointpatternfillsymbol.cpp index 9ca88d97bd77..1c3d4f1f65b8 100644 --- a/tests/src/core/testqgspointpatternfillsymbol.cpp +++ b/tests/src/core/testqgspointpatternfillsymbol.cpp @@ -36,7 +36,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for point pattern fill symbol types. */ class TestQgsPointPatternFillSymbol : public QObject diff --git a/tests/src/core/testqgsrasterblock.cpp b/tests/src/core/testqgsrasterblock.cpp index 23561e269759..de2017bb55e8 100644 --- a/tests/src/core/testqgsrasterblock.cpp +++ b/tests/src/core/testqgsrasterblock.cpp @@ -21,7 +21,8 @@ #include "qgsrasterlayer.h" #include "qgsrasterdataprovider.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsRasterBlock class. */ class TestQgsRasterBlock : public QObject diff --git a/tests/src/core/testqgsrasterfilewriter.cpp b/tests/src/core/testqgsrasterfilewriter.cpp index 4ed5ae0b44bf..a8b3e4d68011 100644 --- a/tests/src/core/testqgsrasterfilewriter.cpp +++ b/tests/src/core/testqgsrasterfilewriter.cpp @@ -34,7 +34,8 @@ #include "qgsrasterprojector.h" #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsRasterFileWriter class. */ class TestQgsRasterFileWriter: public QObject diff --git a/tests/src/core/testqgsrasterfill.cpp b/tests/src/core/testqgsrasterfill.cpp index 7383df23ca6f..125132c19a13 100644 --- a/tests/src/core/testqgsrasterfill.cpp +++ b/tests/src/core/testqgsrasterfill.cpp @@ -34,7 +34,8 @@ //qgis test includes #include "qgsmultirenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for raster fill types. */ class TestQgsRasterFill : public QObject diff --git a/tests/src/core/testqgsrasterlayer.cpp b/tests/src/core/testqgsrasterlayer.cpp index 07cc23db2090..910e36edf54d 100644 --- a/tests/src/core/testqgsrasterlayer.cpp +++ b/tests/src/core/testqgsrasterlayer.cpp @@ -46,7 +46,8 @@ //qgis unit test includes #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsRasterLayer class. */ class TestQgsRasterLayer : public QObject diff --git a/tests/src/core/testqgsrastersublayer.cpp b/tests/src/core/testqgsrastersublayer.cpp index a54994830a3d..ba4474119f00 100644 --- a/tests/src/core/testqgsrastersublayer.cpp +++ b/tests/src/core/testqgsrastersublayer.cpp @@ -40,7 +40,8 @@ //qgis unit test includes #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for raster sublayers */ class TestQgsRasterSubLayer : public QObject diff --git a/tests/src/core/testqgsrenderers.cpp b/tests/src/core/testqgsrenderers.cpp index 92b2e9121fa4..e852fd5a2474 100644 --- a/tests/src/core/testqgsrenderers.cpp +++ b/tests/src/core/testqgsrenderers.cpp @@ -30,7 +30,8 @@ //qgis test includes #include "qgsmultirenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the different renderers for vector layers. */ class TestQgsRenderers : public QObject diff --git a/tests/src/core/testqgsshapeburst.cpp b/tests/src/core/testqgsshapeburst.cpp index b724cd689193..9309130678b7 100644 --- a/tests/src/core/testqgsshapeburst.cpp +++ b/tests/src/core/testqgsshapeburst.cpp @@ -35,7 +35,8 @@ //qgis test includes #include "qgsmultirenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for shapeburst fill types. */ class TestQgsShapeburst : public QObject diff --git a/tests/src/core/testqgssimplemarker.cpp b/tests/src/core/testqgssimplemarker.cpp index 488a3fa1ffe8..68d067fecdbe 100644 --- a/tests/src/core/testqgssimplemarker.cpp +++ b/tests/src/core/testqgssimplemarker.cpp @@ -35,7 +35,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for simple marker symbol types. */ class TestQgsSimpleMarkerSymbol : public QObject diff --git a/tests/src/core/testqgsstyle.cpp b/tests/src/core/testqgsstyle.cpp index 97d0bd054560..826ecfe76147 100644 --- a/tests/src/core/testqgsstyle.cpp +++ b/tests/src/core/testqgsstyle.cpp @@ -32,7 +32,8 @@ #include "qgsstyle.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test to verify that styles are working correctly */ class TestStyle : public QObject diff --git a/tests/src/core/testqgssvgmarker.cpp b/tests/src/core/testqgssvgmarker.cpp index 8435f5439b54..651e0b893913 100644 --- a/tests/src/core/testqgssvgmarker.cpp +++ b/tests/src/core/testqgssvgmarker.cpp @@ -36,7 +36,8 @@ //qgis test includes #include "qgsrenderchecker.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for SVG marker symbol types. */ class TestQgsSvgMarkerSymbol : public QObject diff --git a/tests/src/core/testqgssymbol.cpp b/tests/src/core/testqgssymbol.cpp index d969b2bf8be0..a02d5c7b8561 100644 --- a/tests/src/core/testqgssymbol.cpp +++ b/tests/src/core/testqgssymbol.cpp @@ -33,7 +33,8 @@ #include "qgsstyle.h" -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test to verify that symbols are working correctly */ class TestQgsSymbol : public QObject diff --git a/tests/src/core/testqgsvectorfilewriter.cpp b/tests/src/core/testqgsvectorfilewriter.cpp index 78dec9845298..333b011e2842 100644 --- a/tests/src/core/testqgsvectorfilewriter.cpp +++ b/tests/src/core/testqgsvectorfilewriter.cpp @@ -33,7 +33,8 @@ #include #endif -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsVectorFileWriter class. * * Possible QVariant::Type s diff --git a/tests/src/core/testqgsvectorlayer.cpp b/tests/src/core/testqgsvectorlayer.cpp index 31d9498cc955..22e147d8d935 100644 --- a/tests/src/core/testqgsvectorlayer.cpp +++ b/tests/src/core/testqgsvectorlayer.cpp @@ -62,7 +62,8 @@ class TestSignalReceiver : public QObject } }; -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the vector layer class. */ class TestQgsVectorLayer : public QObject diff --git a/tests/src/core/testqgsvectorlayercache.cpp b/tests/src/core/testqgsvectorlayercache.cpp index e4c06c22831c..b6e137933ed3 100644 --- a/tests/src/core/testqgsvectorlayercache.cpp +++ b/tests/src/core/testqgsvectorlayercache.cpp @@ -27,7 +27,8 @@ #include #include -/** @ingroup UnitTests +/** + * @ingroup UnitTests * This is a unit test for the vector layer cache * * @see QgsVectorLayerCache diff --git a/tests/src/core/testqgsvectorlayerjoinbuffer.cpp b/tests/src/core/testqgsvectorlayerjoinbuffer.cpp index c0c3d3f488f9..f056cdcc2ac5 100644 --- a/tests/src/core/testqgsvectorlayerjoinbuffer.cpp +++ b/tests/src/core/testqgsvectorlayerjoinbuffer.cpp @@ -29,7 +29,8 @@ #include #include "qgslayertree.h" -/** @ingroup UnitTests +/** + * @ingroup UnitTests * This is a unit test for the vector layer join buffer * * @see QgsVectorLayerJoinBuffer diff --git a/tests/src/core/testziplayer.cpp b/tests/src/core/testziplayer.cpp index ce3ce38a4455..b5eaa020d109 100644 --- a/tests/src/core/testziplayer.cpp +++ b/tests/src/core/testziplayer.cpp @@ -31,7 +31,8 @@ #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test to verify that zip vector layers work */ class TestZipLayer: public QObject diff --git a/tests/src/gui/testqgsfieldexpressionwidget.cpp b/tests/src/gui/testqgsfieldexpressionwidget.cpp index d5bb9cf0113c..4612ae82ee43 100644 --- a/tests/src/gui/testqgsfieldexpressionwidget.cpp +++ b/tests/src/gui/testqgsfieldexpressionwidget.cpp @@ -24,7 +24,8 @@ #include #include -/** @ingroup UnitTests +/** + * @ingroup UnitTests * This is a unit test for the field expression widget * * @see QgsFieldExpressionWidget diff --git a/tests/src/gui/testqgsmaptoolzoom.cpp b/tests/src/gui/testqgsmaptoolzoom.cpp index c3781ae3f8a6..89b2e1fbb75a 100644 --- a/tests/src/gui/testqgsmaptoolzoom.cpp +++ b/tests/src/gui/testqgsmaptoolzoom.cpp @@ -62,7 +62,8 @@ void TestQgsMapToolZoom::cleanup() delete canvas; } -/** Zero drag areas can happen on pen based computer when a mouse down, +/** + * Zero drag areas can happen on pen based computer when a mouse down, * move, and up, all happened at the same spot due to the pen. In this case * QGIS thinks it is in dragging mode but it's not really and fails to zoom in. **/ diff --git a/tests/src/gui/testqgsquickprint.cpp b/tests/src/gui/testqgsquickprint.cpp index 902bc20b1d8a..2c3c4c5f777a 100644 --- a/tests/src/gui/testqgsquickprint.cpp +++ b/tests/src/gui/testqgsquickprint.cpp @@ -31,7 +31,8 @@ //qgis test includes #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the different renderers for vector layers. */ class TestQgsQuickPrint : public QObject diff --git a/tests/src/gui/testqgsrasterhistogram.cpp b/tests/src/gui/testqgsrasterhistogram.cpp index 5fd9a5b18063..1176c4ac18b1 100644 --- a/tests/src/gui/testqgsrasterhistogram.cpp +++ b/tests/src/gui/testqgsrasterhistogram.cpp @@ -34,7 +34,8 @@ #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test to verify that raster histogram works */ class TestRasterHistogram : public QObject diff --git a/tests/src/gui/testqgsscalerangewidget.cpp b/tests/src/gui/testqgsscalerangewidget.cpp index d568352399bd..ef082c168b4f 100644 --- a/tests/src/gui/testqgsscalerangewidget.cpp +++ b/tests/src/gui/testqgsscalerangewidget.cpp @@ -28,7 +28,8 @@ #include -/** @ingroup UnitTests +/** + * @ingroup UnitTests * This is a unit test for the scale range widget * * @see QgsScaleRangeWidget diff --git a/tests/src/providers/grass/testqgsgrassprovider.cpp b/tests/src/providers/grass/testqgsgrassprovider.cpp index 736bacc8f5bd..26f41272112f 100644 --- a/tests/src/providers/grass/testqgsgrassprovider.cpp +++ b/tests/src/providers/grass/testqgsgrassprovider.cpp @@ -182,7 +182,8 @@ class TestQgsGrassCommandGroup QMap expectedFids; }; -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsRasterLayer class. */ class TestQgsGrassProvider: public QObject diff --git a/tests/src/providers/testqgsgdalprovider.cpp b/tests/src/providers/testqgsgdalprovider.cpp index 700768ab7095..02b02ca81059 100644 --- a/tests/src/providers/testqgsgdalprovider.cpp +++ b/tests/src/providers/testqgsgdalprovider.cpp @@ -30,7 +30,8 @@ #include #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the gdal provider */ class TestQgsGdalProvider : public QObject diff --git a/tests/src/providers/testqgswcsprovider.cpp b/tests/src/providers/testqgswcsprovider.cpp index a18268b7ba64..28c787896295 100644 --- a/tests/src/providers/testqgswcsprovider.cpp +++ b/tests/src/providers/testqgswcsprovider.cpp @@ -29,7 +29,8 @@ #define TINY_VALUE std::numeric_limits::epsilon() * 20 -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the QgsRasterLayer class. */ class TestQgsWcsProvider: public QObject diff --git a/tests/src/providers/testqgswmscapabilities.cpp b/tests/src/providers/testqgswmscapabilities.cpp index 2d51d6794ef5..6158b878e865 100644 --- a/tests/src/providers/testqgswmscapabilities.cpp +++ b/tests/src/providers/testqgswmscapabilities.cpp @@ -18,7 +18,8 @@ #include #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the WMS capabilities parser. */ class TestQgsWmsCapabilities: public QObject diff --git a/tests/src/providers/testqgswmsprovider.cpp b/tests/src/providers/testqgswmsprovider.cpp index ab4106250fd4..f5fe01aa0a00 100644 --- a/tests/src/providers/testqgswmsprovider.cpp +++ b/tests/src/providers/testqgswmsprovider.cpp @@ -18,7 +18,8 @@ #include #include -/** \ingroup UnitTests +/** + * \ingroup UnitTests * This is a unit test for the WMS provider. */ class TestQgsWmsProvider: public QObject