From e47073b1e1df67ccef671f2579768270ffe370e9 Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Mon, 3 Apr 2017 10:31:30 +1000 Subject: [PATCH] \return -> \returns (for consistency) --- .../interpolation/DualEdgeTriangulation.h | 2 +- src/analysis/interpolation/NormVecDecorator.h | 2 +- src/analysis/interpolation/Triangulation.h | 4 +- .../interpolation/qgsgridfilewriter.h | 2 +- .../interpolation/qgsidwinterpolator.h | 2 +- src/analysis/interpolation/qgsinterpolator.h | 6 +- .../interpolation/qgstininterpolator.h | 4 +- src/analysis/network/qgsgraph.h | 2 +- src/analysis/network/qgsnetworkstrategy.h | 2 +- src/analysis/openstreetmap/qgsosmdownload.h | 4 +- src/analysis/openstreetmap/qgsosmimport.h | 2 +- src/analysis/raster/qgsalignraster.h | 8 +- src/analysis/raster/qgsninecellfilter.h | 6 +- src/analysis/raster/qgsrastercalculator.h | 6 +- src/analysis/raster/qgsrelief.h | 10 +- src/analysis/vector/qgspointsample.h | 2 +- src/analysis/vector/qgstransectsample.h | 4 +- src/analysis/vector/qgszonalstatistics.h | 4 +- src/app/dwg/libdxfrw/libdxfrw.h | 2 +- src/app/gps/qwtpolar-0.1/qwt_polar_curve.h | 10 +- src/app/gps/qwtpolar-1.0/qwt_polar_curve.h | 4 +- src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h | 4 +- src/app/nodetool/qgsmaptoolnodetool.h | 6 +- src/app/nodetool/qgsselectedfeature.h | 8 +- src/app/qgisapp.h | 18 ++-- src/app/qgisappinterface.h | 14 +-- src/app/qgsattributetypedialog.h | 2 +- src/app/qgsdecorationgrid.h | 4 +- src/app/qgsfeatureaction.h | 2 +- src/app/qgsfieldsproperties.h | 4 +- src/app/qgsguivectorlayertools.h | 8 +- src/app/qgsmaptoollabel.h | 22 ++--- src/app/qgsmaptoolselectutils.h | 2 +- src/app/qgsmergeattributesdialog.h | 2 +- src/app/qgsstatusbarscalewidget.h | 2 +- src/app/qgstipfactory.h | 8 +- src/app/qgsvectorlayerproperties.h | 4 +- src/core/auth/qgsauthcertutils.h | 6 +- src/core/auth/qgsauthconfig.h | 2 +- src/core/auth/qgsauthmanager.h | 22 ++--- src/core/auth/qgsauthmethod.h | 6 +- src/core/auth/qgsauthmethodregistry.h | 4 +- src/core/composer/qgscomposeritem.h | 2 +- src/core/composer/qgscomposermapgrid.h | 4 +- src/core/composer/qgscomposernodesitem.h | 4 +- src/core/composer/qgscomposition.h | 6 +- src/core/diagram/qgsdiagram.h | 6 +- src/core/diagram/qgstextdiagram.h | 2 +- src/core/geometry/qgsabstractgeometry.h | 8 +- src/core/geometry/qgscircularstring.h | 2 +- src/core/geometry/qgscompoundcurve.h | 4 +- src/core/geometry/qgscurvepolygon.h | 2 +- src/core/geometry/qgsgeometry.h | 52 +++++----- src/core/geometry/qgsgeometrycollection.h | 2 +- src/core/geometry/qgsgeometryeditutils.h | 4 +- src/core/geometry/qgsgeometryutils.h | 14 +-- src/core/geometry/qgsgeos.h | 6 +- src/core/geometry/qgsinternalgeometryengine.h | 2 +- src/core/geometry/qgslinestring.h | 2 +- src/core/geometry/qgsmultilinestring.h | 2 +- src/core/geometry/qgsmultipolygon.h | 2 +- src/core/geometry/qgspointv2.h | 4 +- src/core/geometry/qgspolygon.h | 2 +- src/core/geometry/qgstriangle.h | 36 +++---- src/core/geometry/qgswkbtypes.h | 2 +- .../gps/qextserialport/qextserialenumerator.h | 6 +- src/core/gps/qextserialport/qextserialport.h | 2 +- .../layertree/qgslayertreemodellegendnode.h | 4 +- src/core/pal/feature.h | 4 +- src/core/pal/geomfunction.h | 2 +- src/core/pal/labelposition.h | 12 +-- src/core/pal/layer.h | 2 +- src/core/pal/pal.h | 10 +- src/core/qgsapplication.h | 4 +- src/core/qgsattributeeditorelement.h | 18 ++-- src/core/qgsattributes.h | 2 +- src/core/qgsbrowsermodel.h | 2 +- src/core/qgscachedfeatureiterator.h | 14 +-- src/core/qgscacheindex.h | 2 +- src/core/qgsclipper.h | 2 +- src/core/qgsconditionalstyle.h | 34 +++---- src/core/qgsconnectionpool.h | 2 +- src/core/qgscoordinatereferencesystem.h | 36 +++---- src/core/qgscoordinatetransform.h | 14 +-- src/core/qgsdataitem.h | 2 +- src/core/qgsdataprovider.h | 8 +- src/core/qgsdistancearea.h | 2 +- src/core/qgseditformconfig.h | 4 +- src/core/qgseditorwidgetsetup.h | 6 +- src/core/qgserror.h | 6 +- src/core/qgsexpression.h | 14 +-- src/core/qgsfeature.h | 10 +- src/core/qgsfeaturefilterprovider.h | 2 +- src/core/qgsfeatureiterator.h | 6 +- src/core/qgsfeaturerequest.h | 16 ++-- src/core/qgsfield.h | 10 +- src/core/qgsfieldformatter.h | 2 +- src/core/qgsfields.h | 8 +- src/core/qgsgml.h | 10 +- src/core/qgsgmlschema.h | 6 +- src/core/qgshistogram.h | 4 +- src/core/qgslabelsearchtree.h | 2 +- src/core/qgsmaplayer.h | 70 +++++++------- src/core/qgsmaplayerstylemanager.h | 10 +- src/core/qgsmaprenderercache.h | 2 +- src/core/qgsmaprendererjob.h | 2 +- src/core/qgsmapsettings.h | 14 +-- src/core/qgsmaptopixel.h | 6 +- src/core/qgsmultirenderchecker.h | 4 +- src/core/qgsnetworkreplyparser.h | 10 +- src/core/qgsogcutils.h | 32 +++---- src/core/qgsogrutils.h | 2 +- src/core/qgspallabeling.h | 2 +- src/core/qgspoint.h | 8 +- src/core/qgsproject.h | 8 +- src/core/qgsprojectproperty.h | 2 +- src/core/qgsproviderregistry.h | 6 +- src/core/qgsrectangle.h | 4 +- src/core/qgsrelation.h | 36 +++---- src/core/qgsrelationmanager.h | 10 +- src/core/qgsrenderchecker.h | 10 +- src/core/qgsrendercontext.h | 2 +- src/core/qgsrulebasedlabeling.h | 30 +++--- src/core/qgsruntimeprofiler.h | 4 +- src/core/qgsscalecalculator.h | 4 +- src/core/qgsscaleutils.h | 4 +- src/core/qgssnapper.h | 2 +- src/core/qgssnappingconfig.h | 4 +- src/core/qgssqlstatement.h | 6 +- src/core/qgsstringutils.h | 2 +- src/core/qgstextrenderer.h | 2 +- src/core/qgstolerance.h | 10 +- src/core/qgstracer.h | 2 +- src/core/qgstransactiongroup.h | 2 +- src/core/qgsunittypes.h | 2 +- src/core/qgsvectordataprovider.h | 32 +++---- src/core/qgsvectorfilewriter.h | 6 +- src/core/qgsvectorlayer.h | 94 +++++++++---------- src/core/qgsvectorlayercache.h | 12 +-- src/core/qgsvectorlayerdiagramprovider.h | 2 +- src/core/qgsvectorlayereditbuffer.h | 2 +- src/core/qgsvectorlayereditutils.h | 22 ++--- src/core/qgsvectorlayerjoinbuffer.h | 2 +- src/core/qgsvectorlayerlabelprovider.h | 2 +- src/core/qgsvectorlayertools.h | 10 +- src/core/raster/qgshillshaderenderer.h | 2 +- src/core/raster/qgsrasterblock.h | 64 ++++++------- src/core/raster/qgsrasterdataprovider.h | 4 +- src/core/raster/qgsrasterinterface.h | 2 +- src/core/raster/qgsrasteriterator.h | 2 +- src/core/raster/qgsrasterprojector.h | 2 +- src/core/raster/qgsrasterrange.h | 2 +- src/core/symbology-ng/qgsarrowsymbollayer.h | 2 +- .../qgsgeometrygeneratorsymbollayer.h | 2 +- src/core/symbology-ng/qgslinesymbollayer.h | 6 +- src/core/symbology-ng/qgsmarkersymbollayer.h | 2 +- src/core/symbology-ng/qgsrenderer.h | 12 +-- src/core/symbology-ng/qgsrulebasedrenderer.h | 28 +++--- src/core/symbology-ng/qgsstyle.h | 42 ++++----- src/core/symbology-ng/qgssymbol.h | 10 +- src/core/symbology-ng/qgssymbollayer.h | 2 +- src/core/symbology-ng/qgssymbollayerutils.h | 2 +- .../qgsattributetablefiltermodel.h | 12 +-- .../attributetable/qgsattributetablemodel.h | 6 +- .../attributetable/qgsattributetableview.h | 2 +- src/gui/attributetable/qgsdualview.h | 12 +-- src/gui/attributetable/qgsfeaturelistmodel.h | 6 +- src/gui/attributetable/qgsfeaturelistview.h | 10 +- .../attributetable/qgsfeatureselectionmodel.h | 4 +- .../qgsfieldconditionalformatwidget.h | 2 +- .../qgsifeatureselectionmanager.h | 4 +- .../qgsvectorlayerselectionmanager.h | 4 +- .../core/qgseditorconfigwidget.h | 6 +- .../core/qgseditorwidgetautoconf.h | 4 +- .../core/qgseditorwidgetfactory.h | 12 +-- .../core/qgseditorwidgetregistry.h | 18 ++-- .../core/qgseditorwidgetwrapper.h | 14 +-- .../core/qgssearchwidgetwrapper.h | 2 +- src/gui/editorwidgets/core/qgswidgetwrapper.h | 18 ++-- .../qgsrelationreferencefactory.h | 4 +- .../qgsrelationreferencewidget.h | 2 +- src/gui/qgisgui.h | 6 +- src/gui/qgisinterface.h | 14 +-- src/gui/qgsadvanceddigitizingdockwidget.h | 14 +-- src/gui/qgsattributedialog.h | 4 +- src/gui/qgsattributeform.h | 8 +- src/gui/qgsattributetypeloaddialog.h | 4 +- src/gui/qgscolordialog.h | 4 +- src/gui/qgsexpressionbuilderwidget.h | 4 +- src/gui/qgsexpressionselectiondialog.h | 4 +- src/gui/qgsfeatureselectiondlg.h | 2 +- src/gui/qgsfilterlineedit.h | 4 +- src/gui/qgskeyvaluewidget.h | 2 +- src/gui/qgslistwidget.h | 4 +- src/gui/qgsmapcanvas.h | 2 +- src/gui/qgsmapcanvasitem.h | 2 +- src/gui/qgsmapcanvassnapper.h | 2 +- src/gui/qgsmaplayerconfigwidgetfactory.h | 12 +-- src/gui/qgsmapmouseevent.h | 12 +-- src/gui/qgsmaptooladvanceddigitizing.h | 2 +- src/gui/qgsmaptoolcapture.h | 16 ++-- src/gui/qgsmaptooledit.h | 2 +- src/gui/qgsmaptoolidentify.h | 6 +- src/gui/qgsmessagebar.h | 6 +- src/gui/qgsnewnamedialog.h | 4 +- src/gui/qgsoptionsdialogbase.h | 2 +- src/gui/qgsoptionswidgetfactory.h | 4 +- src/gui/qgsowssourceselect.h | 2 +- src/gui/qgspanelwidget.h | 6 +- src/gui/qgspanelwidgetstack.h | 4 +- src/gui/qgspixmaplabel.h | 4 +- src/gui/qgsprojectionselectiontreewidget.h | 2 +- src/gui/qgsrubberband.h | 8 +- src/gui/qgssearchquerybuilder.h | 2 +- src/gui/qgssourceselectdialog.h | 2 +- src/gui/raster/qgshillshaderendererwidget.h | 2 +- .../qgscategorizedsymbolrendererwidget.h | 2 +- .../symbology-ng/qgsrulebasedrendererwidget.h | 2 +- .../symbology-ng/qgssymbolselectordialog.h | 6 +- .../utils/qgsgeometrycheckerutils.h | 4 +- .../georeferencer/qgsgeorefplugingui.h | 2 +- src/plugins/grass/qgsgrassmoduleoptions.h | 2 +- src/plugins/grass/qtermwidget/Character.h | 2 +- src/plugins/grass/qtermwidget/ColorScheme.h | 2 +- src/plugins/grass/qtermwidget/kprocess.h | 22 ++--- src/plugins/grass/qtermwidget/kpty.h | 16 ++-- src/plugins/grass/qtermwidget/kptydevice.h | 6 +- src/plugins/grass/qtermwidget/kptyprocess.h | 6 +- src/plugins/grass/qtermwidget/qtermwidget.h | 4 +- .../delimitedtext/qgsdelimitedtextfile.h | 38 ++++---- .../delimitedtext/qgsdelimitedtextprovider.h | 12 +-- src/providers/grass/qgsgrass.h | 14 +-- src/providers/grass/qgsgrassprovider.h | 82 ++++++++-------- src/providers/grass/qgsgrassvector.h | 4 +- src/providers/grass/qgsgrassvectormap.h | 8 +- src/providers/grass/qgsgrassvectormaplayer.h | 4 +- src/providers/postgres/qgspostgresprovider.h | 8 +- .../spatialite/qgsspatialiteconnection.h | 2 +- src/providers/wcs/qgswcscapabilities.h | 2 +- src/providers/wfs/qgswfsprovider.h | 2 +- src/providers/wfs/qgswfssourceselect.h | 2 +- src/python/qgspythonutils.h | 6 +- src/python/qgspythonutilsimpl.h | 12 +-- src/server/qgsaccesscontrol.h | 18 ++-- src/server/qgsaccesscontrolfilter.h | 12 +-- src/server/qgsftptransaction.h | 2 +- src/server/qgshttptransaction.h | 4 +- src/server/qgsinterpolationlayerbuilder.h | 2 +- src/server/qgsmslayerbuilder.h | 2 +- src/server/qgsmslayercache.h | 2 +- src/server/qgsremotedatasourcebuilder.h | 2 +- src/server/qgssentdatasourcebuilder.h | 2 +- src/server/qgsserver.h | 2 +- src/server/qgsserverexception.h | 10 +- src/server/qgsserverinterface.h | 12 +-- src/server/qgsserverinterfaceimpl.h | 2 +- src/server/qgsserverlogger.h | 2 +- src/server/qgsserverplugins.h | 2 +- src/server/qgsserverprojectparser.h | 8 +- src/server/qgsserverprojectutils.h | 36 +++---- src/server/qgsserverrequest.h | 6 +- src/server/qgsserverresponse.h | 6 +- src/server/qgsserversettings.h | 20 ++-- src/server/qgsservice.h | 4 +- src/server/qgsservicenativeloader.h | 4 +- src/server/qgsserviceregistry.h | 4 +- src/server/qgssldconfigparser.h | 8 +- .../services/wms/qgsmaprendererjobproxy.h | 2 +- src/server/services/wms/qgswmsrenderer.h | 14 +-- src/server/services/wms/qgswmsutils.h | 4 +- 270 files changed, 1083 insertions(+), 1083 deletions(-) diff --git a/src/analysis/interpolation/DualEdgeTriangulation.h b/src/analysis/interpolation/DualEdgeTriangulation.h index a23dcfc1301..a8f7fab55f8 100644 --- a/src/analysis/interpolation/DualEdgeTriangulation.h +++ b/src/analysis/interpolation/DualEdgeTriangulation.h @@ -101,7 +101,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation virtual QList *getPointsAroundEdge( double x, double y ) override; /** Saves the triangulation as a (line) shapefile - \return true in case of success*/ + \returns true in case of success*/ virtual bool saveAsShapefile( const QString &fileName ) const override; protected: diff --git a/src/analysis/interpolation/NormVecDecorator.h b/src/analysis/interpolation/NormVecDecorator.h index 5ad7d6bdecb..72386d613b3 100644 --- a/src/analysis/interpolation/NormVecDecorator.h +++ b/src/analysis/interpolation/NormVecDecorator.h @@ -66,7 +66,7 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator virtual bool swapEdge( double x, double y ) override; /** Saves the triangulation as a (line) shapefile - \return true in case of success*/ + \returns true in case of success*/ virtual bool saveAsShapefile( const QString &fileName ) const override; protected: diff --git a/src/analysis/interpolation/Triangulation.h b/src/analysis/interpolation/Triangulation.h index 1a681ffbdc4..dc048839b3c 100644 --- a/src/analysis/interpolation/Triangulation.h +++ b/src/analysis/interpolation/Triangulation.h @@ -52,7 +52,7 @@ class ANALYSIS_EXPORT Triangulation /** * Calculates the normal at a point on the surface and assigns it to 'result'. - * \return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure */ virtual bool calcNormal( double x, double y, Vector3D *result ) = 0; @@ -148,7 +148,7 @@ class ANALYSIS_EXPORT Triangulation /** * Saves the triangulation as a (line) shapefile - * \return true in case of success + * \returns true in case of success */ virtual bool saveAsShapefile( const QString &fileName ) const = 0; }; diff --git a/src/analysis/interpolation/qgsgridfilewriter.h b/src/analysis/interpolation/qgsgridfilewriter.h index 498fb7c313c..d2da7901926 100644 --- a/src/analysis/interpolation/qgsgridfilewriter.h +++ b/src/analysis/interpolation/qgsgridfilewriter.h @@ -35,7 +35,7 @@ class ANALYSIS_EXPORT QgsGridFileWriter /** Writes the grid file. \param showProgressDialog shows a dialog with the possibility to cancel - \return 0 in case of success*/ + \returns 0 in case of success*/ int writeFile( bool showProgressDialog = false ); diff --git a/src/analysis/interpolation/qgsidwinterpolator.h b/src/analysis/interpolation/qgsidwinterpolator.h index 4f72d5bf391..032522fb946 100644 --- a/src/analysis/interpolation/qgsidwinterpolator.h +++ b/src/analysis/interpolation/qgsidwinterpolator.h @@ -33,7 +33,7 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator \param x x-coordinate (in map units) \param y y-coordinate (in map units) \param result out: interpolation result - \return 0 in case of success*/ + \returns 0 in case of success*/ int interpolatePoint( double x, double y, double &result ) override; void setDistanceCoefficient( double p ) {mDistanceCoefficient = p;} diff --git a/src/analysis/interpolation/qgsinterpolator.h b/src/analysis/interpolation/qgsinterpolator.h index b9b150031ac..b2f59aeaf83 100644 --- a/src/analysis/interpolation/qgsinterpolator.h +++ b/src/analysis/interpolation/qgsinterpolator.h @@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsInterpolator \param x x-coordinate (in map units) \param y y-coordinate (in map units) \param result out: interpolation result - \return 0 in case of success*/ + \returns 0 in case of success*/ virtual int interpolatePoint( double x, double y, double &result ) = 0; //! \note not available in Python bindings @@ -73,7 +73,7 @@ class ANALYSIS_EXPORT QgsInterpolator /** Caches the vertex and value data from the provider. All the vertex data will be held in virtual memory - \return 0 in case of success*/ + \returns 0 in case of success*/ int cacheBaseData(); QVector mCachedBaseData; @@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsInterpolator \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) - \return 0 in case of success*/ + \returns 0 in case of success*/ int addVerticesToCache( const QgsGeometry &geom, bool zCoord, double attributeValue ); }; diff --git a/src/analysis/interpolation/qgstininterpolator.h b/src/analysis/interpolation/qgstininterpolator.h index dae997299b6..ce5f13c63b1 100644 --- a/src/analysis/interpolation/qgstininterpolator.h +++ b/src/analysis/interpolation/qgstininterpolator.h @@ -44,7 +44,7 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator \param x x-coordinate (in map units) \param y y-coordinate (in map units) \param result out: interpolation result - \return 0 in case of success*/ + \returns 0 in case of success*/ int interpolatePoint( double x, double y, double &result ) override; void setExportTriangulationToFile( bool e ) {mExportTriangulationToFile = e;} @@ -70,7 +70,7 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator \param zCoord true if the z coordinate is the interpolation attribute \param attr interpolation attribute index (if zCoord is false) \param type point/structure line, break line - \return 0 in case of success, -1 if the feature could not be inserted because of numerical problems*/ + \returns 0 in case of success, -1 if the feature could not be inserted because of numerical problems*/ int insertData( QgsFeature *f, bool zCoord, int attr, InputType type ); }; diff --git a/src/analysis/network/qgsgraph.h b/src/analysis/network/qgsgraph.h index d8b5f56df7e..9b30312471f 100644 --- a/src/analysis/network/qgsgraph.h +++ b/src/analysis/network/qgsgraph.h @@ -167,7 +167,7 @@ class ANALYSIS_EXPORT QgsGraph /** * Find vertex by associated point - * \return vertex index + * \returns vertex index */ int findVertex( const QgsPoint &pt ) const; diff --git a/src/analysis/network/qgsnetworkstrategy.h b/src/analysis/network/qgsnetworkstrategy.h index ba3e0612ea5..0541c311fc8 100644 --- a/src/analysis/network/qgsnetworkstrategy.h +++ b/src/analysis/network/qgsnetworkstrategy.h @@ -45,7 +45,7 @@ class ANALYSIS_EXPORT QgsNetworkStrategy /** * Returns list of the source layer attributes needed for cost calculation. * This method called by QgsGraphDirector. - * \return list of required attributes + * \returns list of required attributes */ virtual QgsAttributeList requiredAttributes() const { return QgsAttributeList(); } diff --git a/src/analysis/openstreetmap/qgsosmdownload.h b/src/analysis/openstreetmap/qgsosmdownload.h index 94e6d762970..126c4b45a03 100644 --- a/src/analysis/openstreetmap/qgsosmdownload.h +++ b/src/analysis/openstreetmap/qgsosmdownload.h @@ -69,13 +69,13 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject * * Only one request may be pending at one point - if you need more requests at once, use several instances. * - * \return true if the network request has been issued, false otherwise (and sets error string) + * \returns true if the network request has been issued, false otherwise (and sets error string) */ bool start(); /** * @brief Aborts current pending request - * \return true if there is a pending request and has been aborted, false otherwise + * \returns true if there is a pending request and has been aborted, false otherwise */ bool abort(); diff --git a/src/analysis/openstreetmap/qgsosmimport.h b/src/analysis/openstreetmap/qgsosmimport.h index 8a7c824bfa0..bcdebfd1814 100644 --- a/src/analysis/openstreetmap/qgsosmimport.h +++ b/src/analysis/openstreetmap/qgsosmimport.h @@ -56,7 +56,7 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject /** * Run import. This will parse the XML file and store the data in a SQLite database. - * \return true on success, false when import failed (see errorString() for the error) + * \returns true on success, false when import failed (see errorString() for the error) */ bool import(); diff --git a/src/analysis/raster/qgsalignraster.h b/src/analysis/raster/qgsalignraster.h index 87f5b708720..04530f7d13e 100644 --- a/src/analysis/raster/qgsalignraster.h +++ b/src/analysis/raster/qgsalignraster.h @@ -145,7 +145,7 @@ class ANALYSIS_EXPORT QgsAlignRaster { //! 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 + //! \returns false if the execution should be canceled, true otherwise virtual bool progress( double complete ) = 0; virtual ~ProgressHandler() = default; @@ -194,14 +194,14 @@ class ANALYSIS_EXPORT QgsAlignRaster //! 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) + //! \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. 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 - //! \return true on success, sets error on error (see errorMessage()) + //! \returns true on success, sets error on error (see errorMessage()) bool checkInputParameters(); //! Return expected size of the resulting aligned raster @@ -212,7 +212,7 @@ class ANALYSIS_EXPORT QgsAlignRaster QgsRectangle alignedRasterExtent() const; //! Run the alignment process - //! \return true on success, sets error on error (see errorMessage()) + //! \returns true on success, sets error on error (see errorMessage()) bool run(); //! Return error from a previous run() call. diff --git a/src/analysis/raster/qgsninecellfilter.h b/src/analysis/raster/qgsninecellfilter.h index edab4c0f7a5..e3297af157f 100644 --- a/src/analysis/raster/qgsninecellfilter.h +++ b/src/analysis/raster/qgsninecellfilter.h @@ -38,7 +38,7 @@ class ANALYSIS_EXPORT QgsNineCellFilter /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile \param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed. - \return 0 in case of success*/ + \returns 0 in case of success*/ int processRaster( QProgressDialog *p ); double cellSizeX() const { return mCellSizeX; } @@ -68,11 +68,11 @@ class ANALYSIS_EXPORT QgsNineCellFilter GDALDatasetH openInputFile( int &nCellsX, int &nCellsY ); /** Opens the output driver and tests if it supports the creation of a new dataset - \return nullptr on error and the driver handle on success*/ + \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 - \return the output dataset or nullptr in case of error*/ + \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); protected: diff --git a/src/analysis/raster/qgsrastercalculator.h b/src/analysis/raster/qgsrastercalculator.h index 54593839e2e..a0a849791f3 100644 --- a/src/analysis/raster/qgsrastercalculator.h +++ b/src/analysis/raster/qgsrastercalculator.h @@ -81,7 +81,7 @@ class ANALYSIS_EXPORT QgsRasterCalculator /** Starts the calculation and writes new raster \param p progress bar (or 0 if called from non-gui code) - \return 0 in case of success*/ + \returns 0 in case of success*/ //TODO QGIS 3.0 - return QgsRasterCalculator::Result int processCalculation( QProgressDialog *p = nullptr ); @@ -90,11 +90,11 @@ class ANALYSIS_EXPORT QgsRasterCalculator QgsRasterCalculator(); /** Opens the output driver and tests if it supports the creation of a new dataset - \return nullptr on error and the driver handle on success*/ + \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 - \return the output dataset or nullptr in case of error*/ + \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDriverH outputDriver ); /** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows diff --git a/src/analysis/raster/qgsrelief.h b/src/analysis/raster/qgsrelief.h index 9b68eb94853..92c5eaf9da8 100644 --- a/src/analysis/raster/qgsrelief.h +++ b/src/analysis/raster/qgsrelief.h @@ -53,7 +53,7 @@ class ANALYSIS_EXPORT QgsRelief /** Starts the calculation, reads from mInputFile and stores the result in mOutputFile \param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed. - \return 0 in case of success*/ + \returns 0 in case of success*/ int processRaster( QProgressDialog *p ); double zFactor() const { return mZFactor; } @@ -65,7 +65,7 @@ class ANALYSIS_EXPORT QgsRelief void setReliefColors( const QList< ReliefColor > &c ) { mReliefColors = c; } /** Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression - \return true in case of success*/ + \returns true in case of success*/ QList< ReliefColor > calculateOptimizedReliefClasses(); //! Write frequency of elevation values to file for manual inspection @@ -102,11 +102,11 @@ class ANALYSIS_EXPORT QgsRelief GDALDatasetH openInputFile( int &nCellsX, int &nCellsY ); /** Opens the output driver and tests if it supports the creation of a new dataset - \return nullptr on error and the driver handle on success*/ + \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 - \return the output dataset or nullptr in case of error*/ + \returns the output dataset or nullptr in case of error*/ GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver ); //! Set elevation color @@ -116,7 +116,7 @@ class ANALYSIS_EXPORT QgsRelief void setDefaultReliefColors(); /** Returns class (0-255) for an elevation value - \return elevation class or -1 in case of error*/ + \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 ); diff --git a/src/analysis/vector/qgspointsample.h b/src/analysis/vector/qgspointsample.h index add97d0339a..209022b8701 100644 --- a/src/analysis/vector/qgspointsample.h +++ b/src/analysis/vector/qgspointsample.h @@ -34,7 +34,7 @@ class ANALYSIS_EXPORT QgsPointSample QgsPointSample( QgsVectorLayer *inputLayer, const QString &outputLayer, const QString &nPointsAttribute, const QString &minDistAttribute = QString() ); /** Starts calculation of random points - \return 0 in case of success*/ + \returns 0 in case of success*/ int createRandomPoints( QProgressDialog *pd ); private: diff --git a/src/analysis/vector/qgstransectsample.h b/src/analysis/vector/qgstransectsample.h index 7f0d3b7cdd6..3ab663383ff 100644 --- a/src/analysis/vector/qgstransectsample.h +++ b/src/analysis/vector/qgstransectsample.h @@ -82,7 +82,7 @@ class ANALYSIS_EXPORT QgsTransectSample \param dist out: distance between the segments \param pt1 out: closest point on first geometry \param pt2 out: closest point on secont geometry - \return true in case of success*/ + \returns true in case of success*/ static bool closestSegmentPoints( const QgsGeometry &g1, const QgsGeometry &g2, double &dist, QgsPoint &pt1, QgsPoint &pt2 ); //! Returns a copy of the multiline element closest to a point (caller takes ownership) static QgsGeometry closestMultilineElement( const QgsPoint &pt, const QgsGeometry &multiLine ); @@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsTransectSample \param stratumGeom stratum polygon \param clippedBaseline base line geometry clipped to the stratum \param tolerance buffer distance (in layer units) - \return clipped buffer line or 0 in case of error*/ + \returns clipped buffer line or 0 in case of error*/ QgsGeometry *clipBufferLine( const QgsGeometry &stratumGeom, QgsGeometry *clippedBaseline, double tolerance ); //! Returns distance to buffer the baseline (takes care of units and buffer settings diff --git a/src/analysis/vector/qgszonalstatistics.h b/src/analysis/vector/qgszonalstatistics.h index ec340e58f61..8bbff7d6056 100644 --- a/src/analysis/vector/qgszonalstatistics.h +++ b/src/analysis/vector/qgszonalstatistics.h @@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics Statistics stats = Statistics( Count | Sum | Mean ) ); /** Starts the calculation - \return 0 in case of success*/ + \returns 0 in case of success*/ int calculateStatistics( QProgressDialog *p ); private: @@ -111,7 +111,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics }; /** Analysis what cells need to be considered to cover the bounding box of a feature - \return 0 in case of success*/ + \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/dwg/libdxfrw/libdxfrw.h b/src/app/dwg/libdxfrw/libdxfrw.h index a274838e0e1..6f01f017bec 100644 --- a/src/app/dwg/libdxfrw/libdxfrw.h +++ b/src/app/dwg/libdxfrw/libdxfrw.h @@ -35,7 +35,7 @@ class dxfRW * components being added. * \param interface_ the interface to use * \param ext should the extrusion be applied to convert in 2D? - * \return true for success + * \returns true for success */ bool read( DRW_Interface *interface_, bool ext ); void setBinary( bool b ) {binFile = b;} diff --git a/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h b/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h index 17001035697..577f1d36301 100644 --- a/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h +++ b/src/app/gps/qwtpolar-0.1/qwt_polar_curve.h @@ -117,13 +117,13 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem PrivateData *d_data; }; -//! \return the curve data +//! \returns the curve data inline QwtData &QwtPolarCurve::data() { return *d_points; } -//! \return the curve data +//! \returns the curve data inline const QwtData &QwtPolarCurve::data() const { return *d_points; @@ -131,7 +131,7 @@ inline const QwtData &QwtPolarCurve::data() const /*! \param i index - \return azimuth at position i + \returns azimuth at position i */ inline double QwtPolarCurve::azimuth( int i ) const { @@ -140,7 +140,7 @@ inline double QwtPolarCurve::azimuth( int i ) const /*! \param i index - \return radius at position i + \returns radius at position i */ inline double QwtPolarCurve::radius( int i ) const { @@ -149,7 +149,7 @@ inline double QwtPolarCurve::radius( int i ) const /*! \param i index - \return point at position i + \returns point at position i */ inline QwtPolarPoint QwtPolarCurve::sample( int i ) const { diff --git a/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h b/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h index 81437957a1b..793602f44dc 100644 --- a/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h +++ b/src/app/gps/qwtpolar-1.0/qwt_polar_curve.h @@ -143,7 +143,7 @@ private: PrivateData *d_data; }; -//! \return the curve data +//! \returns the curve data inline const QwtSeriesData *QwtPolarCurve::data() const { return d_series; @@ -151,7 +151,7 @@ inline const QwtSeriesData *QwtPolarCurve::data() const /*! \param i index - \return point at position i + \returns point at position i */ inline QwtPointPolar QwtPolarCurve::sample( int i ) const { diff --git a/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h b/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h index a4745222cec..0ea3489a9b2 100644 --- a/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h +++ b/src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h @@ -141,7 +141,7 @@ private: PrivateData *d_data; }; -//! \return the the curve data +//! \returns the the curve data inline const QwtSeriesData *QwtPolarCurve::data() const { return d_series; @@ -149,7 +149,7 @@ inline const QwtSeriesData *QwtPolarCurve::data() const /*! \param i index - \return point at position i + \returns point at position i */ inline QwtPointPolar QwtPolarCurve::sample( int i ) const { diff --git a/src/app/nodetool/qgsmaptoolnodetool.h b/src/app/nodetool/qgsmaptoolnodetool.h index 4e93377d506..06da7638b80 100644 --- a/src/app/nodetool/qgsmaptoolnodetool.h +++ b/src/app/nodetool/qgsmaptoolnodetool.h @@ -101,7 +101,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit * Function to check if selected feature exists and is same with original one * stored in internal structures * \param vlayer vector layer for checking - * \return if feature is same as one in internal structures + * \returns if feature is same as one in internal structures */ bool checkCorrectnessOfFeature( QgsVectorLayer *vlayer ); @@ -124,7 +124,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit This is useful for snapping operations that just require a position to snap to and not all the snapping results. If the list is empty, the screen coordinates are transformed into map coordinates and returned \param snapResults results collected from the snapping operation. - \return the snapped point in map coordinates*/ + \returns the snapped point in map coordinates*/ QgsPoint snapPointFromResults( const QList &snapResults, QPoint screenCoords ); /** Inserts vertices to the snapped segments of the editing layer. @@ -132,7 +132,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit \param snapResults results collected from the snapping operation \param editedLayer pointer to the editing layer \param skipFids set of feature IDs to avoid inserting vertices in - \return 0 in case of success*/ + \returns 0 in case of success*/ int insertSegmentVerticesForSnap( const QList &snapResults, QgsVectorLayer *editedLayer, const QgsFeatureIds &skipFids ); /** Snapper object that reads the settings from project and option diff --git a/src/app/nodetool/qgsselectedfeature.h b/src/app/nodetool/qgsselectedfeature.h index 70afaa90245..578e2a1919c 100644 --- a/src/app/nodetool/qgsselectedfeature.h +++ b/src/app/nodetool/qgsselectedfeature.h @@ -97,19 +97,19 @@ class QgsSelectedFeature: public QObject /** * Tells if vertex is selected * \param vertexNr number of vertex for which we are getting info - * \return true if vertex is selected, false otherwise + * \returns true if vertex is selected, false otherwise */ bool isSelected( int vertexNr ); /** * Getting feature Id of feature selected - * \return feature id of selected feature + * \returns feature id of selected feature */ QgsFeatureId featureId(); /** * Getting vertex map of vertexes - * \return currently used vertex map + * \returns currently used vertex map */ QList &vertexMap(); @@ -120,7 +120,7 @@ class QgsSelectedFeature: public QObject /** * Get the layer of the selected feature - * \return used vector layer + * \returns used vector layer */ QgsVectorLayer *vlayer(); diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h index 670021cea6e..1e31537d986 100644 --- a/src/app/qgisapp.h +++ b/src/app/qgisapp.h @@ -342,7 +342,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** 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 - * \return QString::null if user cancels input dialog + * \returns QString::null if user cancels input dialog */ bool uniqueComposerTitle( QWidget *parent, QString &composerTitle, bool acceptEmpty, const QString ¤tTitle = QString() ); //! Creates a new composer and returns a pointer to it @@ -366,7 +366,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Access the vector layer tools. This will be an instance of {@see QgsGuiVectorLayerTools} * by default. - * \return The vector layer tools + * \returns The vector layer tools */ QgsVectorLayerTools *vectorLayerTools() { return mVectorLayerTools; } @@ -991,7 +991,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addPluginToolBarWidget( QWidget *widget ); //! Remove an icon from the plugin toolbar @@ -1005,7 +1005,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addRasterToolBarWidget( QWidget *widget ); //! Remove an icon from the Raster toolbar @@ -1019,7 +1019,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addVectorToolBarWidget( QWidget *widget ); //! Remove an icon from the Vector toolbar @@ -1033,7 +1033,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addDatabaseToolBarWidget( QWidget *widget ); //! Remove an icon from the Database toolbar @@ -1047,7 +1047,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addWebToolBarWidget( QWidget *widget ); //! Remove an icon from the Web toolbar @@ -1573,7 +1573,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow bool checkTasksDependOnProject(); /** Helper function to union several geometries together (used in function mergeSelectedFeatures) - \return empty geometry in case of error or if canceled */ + \returns empty geometry in case of error or if canceled */ QgsGeometry unionGeometries( const QgsVectorLayer *vl, QgsFeatureList &featureList, bool &canceled ); //! Deletes all the composer objects and clears mPrintComposers @@ -1589,7 +1589,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** Paste features from clipboard into a new memory layer. * If no features are in clipboard an empty layer is returned. - * \return pointer to a new layer or 0 if failed + * \returns pointer to a new layer or 0 if failed */ QgsVectorLayer *pasteToNewMemoryVector(); diff --git a/src/app/qgisappinterface.h b/src/app/qgisappinterface.h index dcbf20eca4f..75754f445cc 100644 --- a/src/app/qgisappinterface.h +++ b/src/app/qgisappinterface.h @@ -95,7 +95,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the plugin toolbar @@ -109,7 +109,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addRasterToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the Raster toolbar @@ -123,7 +123,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addVectorToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the Vector toolbar @@ -137,7 +137,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addDatabaseToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the Database toolbar @@ -151,7 +151,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ QAction *addWebToolBarWidget( QWidget *widget ) override; //! Remove an icon (action) from the Web toolbar @@ -459,7 +459,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * \param layer The layer for which the dialog will be created * \param feature The feature for which the dialog will be created * - * \return A feature form + * \returns A feature form */ virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *layer, QgsFeature &feature ) override; @@ -468,7 +468,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface * With the help of this you can access methods like addFeature, startEditing * or stopEditing while giving the user the appropriate dialogs. * - * \return An instance of the vector layer tools + * \returns An instance of the vector layer tools */ virtual QgsVectorLayerTools *vectorLayerTools() override; diff --git a/src/app/qgsattributetypedialog.h b/src/app/qgsattributetypedialog.h index 93f1f8a0ede..0efe859ca8f 100644 --- a/src/app/qgsattributetypedialog.h +++ b/src/app/qgsattributetypedialog.h @@ -125,7 +125,7 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut /** * Getter for constraint expression description - * \return the expression description + * \returns the expression description * \since QGIS 2.16 **/ QString constraintExpressionDescription(); diff --git a/src/app/qgsdecorationgrid.h b/src/app/qgsdecorationgrid.h index 2869d5a32ed..3cce5bf30d4 100644 --- a/src/app/qgsdecorationgrid.h +++ b/src/app/qgsdecorationgrid.h @@ -211,11 +211,11 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem void drawAnnotation( QPainter *p, QPointF pos, int rotation, const QString &annotationText ); /** Returns the grid lines with associated coordinate value - \return 0 in case of success*/ + \returns 0 in case of success*/ int xGridLines( QList< QPair< qreal, QLineF > > &lines ) const; /** Returns the grid lines for the y-coordinates. Not vertical in case of rotation - \return 0 in case of success*/ + \returns 0 in case of success*/ int yGridLines( QList< QPair< qreal, QLineF > > &lines ) const; //! Returns the item border of a point (in item coordinates) Border borderForLineCoord( QPointF point, QPainter *p ) const; diff --git a/src/app/qgsfeatureaction.h b/src/app/qgsfeatureaction.h index f220c4b7153..90adfb6a014 100644 --- a/src/app/qgsfeatureaction.h +++ b/src/app/qgsfeatureaction.h @@ -49,7 +49,7 @@ class APP_EXPORT QgsFeatureAction : public QAction * * \param defaultAttributes Provide some default attributes here if desired. * - * \return true if feature was added if showModal is true. If showModal is false, returns true in every case + * \returns true if feature was added if showModal is true. If showModal is false, returns true in every case */ bool addFeature( const QgsAttributeMap &defaultAttributes = QgsAttributeMap(), bool showModal = true ); diff --git a/src/app/qgsfieldsproperties.h b/src/app/qgsfieldsproperties.h index 1c014b30aa7..7d4abf1c859 100644 --- a/src/app/qgsfieldsproperties.h +++ b/src/app/qgsfieldsproperties.h @@ -139,11 +139,11 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope /** Adds an attribute to the table (but does not commit it yet) \param field the field to add - \return false in case of a name conflict, true in case of success */ + \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 - * \return A widget definition. Containing another container or the final field + * \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/qgsguivectorlayertools.h b/src/app/qgsguivectorlayertools.h index a81dd758c12..689eb255129 100644 --- a/src/app/qgsguivectorlayertools.h +++ b/src/app/qgsguivectorlayertools.h @@ -37,7 +37,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools * \param defaultValues Default values for the feature to add * \param defaultGeometry A default geometry to add to the feature * - * \return True in case of success, False if the operation failed/was aborted + * \returns True in case of success, False if the operation failed/was aborted */ bool addFeature( QgsVectorLayer *layer, const QgsAttributeMap &defaultValues, const QgsGeometry &defaultGeometry, QgsFeature *feat = nullptr ) const override; @@ -47,7 +47,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools * * \param layer The layer on which to start an edit session * - * \return True, if the editing session was started + * \returns True, if the editing session was started */ bool startEditing( QgsVectorLayer *layer ) const override; @@ -59,7 +59,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools * \param layer The layer to commit * \param allowCancel True if a cancel button should be offered * - * \return True if successful + * \returns True if successful */ bool stopEditing( QgsVectorLayer *layer, bool allowCancel = true ) const override; @@ -67,7 +67,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools * Should be called, when the features should be committed but the editing session is not ended. * * \param layer The layer to commit - * \return True if successful + * \returns True if successful */ bool saveEdits( QgsVectorLayer *layer ) const override; diff --git a/src/app/qgsmaptoollabel.h b/src/app/qgsmaptoollabel.h index 6c1c1475d3b..82733eaec53 100644 --- a/src/app/qgsmaptoollabel.h +++ b/src/app/qgsmaptoollabel.h @@ -36,20 +36,20 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool /** 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 - \return true if labels of layer can be moved*/ + \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 \param xCol out: index of the attribute for data defined x coordinate \param yCol out: index of the attribute for data defined y coordinate - \return true if labels of layer can be moved*/ + \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 \param xCol out: index of the attribute for data defined x coordinate \param yCol out: index of the attribute for data defined y coordinate - \return true if layer fields set up and exist*/ + \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 @@ -89,12 +89,12 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool /** Returns label position for mouse click location \param e mouse event \param p out: label position - \return true in case of success, false if no label at this location*/ + \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 \param ignoreUpsideDown treat label as right-side-up - \return true in case of success*/ + \returns true in case of success*/ bool currentLabelRotationPoint( QgsPoint &pos, bool ignoreUpsideDown = false, bool rotatingUnpinned = false ); //! Creates label / feature / fixpoint rubber bands for the current label position @@ -110,7 +110,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool void currentAlignment( QString &hali, QString &vali ); /** Gets vector feature for current label pos - \return true in case of success*/ + \returns true in case of success*/ bool currentFeature( QgsFeature &f, bool fetchGeom = false ); //! Returns the font for the current feature (considering default font and data defined properties) @@ -120,7 +120,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool QString dataDefinedColumnName( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings ) const; /** Returns a data defined attribute column index - \return -1 if column does not exist or an expression is used instead */ + \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 @@ -133,7 +133,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool \param ySuccess out: false if attribute value is NULL \param xCol out: index of the x position column \param yCol out: index of the y position column - \return false if layer does not have data defined label position enabled*/ + \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 @@ -141,7 +141,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool \param rotationSuccess out: false if rotation value is NULL \param rCol out: index of the rotation column \param ignoreXY ignore that x and y are required to be data-defined - \return true if data defined rotation is enabled on the layer + \returns true if data defined rotation is enabled on the layer */ bool currentLabelDataDefinedRotation( double &rotation, bool &rotationSuccess, int &rCol, bool ignoreXY = false ) const; @@ -151,12 +151,12 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool \param show out: show/hide value \param showSuccess out: false if show/hide value is NULL \param showCol out: index of the show label column - \return true if data defined show/hide is enabled on the layer + \returns true if data defined show/hide is enabled on the layer */ bool dataDefinedShowHide( QgsVectorLayer *vlayer, QgsFeatureId featureId, int &show, bool &showSuccess, int &showCol ) const; /** Returns the pin status for the current label/diagram - \return true if the label/diagram is pinned, false otherwise + \returns true if the label/diagram is pinned, false otherwise \since QGIS 2.16 */ bool isPinned(); diff --git a/src/app/qgsmaptoolselectutils.h b/src/app/qgsmaptoolselectutils.h index d4aad8bf810..a1533a43a2e 100644 --- a/src/app/qgsmaptoolselectutils.h +++ b/src/app/qgsmaptoolselectutils.h @@ -92,7 +92,7 @@ namespace QgsMapToolSelectUtils /** Get the current selected canvas map layer. Returns nullptr if it is not a vector layer \param canvas The map canvas used for getting the current layer - \return QgsVectorLayer The layer + \returns QgsVectorLayer The layer */ QgsVectorLayer *getCurrentVectorLayer( QgsMapCanvas *canvas ); diff --git a/src/app/qgsmergeattributesdialog.h b/src/app/qgsmergeattributesdialog.h index 0b5816d667a..3380fd08cb2 100644 --- a/src/app/qgsmergeattributesdialog.h +++ b/src/app/qgsmergeattributesdialog.h @@ -73,7 +73,7 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA QComboBox *createMergeComboBox( QVariant::Type columnType ) const; /** Returns the table widget column index of a combo box - \return the column index or -1 in case of error*/ + \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 void refreshMergedValue( int col ); diff --git a/src/app/qgsstatusbarscalewidget.h b/src/app/qgsstatusbarscalewidget.h index 6d746ee0a99..46155d8ce6f 100644 --- a/src/app/qgsstatusbarscalewidget.h +++ b/src/app/qgsstatusbarscalewidget.h @@ -51,7 +51,7 @@ class APP_EXPORT QgsStatusBarScaleWidget : public QWidget /** * @brief isLocked check if the scale should be locked to use magnifier instead of scale to zoom in/out - * \return True if the scale shall be locked + * \returns True if the scale shall be locked */ bool isLocked() const; diff --git a/src/app/qgstipfactory.h b/src/app/qgstipfactory.h index 81db3d5cae7..2f41a3e3dc2 100644 --- a/src/app/qgstipfactory.h +++ b/src/app/qgstipfactory.h @@ -38,7 +38,7 @@ class APP_EXPORT QgsTipFactory : public QObject ~QgsTipFactory(); /** Get a random tip (generic or gui-centric) - * \return An QgsTip containing the tip + * \returns An QgsTip containing the tip */ QgsTip getTip(); @@ -47,17 +47,17 @@ class APP_EXPORT QgsTipFactory : public QObject * number passed in as position. If the * position is invalid, an empty string will be * returned. - * \return An QgsTip containing the tip + * \returns An QgsTip containing the tip */ QgsTip getTip( int position ); /** Get a random generic tip - * \return An QgsTip containing the tip + * \returns An QgsTip containing the tip */ QgsTip getGenericTip(); /** Get a random gui-centric tip - * \return An QgsTip containing the tip + * \returns An QgsTip containing the tip */ QgsTip getGuiTip(); diff --git a/src/app/qgsvectorlayerproperties.h b/src/app/qgsvectorlayerproperties.h index 77a769c9360..26998708dab 100644 --- a/src/app/qgsvectorlayerproperties.h +++ b/src/app/qgsvectorlayerproperties.h @@ -62,12 +62,12 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private /** Adds an attribute to the table (but does not commit it yet) \param field the field to add - \return false in case of a name conflict, true in case of success */ + \returns false in case of a name conflict, true in case of success */ bool addAttribute( const QgsField &field ); /** Deletes an attribute (but does not commit it) \param name attribute name - \return false in case of a non-existing attribute.*/ + \returns false in case of a non-existing attribute.*/ bool deleteAttribute( int attr ); //! Adds a properties page factory to the vector layer properties dialog. diff --git a/src/core/auth/qgsauthcertutils.h b/src/core/auth/qgsauthcertutils.h index bc1969f6815..52ca1497a02 100644 --- a/src/core/auth/qgsauthcertutils.h +++ b/src/core/auth/qgsauthcertutils.h @@ -122,7 +122,7 @@ class CORE_EXPORT QgsAuthCertUtils * \param keypath File path to private key * \param keypass Passphrase for private key * \param reencrypt Whether to re-encrypt the private key with the passphrase - * \return certificate, private key, key's algorithm type + * \returns certificate, private key, key's algorithm type */ static QStringList certKeyBundleToPem( const QString &certpath, const QString &keypath, @@ -133,7 +133,7 @@ class CORE_EXPORT QgsAuthCertUtils * \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 - * \return certificate, private key, key's algorithm type + * \returns certificate, private key, key's algorithm type */ static QStringList pkcs12BundleToPem( const QString &bundlepath, const QString &bundlepass = QString(), @@ -142,7 +142,7 @@ class CORE_EXPORT QgsAuthCertUtils /** 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 - * \return File path to temporary file + * \returns File path to temporary file */ static QString pemTextToTempFile( const QString &name, const QByteArray &pemtext ); diff --git a/src/core/auth/qgsauthconfig.h b/src/core/auth/qgsauthconfig.h index 3168232ce37..52848c3fc39 100644 --- a/src/core/auth/qgsauthconfig.h +++ b/src/core/auth/qgsauthconfig.h @@ -123,7 +123,7 @@ class CORE_EXPORT QgsAuthMethodConfig /** * Remove a config from map * \param key Config to remove - * \return Number of keys removed (should always be 1 or 0) + * \returns Number of keys removed (should always be 1 or 0) */ int removeConfig( const QString &key ); diff --git a/src/core/auth/qgsauthmanager.h b/src/core/auth/qgsauthmanager.h index e377661d7c5..b6f51986b85 100644 --- a/src/core/auth/qgsauthmanager.h +++ b/src/core/auth/qgsauthmanager.h @@ -246,14 +246,14 @@ class CORE_EXPORT QgsAuthManager : public QObject /** * Store an authentication config in the database * \param mconfig Associated authentication config id - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool storeAuthenticationConfig( QgsAuthMethodConfig &mconfig ); /** * Update an authentication config in the database * \param config Associated authentication config id - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool updateAuthenticationConfig( const QgsAuthMethodConfig &config ); @@ -262,26 +262,26 @@ class CORE_EXPORT QgsAuthManager : public QObject * \param authcfg Associated authentication config id * \param mconfig Subclassed config to load into * \param full Whether to decrypt and populate all sensitive data in subclass - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool loadAuthenticationConfig( const QString &authcfg, QgsAuthMethodConfig &mconfig, bool full = false ); /** * Remove an authentication config in the database * \param authcfg Associated authentication config id - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool removeAuthenticationConfig( const QString &authcfg ); /** * Clear all authentication configs from table in database and from provider caches - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool removeAllAuthenticationConfigs(); /** * Close connection to current authentication database and back it up - * \return Path to backup + * \returns Path to backup */ bool backupAuthenticationDatabase( QString *backuppath = nullptr ); @@ -289,7 +289,7 @@ class CORE_EXPORT QgsAuthManager : public QObject * Erase all rows from all tables in authentication database * \param backup Whether to backup of current database * \param backuppath Where the backup is locate - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool eraseAuthenticationDatabase( bool backup, QString *backuppath = nullptr ); @@ -301,7 +301,7 @@ class CORE_EXPORT QgsAuthManager : public QObject * \param request The QNetworkRequest * \param authcfg Associated authentication config id * \param dataprovider Provider key filter, offering logic branching in authentication method - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg, const QString &dataprovider = QString() ); @@ -311,7 +311,7 @@ class CORE_EXPORT QgsAuthManager : public QObject * \param reply The QNetworkReply * \param authcfg Associated authentication config id * \param dataprovider Provider key filter, offering logic branching in authentication method - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg, const QString &dataprovider = QString() ); @@ -321,7 +321,7 @@ class CORE_EXPORT QgsAuthManager : public QObject * \param connectionItems The connection items, e.g. username=myname, of QgsDataSourceUri * \param authcfg Associated authentication config id * \param dataprovider Provider key filter, offering logic branching in authentication method - * \return Whether operation succeeded + * \returns Whether operation succeeded */ bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg, const QString &dataprovider = QString() ); @@ -451,7 +451,7 @@ class CORE_EXPORT QgsAuthManager : public QObject bool storeCertTrustPolicy( const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy ); /** Get a whether certificate is trusted by user - \return DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy + \returns DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy */ QgsAuthCertUtils::CertTrustPolicy getCertTrustPolicy( const QSslCertificate &cert ); diff --git a/src/core/auth/qgsauthmethod.h b/src/core/auth/qgsauthmethod.h index 83a2e243778..7b2356d4366 100644 --- a/src/core/auth/qgsauthmethod.h +++ b/src/core/auth/qgsauthmethod.h @@ -83,7 +83,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject * \param authcfg Authentication configuration ID * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * for custom updater code specific to the provider - * \return Whether the update succeeded + * \returns Whether the update succeeded */ virtual bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg, const QString &dataprovider = QString() ) @@ -99,7 +99,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject * \param authcfg Authentication configuration ID * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * for custom updater code specific to the provider - * \return Whether the update succeeded + * \returns Whether the update succeeded */ virtual bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg, const QString &dataprovider = QString() ) @@ -115,7 +115,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject * \param authcfg Authentication configuration ID * \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows * for custom updater code specific to the provider - * \return Whether the update succeeded + * \returns Whether the update succeeded */ virtual bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg, const QString &dataprovider = QString() ) diff --git a/src/core/auth/qgsauthmethodregistry.h b/src/core/auth/qgsauthmethodregistry.h index 76e2bc948b6..d42a1d5a63d 100644 --- a/src/core/auth/qgsauthmethodregistry.h +++ b/src/core/auth/qgsauthmethodregistry.h @@ -63,7 +63,7 @@ class CORE_EXPORT QgsAuthMethodRegistry /** Create an instance of the auth method \param authMethodKey identificator of the auth method - \return instance of auth method or nullptr on error + \returns instance of auth method or nullptr on error */ QgsAuthMethod *authMethod( const QString &authMethodKey ); @@ -81,7 +81,7 @@ class CORE_EXPORT QgsAuthMethodRegistry /** Get pointer to auth method function \param authMethodKey identificator of the auth method \param functionName name of function - \return pointer to function or nullptr on error + \returns pointer to function or nullptr on error */ QFunctionPointer function( const QString &authMethodKey, const QString &functionName ); diff --git a/src/core/composer/qgscomposeritem.h b/src/core/composer/qgscomposeritem.h index 188d0e614c4..b38d3b04c7a 100644 --- a/src/core/composer/qgscomposeritem.h +++ b/src/core/composer/qgscomposeritem.h @@ -659,7 +659,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec double rectHandlerBorderTolerance() const; /** Returns the zoom factor of the graphics view. - * \return the factor or -1 in case of error (e.g. graphic view does not exist) + * \returns the factor or -1 in case of error (e.g. graphic view does not exist) */ double horizontalViewScaleFactor() const; diff --git a/src/core/composer/qgscomposermapgrid.h b/src/core/composer/qgscomposermapgrid.h index b2f352eb6f1..5e1269b7128 100644 --- a/src/core/composer/qgscomposermapgrid.h +++ b/src/core/composer/qgscomposermapgrid.h @@ -974,11 +974,11 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem QString gridAnnotationString( double value, AnnotationCoordinate coord, QgsExpressionContext &expressionContext ) const; /** Returns the grid lines with associated coordinate value - \return 0 in case of success*/ + \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 - \return 0 in case of success*/ + \returns 0 in case of success*/ int yGridLines( QList< QPair< double, QLineF > > &lines ) const; int xGridLinesCrsTransform( const QgsRectangle &bbox, const QgsCoordinateTransform &t, QList< QPair< double, QPolygonF > > &lines ) const; diff --git a/src/core/composer/qgscomposernodesitem.h b/src/core/composer/qgscomposernodesitem.h index 837bfe5dbfe..c4ace64a15a 100644 --- a/src/core/composer/qgscomposernodesitem.h +++ b/src/core/composer/qgscomposernodesitem.h @@ -81,7 +81,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem /** Gets the position of a node in scene coordinate. * \param index of the node * \param position the position of the node - * \return true if the index is valid and the position is set, false otherwise + * \returns true if the index is valid and the position is set, false otherwise */ bool nodePosition( const int index, QPointF &position ); @@ -105,7 +105,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem bool setSelectedNode( const int index ); /** Returns the currently selected node. - * \return the index of the selected node, -1 otherwise + * \returns the index of the selected node, -1 otherwise */ int selectedNode() { return mSelectedNode; } diff --git a/src/core/composer/qgscomposition.h b/src/core/composer/qgscomposition.h index c05a5a17b07..9a33f9d674e 100644 --- a/src/core/composer/qgscomposition.h +++ b/src/core/composer/qgscomposition.h @@ -403,14 +403,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo template void composerItemsOnPage( QList &itemList, const int pageNumber ) const; /** Returns the composer map with specified id - * \return QgsComposerMap or 0 pointer if the composer map item does not exist + * \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. * Ids are not necessarely unique, but this function returns only one element. * \param id - A QString representing the identifier of the item to retrieve. - * \return QgsComposerItem pointer or 0 pointer if no such item exists. + * \returns QgsComposerItem pointer or 0 pointer if no such item exists. */ const QgsComposerItem *getComposerItemById( const QString &id ) const; @@ -960,7 +960,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo void updateZValues( const bool addUndoCommands = true ); /** Returns the bounding rectangle of the selected items in scene coordinates - \return 0 in case of success*/ + \returns 0 in case of success*/ int boundingRectOfSelectedItems( QRectF &bRect ); //! Loads default composer settings diff --git a/src/core/diagram/qgsdiagram.h b/src/core/diagram/qgsdiagram.h index eddab867025..14a4a7a89f1 100644 --- a/src/core/diagram/qgsdiagram.h +++ b/src/core/diagram/qgsdiagram.h @@ -87,7 +87,7 @@ class CORE_EXPORT QgsDiagram * \param s The settings that specify the size type * \param c The rendering specifying the proper scale units for pixel conversion * - * \return The converted size for rendering + * \returns The converted size for rendering */ QSizeF sizePainterUnits( QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c ); @@ -96,7 +96,7 @@ class CORE_EXPORT QgsDiagram * \param s Unused * \param c The rendering specifying the proper scale units for pixel conversion * - * \return The converted length for rendering + * \returns The converted length for rendering */ double sizePainterUnits( double l, const QgsDiagramSettings &s, const QgsRenderContext &c ); @@ -104,7 +104,7 @@ class CORE_EXPORT QgsDiagram * \param s The settings that contain the font size and size type * \param c The rendering specifying the proper scale units for pixel conversion * - * \return The properly scaled font for rendering + * \returns The properly scaled font for rendering */ QFont scaledFont( const QgsDiagramSettings &s, const QgsRenderContext &c ); diff --git a/src/core/diagram/qgstextdiagram.h b/src/core/diagram/qgstextdiagram.h index a4aca85c0c2..9df6419d9ac 100644 --- a/src/core/diagram/qgstextdiagram.h +++ b/src/core/diagram/qgstextdiagram.h @@ -66,7 +66,7 @@ class CORE_EXPORT QgsTextDiagram: public QgsDiagram QPen mPen; /** Calculates intersection points between a line and an ellipse - \return intersection points*/ + \returns intersection points*/ void lineEllipseIntersection( QPointF lineStart, QPointF lineEnd, QPointF ellipseMid, double r1, double r2, QList &result ) const; }; diff --git a/src/core/geometry/qgsabstractgeometry.h b/src/core/geometry/qgsabstractgeometry.h index b66f5f0adf2..cf450eb810b 100644 --- a/src/core/geometry/qgsabstractgeometry.h +++ b/src/core/geometry/qgsabstractgeometry.h @@ -219,12 +219,12 @@ class CORE_EXPORT QgsAbstractGeometry * \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 - * \return false if at end + * \returns false if at end */ virtual bool nextVertex( QgsVertexId &id, QgsPointV2 &vertex ) const = 0; /** Retrieves the sequence of geometries, rings and nodes. - * \return coordinate sequence + * \returns coordinate sequence */ virtual QgsCoordinateSequence coordinateSequence() const = 0; @@ -314,14 +314,14 @@ class CORE_EXPORT QgsAbstractGeometry /** Returns the geometry converted to the more generic curve type. E.g. QgsLineString -> QgsCompoundCurve, QgsPolygonV2 -> QgsCurvePolygon, QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface - \return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ virtual QgsAbstractGeometry *toCurveType() const { return 0; } /** 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 - * \return rotation in radians, clockwise from north + * \returns rotation in radians, clockwise from north */ virtual double vertexAngle( QgsVertexId vertex ) const = 0; diff --git a/src/core/geometry/qgscircularstring.h b/src/core/geometry/qgscircularstring.h index f64610e3dad..7c0d79ea7a1 100644 --- a/src/core/geometry/qgscircularstring.h +++ b/src/core/geometry/qgscircularstring.h @@ -121,7 +121,7 @@ class CORE_EXPORT QgsCircularString: public QgsCurve /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. \param vertex the vertex id - \return rotation in radians, clockwise from north*/ + \returns rotation in radians, clockwise from north*/ double vertexAngle( QgsVertexId vertex ) const override; virtual QgsCircularString *reversed() const override; diff --git a/src/core/geometry/qgscompoundcurve.h b/src/core/geometry/qgscompoundcurve.h index 68e8a7b3d89..0a2f9514675 100644 --- a/src/core/geometry/qgscompoundcurve.h +++ b/src/core/geometry/qgscompoundcurve.h @@ -110,7 +110,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. \param vertex the vertex id - \return rotation in radians, clockwise from north*/ + \returns rotation in radians, clockwise from north*/ double vertexAngle( QgsVertexId vertex ) const override; virtual QgsCompoundCurve *reversed() const override; @@ -132,7 +132,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve QList< QgsCurve * > mCurves; /** Turns a vertex id for the compound curve into one or more ids for the subcurves - \return the index of the subcurve or -1 in case of error*/ + \returns the index of the subcurve or -1 in case of error*/ QList< QPair > curveVertexId( QgsVertexId id ) const; }; diff --git a/src/core/geometry/qgscurvepolygon.h b/src/core/geometry/qgscurvepolygon.h index 5058e0b4855..30a9721a86d 100644 --- a/src/core/geometry/qgscurvepolygon.h +++ b/src/core/geometry/qgscurvepolygon.h @@ -123,7 +123,7 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. * \param vertex the vertex id - * \return rotation in radians, clockwise from north + * \returns rotation in radians, clockwise from north */ double vertexAngle( QgsVertexId vertex ) const override; diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h index 87472be2bd5..5403167fad0 100644 --- a/src/core/geometry/qgsgeometry.h +++ b/src/core/geometry/qgsgeometry.h @@ -317,7 +317,7 @@ class CORE_EXPORT QgsGeometry /** * Returns coordinates of a vertex. * \param atVertex index of the vertex - * \return Coordinates of the vertex or QgsPoint(0,0) on error + * \returns Coordinates of the vertex or QgsPoint(0,0) on error */ QgsPoint vertexAt( int atVertex ) const; @@ -344,7 +344,7 @@ class CORE_EXPORT QgsGeometry * Searches for the closest vertex in this geometry to the given point. * \param point Specifiest the point for search * \param atVertex Receives index of the closest vertex - * \return The squared cartesian distance is also returned in sqrDist, negative number on error + * \returns The squared cartesian distance is also returned in sqrDist, negative number on error */ double closestVertexWithContext( const QgsPoint &point, int &atVertex ) const; @@ -356,18 +356,18 @@ class CORE_EXPORT QgsGeometry * before the closest segment is always afterVertex - 1 * \param leftOf Out: Returns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right ) * \param epsilon epsilon for segment snapping (added in 1.8) - * \return The squared cartesian distance is also returned in sqrDist, negative number on error + * \returns The squared cartesian distance is also returned in sqrDist, negative number on error */ double closestSegmentWithContext( const QgsPoint &point, QgsPoint &minDistPoint, int &afterVertex, double *leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const; /** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons. - \return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, + \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ // TODO QGIS 3.0 returns an enum instead of a magic constant int addRing( const QList &ring ); /** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons. - \return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, + \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ // TODO QGIS 3.0 returns an enum instead of a magic constant int addRing( QgsCurve *ring ); @@ -401,7 +401,7 @@ class CORE_EXPORT QgsGeometry /** Adds a new island polygon to a multipolygon feature * \param newPart part to add. Ownership is NOT transferred. - * \return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring + * \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring * not disjoint with existing polygons of the feature * \note not available in Python bindings */ @@ -409,7 +409,7 @@ class CORE_EXPORT QgsGeometry int addPart( GEOSGeometry *newPart ); /** Adds a new island polygon to a multipolygon feature - \return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring + \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring not disjoint with existing polygons of the feature \note available in Python bindings as addPartGeometry \since QGIS 2.2 @@ -426,23 +426,23 @@ class CORE_EXPORT QgsGeometry QgsGeometry removeInteriorRings( double minimumAllowedArea = -1 ) const; /** Translate this geometry by dx, dy - \return 0 in case of success*/ + \returns 0 in case of success*/ int translate( double dx, double dy ); /** Transform this geometry as described by CoordinateTransform ct - \return 0 in case of success*/ + \returns 0 in case of success*/ int transform( const QgsCoordinateTransform &ct ); /** Transform this geometry as described by QTransform ct \since QGIS 2.8 - \return 0 in case of success*/ + \returns 0 in case of success*/ int transform( const QTransform &ct ); /** Rotate this geometry around the Z axis \since QGIS 2.8 \param rotation clockwise rotation in degrees \param center rotation center - \return 0 in case of success*/ + \returns 0 in case of success*/ int rotate( double rotation, const QgsPoint ¢er ); /** Splits this geometry according to a given line. @@ -450,7 +450,7 @@ class CORE_EXPORT QgsGeometry \param[out] newGeometries list of new geometries that have been created with the split \param topological true if topological editing is enabled \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset - \return 0 in case of success, 1 if geometry has not been split, error else*/ + \returns 0 in case of success, 1 if geometry has not been split, error else*/ // TODO QGIS 3.0 returns an enum instead of a magic constant int splitGeometry( const QList &splitLine, QList &newGeometries, @@ -458,21 +458,21 @@ class CORE_EXPORT QgsGeometry QList &topologyTestPoints ); /** Replaces a part of this geometry with another line - * \return 0 in case of success + * \returns 0 in case of success * \since QGIS 1.3 */ int reshapeGeometry( const QList &reshapeWithLine ); /** Changes this geometry such that it does not intersect the other geometry * \param other geometry that should not be intersect - * \return 0 in case of success + * \returns 0 in case of success */ int makeDifference( const QgsGeometry *other ); /** Returns the geometry formed by modifying this geometry such that it does not * intersect the other geometry. * \param other geometry that should not be intersect - * \return difference geometry, or empty geometry if difference could not be calculated + * \returns difference geometry, or empty geometry if difference could not be calculated * \since QGIS 3.0 */ QgsGeometry makeDifference( const QgsGeometry &other ) const; @@ -593,7 +593,7 @@ class CORE_EXPORT QgsGeometry * \param side side of geometry to buffer * \param joinStyle join style for corners * \param mitreLimit limit on the mitre ratio used for very sharp corners - * \return buffered geometry, or an empty geometry if buffer could not be + * \returns buffered geometry, or an empty geometry if buffer could not be * calculated * \since QGIS 3.0 */ @@ -714,7 +714,7 @@ class CORE_EXPORT QgsGeometry * how far along this linestring you need to traverse to get to the closest location * where this linestring comes to the specified point. * \param point point to seek proximity to - * \return distance along line, or -1 on error + * \returns distance along line, or -1 on error * \note only valid for linestring geometries * @see interpolate() * \since QGIS 3.0 @@ -765,12 +765,12 @@ class CORE_EXPORT QgsGeometry /** Exports the geometry to WKT * \note precision parameter added in QGIS 2.4 - * \return true in case of success and false else + * \returns true in case of success and false else */ QString exportToWkt( int precision = 17 ) const; /** Exports the geometry to GeoJSON - * \return a QString representing the geometry as GeoJSON + * \returns a QString representing the geometry as GeoJSON * \since QGIS 1.8 * \note Available in Python bindings since QGIS 1.9 * \note precision parameter added in QGIS 2.4 @@ -780,7 +780,7 @@ class CORE_EXPORT QgsGeometry /** Try to convert the geometry to the requested type * \param destType the geometry type to be converted to * \param destMultipart determines if the output geometry will be multipart or not - * \return the converted geometry or nullptr if the conversion fails. + * \returns the converted geometry or nullptr if the conversion fails. * \since QGIS 2.2 */ QgsGeometry convertToType( QgsWkbTypes::GeometryType destType, bool destMultipart = false ) const; @@ -833,12 +833,12 @@ class CORE_EXPORT QgsGeometry /** Delete a ring in polygon or multipolygon. Ring 0 is outer ring and can't be deleted. - \return true on success + \returns true on success \since QGIS 1.2 */ bool deleteRing( int ringNum, int partNum = 0 ); /** Delete part identified by the part number - \return true on success + \returns true on success \since QGIS 1.2 */ bool deletePart( int partNum ); @@ -848,7 +848,7 @@ class CORE_EXPORT QgsGeometry * If it is already a multipart geometry, it will return true and * not change the geometry. * - * \return true in case of success and false else + * \returns true in case of success and false else */ bool convertToMultiType(); @@ -859,12 +859,12 @@ class CORE_EXPORT QgsGeometry * If it is already a single part geometry, it will return true and * not change the geometry. * - * \return true in case of success and false else + * \returns true in case of success and false else */ bool convertToSingleType(); /** Modifies geometry to avoid intersections with the layers specified in project properties - * \return 0 in case of success, + * \returns 0 in case of success, * 1 if geometry is not of polygon type, * 2 if avoid intersection would change the geometry type, * 3 other error during intersection removal @@ -884,7 +884,7 @@ class CORE_EXPORT QgsGeometry * of lower-to-equal dimension geometries or a geometry of lower dimension. * Single polygons may become multi-geometries in case of self-intersections. * It preserves Z values, but M values will be dropped. - * \return new valid QgsGeometry or null geometry on error + * \returns new valid QgsGeometry or null geometry on error * \since QGIS 3.0 */ QgsGeometry makeValid(); diff --git a/src/core/geometry/qgsgeometrycollection.h b/src/core/geometry/qgsgeometrycollection.h index 9a82cdd4ec7..b9bacb6143d 100644 --- a/src/core/geometry/qgsgeometrycollection.h +++ b/src/core/geometry/qgsgeometrycollection.h @@ -115,7 +115,7 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry /** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments. * \param vertex the vertex id - * \return rotation in radians, clockwise from north + * \returns rotation in radians, clockwise from north */ double vertexAngle( QgsVertexId vertex ) const override; diff --git a/src/core/geometry/qgsgeometryeditutils.h b/src/core/geometry/qgsgeometryeditutils.h index 29762d4c092..51125f9e67f 100644 --- a/src/core/geometry/qgsgeometryeditutils.h +++ b/src/core/geometry/qgsgeometryeditutils.h @@ -36,13 +36,13 @@ class QgsGeometryEditUtils public: /** Adds interior ring (taking ownership). - \return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, + \returns 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed, 3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/ // TODO QGIS 3.0 returns an enum instead of a magic constant static int addRing( QgsAbstractGeometry *geom, QgsCurve *ring ); /** Adds part to multi type geometry (taking ownership) - \return 0 in case of success, 1 if not a multigeometry, 2 if part is not a valid geometry, 3 if new polygon ring + \returns 0 in case of success, 1 if not a multigeometry, 2 if part is not a valid geometry, 3 if new polygon ring not disjoint with existing polygons of the feature*/ // TODO QGIS 3.0 returns an enum instead of a magic constant static int addPart( QgsAbstractGeometry *geom, QgsAbstractGeometry *part ); diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h index 00daba82310..c388c08c667 100644 --- a/src/core/geometry/qgsgeometryutils.h +++ b/src/core/geometry/qgsgeometryutils.h @@ -83,7 +83,7 @@ class CORE_EXPORT QgsGeometryUtils * \param q1 Point on the second line * \param w Direction vector of the second line * \param inter Output parameter, the intersection point - * \return Whether the lines intersect + * \returns Whether the lines intersect */ static bool lineIntersection( const QgsPointV2 &p1, QgsVector v, const QgsPointV2 &q1, QgsVector w, QgsPointV2 &inter ); @@ -95,7 +95,7 @@ class CORE_EXPORT QgsGeometryUtils * \param q2 Second segment end point * \param inter Output parameter, the intersection point * \param tolerance The tolerance to use - * \return Whether the segments intersect + * \returns Whether the segments intersect */ static bool segmentIntersection( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &q1, const QgsPointV2 &q2, QgsPointV2 &inter, double tolerance ); @@ -104,7 +104,7 @@ class CORE_EXPORT QgsGeometryUtils * \param p The point * \param s1 The segment start point * \param s2 The segment end point - * \return The projection of the point on the segment + * \returns The projection of the point on the segment */ static QgsPointV2 projPointOnSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 ) { @@ -128,7 +128,7 @@ class CORE_EXPORT QgsGeometryUtils * \param part The part of the geometry to check * \param ring The ring of the geometry part to check * \param tolerance The tolerance to use - * \return The list of self intersections + * \returns The list of self intersections * \note not available in Python bindings * \since QGIS 2.12 */ @@ -274,7 +274,7 @@ class CORE_EXPORT QgsGeometryUtils * M value is computed if one of this point have M. * \param pt1 first point. * \param pt2 second point. - * \return New point at middle between points pt1 and pt2. + * \returns New point at middle between points pt1 and pt2. * * Example: * \code{.py} * p = QgsPointV2( 4, 6 ) # 2D point @@ -294,7 +294,7 @@ class CORE_EXPORT QgsGeometryUtils /** Return the gradient of a line defined by points \a pt1 and \a pt2. * \param pt1 first point. * \param pt2 second point. - * \return The gradient of this linear entity, or infinity if vertical + * \returns The gradient of this linear entity, or infinity if vertical * \since QGIS 3.0 */ static double gradient( const QgsPointV2 &pt1, const QgsPointV2 &pt2 ); @@ -314,7 +314,7 @@ class CORE_EXPORT QgsGeometryUtils * \param p The point * \param s1 The segment start point * \param s2 The segment end point - * \return A line (segment) from p to perpendicular point on segment [s1, s2] + * \returns A line (segment) from p to perpendicular point on segment [s1, s2] */ static QgsLineString perpendicularSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 ); diff --git a/src/core/geometry/qgsgeos.h b/src/core/geometry/qgsgeos.h index fbc81e8d14f..b846627e005 100644 --- a/src/core/geometry/qgsgeos.h +++ b/src/core/geometry/qgsgeos.h @@ -79,7 +79,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine \param topological true if topological editing is enabled \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset \param[out] errorMsg error messages emitted, if any - \return 0 in case of success, 1 if geometry has not been split, error else*/ + \returns 0 in case of success, 1 if geometry has not been split, error else*/ int splitGeometry( const QgsLineString &splitLine, QList &newGeometries, bool topological, @@ -97,7 +97,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine * \param joinStyle join style for corners ( Round (1) / Mitre (2) / Bevel (3) ) * \param mitreLimit limit on the mitre ratio used for very sharp corners * \param errorMsg error messages emitted, if any - * \return buffered geometry, or an nullptr if buffer could not be + * \returns buffered geometry, or an nullptr if buffer could not be * calculated * \since QGIS 3.0 */ @@ -137,7 +137,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine * \param point point to seek proximity to * \param errorMsg error messages emitted, if any * \note only valid for linestring geometries - * \return distance along line, or -1 on error + * \returns distance along line, or -1 on error */ double lineLocatePoint( const QgsPointV2 &point, QString *errorMsg = nullptr ) const; diff --git a/src/core/geometry/qgsinternalgeometryengine.h b/src/core/geometry/qgsinternalgeometryengine.h index c2d1d06cf56..de481331343 100644 --- a/src/core/geometry/qgsinternalgeometryengine.h +++ b/src/core/geometry/qgsinternalgeometryengine.h @@ -46,7 +46,7 @@ class QgsInternalGeometryEngine * * \param x offset in x direction * \param y offset in y direction - * \return an extruded polygon + * \returns an extruded polygon */ QgsGeometry extrude( double x, double y ) const; diff --git a/src/core/geometry/qgslinestring.h b/src/core/geometry/qgslinestring.h index 263a09867f1..1e32d3f76e1 100644 --- a/src/core/geometry/qgslinestring.h +++ b/src/core/geometry/qgslinestring.h @@ -137,7 +137,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve void close(); /** Returns the geometry converted to the more generic curve type QgsCompoundCurve - \return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ QgsAbstractGeometry *toCurveType() const override; /** diff --git a/src/core/geometry/qgsmultilinestring.h b/src/core/geometry/qgsmultilinestring.h index 0a6511d094d..86399158e4d 100644 --- a/src/core/geometry/qgsmultilinestring.h +++ b/src/core/geometry/qgsmultilinestring.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve virtual bool addGeometry( QgsAbstractGeometry *g ) override; /** Returns the geometry converted to the more generic curve type QgsMultiCurve - \return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ QgsAbstractGeometry *toCurveType() const override; protected: diff --git a/src/core/geometry/qgsmultipolygon.h b/src/core/geometry/qgsmultipolygon.h index aa619703b70..3c70f947e95 100644 --- a/src/core/geometry/qgsmultipolygon.h +++ b/src/core/geometry/qgsmultipolygon.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsMultiPolygonV2: public QgsMultiSurface virtual bool addGeometry( QgsAbstractGeometry *g ) override; /** Returns the geometry converted to the more generic curve type QgsMultiSurface - \return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ QgsAbstractGeometry *toCurveType() const override; virtual QgsAbstractGeometry *boundary() const override; diff --git a/src/core/geometry/qgspointv2.h b/src/core/geometry/qgspointv2.h index 3583e3743b4..6d1da7ef91a 100644 --- a/src/core/geometry/qgspointv2.h +++ b/src/core/geometry/qgspointv2.h @@ -234,7 +234,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry * \param distance distance to project * \param azimuth angle to project in X Y, clockwise in degrees starting from north * \param inclination angle to project in Z (3D) - * \return The point projected. If a 2D point is projected a 3D point will be returned except if + * \returns The point projected. If a 2D point is projected a 3D point will be returned except if * inclination is 90. A 3D point is always returned if a 3D point is projected. * Example: * \code{.py} @@ -319,7 +319,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry /** Angle undefined. Always returns 0.0 \param vertex the vertex id - \return 0.0*/ + \returns 0.0*/ double vertexAngle( QgsVertexId vertex ) const override { Q_UNUSED( vertex ); return 0.0; } virtual int vertexCount( int /*part*/ = 0, int /*ring*/ = 0 ) const override { return 1; } diff --git a/src/core/geometry/qgspolygon.h b/src/core/geometry/qgspolygon.h index dff13895ecf..fae2c680884 100644 --- a/src/core/geometry/qgspolygon.h +++ b/src/core/geometry/qgspolygon.h @@ -52,7 +52,7 @@ class CORE_EXPORT QgsPolygonV2: public QgsCurvePolygon QgsPolygonV2 *surfaceToPolygon() const override; /** Returns the geometry converted to the more generic curve type QgsCurvePolygon - \return the converted geometry. Caller takes ownership*/ + \returns the converted geometry. Caller takes ownership*/ QgsAbstractGeometry *toCurveType() const override; void addInteriorRing( QgsCurve *ring ) override; diff --git a/src/core/geometry/qgstriangle.h b/src/core/geometry/qgstriangle.h index aef57a73d02..7c32a0884a7 100644 --- a/src/core/geometry/qgstriangle.h +++ b/src/core/geometry/qgstriangle.h @@ -98,13 +98,13 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Returns coordinates of a vertex. * \param atVertex index of the vertex - * \return Coordinates of the vertex or QgsPointV2(0,0) on error (\a atVertex < 0 or > 3). + * \returns Coordinates of the vertex or QgsPointV2(0,0) on error (\a atVertex < 0 or > 3). */ QgsPointV2 vertexAt( int atVertex ) const; /** * Returns the three lengths of the triangle. - * \return Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2 + * \returns Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2 * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -116,7 +116,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Returns the three angles of the triangle. - * \return Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2 + * \returns Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2 * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -129,7 +129,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Is the triangle isocele (two sides with the same length)? * \param lengthTolerance The tolerance to use - * \return True or False + * \returns True or False * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -145,7 +145,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Is the triangle equilateral (three sides with the same length)? * \param lengthTolerance The tolerance to use - * \return True or False + * \returns True or False * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 10, 10 ), QgsPointV2( 16, 10 ), QgsPointV2( 13, 15.1962 ) ) @@ -161,7 +161,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Is the triangle right-angled? * \param angleTolerance The tolerance to use - * \return True or False + * \returns True or False * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -177,8 +177,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Is the triangle scalene (all sides have differen lengths)? * \param lengthTolerance The tolerance to use - * \return True or False - * \return True or False + * \returns True or False + * \returns True or False * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 7.2825, 4.2368 ), QgsPointV2( 13.0058, 3.3218 ), QgsPointV2( 9.2145, 6.5242 ) ) @@ -193,7 +193,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * An altitude is a segment (defined by a QgsLineString) from a vertex to the opposite side (or, if necessary, to the extension of the opposite side). - * \return Three altitudes from this triangle + * \returns Three altitudes from this triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -205,7 +205,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * A median is a segment (defined by a QgsLineString) from a vertex to the midpoint of the opposite side. - * \return Three medians from this triangle + * \returns Three medians from this triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -218,7 +218,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * The segment (defined by a QgsLineString) returned bisect the angle of a vertex to the opposite side. * \param lengthTolerance The tolerance to use - * \return Three angle bisector from this triangle + * \returns Three angle bisector from this triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -230,7 +230,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Medial (or midpoint) triangle of a triangle ABC is the triangle with vertices at the midpoints of the triangle's sides. - * \return The medial from this triangle + * \returns The medial from this triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -243,7 +243,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * An orthocenter is the point of intersection of the altitudes of a triangle. * \param lengthTolerance The tolerance to use - * \return The orthocenter of the triangle. + * \returns The orthocenter of the triangle. * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -255,7 +255,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Center of the circumscribed circle of the triangle. - * \return The center of the circumscribed circle of the triangle + * \returns The center of the circumscribed circle of the triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -267,7 +267,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Radius of the circumscribed circle of the triangle. - * \return The radius of the circumscribed circle of the triangle + * \returns The radius of the circumscribed circle of the triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -282,7 +282,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Center of the inscribed circle of the triangle. - * \return The center of the inscribed circle of the triangle + * \returns The center of the inscribed circle of the triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -294,7 +294,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 /** * Radius of the inscribed circle of the triangle. - * \return The radius of the inscribed circle of the triangle + * \returns The radius of the inscribed circle of the triangle * * Example: * \code{.py} * tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) ) @@ -313,7 +313,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2 * \param p1 first point * \param p2 second point * \param p3 third point - * \return True if the points can create a triangle, otherwise false. + * \returns True if the points can create a triangle, otherwise false. * \note not available in Python bindings */ bool validateGeom( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &p3 ); diff --git a/src/core/geometry/qgswkbtypes.h b/src/core/geometry/qgswkbtypes.h index 32e9740a905..0f5f6f27ec8 100644 --- a/src/core/geometry/qgswkbtypes.h +++ b/src/core/geometry/qgswkbtypes.h @@ -930,7 +930,7 @@ class CORE_EXPORT QgsWkbTypes /** * Will convert the 25D version of the flat type if supported or Unknown if not supported. * \param type The type to convert - * \return the 25D version of the type or Unknown + * \returns the 25D version of the type or Unknown */ static Type to25D( Type type ) { diff --git a/src/core/gps/qextserialport/qextserialenumerator.h b/src/core/gps/qextserialport/qextserialenumerator.h index fcdeb652cd3..d87ae20caa5 100644 --- a/src/core/gps/qextserialport/qextserialenumerator.h +++ b/src/core/gps/qextserialport/qextserialenumerator.h @@ -117,7 +117,7 @@ Q_OBJECT * Get value of specified property from the registry. * \param key handle to an open key. * \param property property name. - * \return property value. + * \returns property value. */ static QString getRegKeyValue(HKEY key, LPCTSTR property); @@ -128,7 +128,7 @@ Q_OBJECT * \param devData pointer to an SP_DEVINFO_DATA structure that defines the device instance. * this is returned by SetupDiGetDeviceInterfaceDetail() function. * \param property registry property. One of defined SPDRP_* constants. - * \return property string. + * \returns property string. */ static QString getDeviceProperty(HDEVINFO devInfo, PSP_DEVINFO_DATA devData, DWORD property); @@ -178,7 +178,7 @@ Q_OBJECT public: /*! Get list of ports. - \return list of ports currently available in the system. + \returns list of ports currently available in the system. */ static QList getPorts(); /*! diff --git a/src/core/gps/qextserialport/qextserialport.h b/src/core/gps/qextserialport/qextserialport.h index dee04bf8bf3..142c9d1ada2 100644 --- a/src/core/gps/qextserialport/qextserialport.h +++ b/src/core/gps/qextserialport/qextserialport.h @@ -200,7 +200,7 @@ class QextSerialPort: public QIODevice /**! * Get query mode. - * \return query mode. + * \returns query mode. */ inline QueryMode queryMode() const { return _queryMode; } diff --git a/src/core/layertree/qgslayertreemodellegendnode.h b/src/core/layertree/qgslayertreemodellegendnode.h index 0aae01c8bfe..decb0415cfb 100644 --- a/src/core/layertree/qgslayertreemodellegendnode.h +++ b/src/core/layertree/qgslayertreemodellegendnode.h @@ -107,7 +107,7 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject * \param settings Legend layout configuration * \param ctx Context for rendering - may be null if only doing layout without actual rendering * \param itemHeight Minimal height of the legend item - used for correct positioning when rendering - * \return Real size of the symbol (may be bigger than "normal" symbol size from settings) + * \returns Real size of the symbol (may be bigger than "normal" symbol size from settings) */ virtual QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const; @@ -116,7 +116,7 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject * \param settings Legend layout configuration * \param ctx Context for rendering - may be null if only doing layout without actual rendering * \param symbolSize Real size of the associated symbol - used for correct positioning when rendering - * \return Size of the label (may span multiple lines) + * \returns Size of the label (may span multiple lines) */ virtual QSizeF drawSymbolText( const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize ) const; diff --git a/src/core/pal/feature.h b/src/core/pal/feature.h index c4a3d9c3ca1..f2294ffc9e5 100644 --- a/src/core/pal/feature.h +++ b/src/core/pal/feature.h @@ -124,7 +124,7 @@ namespace pal * \param bboxMax max values of the map extent * \param mapShape generate candidates for this spatial entity * \param candidates index for candidates - * \return the number of candidates generated in lPos + * \returns the number of candidates generated in lPos */ int createCandidates( QList &lPos, double bboxMin[2], double bboxMax[2], PointSet *mapShape, RTree *candidates ); @@ -203,7 +203,7 @@ namespace pal /** 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 - * \return the number of generated candidates + * \returns the number of generated candidates */ int createCandidatesForPolygon( QList &lPos, PointSet *mapShape ); diff --git a/src/core/pal/geomfunction.h b/src/core/pal/geomfunction.h index 0a9b393a3d2..4234203111d 100644 --- a/src/core/pal/geomfunction.h +++ b/src/core/pal/geomfunction.h @@ -81,7 +81,7 @@ namespace pal * \param y y coordinates * \param n Size of subset (vector id) * \param cHull returns the point id (id of id's vector...) whom are parts of the convex hull - * \return convexHull's size + * \returns convexHull's size */ static int convexHullId( int *id, const double *const x, const double *const y, int n, int *&cHull ); diff --git a/src/core/pal/labelposition.h b/src/core/pal/labelposition.h index 5361fb66687..1bc646aa3be 100644 --- a/src/core/pal/labelposition.h +++ b/src/core/pal/labelposition.h @@ -121,7 +121,7 @@ namespace pal * \brief Check whether or not this overlap with another labelPosition * * \param ls other labelposition - * \return true or false + * \returns true or false */ bool isInConflict( LabelPosition *ls ); @@ -150,13 +150,13 @@ namespace pal void offsetPosition( double xOffset, double yOffset ); /** \brief return id - * \return id + * \returns id */ int getId() const; /** \brief return the feature corresponding to this labelposition - * \return the feature + * \returns the feature */ FeaturePart *getFeaturePart(); @@ -202,13 +202,13 @@ namespace pal /** * \brief get the down-left x coordinate - * \return x coordinate + * \returns x coordinate */ double getX( int i = 0 ) const; /** * \brief get the down-left y coordinate - * \return y coordinate + * \returns y coordinate */ double getY( int i = 0 ) const; @@ -217,7 +217,7 @@ namespace pal /** * \brief get alpha - * \return alpha to rotate text (in rad) + * \returns alpha to rotate text (in rad) */ double getAlpha() const; bool getReversed() const { return reversed; } diff --git a/src/core/pal/layer.h b/src/core/pal/layer.h index f7470ebd03d..fd9332496fd 100644 --- a/src/core/pal/layer.h +++ b/src/core/pal/layer.h @@ -225,7 +225,7 @@ namespace pal * * @throws PalException::FeatureExists * - * \return true on success (i.e. valid geometry) + * \returns true on success (i.e. valid geometry) */ bool registerFeature( QgsLabelFeature *label ); diff --git a/src/core/pal/pal.h b/src/core/pal/pal.h index b94d53160a8..a61542e071e 100644 --- a/src/core/pal/pal.h +++ b/src/core/pal/pal.h @@ -134,7 +134,7 @@ namespace pal * \param stats A PalStat object (can be NULL) * \param displayAll if true, all feature will be labelled even though overlaps occur * - * \return A list of label to display on map + * \returns A list of label to display on map */ QList *labeller( double bbox[4], PalStat **stats, bool displayAll ); @@ -160,7 +160,7 @@ namespace pal /** * \brief Get flag show partial label * - * \return value of flag + * \returns value of flag */ bool getShowPartial(); @@ -216,7 +216,7 @@ namespace pal /** * \brief get the search method in use * - * \return the search method + * \returns the search method */ SearchMethod getSearch(); @@ -317,13 +317,13 @@ namespace pal /** * \brief Get the minimum # of iteration doing in POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN - * \return minimum # of iteration + * \returns minimum # of iteration */ int getMinIt(); /** * \brief Get the maximum # of iteration doing in POPMUSIC_TABU, POPMUSIC_CHAIN and POPMUSIC_TABU_CHAIN - * \return maximum # of iteration + * \returns maximum # of iteration */ int getMaxIt(); diff --git a/src/core/qgsapplication.h b/src/core/qgsapplication.h index 2b7a27e3bf3..04e11f52494 100644 --- a/src/core/qgsapplication.h +++ b/src/core/qgsapplication.h @@ -113,7 +113,7 @@ class CORE_EXPORT QgsApplication : public QApplication * @brief All themes found in ~/.qgis3/themes folder. * The path is to the root folder for the theme * \note Valid theme folders must contain a style.qss file. - * \return A hash of theme name and theme path. Valid theme folders contain style.qss + * \returns A hash of theme name and theme path. Valid theme folders contain style.qss */ static QHash uiThemes(); @@ -318,7 +318,7 @@ class CORE_EXPORT QgsApplication : public QApplication * Typically you will use this method by doing: * QString myStyle = QgsApplication::reportStyleSheet(); * textBrowserReport->document()->setDefaultStyleSheet(myStyle); - * \return QString containing the CSS 2.1 compliant stylesheet. + * \returns QString containing the CSS 2.1 compliant stylesheet. * \note you can use the special Qt extensions too, for example * the gradient fills for backgrounds. */ diff --git a/src/core/qgsattributeeditorelement.h b/src/core/qgsattributeeditorelement.h index d002d690501..5d54ac74b0d 100644 --- a/src/core/qgsattributeeditorelement.h +++ b/src/core/qgsattributeeditorelement.h @@ -63,14 +63,14 @@ class CORE_EXPORT QgsAttributeEditorElement /** * Return the name of this element * - * \return The name for this element + * \returns The name for this element */ QString name() const { return mName; } /** * The type of this element * - * \return The type + * \returns The type */ AttributeEditorType type() const { return mType; } @@ -86,7 +86,7 @@ class CORE_EXPORT QgsAttributeEditorElement * * \param doc The QDomDocument which is used to create new XML elements * - * \return A DOM element to serialize this element + * \returns A DOM element to serialize this element */ QDomElement toDomElement( QDomDocument &doc ) const; @@ -176,14 +176,14 @@ class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement /** * Returns if this container is going to be rendered as a group box * - * \return True if it will be a group box, false if it will be a tab + * \returns True if it will be a group box, false if it will be a tab */ virtual bool isGroupBox() const { return mIsGroupBox; } /** * Get a list of the children elements of this container * - * \return A list of elements + * \returns A list of elements */ QList children() const { return mChildren; } @@ -192,7 +192,7 @@ class CORE_EXPORT QgsAttributeEditorContainer : public QgsAttributeEditorElement * * \param type The type which should be searched * - * \return A list of elements of the type which has been searched for + * \returns A list of elements of the type which has been searched for */ virtual QList findElements( AttributeEditorType type ) const; @@ -272,7 +272,7 @@ class CORE_EXPORT QgsAttributeEditorField : public QgsAttributeEditorElement /** * Return the index of the field - * \return + * \returns */ int idx() const { return mIdx; } @@ -323,7 +323,7 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement /** * Get the id of the relation which shall be embedded * - * \return the id + * \returns the id */ const QgsRelation &relation() const { return mRelation; } @@ -331,7 +331,7 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement * Initializes the relation from the id * * \param relManager The relation manager to use for the initialization - * \return true if the relation was found in the relationmanager + * \returns true if the relation was found in the relationmanager */ bool init( QgsRelationManager *relManager ); diff --git a/src/core/qgsattributes.h b/src/core/qgsattributes.h index a17073c2ba2..b96b4a8d8ca 100644 --- a/src/core/qgsattributes.h +++ b/src/core/qgsattributes.h @@ -94,7 +94,7 @@ class CORE_EXPORT QgsAttributes : public QVector * handle NULL values for certain types (like int). * * \param v The attributes to compare - * \return True if v is equal + * \returns True if v is equal */ bool operator==( const QgsAttributes &v ) const { diff --git a/src/core/qgsbrowsermodel.h b/src/core/qgsbrowsermodel.h index 4d66e939804..658ae88fea4 100644 --- a/src/core/qgsbrowsermodel.h +++ b/src/core/qgsbrowsermodel.h @@ -118,7 +118,7 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel * \param path item path * \param matchFlag supported is Qt::MatchExactly and Qt::MatchStartsWith which has reverse meaning, i.e. find * item with the longest match from start with path (to get as close/deep as possible to deleted item). - * \return model index, invalid if item not found */ + * \returns model index, invalid if item not found */ QModelIndex findPath( const QString &path, Qt::MatchFlag matchFlag = Qt::MatchExactly ); //! \note not available in Python bindings diff --git a/src/core/qgscachedfeatureiterator.h b/src/core/qgscachedfeatureiterator.h index 4a5a4e8c9fa..bb68421f5f3 100644 --- a/src/core/qgscachedfeatureiterator.h +++ b/src/core/qgscachedfeatureiterator.h @@ -42,14 +42,14 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator /** * Rewind to the beginning of the iterator * - * \return bool true if the operation was ok + * \returns bool true if the operation was ok */ virtual bool rewind() override; /** * Close this iterator. No further features will be available. * - * \return true if successful + * \returns true if successful */ virtual bool close() override; @@ -60,7 +60,7 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator * Implementation for fetching a feature. * * \param f Will write to this feature - * \return bool true if the operation was ok + * \returns bool true if the operation was ok * * @see bool getFeature( QgsFeature& f ) */ @@ -70,7 +70,7 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator * We have a local special iterator for FilterFids, no need to run the generic. * * \param f Will write to this feature - * \return bool true if the operation was ok + * \returns bool true if the operation was ok */ virtual bool nextFeatureFilterFids( QgsFeature &f ) override { return fetchFeature( f ); } @@ -100,14 +100,14 @@ class CORE_EXPORT QgsCachedFeatureWriterIterator : public QgsAbstractFeatureIter /** * Rewind to the beginning of the iterator * - * \return bool true if the operation was ok + * \returns bool true if the operation was ok */ virtual bool rewind() override; /** * Close this iterator. No further features will be available. * - * \return true if successful + * \returns true if successful */ virtual bool close() override; @@ -117,7 +117,7 @@ class CORE_EXPORT QgsCachedFeatureWriterIterator : public QgsAbstractFeatureIter * Implementation for fetching a feature. * * \param f Will write to this feature - * \return bool true if the operation was ok + * \returns bool true if the operation was ok * * @see bool getFeature( QgsFeature& f ) */ diff --git a/src/core/qgscacheindex.h b/src/core/qgscacheindex.h index e843b6628fe..9ae64f029b5 100644 --- a/src/core/qgscacheindex.h +++ b/src/core/qgscacheindex.h @@ -71,7 +71,7 @@ class CORE_EXPORT QgsAbstractCacheIndex * value is true. * \param featureRequest The feature request, for which this index is queried. * - * \return True, if this index holds the information to answer the request. + * \returns True, if this index holds the information to answer the request. * */ virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0; diff --git a/src/core/qgsclipper.h b/src/core/qgsclipper.h index dd03ef4832d..8c3cdf433e0 100644 --- a/src/core/qgsclipper.h +++ b/src/core/qgsclipper.h @@ -100,7 +100,7 @@ class CORE_EXPORT QgsClipper /** Takes a linestring and clips it to clipExtent * \param curve the linestring * \param clipExtent clipping bounds - * \return clipped line coordinates + * \returns clipped line coordinates */ static QPolygonF clippedLine( const QgsCurve &curve, const QgsRectangle &clipExtent ); diff --git a/src/core/qgsconditionalstyle.h b/src/core/qgsconditionalstyle.h index 6699aede1ff..74af33b65c1 100644 --- a/src/core/qgsconditionalstyle.h +++ b/src/core/qgsconditionalstyle.h @@ -43,7 +43,7 @@ class CORE_EXPORT QgsConditionalLayerStyles /** * @brief Returns the conditional styles set for the field UI properties - * \return A list of conditional styles that have been set. + * \returns A list of conditional styles that have been set. */ QList fieldStyles( const QString &fieldName ); @@ -77,13 +77,13 @@ class CORE_EXPORT QgsConditionalStyle * @brief Check if the rule matches using the given value and feature * \param value The current value being checked. The "value" variable from the context is replaced with this value. * \param context Expression context for evaluating rule expression - * \return True of the rule matches against the given feature + * \returns True of the rule matches against the given feature */ bool matches( const QVariant &value, QgsExpressionContext &context ) const; /** * @brief Render a preview icon of the rule. - * \return QPixmap preview of the style + * \returns QPixmap preview of the style */ QPixmap renderPreview() const; @@ -126,71 +126,71 @@ class CORE_EXPORT QgsConditionalStyle /** * @brief The name of the style. - * \return The name of the style. Names are optional so might be empty. + * \returns The name of the style. Names are optional so might be empty. */ QString displayText() const; /** * @brief The name of the style. - * \return The name of the style. Names are optional so might be empty. + * \returns The name of the style. Names are optional so might be empty. */ QString name() const { return mName; } /** * @brief The icon set for style generated from the set symbol - * \return A QPixmap that was set for the icon using the symbol + * \returns A QPixmap that was set for the icon using the symbol */ QPixmap icon() const { return mIcon; } /** * @brief The symbol used to generate the icon for the style - * \return The QgsSymbol used for the icon + * \returns The QgsSymbol used for the icon */ QgsSymbol *symbol() const { return mSymbol.get(); } /** * @brief The text color set for style - * \return QColor for text color + * \returns QColor for text color */ QColor textColor() const { return mTextColor; } /** * @brief Check if the text color is valid for render. * Valid colors are non invalid QColors and a color with a > 0 alpha - * \return True of the color set for text is valid. + * \returns True of the color set for text is valid. */ bool validTextColor() const; /** * @brief The background color for style - * \return QColor for background color + * \returns QColor for background color */ QColor backgroundColor() const { return mBackColor; } /** * @brief Check if the background color is valid for render. * Valid colors are non invalid QColors and a color with a > 0 alpha - * \return True of the color set for background is valid. + * \returns True of the color set for background is valid. */ bool validBackgroundColor() const; /** * @brief The font for the style - * \return QFont for the style + * \returns QFont for the style */ QFont font() const { return mFont; } /** * @brief The condition rule set for the style. Rule may contain variable \@value * to represent the current value - * \return QString of the current set rule + * \returns QString of the current set rule */ QString rule() const { return mRule; } /** * @brief isValid Check if this rule is valid. A valid rule has one or more properties * set. - * \return True if the rule is valid. + * \returns True if the rule is valid. */ bool isValid() const { return mValid; } @@ -198,7 +198,7 @@ class CORE_EXPORT QgsConditionalStyle * @brief Find and return the matching styles for the value and feature. * If no match is found a invalid QgsConditionalStyle is return. * - * \return A condtional style that matches the value and feature. + * \returns A condtional style that matches the value and feature. * Check with QgsConditionalStyle::isValid() */ static QList matchingConditionalStyles( const QList &styles, const QVariant &value, QgsExpressionContext &context ); @@ -207,7 +207,7 @@ class CORE_EXPORT QgsConditionalStyle * @brief Find and return the matching style for the value and feature. * If no match is found a invalid QgsConditionalStyle is return. * - * \return A condtional style that matches the value and feature. + * \returns A condtional style that matches the value and feature. * Check with QgsConditionalStyle::isValid() */ static QgsConditionalStyle matchingConditionalStyle( const QList &styles, const QVariant &value, QgsExpressionContext &context ); @@ -216,7 +216,7 @@ class CORE_EXPORT QgsConditionalStyle * @brief Compress a list of styles into a single style. This can be used to stack the elements of the * styles. The font of the last style is used in the output. * \param styles The list of styles to compress down - * \return A single style generated from joining each style property. + * \returns A single style generated from joining each style property. */ static QgsConditionalStyle compressStyles( const QList &styles ); diff --git a/src/core/qgsconnectionpool.h b/src/core/qgsconnectionpool.h index 14c5e64b0aa..26a9a21e41d 100644 --- a/src/core/qgsconnectionpool.h +++ b/src/core/qgsconnectionpool.h @@ -256,7 +256,7 @@ class QgsConnectionPool } //! Try to acquire a connection: if no connections are available, the thread will get blocked. - //! \return initialized connection or null on error + //! \returns initialized connection or null on error T acquireConnection( const QString &connInfo ) { mMutex.lock(); diff --git a/src/core/qgscoordinatereferencesystem.h b/src/core/qgscoordinatereferencesystem.h index 4024b71b494..67d7c9a064b 100644 --- a/src/core/qgscoordinatereferencesystem.h +++ b/src/core/qgscoordinatereferencesystem.h @@ -293,7 +293,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * Sets this CRS by lookup of the given ID in the CRS database. * \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. - * \return True on success else false + * \returns True on success else false */ // TODO QGIS 3: remove type and always use EPSG code, rename to createFromEpsg bool createFromId( const long id, CrsType type = PostgisCrsId ); @@ -305,7 +305,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * It also recognizes "QGIS", "USER", "CUSTOM" authorities, which all have the same meaning * and refer to QGIS internal CRS IDs. * \note this method uses an internal cache. Call invalidateCache() to clear the cache. - * \return True on success else false + * \returns True on success else false * @see fromOgcWmsCrs() */ // TODO QGIS 3: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid()) @@ -313,7 +313,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem /** 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. - * \return True on success else false + * \returns True on success else false */ // TODO QGIS 3: remove unless really necessary - let's use EPSG codes instead bool createFromSrid( const long srid ); @@ -327,7 +327,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * \note Some members may be left blank if no match can be found in CRS database. * \note this method uses an internal cache. Call invalidateCache() to clear the cache. * \param wkt The WKT for the desired spatial reference system. - * \return True on success else false + * \returns True on success else false * @see fromWkt() */ bool createFromWkt( const QString &wkt ); @@ -338,7 +338,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * user's local CRS database from home directory is used. * \note this method uses an internal cache. Call invalidateCache() to clear the cache. * \param srsId The internal QGIS CRS ID for the desired spatial reference system. - * \return True on success else false + * \returns True on success else false * @see fromSrsId() */ bool createFromSrsId( const long srsId ); @@ -362,7 +362,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * \note Some members may be left blank if no match can be found in CRS database. * \note this method uses an internal cache. Call invalidateCache() to clear the cache. * \param projString A proj4 format string - * \return True on success else false + * \returns True on success else false * @see fromProj4() */ bool createFromProj4( const QString &projString ); @@ -378,7 +378,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * * If no prefix is specified, WKT definition is assumed. * \param definition A String containing a coordinate reference system definition. - * \return True on success else false + * \returns True on success else false */ bool createFromString( const QString &definition ); @@ -394,7 +394,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * \note this function generates a WKT string using OSRSetFromUserInput() and * passes it to createFromWkt() function. * \param definition A String containing a coordinate reference system definition. - * \return True on success else false + * \returns True on success else false */ // TODO QGIS3: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend bool createFromUserInput( const QString &definition ); @@ -428,7 +428,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * 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! - * \return long the SrsId of the matched CRS, zero if no match was found + * \returns long the SrsId of the matched CRS, zero if no match was found */ // TODO QGIS 3: seems completely obsolete now (only compares proj4 - already done in createFromProj4) long findMatchingProj(); @@ -447,14 +447,14 @@ class CORE_EXPORT QgsCoordinateReferenceSystem /** Restores state from the given DOM node. * \param node The node from which state will be restored - * \return bool True on success, False on failure + * \returns bool True on success, False on failure */ bool readXml( const QDomNode &node ); /** 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 - * \return bool True on success, False on failure + * \returns bool True on success, False on failure */ bool writeXml( QDomNode &node, QDomDocument &doc ) const; @@ -473,12 +473,12 @@ class CORE_EXPORT QgsCoordinateReferenceSystem // Accessors ----------------------------------- /** Returns the internal CRS ID, if available. - * \return the internal sqlite3 srs.db primary key for this CRS + * \returns the internal sqlite3 srs.db primary key for this CRS */ long srsid() const; /** Returns PostGIS SRID for the CRS. - * \return the PostGIS spatial_ref_sys identifier for this CRS (defaults to 0) + * \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; @@ -520,7 +520,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem QString ellipsoidAcronym() const; /** Returns a WKT representation of this CRS. - * \return string containing WKT of the CRS + * \returns string containing WKT of the CRS * @see toProj4() */ QString toWkt() const; @@ -530,7 +530,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * If proj and ellps keys are found in the parameters, * they will be stripped out and the projection and ellipsoid acronyms will be * overridden with these. - * \return Proj4 format string that defines this CRS. + * \returns Proj4 format string that defines this CRS. * \note an empty string will be returned if the CRS could not be represented by a Proj4 string * @see toWkt() */ @@ -596,7 +596,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem /** A static helper function to find out the proj4 string for a srsid * \param srsId The srsid used for the lookup - * \return QString The proj4 string + * \returns QString The proj4 string */ static QString proj4FromSrsId( const int srsId ); @@ -663,12 +663,12 @@ class CORE_EXPORT QgsCoordinateReferenceSystem * \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 - * \return An associative array of field name <-> value pairs + * \returns An associative array of field name <-> value pairs */ RecordMap getRecord( const QString &sql ); //! Open SQLite db and show message if cannot be opened - //! \return the same code as sqlite3_open + //! \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 diff --git a/src/core/qgscoordinatetransform.h b/src/core/qgscoordinatetransform.h index c2871bf219a..62d7feb4d74 100644 --- a/src/core/qgscoordinatetransform.h +++ b/src/core/qgscoordinatetransform.h @@ -116,7 +116,7 @@ class CORE_EXPORT QgsCoordinateTransform * otherwise points are transformed from destination to source CRS. * \param point point to transform * \param direction transform direction (defaults to ForwardTransform) - * \return transformed point + * \returns transformed point */ QgsPoint transform( const QgsPoint &point, TransformDirection direction = ForwardTransform ) const; @@ -126,7 +126,7 @@ class CORE_EXPORT QgsCoordinateTransform * \param x x coordinate of point to transform * \param y y coordinate of point to transform * \param direction transform direction (defaults to ForwardTransform) - * \return transformed point + * \returns transformed point */ QgsPoint transform( const double x, const double y, TransformDirection direction = ForwardTransform ) const; @@ -140,7 +140,7 @@ class CORE_EXPORT QgsCoordinateTransform * \param direction transform direction (defaults to ForwardTransform) * \param handle180Crossover set to true if destination CRS is geographic and handling of extents * crossing the 180 degree longitude line is required - * \return rectangle in destination CRS + * \returns rectangle in destination CRS */ QgsRectangle transformBoundingBox( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform, const bool handle180Crossover = false ) const; @@ -221,7 +221,7 @@ class CORE_EXPORT QgsCoordinateTransform * otherwise points are transformed from destination to source CRS. * \param rectangle rectangle to transform * \param direction transform direction (defaults to ForwardTransform) - * \return transformed rectangle + * \returns transformed rectangle */ QgsRectangle transform( const QgsRectangle &rectangle, TransformDirection direction = ForwardTransform ) const; @@ -247,7 +247,7 @@ class CORE_EXPORT QgsCoordinateTransform static QString datumTransformString( int datumTransform ); /** Gets name of source and dest geographical CRS (to show in a tooltip) - \return epsgNr epsg code of the transformation (or 0 if not in epsg db)*/ + \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 ); int sourceDatumTransform() const; @@ -260,7 +260,7 @@ class CORE_EXPORT QgsCoordinateTransform /** Restores state from the given Dom node. * \param node The node from which state will be restored - * \return bool True on success, False on failure + * \returns bool True on success, False on failure * @see writeXml() */ bool readXml( const QDomNode &node ); @@ -268,7 +268,7 @@ class CORE_EXPORT QgsCoordinateTransform /** 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 - * \return bool True on success, False on failure + * \returns bool True on success, False on failure * @see readXml() */ bool writeXml( QDomNode &node, QDomDocument &document ) const; diff --git a/src/core/qgsdataitem.h b/src/core/qgsdataitem.h index 8503b9db6d0..d8de5c36be8 100644 --- a/src/core/qgsdataitem.h +++ b/src/core/qgsdataitem.h @@ -368,7 +368,7 @@ class CORE_EXPORT QgsLayerItem : public QgsDataItem static QIcon iconRaster(); static QIcon iconDefault(); - //! \return the layer name + //! \returns the layer name virtual QString layerName() const { return name(); } }; diff --git a/src/core/qgsdataprovider.h b/src/core/qgsdataprovider.h index ac8c7cb2167..b8c96867ba2 100644 --- a/src/core/qgsdataprovider.h +++ b/src/core/qgsdataprovider.h @@ -100,7 +100,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * Get the data source specification. This may be a path or database * connection string * \param expandAuthConfig Whether to expand any assigned authentication configuration - * \return data source specification + * \returns data source specification * \note The default authentication configuration expansion is FALSE. This keeps credentials * out of layer data source URIs and project files. Expansion should be specifically done * only when needed within a provider @@ -121,7 +121,7 @@ class CORE_EXPORT QgsDataProvider : public QObject /** * Returns the extent of the layer - * \return QgsRectangle containing the extent of the layer + * \returns QgsRectangle containing the extent of the layer */ virtual QgsRectangle extent() const = 0; @@ -336,7 +336,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * a concept of stack of calls that must be handled by the provider. Only the first * call to enterUpdateMode() will really turn update mode on. * - * \return true in case of success (or no-op implementation), false in case of failure. + * \returns true in case of success (or no-op implementation), false in case of failure. * * \since QGIS 2.16 */ @@ -354,7 +354,7 @@ class CORE_EXPORT QgsDataProvider : public QObject * a concept of stack of calls that must be handled by the provider. Only the last * call to leaveUpdateMode() will really turn update mode off. * - * \return true in case of success (or no-op implementation), false in case of failure. + * \returns true in case of success (or no-op implementation), false in case of failure. * * \since QGIS 2.16 */ diff --git a/src/core/qgsdistancearea.h b/src/core/qgsdistancearea.h index fb9b6a71b97..0d7d206259c 100644 --- a/src/core/qgsdistancearea.h +++ b/src/core/qgsdistancearea.h @@ -299,7 +299,7 @@ class CORE_EXPORT QgsDistanceArea * * \note if course1 is not NULL, bearing (in radians) from first point is calculated * (the same for course2) - * \return distance in meters + * \returns distance in meters */ double computeDistanceBearing( const QgsPoint &p1, const QgsPoint &p2, double *course1 = nullptr, double *course2 = nullptr ) const; diff --git a/src/core/qgseditformconfig.h b/src/core/qgseditformconfig.h index cb06d84bbc0..0160e4e2082 100644 --- a/src/core/qgseditformconfig.h +++ b/src/core/qgseditformconfig.h @@ -165,7 +165,7 @@ class CORE_EXPORT QgsEditFormConfig * * \param widgetName The name of the widget. * - * \return The configuration for the editor widget or an empty config if the field does not exist + * \returns The configuration for the editor widget or an empty config if the field does not exist */ QVariantMap widgetConfig( const QString &widgetName ) const; @@ -174,7 +174,7 @@ class CORE_EXPORT QgsEditFormConfig * * \param widgetName The name of the widget. * - * \return true if a configuration has been removed + * \returns true if a configuration has been removed */ bool removeWidgetConfig( const QString &widgetName ); diff --git a/src/core/qgseditorwidgetsetup.h b/src/core/qgseditorwidgetsetup.h index fd4ea75f8df..4c00be808e1 100644 --- a/src/core/qgseditorwidgetsetup.h +++ b/src/core/qgseditorwidgetsetup.h @@ -39,17 +39,17 @@ class CORE_EXPORT QgsEditorWidgetSetup QgsEditorWidgetSetup() {} /** - * \return the widget type to use + * \returns the widget type to use */ QString type() const { return mType; } /** - * \return the widget configuration to used + * \returns the widget configuration to used */ QVariantMap config() const { return mConfig; } /** - * \return true if there is no widget configured. + * \returns true if there is no widget configured. */ bool isNull() const { return mType.isEmpty(); } diff --git a/src/core/qgserror.h b/src/core/qgserror.h index f1edf721331..99945575e60 100644 --- a/src/core/qgserror.h +++ b/src/core/qgserror.h @@ -103,18 +103,18 @@ class CORE_EXPORT QgsError void append( const QgsErrorMessage &message ); /** Test if any error is set. - * \return true if contains error + * \returns true if contains error */ bool isEmpty() const { return mMessageList.isEmpty(); } /** Full error messages description * \param format output format - * \return error report + * \returns error report */ QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const; /** Short error description, usually the first error in chain, the real error. - * \return error description + * \returns error description */ QString summary() const; diff --git a/src/core/qgsexpression.h b/src/core/qgsexpression.h index 68154694af8..9e92c13e2d5 100644 --- a/src/core/qgsexpression.h +++ b/src/core/qgsexpression.h @@ -568,7 +568,7 @@ class CORE_EXPORT QgsExpression /** Returns a list of possible aliases for the function. These include * other permissible names for the function, e.g., deprecated names. - * \return list of known aliases + * \returns list of known aliases * \since QGIS 2.9 */ virtual QStringList aliases() const { return QStringList(); } @@ -788,7 +788,7 @@ class CORE_EXPORT QgsExpression static int functionIndex( const QString &name ); /** Returns the number of functions defined in the parser - * \return The number of function defined in the parser. + * \returns The number of function defined in the parser. */ static int functionCount(); @@ -846,7 +846,7 @@ class CORE_EXPORT QgsExpression /** * Abstract virtual that returns the type of this node. * - * \return The type of this node + * \returns The type of this node */ virtual NodeType nodeType() const = 0; @@ -867,7 +867,7 @@ class CORE_EXPORT QgsExpression /** * Abstract virtual dump method * - * \return An expression which represents this node as string + * \returns An expression which represents this node as string */ virtual QString dump() const = 0; @@ -877,7 +877,7 @@ class CORE_EXPORT QgsExpression * generated in prepare and context related. * Ownership is transferred to the caller. * - * \return a deep copy of this node. + * \returns a deep copy of this node. */ virtual Node *clone() const = 0; @@ -889,7 +889,7 @@ class CORE_EXPORT QgsExpression * evaluate this node and in addition recursively collect all the columns required * to evaluate child nodes. * - * \return A list of columns required to evaluate this expression + * \returns A list of columns required to evaluate this expression */ virtual QSet referencedColumns() const = 0; @@ -904,7 +904,7 @@ class CORE_EXPORT QgsExpression * * This needs to call `needsGeometry()` recursively on any child nodes. * - * \return true if a geometry is required to evaluate this expression + * \returns true if a geometry is required to evaluate this expression */ virtual bool needsGeometry() const = 0; }; diff --git a/src/core/qgsfeature.h b/src/core/qgsfeature.h index fbbfdac8941..935986c3181 100644 --- a/src/core/qgsfeature.h +++ b/src/core/qgsfeature.h @@ -249,7 +249,7 @@ class CORE_EXPORT QgsFeature * 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 - * \return false, if the field index does not exist + * \returns false, if the field index does not exist * \note For Python: raises a KeyError exception instead of returning false * \note Alternatively in Python: @code feature[field] = attr @endcode * @see setAttributes @@ -364,7 +364,7 @@ class CORE_EXPORT QgsFeature * The feature will be valid if it was successful * \param name The name of the field to set * \param value The value to set - * \return false if attribute name could not be converted to index (C++ only) + * \returns false if attribute name could not be converted to index (C++ only) * \note For Python: raises a KeyError exception instead of returning false * \note Alternatively in Python: @code feature[name] = attr @endcode * @see setFields @@ -397,7 +397,7 @@ class CORE_EXPORT QgsFeature /** Removes an attribute value by field name. Field map must be associated using @link setFields @endlink * before this method can be used. * \param name The name of the field to delete - * \return false if attribute name could not be converted to index (C++ only) + * \returns false if attribute name could not be converted to index (C++ only) * \note For Python: raises a KeyError exception instead of returning false * \note Alternatively in Python: @code del feature[name] @endcode * @see setFields @@ -423,7 +423,7 @@ class CORE_EXPORT QgsFeature /** Lookup attribute value from attribute name. Field map must be associated using @link setFields @endlink * before this method can be used. * \param name The name of the attribute to get - * \return The value of the attribute (C++: Invalid variant if no such name exists ) + * \returns The value of the attribute (C++: Invalid variant if no such name exists ) * \note For Python: raises a KeyError exception if the field is not found * \note Alternatively in Python: @code feature[name] @endcode * @see setFields @@ -450,7 +450,7 @@ class CORE_EXPORT QgsFeature /** Lookup attribute value from its index. Field map must be associated using @link setFields @endlink * before this method can be used. * \param fieldIdx The index of the attribute to get - * \return The value of the attribute (C++: Invalid variant if no such index exists ) + * \returns The value of the attribute (C++: Invalid variant if no such index exists ) * \note For Python: raises a KeyError exception if the field is not found * \note Alternatively in Python: @code feature[fieldIdx] @endcode * @see setFields diff --git a/src/core/qgsfeaturefilterprovider.h b/src/core/qgsfeaturefilterprovider.h index 6aade050065..23c98977b5c 100644 --- a/src/core/qgsfeaturefilterprovider.h +++ b/src/core/qgsfeaturefilterprovider.h @@ -52,7 +52,7 @@ class CORE_EXPORT QgsFeatureFilterProvider virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0; /** Create a clone of the feature filter provider - * \return a new clone + * \returns a new clone */ virtual QgsFeatureFilterProvider *clone() const = 0; }; diff --git a/src/core/qgsfeatureiterator.h b/src/core/qgsfeatureiterator.h index 7513198551d..429abe4d3b2 100644 --- a/src/core/qgsfeatureiterator.h +++ b/src/core/qgsfeatureiterator.h @@ -84,7 +84,7 @@ class CORE_EXPORT QgsAbstractFeatureIterator * need to implement!! * * \param f The feature to write to - * \return true if a feature was written to f + * \returns true if a feature was written to f */ virtual bool fetchFeature( QgsFeature &f ) = 0; @@ -96,7 +96,7 @@ class CORE_EXPORT QgsAbstractFeatureIterator * redirect this call to fetchFeature so the default check will be omitted. * * \param f The feature to write to - * \return true if a feature was written to f + * \returns true if a feature was written to f */ virtual bool nextFeatureFilterExpression( QgsFeature &f ); @@ -109,7 +109,7 @@ class CORE_EXPORT QgsAbstractFeatureIterator * so the default check will be omitted. * * \param f The feature to write to - * \return true if a feature was written to f + * \returns true if a feature was written to f */ virtual bool nextFeatureFilterFids( QgsFeature &f ); diff --git a/src/core/qgsfeaturerequest.h b/src/core/qgsfeaturerequest.h index 6e46799ef84..9f7f56e8b7b 100644 --- a/src/core/qgsfeaturerequest.h +++ b/src/core/qgsfeaturerequest.h @@ -132,13 +132,13 @@ class CORE_EXPORT QgsFeatureRequest /** * The expression - * \return the expression + * \returns the expression */ QgsExpression expression() const; /** * Order ascending - * \return If ascending order is requested + * \returns If ascending order is requested */ bool ascending() const; @@ -149,7 +149,7 @@ class CORE_EXPORT QgsFeatureRequest /** * Set if NULLS should be returned first - * \return if NULLS should be returned first + * \returns if NULLS should be returned first */ bool nullsFirst() const; @@ -245,7 +245,7 @@ class CORE_EXPORT QgsFeatureRequest /** * Return the filter type which is currently set on this request * - * \return Filter type + * \returns Filter type */ FilterType filterType() const { return mFilter; } @@ -308,7 +308,7 @@ class CORE_EXPORT QgsFeatureRequest * Disables filter conditions. * The spatial filter (filterRect) will be kept in place. * - * \return The object the method is called on for chaining + * \returns The object the method is called on for chaining * * \since QGIS 2.12 */ @@ -375,7 +375,7 @@ class CORE_EXPORT QgsFeatureRequest /** * Return the subset of attributes which at least need to be fetched - * \return A list of attributes to be fetched + * \returns A list of attributes to be fetched */ QgsAttributeList subsetOfAttributes() const { return mAttrs; } @@ -397,7 +397,7 @@ class CORE_EXPORT QgsFeatureRequest * * \param feature The feature which will be tested * - * \return true, if the filter accepts the feature + * \returns true, if the filter accepts the feature * * \since QGIS 2.1 */ @@ -435,7 +435,7 @@ class CORE_EXPORT QgsAbstractFeatureSource /** * Get an iterator for features matching the specified request * \param request The request - * \return A feature iterator + * \returns A feature iterator */ virtual QgsFeatureIterator getFeatures( const QgsFeatureRequest &request ) = 0; diff --git a/src/core/qgsfield.h b/src/core/qgsfield.h index 7f1fcd175a4..3234803bbf7 100644 --- a/src/core/qgsfield.h +++ b/src/core/qgsfield.h @@ -121,19 +121,19 @@ class CORE_EXPORT QgsField * Gets the field type. Field types vary depending on the data source. Examples * are char, int, double, blob, geometry, etc. The type is stored exactly as * the data store reports it, with no attempt to standardize the value. - * \return QString containing the field type + * \returns QString containing the field type */ QString typeName() const; /** * Gets the length of the field. - * \return int containing the length of the field + * \returns int containing the length of the field */ int length() const; /** * Gets the precision of the field. Not all field types have a related precision. - * \return int containing the precision or zero if not applicable to the field type. + * \returns int containing the precision or zero if not applicable to the field type. */ int precision() const; @@ -244,7 +244,7 @@ class CORE_EXPORT QgsField * * \param v The value to convert * - * \return True if the conversion was successful + * \returns True if the conversion was successful */ bool convertCompatible( QVariant &v ) const; @@ -267,7 +267,7 @@ class CORE_EXPORT QgsField * Defaults may be set by the provider and can be overridden * by manual field configuration. * - * \return the value + * \returns the value */ QgsEditorWidgetSetup editorWidgetSetup() const; diff --git a/src/core/qgsfieldformatter.h b/src/core/qgsfieldformatter.h index 44b56ce190f..50a3e817acf 100644 --- a/src/core/qgsfieldformatter.h +++ b/src/core/qgsfieldformatter.h @@ -55,7 +55,7 @@ class CORE_EXPORT QgsFieldFormatter /** * Create a pretty String representation of the value. * - * \return By default the string representation of the provided value as implied by the field definition is returned. + * \returns By default the string representation of the provided value as implied by the field definition is returned. * * \since QGIS 3.0 */ diff --git a/src/core/qgsfields.h b/src/core/qgsfields.h index ddcba9d453a..8c7f48d2553 100644 --- a/src/core/qgsfields.h +++ b/src/core/qgsfields.h @@ -104,7 +104,7 @@ class CORE_EXPORT QgsFields int size() const; //! Return if a field index is valid //! \param i Index of the field which needs to be checked - //! \return True if the field exists + //! \returns True if the field exists bool exists( int i ) const; //! Get field at particular index (must be in range 0..N-1) @@ -131,7 +131,7 @@ class CORE_EXPORT QgsFields * * \param fieldName The name of the field. * - * \return The field index if found or -1 in case it cannot be found. + * \returns The field index if found or -1 in case it cannot be found. * @see lookupField For a more tolerant alternative. */ int indexFromName( const QString &fieldName ) const; @@ -143,7 +143,7 @@ class CORE_EXPORT QgsFields * * \param fieldName The name of the field. * - * \return The field index if found or -1 in case it cannot be found. + * \returns The field index if found or -1 in case it cannot be found. * @see lookupField For a more tolerant alternative. * \since QGIS 3.0 */ @@ -159,7 +159,7 @@ class CORE_EXPORT QgsFields * * \param fieldName The name to look for. * - * \return The field index if found or -1 in case it cannot be found. + * \returns The field index if found or -1 in case it cannot be found. * @see indexFromName For a more performant and precise but less tolerant alternative. * \since QGIS 2.4 */ diff --git a/src/core/qgsgml.h b/src/core/qgsgml.h index 807876ce0af..73d44ae3dea 100644 --- a/src/core/qgsgml.h +++ b/src/core/qgsgml.h @@ -185,14 +185,14 @@ class CORE_EXPORT QgsGmlStreamingParser /** Reads attribute srsName="EpsgCrsId:..." \param epsgNr result \param attr attribute strings - \return 0 in case of success + \returns 0 in case of success */ int readEpsgFromAttribute( int &epsgNr, const XML_Char **attr ); /** Reads attribute as string \param attributeName \param attr - \return attribute value or an empty string if no such attribute + \returns attribute value or an empty string if no such attribute */ QString readAttribute( const QString &attributeName, const XML_Char **attr ) const; //! Creates a rectangle from a coordinate string. @@ -201,7 +201,7 @@ class CORE_EXPORT QgsGmlStreamingParser /** 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 - \return 0 in case of success + \returns 0 in case of success */ int pointsFromCoordinateString( QList &points, const QString &coordString ) const; @@ -209,7 +209,7 @@ class CORE_EXPORT QgsGmlStreamingParser \param points list that will contain the created points \param coordString the text containing the coordinates \param dimension number of dimensions - \return 0 in case of success + \returns 0 in case of success */ int pointsFromPosListString( QList &points, const QString &coordString, int dimension ) const; @@ -348,7 +348,7 @@ class CORE_EXPORT QgsGml : public QObject * \param userName username for authentication * \param password password for authentication * \param authcfg authentication configuration id - * \return 0 in case of success + * \returns 0 in case of success * \note available in Python as getFeaturesUri */ int getFeatures( const QString &uri, diff --git a/src/core/qgsgmlschema.h b/src/core/qgsgmlschema.h index 246bf869988..7b81f2cb53f 100644 --- a/src/core/qgsgmlschema.h +++ b/src/core/qgsgmlschema.h @@ -86,7 +86,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject * 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 - * \return true in case of success */ + * \returns true in case of success */ bool guessSchema( const QByteArray &data ); //! Get list of dot separated paths to feature classes parsed from GML or XSD @@ -136,7 +136,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject //helper routines /** Reads attribute as string - \return attribute value or an empty string if no such attribute*/ + \returns attribute value or an empty string if no such attribute*/ QString readAttribute( const QString &attributeName, const XML_Char **attr ) const; //! Returns pointer to main window or 0 if it does not exist @@ -160,7 +160,7 @@ class CORE_EXPORT QgsGmlSchema : public QObject /** Find GML base type for complex type of given name * \param element input element * \param name complex type name - * \return name of GML base type without NS, e.g. AbstractFeatureType or empty string if not passed on GML type + * \returns name of GML base type without NS, e.g. AbstractFeatureType or empty string if not passed on GML type */ QString xsdComplexTypeGmlBaseType( const QDomElement &element, const QString &name ); diff --git a/src/core/qgshistogram.h b/src/core/qgshistogram.h index af450f8be64..e00270808b3 100644 --- a/src/core/qgshistogram.h +++ b/src/core/qgshistogram.h @@ -75,14 +75,14 @@ class CORE_EXPORT QgsHistogram /** 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 - * \return list of bin edges + * \returns list of bin edges * \note values must first be specified using @link setValues @endlink */ QList binEdges( int bins ) const; /** Returns the calculated list of the counts for the histogram bins. * \param bins number of histogram bins - * \return list of histogram counts + * \returns list of histogram counts * \note values must first be specified using @link setValues @endlink */ QList counts( int bins ) const; diff --git a/src/core/qgslabelsearchtree.h b/src/core/qgslabelsearchtree.h index 3ecf96ecb42..ddebe8a7c6d 100644 --- a/src/core/qgslabelsearchtree.h +++ b/src/core/qgslabelsearchtree.h @@ -58,7 +58,7 @@ class CORE_EXPORT QgsLabelSearchTree void labelsInRect( const QgsRectangle &r, QList &posList ) const; /** Inserts label position. Does not take ownership of labelPos - * \return true in case of success + * \returns true in case of success * \note not available in Python bindings */ bool insertLabel( pal::LabelPosition *labelPos, int featureId, const QString &layerName, const QString &labeltext, const QFont &labelfont, bool diagram = false, bool pinned = false, const QString &providerId = QString() ); diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h index 0e8b6b9b563..0353b569ce0 100644 --- a/src/core/qgsmaplayer.h +++ b/src/core/qgsmaplayer.h @@ -96,68 +96,68 @@ class CORE_EXPORT QgsMapLayer : public QObject void setName( const QString &name ); /** Returns the display name of the layer. - * \return the layer name + * \returns the layer name * @see setName() */ QString name() const; /** Returns the original name of the layer. - * \return the original layer name + * \returns the original layer name */ QString originalName() const { return mLayerOrigName; } /** Sets the short name of the layer * used by QGIS Server to identify the layer. - * \return the layer short name + * \returns the layer short name * @see shortName() */ void setShortName( const QString &shortName ) { mShortName = shortName; } /** Returns the short name of the layer * used by QGIS Server to identify the layer. - * \return the layer short name + * \returns the layer short name * @see setShortName() */ QString shortName() const { return mShortName; } /** Sets the title of the layer * used by QGIS Server in GetCapabilities request. - * \return the layer title + * \returns the layer title * @see title() */ void setTitle( const QString &title ) { mTitle = title; } /** Returns the title of the layer * used by QGIS Server in GetCapabilities request. - * \return the layer title + * \returns the layer title * @see setTitle() */ QString title() const { return mTitle; } /** Sets the abstract of the layer * used by QGIS Server in GetCapabilities request. - * \return the layer abstract + * \returns the layer abstract * @see abstract() */ void setAbstract( const QString &abstract ) { mAbstract = abstract; } /** Returns the abstract of the layer * used by QGIS Server in GetCapabilities request. - * \return the layer abstract + * \returns the layer abstract * @see setAbstract() */ QString abstract() const { return mAbstract; } /** Sets the keyword list of the layer * used by QGIS Server in GetCapabilities request. - * \return the layer keyword list + * \returns the layer keyword list * @see keywordList() */ void setKeywordList( const QString &keywords ) { mKeywordList = keywords; } /** Returns the keyword list of the layer * used by QGIS Server in GetCapabilities request. - * \return the layer keyword list + * \returns the layer keyword list * @see setKeywordList() */ QString keywordList() const { return mKeywordList; } @@ -167,7 +167,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return the layer DataUrl + * \returns the layer DataUrl * @see dataUrl() */ void setDataUrl( const QString &dataUrl ) { mDataUrl = dataUrl; } @@ -175,7 +175,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return the layer DataUrl + * \returns the layer DataUrl * @see setDataUrl() */ QString dataUrl() const { return mDataUrl; } @@ -183,7 +183,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return the layer DataUrl format + * \returns the layer DataUrl format * @see dataUrlFormat() */ void setDataUrlFormat( const QString &dataUrlFormat ) { mDataUrlFormat = dataUrlFormat; } @@ -191,7 +191,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return the layer DataUrl format + * \returns the layer DataUrl format * @see setDataUrlFormat() */ QString dataUrlFormat() const { return mDataUrlFormat; } @@ -201,7 +201,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Sets the attribution of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. - * \return the layer attribution + * \returns the layer attribution * @see attribution() */ void setAttribution( const QString &attrib ) { mAttribution = attrib; } @@ -209,7 +209,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Returns the attribution of the layer * used by QGIS Server in GetCapabilities request. * Attribution indicates the provider of a layer or collection of layers. - * \return the layer attribution + * \returns the layer attribution * @see setAttribution() */ QString attribution() const { return mAttribution; } @@ -217,7 +217,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return the layer attribution URL + * \returns the layer attribution URL * @see attributionUrl() */ void setAttributionUrl( const QString &attribUrl ) { mAttributionUrl = attribUrl; } @@ -225,7 +225,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return the layer attribution URL + * \returns the layer attribution URL * @see setAttributionUrl() */ QString attributionUrl() const { return mAttributionUrl; } @@ -235,7 +235,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return the layer metadata URL + * \returns the layer metadata URL * @see metadataUrl() */ void setMetadataUrl( const QString &metaUrl ) { mMetadataUrl = metaUrl; } @@ -243,7 +243,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return the layer metadata URL + * \returns the layer metadata URL * @see setMetadataUrl() */ QString metadataUrl() const { return mMetadataUrl; } @@ -251,7 +251,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Set the metadata type of the layer * used by QGIS Server in GetCapabilities request * MetadataUrlType indicates the standard to which the metadata complies. - * \return the layer metadata type + * \returns the layer metadata type * @see metadataUrlType() */ void setMetadataUrlType( const QString &metaUrlType ) { mMetadataUrlType = metaUrlType; } @@ -259,7 +259,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Returns the metadata type of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates the standard to which the metadata complies. - * \return the layer metadata type + * \returns the layer metadata type * @see setMetadataUrlType() */ QString metadataUrlType() const { return mMetadataUrlType; } @@ -267,7 +267,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Sets the metadata format of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates how the metadata is structured. - * \return the layer metadata format + * \returns the layer metadata format * @see metadataUrlFormat() */ void setMetadataUrlFormat( const QString &metaUrlFormat ) { mMetadataUrlFormat = metaUrlFormat; } @@ -275,7 +275,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Returns the metadata format of the layer * used by QGIS Server in GetCapabilities request. * MetadataUrlType indicates how the metadata is structured. - * \return the layer metadata format + * \returns the layer metadata format * @see setMetadataUrlFormat() */ QString metadataUrlFormat() const { return mMetadataUrlFormat; } @@ -308,7 +308,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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. - * \return true if the layer is valid and can be accessed + * \returns true if the layer is valid and can be accessed */ bool isValid() const; @@ -422,7 +422,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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) - * \return a QString with the style file name + * \returns a QString with the style file name * @see also loadNamedStyle () and saveNamedStyle (); */ virtual QString styleURI() const; @@ -432,7 +432,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * 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 * we did not manage to load the default style. - * \return a QString with any status messages + * \returns a QString with any status messages * @see also loadNamedStyle (); */ virtual QString loadDefaultStyle( bool &resultFlag ); @@ -447,7 +447,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * key matches the URI. * \param resultFlag a reference to a flag that will be set to false if * we did not manage to load the default style. - * \return a QString with any status messages + * \returns a QString with any status messages * @see also loadDefaultStyle (); */ virtual QString loadNamedStyle( const QString &uri, bool &resultFlag ); @@ -465,7 +465,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * \param doc source QDomDocument * \param errorMsg this QString will be initialized on error * during the execution of readSymbology - * \return true on success + * \returns true on success * \since QGIS 2.8 */ virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg ); @@ -492,7 +492,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * 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 * we did not manage to save the default style. - * \return a QString with any status messages + * \returns a QString with any status messages * @sa loadNamedStyle() and @see saveNamedStyle() */ virtual QString saveDefaultStyle( bool &resultFlag ); @@ -507,7 +507,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * key matches the URI. * \param resultFlag a reference to a flag that will be set to false if * we did not manage to save the default style. - * \return a QString with any status messages + * \returns a QString with any status messages * @sa saveDefaultStyle() */ virtual QString saveNamedStyle( const QString &uri, bool &resultFlag ); @@ -538,14 +538,14 @@ class CORE_EXPORT QgsMapLayer : public QObject /** 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 - * \return true in case of success. + * \returns true in case of success. */ virtual bool readSymbology( const QDomNode &node, QString &errorMessage ) = 0; /** 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 - * \return true in case of success. + * \returns true in case of success. * \since QGIS 2.16 * \note To be implemented in subclasses. Default implementation does nothing and returns false. */ @@ -555,7 +555,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * \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 - * \return true in case of success. + * \returns true in case of success. */ virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const = 0; @@ -563,7 +563,7 @@ class CORE_EXPORT QgsMapLayer : public QObject * \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 - * \return true in case of success. + * \returns true in case of success. * \since QGIS 2.16 * \note To be implemented in subclasses. Default implementation does nothing and returns false. */ diff --git a/src/core/qgsmaplayerstylemanager.h b/src/core/qgsmaplayerstylemanager.h index 931dd93bb15..b86babfcd4a 100644 --- a/src/core/qgsmaplayerstylemanager.h +++ b/src/core/qgsmaplayerstylemanager.h @@ -114,22 +114,22 @@ class CORE_EXPORT QgsMapLayerStyleManager : public QObject QgsMapLayerStyle style( const QString &name ) const; //! Add a style with given name and data - //! \return true on success (name is unique and style is valid) + //! \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 - //! \return true on success + //! \returns true on success bool addStyleFromLayer( const QString &name ); //! Remove a stored style - //! \return true on success (style exists and it is not the last one) + //! \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 - //! \return true on success (style exists and new name is unique) + //! \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 - //! \return true on success + //! \returns true on success bool setCurrentStyle( const QString &name ); //! Temporarily apply a different style to the layer. The argument diff --git a/src/core/qgsmaprenderercache.h b/src/core/qgsmaprenderercache.h index 569294e7fd8..79ebc0a7e08 100644 --- a/src/core/qgsmaprenderercache.h +++ b/src/core/qgsmaprenderercache.h @@ -54,7 +54,7 @@ class CORE_EXPORT QgsMapRendererCache : public QObject /** * Initialize cache: set new parameters and clears the cache if any * parameters have changed since last initialization. - * \return flag whether the parameters are the same as last time + * \returns flag whether the parameters are the same as last time */ bool init( const QgsRectangle &extent, double scale ); diff --git a/src/core/qgsmaprendererjob.h b/src/core/qgsmaprendererjob.h index 469ebce4e41..bfc4b4ac4ef 100644 --- a/src/core/qgsmaprendererjob.h +++ b/src/core/qgsmaprendererjob.h @@ -194,7 +194,7 @@ class CORE_EXPORT QgsMapRendererJob : public QObject /** * Return map settings with which this job was started. - * \return A QgsMapSettings instance with render settings + * \returns A QgsMapSettings instance with render settings * \since QGIS 2.8 */ const QgsMapSettings &mapSettings() const; diff --git a/src/core/qgsmapsettings.h b/src/core/qgsmapsettings.h index d931ffbcf0c..f93414bf5c3 100644 --- a/src/core/qgsmapsettings.h +++ b/src/core/qgsmapsettings.h @@ -226,47 +226,47 @@ class CORE_EXPORT QgsMapSettings /** * @brief transform bounding box from layer's CRS to output CRS * @see layerToMapCoordinates( QgsMapLayer* layer, QgsRectangle rect ) if you want to transform a rectangle - * \return a bounding box (aligned rectangle) containing the transformed extent + * \returns a bounding box (aligned rectangle) containing the transformed extent */ QgsRectangle layerExtentToOutputExtent( const QgsMapLayer *layer, QgsRectangle extent ) const; /** * @brief transform bounding box from output CRS to layer's CRS * @see mapToLayerCoordinates( QgsMapLayer* layer,QgsRectangle rect ) if you want to transform a rectangle - * \return a bounding box (aligned rectangle) containing the transformed extent + * \returns a bounding box (aligned rectangle) containing the transformed extent */ QgsRectangle outputExtentToLayerExtent( const QgsMapLayer *layer, QgsRectangle extent ) const; /** * @brief transform point coordinates from layer's CRS to output CRS - * \return the transformed point + * \returns the transformed point */ QgsPoint layerToMapCoordinates( const QgsMapLayer *layer, QgsPoint point ) const; /** * @brief transform rectangle from layer's CRS to output CRS * @see layerExtentToOutputExtent() if you want to transform a bounding box - * \return the transformed rectangle + * \returns the transformed rectangle */ QgsRectangle layerToMapCoordinates( const QgsMapLayer *layer, QgsRectangle rect ) const; /** * @brief transform point coordinates from output CRS to layer's CRS - * \return the transformed point + * \returns the transformed point */ QgsPoint mapToLayerCoordinates( const QgsMapLayer *layer, QgsPoint point ) const; /** * @brief transform rectangle from output CRS to layer's CRS * @see outputExtentToLayerExtent() if you want to transform a bounding box - * \return the transformed rectangle + * \returns the transformed rectangle */ QgsRectangle mapToLayerCoordinates( const QgsMapLayer *layer, QgsRectangle rect ) const; /** * @brief Return coordinate transform from layer's CRS to destination CRS * \param layer - * \return transform - may be invalid if the transform is not needed + * \returns transform - may be invalid if the transform is not needed */ QgsCoordinateTransform layerTransform( const QgsMapLayer *layer ) const; diff --git a/src/core/qgsmaptopixel.h b/src/core/qgsmaptopixel.h index d44462540e1..94bdf0b7688 100644 --- a/src/core/qgsmaptopixel.h +++ b/src/core/qgsmaptopixel.h @@ -72,7 +72,7 @@ class CORE_EXPORT QgsMapToPixel /** * Transform the point from map (world) coordinates to device coordinates * \param p Point to transform - * \return QgsPoint in device coordinates + * \returns QgsPoint in device coordinates */ QgsPoint transform( const QgsPoint &p ) const; @@ -83,7 +83,7 @@ class CORE_EXPORT QgsMapToPixel * coordinates to device coordinates * \param x x cordinate o point to transform * \param y y coordinate of point to transform - * \return QgsPoint in device coordinates + * \returns QgsPoint in device coordinates */ QgsPoint transform( qreal x, qreal y ) const; @@ -119,7 +119,7 @@ class CORE_EXPORT QgsMapToPixel /** * Transform device coordinates to map (world) coordinates * \param p Point to be converted to map cooordinates - * \return QgsPoint in map coorndiates + * \returns QgsPoint in map coorndiates */ QgsPoint toMapCoordinates( QPoint p ) const; diff --git a/src/core/qgsmultirenderchecker.h b/src/core/qgsmultirenderchecker.h index 28cb1ba322d..b57a6c527c8 100644 --- a/src/core/qgsmultirenderchecker.h +++ b/src/core/qgsmultirenderchecker.h @@ -107,13 +107,13 @@ class CORE_EXPORT QgsMultiRenderChecker /** * Returns a report for this test * - * \return A report + * \returns A report */ QString report() const { return mReport; } /** * @brief controlImagePath - * \return + * \returns */ QString controlImagePath() const; diff --git a/src/core/qgsnetworkreplyparser.h b/src/core/qgsnetworkreplyparser.h index 8446e1938d0..3eefca663f7 100644 --- a/src/core/qgsnetworkreplyparser.h +++ b/src/core/qgsnetworkreplyparser.h @@ -45,17 +45,17 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject QgsNetworkReplyParser( QNetworkReply *reply ); /** Indicates if successfully parsed - * \return true if successfully parsed */ + * \returns true if successfully parsed */ bool isValid() const { return mValid; } /** Get number of parts - * \return number of parts */ + * \returns number of parts */ int parts() const { return mHeaders.size(); } /** Get part header * \param part part index * \param headerName header name - * \return raw header */ + * \returns raw header */ QByteArray rawHeader( int part, const QByteArray &headerName ) const { return mHeaders.value( part ).value( headerName ); } //! Get headers @@ -63,7 +63,7 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject /** Get part part body * \param part part index - * \return part body */ + * \returns part body */ QByteArray body( int part ) const { return mBodies.value( part ); } //! Get bodies @@ -73,7 +73,7 @@ class CORE_EXPORT QgsNetworkReplyParser : public QObject QString error() const { return mError; } /** Test if reply is multipart. - * \return true if reply is multipart */ + * \returns true if reply is multipart */ static bool isMultipart( QNetworkReply *reply ); private: diff --git a/src/core/qgsogcutils.h b/src/core/qgsogcutils.h index dc2aab6cbeb..a6b765fbfcc 100644 --- a/src/core/qgsogcutils.h +++ b/src/core/qgsogcutils.h @@ -73,7 +73,7 @@ class CORE_EXPORT QgsOgcUtils static QgsRectangle rectangleFromGMLEnvelope( const QDomNode &envelopeNode ); /** Exports the geometry to GML - \return QDomElement + \returns QDomElement \since QGIS 2.16 */ static QDomElement geometryToGML( const QgsGeometry *geometry, QDomDocument &doc, @@ -84,22 +84,22 @@ class CORE_EXPORT QgsOgcUtils int precision = 17 ); /** Exports the geometry to GML2 or GML3 - \return QDomElement + \returns QDomElement */ static QDomElement geometryToGML( const QgsGeometry *geometry, QDomDocument &doc, const QString &format, int precision = 17 ); /** Exports the geometry to GML2 - \return QDomElement + \returns QDomElement */ static QDomElement geometryToGML( const QgsGeometry *geometry, QDomDocument &doc, int precision = 17 ); /** Exports the rectangle to GML2 Box - \return QDomElement + \returns QDomElement */ static QDomElement rectangleToGMLBox( QgsRectangle *box, QDomDocument &doc, int precision = 17 ); /** Exports the rectangle to GML2 Box - \return QDomElement + \returns QDomElement \since QGIS 2.16 */ static QDomElement rectangleToGMLBox( QgsRectangle *box, QDomDocument &doc, @@ -108,12 +108,12 @@ class CORE_EXPORT QgsOgcUtils int precision = 17 ); /** Exports the rectangle to GML3 Envelope - \return QDomElement + \returns QDomElement */ static QDomElement rectangleToGMLEnvelope( QgsRectangle *env, QDomDocument &doc, int precision = 17 ); /** Exports the rectangle to GML3 Envelope - \return QDomElement + \returns QDomElement \since QGIS 2.16 */ static QDomElement rectangleToGMLEnvelope( QgsRectangle *env, QDomDocument &doc, @@ -130,7 +130,7 @@ class CORE_EXPORT QgsOgcUtils /** Creates OGC filter XML element. Supports minimum standard filter * according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT) - * \return valid \verbatim \endverbatim QDomElement on success, + * \returns valid \verbatim \endverbatim QDomElement on success, * otherwise null QDomElement */ static QDomElement expressionToOgcFilter( const QgsExpression &exp, QDomDocument &doc, QString *errorMessage = nullptr ); @@ -147,7 +147,7 @@ class CORE_EXPORT QgsOgcUtils /** Creates OGC filter XML element. Supports minimum standard filter * according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT) - * \return valid \verbatim \endverbatim QDomElement on success, + * \returns valid \verbatim \endverbatim QDomElement on success, * otherwise null QDomElement * \since QGIS 2.16 * \note not available in Python bindings @@ -163,13 +163,13 @@ class CORE_EXPORT QgsOgcUtils QString *errorMessage = nullptr ); /** Creates an OGC expression XML element. - * \return valid OGC expression QDomElement on success, + * \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. - * \return valid OGC expression QDomElement on success, + * \returns valid OGC expression QDomElement on success, * otherwise null QDomElement */ static QDomElement expressionToOgcExpression( const QgsExpression &exp, @@ -213,7 +213,7 @@ class CORE_EXPORT QgsOgcUtils * ST_Disjoint(), ST_Overlaps(), ST_Touches(), ST_Within() * ST_DWithin(), ST_Beyond() * custom functions - * \return valid \verbatim \endverbatim QDomElement on success, + * \returns valid \verbatim \endverbatim QDomElement on success, * otherwise null QDomElement * \since QGIS 2.16 * \note not available in Python bindings @@ -246,7 +246,7 @@ class CORE_EXPORT QgsOgcUtils /** 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 - \return boolean for success*/ + \returns boolean for success*/ static bool readGMLCoordinates( QgsPolyline &coords, const QDomElement &elem ); /** Reads the \verbatim \endverbatim or \verbatim \endverbatim @@ -254,20 +254,20 @@ class CORE_EXPORT QgsOgcUtils \param coords list where the found coordinates are appended \param elem the \verbatim \endverbatim or \verbatim \endverbatim element - \return boolean for success*/ + \returns boolean for success*/ static bool readGMLPositions( QgsPolyline &coords, const QDomElement &elem ); /** Create a GML coordinates element from a point list. \param points list of data points \param doc the GML document - \return QDomElement */ + \returns QDomElement */ static QDomElement createGMLCoordinates( const QgsPolyline &points, QDomDocument &doc ); /** Create a GML pos or posList element from a point list. \param points list of data points \param doc the GML document - \return QDomElement */ + \returns QDomElement */ static QDomElement createGMLPositions( const QgsPolyline &points, QDomDocument &doc ); //! handle a generic sub-expression diff --git a/src/core/qgsogrutils.h b/src/core/qgsogrutils.h index 3d6577060c3..59c86559cb9 100644 --- a/src/core/qgsogrutils.h +++ b/src/core/qgsogrutils.h @@ -39,7 +39,7 @@ class CORE_EXPORT QgsOgrUtils * \param ogrFet OGR feature handle * \param fields fields collection corresponding to feature * \param encoding text encoding - * \return valid feature if read was successful + * \returns valid feature if read was successful */ static QgsFeature readOgrFeature( OGRFeatureH ogrFet, const QgsFields &fields, QTextCodec *encoding ); diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h index 9f258399a34..9d5e0b28716 100644 --- a/src/core/qgspallabeling.h +++ b/src/core/qgspallabeling.h @@ -628,7 +628,7 @@ class CORE_EXPORT QgsPalLayerSettings void parseDropShadow( QgsRenderContext &context ); /** Checks if a feature is larger than a minimum size (in mm) - \return true if above size, false if below*/ + \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) diff --git a/src/core/qgspoint.h b/src/core/qgspoint.h index fd5b0120fef..73cf5142148 100644 --- a/src/core/qgspoint.h +++ b/src/core/qgspoint.h @@ -113,7 +113,7 @@ class CORE_EXPORT QgsPoint } /** Get the x value of the point - * \return x coordinate + * \returns x coordinate */ double x() const { @@ -121,7 +121,7 @@ class CORE_EXPORT QgsPoint } /** Get the y value of the point - * \return y coordinate + * \returns y coordinate */ double y() const { @@ -165,7 +165,7 @@ class CORE_EXPORT QgsPoint /** Return the well known text representation for the point. * The wkt is created without an SRID. - * \return Well known text in the form POINT(x y) + * \returns Well known text in the form POINT(x y) */ QString wellKnownText() const; @@ -226,7 +226,7 @@ class CORE_EXPORT QgsPoint void multiply( double scalar ); //! Test if this point is on the segment defined by points a, b - //! \return 0 if this point is not on the open ray through a and b, + //! \returns 0 if this point is not on the open ray through a and b, //! 1 if point is on open ray a, 2 if point is within line segment, //! 3 if point is on open ray b. int onSegment( const QgsPoint &a, const QgsPoint &b ) const; diff --git a/src/core/qgsproject.h b/src/core/qgsproject.h index 192cbb1d883..e480102bce9 100644 --- a/src/core/qgsproject.h +++ b/src/core/qgsproject.h @@ -327,7 +327,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera QString layerIsEmbedded( const QString &id ) const; /** Creates a maplayer instance defined in an arbitrary project file. Caller takes ownership - * \return the layer or 0 in case of error + * \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, @@ -374,7 +374,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera void setAreaUnits( QgsUnitTypes::AreaUnit unit ); /** Return project's home path - \return home path of project (or QString::null if not set) */ + \returns home path of project (or QString::null if not set) */ QString homePath() const; QgsRelationManager *relationManager() const; @@ -582,7 +582,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * If you specify false here you have take care of deleting * the layers yourself. Not available in Python. * - * \return a list of the map layers that were added + * \returns a list of the map layers that were added * successfully. If a layer is invalid, or already exists in the registry, * it will not be part of the returned QList. * @@ -613,7 +613,7 @@ class CORE_EXPORT QgsProject : public QObject, public QgsExpressionContextGenera * If you specify false here you have take care of deleting * the layer yourself. Not available in Python. * - * \return nullptr if unable to add layer, otherwise pointer to newly added layer + * \returns nullptr if unable to add layer, otherwise pointer to newly added layer * * @see addMapLayers * diff --git a/src/core/qgsprojectproperty.h b/src/core/qgsprojectproperty.h index fd1c623ccc6..7648dce9876 100644 --- a/src/core/qgsprojectproperty.h +++ b/src/core/qgsprojectproperty.h @@ -235,7 +235,7 @@ class CORE_EXPORT QgsProjectPropertyKey : public QgsProjectProperty * Sets the value associated with this key. * \param name is the key name * \param value is the value to set - * \return pointer to property value + * \returns pointer to property value */ QgsProjectPropertyValue *setValue( const QString &name, const QVariant &value ) { diff --git a/src/core/qgsproviderregistry.h b/src/core/qgsproviderregistry.h index cd777212183..94efba0f78d 100644 --- a/src/core/qgsproviderregistry.h +++ b/src/core/qgsproviderregistry.h @@ -70,7 +70,7 @@ class CORE_EXPORT QgsProviderRegistry /** Create an instance of the provider \param providerKey identificator of the provider \param dataSource string containing data source for the provider - \return instance of provider or NULL on error + \returns instance of provider or NULL on error */ QgsDataProvider *provider( const QString &providerKey, const QString &dataSource ); @@ -89,7 +89,7 @@ class CORE_EXPORT QgsProviderRegistry /** Get pointer to provider function \param providerKey identificator of the provider \param functionName name of function - \return pointer to function or NULL on error + \returns pointer to function or NULL on error */ QFunctionPointer function( const QString &providerKey, const QString &functionName ); @@ -153,7 +153,7 @@ class CORE_EXPORT QgsProviderRegistry * * \param name could be a file, URI * \param provider is the key for the dataprovider used to open name - * \return NULL if unable to open vector data source + * \returns NULL if unable to open vector data source * * Temporarily always returns false until finished implementing. * diff --git a/src/core/qgsrectangle.h b/src/core/qgsrectangle.h index e276ee7a210..4a038de6ea6 100644 --- a/src/core/qgsrectangle.h +++ b/src/core/qgsrectangle.h @@ -126,12 +126,12 @@ class CORE_EXPORT QgsRectangle QString asPolygon() const; /** Comparison operator - * \return True if rectangles are equal + * \returns True if rectangles are equal */ bool operator==( const QgsRectangle &r1 ) const; /** Comparison operator - * \return False if rectangles are equal + * \returns False if rectangles are equal */ bool operator!=( const QgsRectangle &r1 ) const; diff --git a/src/core/qgsrelation.h b/src/core/qgsrelation.h index 7c924cf2e40..8c4d7749f52 100644 --- a/src/core/qgsrelation.h +++ b/src/core/qgsrelation.h @@ -82,7 +82,7 @@ class CORE_EXPORT QgsRelation * * \param node The dom node containing the relation information * - * \return A relation + * \returns A relation */ static QgsRelation createFromXml( const QDomNode &node ); @@ -140,7 +140,7 @@ class CORE_EXPORT QgsRelation * * \param feature A feature from the referenced (parent) layer * - * \return An iterator with all the referenced features + * \returns An iterator with all the referenced features * @see getRelatedFeaturesRequest() * @see getRelatedFeaturesFilter() */ @@ -152,7 +152,7 @@ class CORE_EXPORT QgsRelation * * \param feature A feature from the referenced (parent) layer * - * \return A request for all the referencing features + * \returns A request for all the referencing features * @see getRelatedFeatures() * @see getRelatedFeaturesFilter() */ @@ -161,7 +161,7 @@ class CORE_EXPORT QgsRelation /** 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 - * \return expression filter string for all the referencing features + * \returns expression filter string for all the referencing features * \since QGIS 2.16 * @see getRelatedFeatures() * @see getRelatedFeaturesRequest() @@ -174,7 +174,7 @@ class CORE_EXPORT QgsRelation * * \param attributes An attribute vector containing the foreign key * - * \return A request the referenced feature + * \returns A request the referenced feature * \note not available in Python bindings */ QgsFeatureRequest getReferencedFeatureRequest( const QgsAttributes &attributes ) const; @@ -185,7 +185,7 @@ class CORE_EXPORT QgsRelation * * \param feature A feature from the referencing (child) layer * - * \return A request the referenced feature + * \returns A request the referenced feature */ QgsFeatureRequest getReferencedFeatureRequest( const QgsFeature &feature ) const; @@ -195,7 +195,7 @@ class CORE_EXPORT QgsRelation * * \param feature A feature from the referencing (child) layer * - * \return A request the referenced feature + * \returns A request the referenced feature */ QgsFeature getReferencedFeature( const QgsFeature &feature ) const; @@ -204,14 +204,14 @@ class CORE_EXPORT QgsRelation * * @see id() * - * \return A name + * \returns A name */ QString name() const; /** * A (project-wide) unique id for this relation * - * \return The id + * \returns The id */ QString id() const; @@ -225,7 +225,7 @@ class CORE_EXPORT QgsRelation * Access the referencing (child) layer's id * This is the layer which has the field(s) which point to another layer * - * \return The id of the referencing layer + * \returns The id of the referencing layer */ QString referencingLayerId() const; @@ -233,21 +233,21 @@ class CORE_EXPORT QgsRelation * Access the referencing (child) layer * This is the layer which has the field(s) which point to another layer * - * \return The referencing layer + * \returns The referencing layer */ QgsVectorLayer *referencingLayer() const; /** * Access the referenced (parent) layer's id * - * \return The id of the referenced layer + * \returns The id of the referenced layer */ QString referencedLayerId() const; /** * Access the referenced (parent) layer * - * \return referenced layer + * \returns referenced layer */ QgsVectorLayer *referencedLayer() const; @@ -256,7 +256,7 @@ class CORE_EXPORT QgsRelation * The first element of each pair are the field names of the foreign key. * The second element of each pair are the field names of the matching primary key. * - * \return The fields forming the relation + * \returns The fields forming the relation */ QList< FieldPair > fieldPairs() const; @@ -264,7 +264,7 @@ class CORE_EXPORT QgsRelation * Returns a list of attributes used to form the referenced fields * (most likely primary key) on the referenced (parent) layer. * - * \return A list of attributes + * \returns A list of attributes */ QgsAttributeList referencedFields() const; @@ -272,14 +272,14 @@ class CORE_EXPORT QgsRelation * Returns a list of attributes used to form the referencing fields * (foreign key) on the referencing (child) layer. * - * \return A list of attributes + * \returns A list of attributes */ QgsAttributeList referencingFields() const; /** * Returns the validity of this relation. Don't use the information if it's not valid. * - * \return true if the relation is valid + * \returns true if the relation is valid */ bool isValid() const; @@ -287,7 +287,7 @@ class CORE_EXPORT QgsRelation * Compares the two QgsRelation, ignoring the name and the ID. * * \param other The other relation - * \return true if they are similar + * \returns true if they are similar * \since QGIS 3.0 */ bool hasEqualDefinition( const QgsRelation &other ) const; diff --git a/src/core/qgsrelationmanager.h b/src/core/qgsrelationmanager.h index 7799647024e..4827a451464 100644 --- a/src/core/qgsrelationmanager.h +++ b/src/core/qgsrelationmanager.h @@ -51,7 +51,7 @@ class CORE_EXPORT QgsRelationManager : public QObject /** * Get access to the relations managed by this class. * - * \return A QMap where the key is the relation id, the value the relation object. + * \returns A QMap where the key is the relation id, the value the relation object. */ QMap relations() const; @@ -81,7 +81,7 @@ class CORE_EXPORT QgsRelationManager : public QObject * * \param id The id to search for * - * \return A relation. Invalid if not found. + * \returns A relation. Invalid if not found. * @see relationsByName() */ Q_INVOKABLE QgsRelation relation( const QString &id ) const; @@ -105,7 +105,7 @@ class CORE_EXPORT QgsRelationManager : public QObject * \param layer The layer which should be searched for. * \param fieldIdx The field which should be part of the foreign key. If not set will return all relations. * - * \return A list of relations matching the given layer and fieldIdx. + * \returns A list of relations matching the given layer and fieldIdx. */ QList referencingRelations( const QgsVectorLayer *layer = nullptr, int fieldIdx = -2 ) const; @@ -114,7 +114,7 @@ class CORE_EXPORT QgsRelationManager : public QObject * * \param layer The layer which should be searched for. * - * \return A list of relations where the specified layer is the referenced part. + * \returns A list of relations where the specified layer is the referenced part. */ QList referencedRelations( QgsVectorLayer *layer = nullptr ) const; @@ -123,7 +123,7 @@ class CORE_EXPORT QgsRelationManager : public QObject * * \param existingRelations the existing relations to filter them out * \param layers the current layers - * \return the list of discovered relations + * \returns the list of discovered relations * \since QGIS 3.0 */ static QList discoverRelations( const QList &existingRelations, const QList &layers ); diff --git a/src/core/qgsrenderchecker.h b/src/core/qgsrenderchecker.h index 27d3f6ed6f9..86efd467a87 100644 --- a/src/core/qgsrenderchecker.h +++ b/src/core/qgsrenderchecker.h @@ -77,7 +77,7 @@ class CORE_EXPORT QgsRenderChecker * The path of the rendered image can be retrieved through that method. * Will return the path set with setRenderedImage() or generated in runTest() * - * \return The path to the rendered image + * \returns The path to the rendered image */ QString renderedImage() { return mRenderedImageFile; } @@ -129,7 +129,7 @@ class CORE_EXPORT QgsRenderChecker * mismatch), but where the output was still acceptable. If the render * diff matches one of these anomalies we will still consider it to be * acceptable. - * \return a bool indicating if the diff matched one of the anomaly files + * \returns a bool indicating if the diff matched one of the anomaly files */ bool isKnownAnomaly( const QString &diffImageFile ); @@ -141,7 +141,7 @@ class CORE_EXPORT QgsRenderChecker /** * Returns the path to the expected image file * - * \return Path to the expected image file + * \returns Path to the expected image file */ QString expectedImageFile() const { return mExpectedImageFile; } @@ -158,7 +158,7 @@ class CORE_EXPORT QgsRenderChecker * Get access to buffered dash messages. * Only will return something if you call enableDashBuffering( true ); before. * - * \return buffered dash messages + * \returns buffered dash messages * \note not available in Python bindings */ QVector dartMeasurements() const { return mDashMessages; } @@ -192,7 +192,7 @@ class CORE_EXPORT QgsRenderChecker * \param a first WKT string * \param b second WKT string * \param tolerance tolerance to use (optional, defaults to 0.000001) - * \return bool indicating if the WKT are sufficiently equal + * \returns bool indicating if the WKT are sufficiently equal */ inline bool compareWkt( const QString &a, const QString &b, double tolerance = 0.000001 ) diff --git a/src/core/qgsrendercontext.h b/src/core/qgsrendercontext.h index 92d19d149cb..0872331a963 100644 --- a/src/core/qgsrendercontext.h +++ b/src/core/qgsrendercontext.h @@ -254,7 +254,7 @@ class CORE_EXPORT QgsRenderContext void setFeatureFilterProvider( const QgsFeatureFilterProvider *ffp ); /** Get the filter feature provider used for additional filtering of rendered features. - * \return the filter feature provider + * \returns the filter feature provider * \since QGIS 2.14 * @see setFeatureFilterProvider() */ diff --git a/src/core/qgsrulebasedlabeling.h b/src/core/qgsrulebasedlabeling.h index 9f9ac6732e8..ca561f313d6 100644 --- a/src/core/qgsrulebasedlabeling.h +++ b/src/core/qgsrulebasedlabeling.h @@ -79,7 +79,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** * Determines if scale based labeling is active * - * \return True if scale based labeling is active + * \returns True if scale based labeling is active */ bool dependsOnScale() const { return mScaleMinDenom != 0 || mScaleMaxDenom != 0; } @@ -89,7 +89,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling * E.g. Denominator 1000 is a scale of 1:1000, where a rule with minimum denominator * of 900 will not be applied while a rule with 2000 will be applied. * - * \return The minimum scale denominator + * \returns The minimum scale denominator */ int scaleMinDenom() const { return mScaleMinDenom; } @@ -99,34 +99,34 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling * E.g. Denominator 1000 is a scale of 1:1000, where a rule with maximum denominator * of 900 will be applied while a rule with 2000 will not be applied. * - * \return The maximum scale denominator + * \returns The maximum scale denominator */ int scaleMaxDenom() const { return mScaleMaxDenom; } /** * A filter that will check if this rule applies - * \return An expression + * \returns An expression */ QString filterExpression() const { return mFilterExp; } /** * A human readable description for this rule * - * \return Description + * \returns Description */ QString description() const { return mDescription; } /** * Returns if this rule is active * - * \return True if the rule is active + * \returns True if the rule is active */ bool active() const { return mIsActive; } /** * Check if this rule is an ELSE rule * - * \return True if this rule is an else rule + * \returns True if this rule is an else rule */ bool isElse() const { return mElseRule; } @@ -187,35 +187,35 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** * Return all children rules of this rule * - * \return A list of rules + * \returns A list of rules */ const RuleList &children() const { return mChildren; } /** * Return all children rules of this rule * - * \return A list of rules + * \returns A list of rules */ RuleList &children() { return mChildren; } /** * Returns all children, grand-children, grand-grand-children, grand-gra... you get it * - * \return A list of descendant rules + * \returns A list of descendant rules */ RuleList descendants() const { RuleList l; Q_FOREACH ( Rule *c, mChildren ) { l += c; l += c->descendants(); } return l; } /** * The parent rule * - * \return Parent rule + * \returns Parent rule */ const Rule *parent() const { return mParent; } /** * The parent rule * - * \return Parent rule + * \returns Parent rule */ Rule *parent() { return mParent; } @@ -239,7 +239,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling /** * Create a rule from an XML definition * \param ruleElem The XML rule element - * \return A new rule + * \returns A new rule */ static Rule *create( const QDomElement &ruleElem ); @@ -273,7 +273,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling * * \param f The feature to test * \param context The context in which the rendering happens - * \return True if the feature shall be rendered + * \returns True if the feature shall be rendered */ bool isFilterOK( QgsFeature &f, QgsRenderContext &context ) const; @@ -281,7 +281,7 @@ class CORE_EXPORT QgsRuleBasedLabeling : public QgsAbstractVectorLayerLabeling * Check if this rule applies for a given scale * \param scale The scale to check. If set to 0, it will always return true. * - * \return If the rule will be evaluated at this scale + * \returns If the rule will be evaluated at this scale */ bool isScaleOK( double scale ) const; diff --git a/src/core/qgsruntimeprofiler.h b/src/core/qgsruntimeprofiler.h index 4c77f20277b..4ecce67b4d8 100644 --- a/src/core/qgsruntimeprofiler.h +++ b/src/core/qgsruntimeprofiler.h @@ -45,7 +45,7 @@ class CORE_EXPORT QgsRuntimeProfiler /** * @brief Return all the current profile times. - * \return A list of profile event names and times. + * \returns A list of profile event names and times. * \note not available in Python bindings */ const QList > profileTimes() const { return mProfileTimes; } @@ -57,7 +57,7 @@ class CORE_EXPORT QgsRuntimeProfiler /** * @brief The current total time collected in the profiler. - * \return The current total time collected in the profiler. + * \returns The current total time collected in the profiler. */ double totalTime(); diff --git a/src/core/qgsscalecalculator.h b/src/core/qgsscalecalculator.h index 5c9821e953f..6524a021820 100644 --- a/src/core/qgsscalecalculator.h +++ b/src/core/qgsscalecalculator.h @@ -50,7 +50,7 @@ class CORE_EXPORT QgsScaleCalculator /** * Accessor for dpi used in scale calculations - * \return int the dpi used for scale calculations. + * \returns int the dpi used for scale calculations. */ double dpi(); @@ -67,7 +67,7 @@ class CORE_EXPORT QgsScaleCalculator * Calculate the scale denominator * \param mapExtent QgsRectangle containing the current map extent * \param canvasWidth Width of the map canvas in pixel (physical) units - * \return scale denominator of current map view + * \returns scale denominator of current map view */ double calculate( const QgsRectangle &mapExtent, int canvasWidth ); diff --git a/src/core/qgsscaleutils.h b/src/core/qgsscaleutils.h index 0a409efc20b..39155873e33 100644 --- a/src/core/qgsscaleutils.h +++ b/src/core/qgsscaleutils.h @@ -32,7 +32,7 @@ class CORE_EXPORT QgsScaleUtils * \param scales the list of scales to save * \param errorMessage it will contain the error message if something * went wrong - * \return true on success and false if failed + * \returns true on success and false if failed */ static bool saveScaleList( const QString &fileName, const QStringList &scales, QString &errorMessage ); @@ -41,7 +41,7 @@ class CORE_EXPORT QgsScaleUtils * \param scales it will contain loaded scales * \param errorMessage it will contain the error message if something * went wrong - * \return true on success and false if failed + * \returns true on success and false if failed */ static bool loadScaleList( const QString &fileName, QStringList &scales, QString &errorMessage ); }; diff --git a/src/core/qgssnapper.h b/src/core/qgssnapper.h index 6da89520c31..cc6b8051d3b 100644 --- a/src/core/qgssnapper.h +++ b/src/core/qgssnapper.h @@ -107,7 +107,7 @@ class CORE_EXPORT QgsSnapper * \param mapCoordPoint the start point for snapping (in map coordinates) * \param snappingResult the list where the results are inserted (everything in map coordinate system) * \param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position - * \return 0 in case of success + * \returns 0 in case of success */ int snapMapPoint( const QgsPoint &mapCoordPoint, QList &snappingResult, const QList &excludePoints = QList() ); diff --git a/src/core/qgssnappingconfig.h b/src/core/qgssnappingconfig.h index 1f3e9a53c3a..b710646ea47 100644 --- a/src/core/qgssnappingconfig.h +++ b/src/core/qgssnappingconfig.h @@ -200,7 +200,7 @@ class CORE_EXPORT QgsSnappingConfig * When implementing a long-living QgsSnappingConfig (like the one in QgsProject) * it is best to directly feed this with information from the layer registry. * - * \return True if changes have been done. + * \returns True if changes have been done. * * \since QGIS 3.0 */ @@ -212,7 +212,7 @@ class CORE_EXPORT QgsSnappingConfig * When implementing a long-living QgsSnappingConfig (like the one in QgsProject) * it is best to directly feed this with information from the layer registry. * - * \return True if changes have been done. + * \returns True if changes have been done. * * \since QGIS 3.0 */ diff --git a/src/core/qgssqlstatement.h b/src/core/qgssqlstatement.h index 658cc344910..53ba80ea5b2 100644 --- a/src/core/qgssqlstatement.h +++ b/src/core/qgssqlstatement.h @@ -203,14 +203,14 @@ class CORE_EXPORT QgsSQLStatement /** * Abstract virtual that returns the type of this node. * - * \return The type of this node + * \returns The type of this node */ virtual NodeType nodeType() const = 0; /** * Abstract virtual dump method * - * \return A statement which represents this node as string + * \returns A statement which represents this node as string */ virtual QString dump() const = 0; @@ -220,7 +220,7 @@ class CORE_EXPORT QgsSQLStatement * generated in prepare and context related. * Ownership is transferred to the caller. * - * \return a deep copy of this node. + * \returns a deep copy of this node. */ virtual Node *clone() const = 0; diff --git a/src/core/qgsstringutils.h b/src/core/qgsstringutils.h index f32bb969ef3..af85627e64a 100644 --- a/src/core/qgsstringutils.h +++ b/src/core/qgsstringutils.h @@ -180,7 +180,7 @@ class CORE_EXPORT QgsStringUtils /** Converts a string by applying capitalization rules to the string. * \param string input string * \param capitalization capitalization type to apply - * \return capitalized string + * \returns capitalized string * \since QGIS 3.0 */ static QString capitalize( const QString &string, Capitalization capitalization ); diff --git a/src/core/qgstextrenderer.h b/src/core/qgstextrenderer.h index c2943960de5..96bff2139a1 100644 --- a/src/core/qgstextrenderer.h +++ b/src/core/qgstextrenderer.h @@ -1133,7 +1133,7 @@ class CORE_EXPORT QgsTextRenderer * \param c rendercontext * \param unit size units * \param mapUnitScale a mapUnitScale clamper - * \return font pixel size + * \returns font pixel size */ static int sizeToPixel( double size, const QgsRenderContext &c, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &mapUnitScale = QgsMapUnitScale() ); diff --git a/src/core/qgstolerance.h b/src/core/qgstolerance.h index c49cb4cc604..7acfc925db4 100644 --- a/src/core/qgstolerance.h +++ b/src/core/qgstolerance.h @@ -46,7 +46,7 @@ class CORE_EXPORT QgsTolerance /** * Static function to get vertex tolerance value. * The value is read from settings and transformed if necessary. - * \return value of vertex tolerance in map units (not layer units) + * \returns value of vertex tolerance in map units (not layer units) * \since QGIS 2.8 */ static double vertexSearchRadius( const QgsMapSettings &mapSettings ); @@ -54,14 +54,14 @@ class CORE_EXPORT QgsTolerance /** * Static function to get vertex tolerance value for a layer. * The value is read from settings and transformed if necessary. - * \return value of vertex tolerance in layer units + * \returns value of vertex tolerance in layer units */ static double vertexSearchRadius( QgsMapLayer *layer, const QgsMapSettings &mapSettings ); /** * Static function to get default tolerance value for a layer. * The value is read from settings and transformed if necessary. - * \return value of default tolerance in layer units + * \returns value of default tolerance in layer units */ static double defaultTolerance( QgsMapLayer *layer, const QgsMapSettings &mapSettings ); @@ -71,7 +71,7 @@ class CORE_EXPORT QgsTolerance * \param layer source layer necessary in case tolerance is in layer units * \param mapSettings settings of the map * \param units type of units to be translated - * \return value of tolerance in map units + * \returns value of tolerance in map units * \since QGIS 2.8 */ static double toleranceInProjectUnits( double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, QgsTolerance::UnitType units ); @@ -82,7 +82,7 @@ class CORE_EXPORT QgsTolerance * \param layer reference layer * \param mapSettings settings of the map * \param units type of units to be translated - * \return value of tolerance in layer units + * \returns value of tolerance in layer units */ static double toleranceInMapUnits( double tolerance, QgsMapLayer *layer, const QgsMapSettings &mapSettings, UnitType units = LayerUnits ); diff --git a/src/core/qgstracer.h b/src/core/qgstracer.h index cadf3c8b9ab..487bafef857 100644 --- a/src/core/qgstracer.h +++ b/src/core/qgstracer.h @@ -89,7 +89,7 @@ class CORE_EXPORT QgsTracer : public QObject //! 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) + //! \returns array of points - trace of linestrings of other features (empty array one error) QVector findShortestPath( const QgsPoint &p1, const QgsPoint &p2, PathError *error = nullptr ); //! Find out whether the point is snapped to a vertex or edge (i.e. it can be used for tracing start/stop) diff --git a/src/core/qgstransactiongroup.h b/src/core/qgstransactiongroup.h index d040ab9e92d..15616bb60ac 100644 --- a/src/core/qgstransactiongroup.h +++ b/src/core/qgstransactiongroup.h @@ -43,7 +43,7 @@ class CORE_EXPORT QgsTransactionGroup : public QObject /** * Get the set of layers currently managed by this transaction group. * - * \return Layer set + * \returns Layer set */ QSet layers() const; diff --git a/src/core/qgsunittypes.h b/src/core/qgsunittypes.h index ebf03bab1d8..20fb221c7ed 100644 --- a/src/core/qgsunittypes.h +++ b/src/core/qgsunittypes.h @@ -244,7 +244,7 @@ class CORE_EXPORT QgsUnitTypes /** Converts a distance unit to its corresponding area unit, e.g., meters to square meters * \param distanceUnit distance unit to convert - * \return matching areal unit + * \returns matching areal unit */ Q_INVOKABLE static AreaUnit distanceToAreaUnit( QgsUnitTypes::DistanceUnit distanceUnit ); diff --git a/src/core/qgsvectordataprovider.h b/src/core/qgsvectordataprovider.h index 54606dc4e7d..9fa1462e1bf 100644 --- a/src/core/qgsvectordataprovider.h +++ b/src/core/qgsvectordataprovider.h @@ -132,7 +132,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * same time, some synchronization mechanisms must be used (e.g. mutexes) to prevent data corruption. * * \since QGIS 2.4 - * \return new instance of QgsAbstractFeatureSource (caller is responsible for deleting it) + * \returns new instance of QgsAbstractFeatureSource (caller is responsible for deleting it) */ virtual QgsAbstractFeatureSource *featureSource() const = 0; @@ -155,7 +155,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Number of features in the layer - * \return long containing number of features + * \returns long containing number of features */ virtual long featureCount() const = 0; @@ -219,7 +219,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * \param parameters parameters controlling aggregate calculation * \param context expression context for filter * \param ok will be set to true if calculation was successfully performed by the data provider - * \return calculated aggregate value + * \returns calculated aggregate value * \since QGIS 2.16 */ virtual QVariant aggregate( QgsAggregateCalculator::Aggregate aggregate, @@ -238,14 +238,14 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Adds a list of features - * \return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure */ virtual bool addFeatures( QgsFeatureList &flist ); /** * Deletes one or more features from the provider. This requires the DeleteFeatures capability. * \param id list containing feature ids to delete - * \return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure * @see truncate() */ virtual bool deleteFeatures( const QgsFeatureIds &id ); @@ -271,7 +271,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * If attributes are deleted using this method then QgsVectorLayer::updateFields() must be called * manually to ensure that the layer's field are correctly reported. * \param attributes a set containing indices of attributes - * \return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure */ virtual bool deleteAttributes( const QgsAttributeIds &attributes ); @@ -280,7 +280,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * If attributes are renamed using this method then QgsVectorLayer::updateFields() must be called * manually to ensure that the layer's field are correctly reported. * \param renamedAttributes map of attribute index to new attribute name - * \return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure * \since QGIS 2.16 */ virtual bool renameAttributes( const QgsFieldNameMap &renamedAttributes ); @@ -289,7 +289,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * Changes attribute values of existing features. This should * succeed if the provider reports the ChangeAttributeValues capability. * \param attr_map a map containing changed attributes - * \return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure */ virtual bool changeAttributeValues( const QgsChangedAttributesMap &attr_map ); @@ -302,7 +302,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * \param geometry_map A QgsGeometryMap whose index contains the feature IDs * that will have their geometries changed. * The second map parameter being the new geometries themselves - * \return true in case of success and false in case of failure + * \returns true in case of success and false in case of failure */ virtual bool changeFeatures( const QgsChangedAttributesMap &attr_map, const QgsGeometryMap &geometry_map ); @@ -351,13 +351,13 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * \param geometry_map A QgsGeometryMap whose index contains the feature IDs * that will have their geometries changed. * The second map parameter being the new geometries themselves - * \return True in case of success and false in case of failure + * \returns True in case of success and false in case of failure */ virtual bool changeGeometryValues( const QgsGeometryMap &geometry_map ); /** * Creates a spatial index on the datasource (if supported by the provider type). - * \return true in case of success + * \returns true in case of success */ virtual bool createSpatialIndex(); @@ -505,21 +505,21 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * Discover the available relations with the given layers. * \param self the layer using this data provider. * \param layers the other layers. - * \return the list of N-1 relations from this provider. + * \returns the list of N-1 relations from this provider. * \since QGIS 3.0 */ virtual QList discoverRelations( const QgsVectorLayer *self, const QList &layers ) const; /** * Get metadata, dependent on the provider type, that will be display in the metadata tab of the layer properties. - * \return The provider metadata + * \returns The provider metadata */ virtual QVariantMap metadata() const { return QVariantMap(); }; /** * Get the translated metadata key. * \param mdKey The metadata key - * \return The translated metadata value + * \returns The translated metadata value */ virtual QString translateMetadataKey( const QString &mdKey ) const { return mdKey; }; @@ -527,7 +527,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider * Get the translated metadata value. * \param mdKey The metadata key * \param value The metadata value - * \return The translated metadata value + * \returns The translated metadata value */ virtual QString translateMetadataValue( const QString &mdKey, const QVariant &value ) const { Q_UNUSED( mdKey ); return value.toString(); }; @@ -566,7 +566,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider /** * Converts the geometry to the provider type if possible / necessary - * \return the converted geometry or nullptr if no conversion was necessary or possible + * \returns the converted geometry or nullptr if no conversion was necessary or possible */ QgsGeometry *convertToProviderType( const QgsGeometry &geom ) const; diff --git a/src/core/qgsvectorfilewriter.h b/src/core/qgsvectorfilewriter.h index e9c78509c2e..3ecdfc9ab54 100644 --- a/src/core/qgsvectorfilewriter.h +++ b/src/core/qgsvectorfilewriter.h @@ -191,14 +191,14 @@ class CORE_EXPORT QgsVectorFileWriter /** Return a possibly modified field definition. Default implementation will return provided field unmodified. * \param field original field definition - * \return possibly modified 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. * \param fieldIdxInLayer field index * \param value original raw value - * \return possibly modified value. + * \returns possibly modified value. */ virtual QVariant convert( int fieldIdxInLayer, const QVariant &value ); }; @@ -467,7 +467,7 @@ class CORE_EXPORT QgsVectorFileWriter /** Delete a shapefile (and its accompanying shx / dbf / prf) * \param fileName /path/to/file.shp - * \return bool true if the file was deleted successfully + * \returns bool true if the file was deleted successfully */ static bool deleteShapeFile( const QString &fileName ); diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h index 8dbc5a476e1..f88a08429f0 100644 --- a/src/core/qgsvectorlayer.h +++ b/src/core/qgsvectorlayer.h @@ -433,7 +433,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Get the preview expression, used to create a human readable preview string. * Uses { @link QgsExpression } * - * \return The expression which will be used to preview features for this layer + * \returns The expression which will be used to preview features for this layer */ QString displayExpression() const; @@ -492,7 +492,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param exp The expression which calculates the field * \param fld The field to calculate * - * \return The index of the new field + * \returns The index of the new field * * \since QGIS 2.9 */ @@ -512,7 +512,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * * \param index An index of an epxression based (virtual) field * - * \return The expression for the field at index + * \returns The expression for the field at index * * \since QGIS 2.9 */ @@ -540,7 +540,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * The number of features that are selected in this layer * - * \return See description + * \returns See description */ int selectedFeatureCount() const; @@ -611,7 +611,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Get a copy of the user-selected features * - * \return A list of { @link QgsFeature } 's + * \returns A list of { @link QgsFeature } 's * * @see selectedFeatureIds() * @see selectedFeaturesIterator() which is more memory friendly when handling large selections @@ -624,7 +624,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param request You may specify a request, e.g. to limit the set of requested attributes. * Any filter on the request will be discarded. * - * \return Iterator over the selected features + * \returns Iterator over the selected features * * @see selectedFeatureIds() * @see selectedFeatures() @@ -634,7 +634,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Return reference to identifiers of selected features * - * \return A list of { @link QgsFeatureId } 's + * \returns A list of { @link QgsFeatureId } 's * @see selectedFeatures() */ const QgsFeatureIds &selectedFeatureIds() const; @@ -643,13 +643,13 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte QgsRectangle boundingBoxOfSelected() const; /** Returns whether the layer contains labels which are enabled and should be drawn. - * \return true if layer contains enabled labels + * \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. - * \return true if layer contains enabled diagrams + * \returns true if layer contains enabled diagrams * \since QGIS 2.9 */ bool diagramsEnabled() const; @@ -720,7 +720,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param names the list in which will be stored the style names * \param descriptions the list in which will be stored the style descriptions * \param msgError - * \return the number of styles related to current layer + * \returns the number of styles related to current layer */ virtual int listStylesInDatabase( QStringList &ids SIP_OUT, QStringList &names SIP_OUT, QStringList &descriptions SIP_OUT, QString &msgError SIP_OUT ); @@ -735,7 +735,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \since QGIS 3.0 * \param styleId the provider's layer_styles table id of the style to delete * \param msgError reference to string that will be updated with any error messages - * \return true in case of success + * \returns true in case of success */ virtual bool deleteStyleFromDatabase( const QString &styleId, QString &msgError SIP_OUT ); @@ -756,14 +756,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** 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 - * \return true in case of success. + * \returns true in case of success. */ bool readSymbology( const QDomNode &layerNode, QString &errorMessage ) override; /** 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 - * \return true in case of success. + * \returns true in case of success. */ bool readStyle( const QDomNode &node, QString &errorMessage ) override; @@ -771,7 +771,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \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 - * \return true in case of success. + * \returns true in case of success. */ bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const override; @@ -779,7 +779,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \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 - * \return true in case of success. + * \returns true in case of success. */ bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage ) const override; @@ -789,7 +789,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param doc the document that will have the QDomNode added. * \param errorMessage reference to string that will be updated with any error messages * \param props a open ended set of properties that can drive/inform the SLD encoding - * \return true in case of success + * \returns true in case of success */ bool writeSld( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsStringMap &props = QgsStringMap() ) const; @@ -798,7 +798,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Number of features rendered with specified legend key. Features must be first * calculated by countSymbolFeatures() - * \return number of features rendered by symbol or -1 if failed or counts are not available + * \returns number of features rendered by symbol or -1 if failed or counts are not available */ long featureCount( const QString &legendKey ) const; @@ -817,7 +817,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * Count features for symbols. Feature counts may be get by featureCount(). * \param showProgress show progress dialog - * \return true if calculated, false if failed or was canceled by user + * \returns true if calculated, false if failed or was canceled by user */ bool countSymbolFeatures( bool showProgress = true ); @@ -826,13 +826,13 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param subset The subset string. This may be the where clause of a sql statement * or other definition string specific to the underlying dataprovider * and data store. - * \return true, when setting the subset string was successful, false otherwise + * \returns true, when setting the subset string was successful, false otherwise */ virtual bool setSubsetString( const QString &subset ); /** * Get the string (typically sql) used to define a subset of the layer - * \return The subset string or QString::null if not implemented by the provider + * \returns The subset string or QString::null if not implemented by the provider */ virtual QString subsetString() const; @@ -881,7 +881,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** Adds a feature \param feature feature to add \param alsoUpdateExtent If True, will also go to the effort of e.g. updating the extents. - \return True in case of success and False in case of error + \returns True in case of success and False in case of error */ bool addFeature( QgsFeature &feature, bool alsoUpdateExtent = true ); @@ -889,7 +889,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte on every call. Consider using {@link changeAttributeValue()} or {@link changeGeometry()} instead. \param f Feature to update - \return True in case of success and False in case of error + \returns True in case of success and False in case of error */ bool updateFeature( QgsFeature &f ); @@ -926,14 +926,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte EditResult deleteVertex( QgsFeatureId featureId, int vertex ); /** Deletes the selected features - * \return true in case of success and false otherwise + * \returns true in case of success and false otherwise */ bool deleteSelectedFeatures( int *deletedCount = nullptr ); /** 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 - * \return + * \returns * 0 in case of success, * 1 problem with feature type, * 2 ring not closed, @@ -948,7 +948,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** 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 - * \return + * \returns * 0 in case of success * 1 problem with feature type * 2 ring not closed @@ -959,7 +959,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte int addRing( QgsCurve *ring SIP_TRANSFER, QgsFeatureId *featureId = nullptr ) SIP_PYNAME( addCurvedRing ); /** Adds a new part polygon to a multipart feature - * \return + * \returns * 0 in case of success, * 1 if selected feature is not multipart, * 2 if ring is not a valid geometry, @@ -973,7 +973,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte int addPart( const QList &ring ); /** Adds a new part polygon to a multipart feature - * \return + * \returns * 0 in case of success, * 1 if selected feature is not multipart, * 2 if ring is not a valid geometry, @@ -994,14 +994,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param featureId id of the feature to translate * \param dx translation of x-coordinate * \param dy translation of y-coordinate - * \return 0 in case of success + * \returns 0 in case of success */ int translateFeature( QgsFeatureId featureId, double dx, double dy ); /** Splits parts cut by the given line * \param splitLine line that splits the layer features * \param topologicalEditing true if topological editing is enabled - * \return + * \returns * 0 in case of success, * 4 if there is a selection but no feature split */ @@ -1011,7 +1011,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** Splits features cut by the given line * \param splitLine line that splits the layer features * \param topologicalEditing true if topological editing is enabled - * \return + * \returns * 0 in case of success, * 4 if there is a selection but no feature split */ @@ -1021,7 +1021,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** 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 - * \return 0 in case of success + * \returns 0 in case of success */ int addTopologicalPoints( const QgsGeometry &geom ); @@ -1030,14 +1030,14 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * no additional vertex is inserted. This method is useful for topological * editing. * \param p position of the vertex - * \return 0 in case of success + * \returns 0 in case of success */ int addTopologicalPoints( const QgsPoint &p ); /** Inserts vertices to the snapped segments. * This is useful for topological editing if snap to segment is enabled. * \param snapResults results collected from the snapping operation - * \return 0 in case of success + * \returns 0 in case of success */ int insertSegmentVerticesForSnap( const QList &snapResults ); @@ -1065,7 +1065,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param point The point which is set to the position of a vertex if there is one within the snapping tolerance. * If there is no point within this tolerance, point is left unchanged. * \param tolerance The snapping tolerance - * \return true if the point has been snapped, false if no vertex within search tolerance + * \returns true if the point has been snapped, false if no vertex within search tolerance */ bool snapPoint( QgsPoint &point, double tolerance ); @@ -1074,7 +1074,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param snappingTolerance distance tolerance for snapping * \param snappingResults snapping results. Key is the distance between startPoint and snapping target * \param snap_to to segment / to vertex - * \return 0 in case of success + * \returns 0 in case of success */ int snapWithContext( const QgsPoint &startPoint, double snappingTolerance, @@ -1096,7 +1096,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Returns the list of fields of this layer. * This also includes fields which have not yet been saved to the provider. * - * \return A list of fields + * \returns A list of fields */ inline QgsFields fields() const { return mFields; } @@ -1105,7 +1105,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * This also includes fields which have not yet been saved to the provider. * Alias for {@link fields()} * - * \return A list of fields + * \returns A list of fields */ inline QgsFields pendingFields() const { return mFields; } @@ -1143,7 +1143,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte long featureCount() const; /** Make layer read-only (editing disabled) or not - * \return false if the layer is in editing yet + * \returns false if the layer is in editing yet */ bool setReadOnly( bool readonly = true ); @@ -1158,7 +1158,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param newValue The value which will be assigned to the field * \param oldValue The previous value to restore on undo (will otherwise be retrieved) * - * \return true in case of success + * \returns true in case of success */ bool changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue = QVariant() ); @@ -1229,7 +1229,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Deletes a list of attribute fields (but does not commit it) * * \param attrs the indices of the attributes to delete - * \return true if at least one attribute has been deleted + * \returns true if at least one attribute has been deleted * */ bool deleteAttributes( QList attrs ); @@ -1244,7 +1244,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Deletes a set of features from the layer (but does not commit it) * \param fids The feature ids to delete * - * \return false if the layer is not in edit mode or does not support deleting + * \returns false if the layer is not in edit mode or does not support deleting * in case of an active transaction depends on the provider implementation */ bool deleteFeatures( const QgsFeatureIds &fids ); @@ -1288,7 +1288,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Get relations, where the foreign key is on this layer * * \param idx Only get relations, where idx forms part of the foreign key - * \return A list of relations + * \returns A list of relations */ QList referencingRelations( int idx ) const; @@ -1334,7 +1334,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * the default value. * \param context optional expression context to evaluate expressions again. If not * specified, a default context will be created - * \return calculated default value + * \returns calculated default value * \since QGIS 3.0 * @see setDefaultValueExpression() */ @@ -1483,7 +1483,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * \param parameters parameters controlling aggregate calculation * \param context expression context for expressions and filters * \param ok if specified, will be set to true if aggregate calculation was successful - * \return calculated aggregate value + * \returns calculated aggregate value * \since QGIS 2.16 */ QVariant aggregate( QgsAggregateCalculator::Aggregate aggregate, @@ -1550,7 +1550,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte /** * @brief Return the conditional styles that are set for this layer. Style information is * used to render conditional formatting in the attribute table. - * \return Return a QgsConditionalLayerStyles object holding the conditional attribute + * \returns Return a QgsConditionalLayerStyles object holding the conditional attribute * style information. Style information is generic and can be used for anything. * \since QGIS 2.12 */ @@ -1592,7 +1592,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Get the configuration of the form used to represent this vector layer. * This is a writable configuration that can directly be changed in place. * - * \return The configuration of this layers' form + * \returns The configuration of this layers' form * * \since QGIS 2.14 */ @@ -1602,7 +1602,7 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer, public QgsExpressionConte * Get the configuration of the form used to represent this vector layer. * This is a writable configuration that can directly be changed in place. * - * \return The configuration of this layers' form + * \returns The configuration of this layers' form * * \since QGIS 3.0 */ diff --git a/src/core/qgsvectorlayercache.h b/src/core/qgsvectorlayercache.h index dddf0d9a8a4..5e401da526c 100644 --- a/src/core/qgsvectorlayercache.h +++ b/src/core/qgsvectorlayercache.h @@ -98,7 +98,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject * Returns the maximum number of features this cache will hold. * In case full caching is enabled, this number can change, as new features get added. * - * \return int + * \returns int */ int cacheSize(); @@ -172,7 +172,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject * If it's not possible to fully satisfy the request from the cache, part or all of the features * will be requested from the data provider. * \param featureRequest The request specifying filter and required data. - * \return An iterator over the requested data. + * \returns An iterator over the requested data. */ QgsFeatureIterator getFeatures( const QgsFeatureRequest &featureRequest = QgsFeatureRequest() ); @@ -214,7 +214,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject /** * Check if a certain feature id is cached. * \param fid The feature id to look for - * \return True if this id is in the cache + * \returns True if this id is in the cache * @see cachedFeatureIds() */ bool isFidCached( const QgsFeatureId fid ) const; @@ -230,14 +230,14 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject * \param featureId The id of the feature to query * \param feature The result of the operation will be written to this feature * \param skipCache Will query the layer regardless if the feature is in the cache already - * \return true in case of success + * \returns true in case of success */ bool featureAtId( QgsFeatureId featureId, QgsFeature &feature, bool skipCache = false ); /** * Removes the feature identified by fid from the cache if present. * \param fid The id of the feature to delete - * \return true if the feature was removed, false if the feature id was not found in the cache + * \returns true if the feature was removed, false if the feature id was not found in the cache */ bool removeCachedFeature( QgsFeatureId fid ); @@ -275,7 +275,7 @@ class CORE_EXPORT QgsVectorLayerCache : public QObject * * * \param featureRequest The {@link QgsFeatureRequest} to be answered - * \return True if the information is being cached, false if not + * \returns True if the information is being cached, false if not */ bool checkInformationCovered( const QgsFeatureRequest &featureRequest ); diff --git a/src/core/qgsvectorlayerdiagramprovider.h b/src/core/qgsvectorlayerdiagramprovider.h index e01fa23dc7c..4ac9135001c 100644 --- a/src/core/qgsvectorlayerdiagramprovider.h +++ b/src/core/qgsvectorlayerdiagramprovider.h @@ -75,7 +75,7 @@ class CORE_EXPORT QgsVectorLayerDiagramProvider : public QgsAbstractLabelProvide * Prepare for registration of features. Must be called after provider has been added to engine (uses its map settings) * \param context render context. * \param attributeNames list of attribute names to which additional required attributes shall be added - * \return Whether the preparation was successful - if not, the provider shall not be used + * \returns Whether the preparation was successful - if not, the provider shall not be used */ virtual bool prepare( const QgsRenderContext &context, QSet &attributeNames ); diff --git a/src/core/qgsvectorlayereditbuffer.h b/src/core/qgsvectorlayereditbuffer.h index cc5c2921793..a1e7605f7d5 100644 --- a/src/core/qgsvectorlayereditbuffer.h +++ b/src/core/qgsvectorlayereditbuffer.h @@ -44,7 +44,7 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject /** Adds a feature \param f feature to add - \return True in case of success and False in case of error + \returns True in case of success and False in case of error */ virtual bool addFeature( QgsFeature &f ); diff --git a/src/core/qgsvectorlayereditutils.h b/src/core/qgsvectorlayereditutils.h index b165825826c..d013a2f8be9 100644 --- a/src/core/qgsvectorlayereditutils.h +++ b/src/core/qgsvectorlayereditutils.h @@ -73,7 +73,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils * \param targetFeatureIds if specified, only these features will be the candidates for adding a ring. Otherwise * all intersecting features are tested and the ring is added to the first valid feature. * \param modifiedFeatureId if specified, feature ID for feature that ring was added to will be stored in this parameter - * \return + * \returns * 0 in case of success, * 1 problem with feature type, * 2 ring not closed, @@ -89,7 +89,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils * \param targetFeatureIds if specified, only these features will be the candidates for adding a ring. Otherwise * all intersecting features are tested and the ring is added to the first valid feature. * \param modifiedFeatureId if specified, feature ID for feature that ring was added to will be stored in this parameter - * \return + * \returns * 0 in case of success, * 1 problem with feature type, * 2 ring not closed, @@ -102,7 +102,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils int addRing( QgsCurve *ring, const QgsFeatureIds &targetFeatureIds = QgsFeatureIds(), QgsFeatureId *modifiedFeatureId = nullptr ); /** Adds a new part polygon to a multipart feature - * \return + * \returns * 0 in case of success, * 1 if selected feature is not multipart, * 2 if ring is not a valid geometry, @@ -115,7 +115,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils int addPart( const QList &ring, QgsFeatureId featureId ); /** Adds a new part polygon to a multipart feature - * \return + * \returns * 0 in case of success, * 1 if selected feature is not multipart, * 2 if ring is not a valid geometry, @@ -136,14 +136,14 @@ class CORE_EXPORT QgsVectorLayerEditUtils * \param featureId id of the feature to translate * \param dx translation of x-coordinate * \param dy translation of y-coordinate - * \return 0 in case of success + * \returns 0 in case of success */ int translateFeature( QgsFeatureId featureId, double dx, double dy ); /** Splits parts cut by the given line * \param splitLine line that splits the layer feature parts * \param topologicalEditing true if topological editing is enabled - * \return + * \returns * 0 in case of success, * 4 if there is a selection but no feature split */ @@ -153,7 +153,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils /** Splits features cut by the given line * \param splitLine line that splits the layer features * \param topologicalEditing true if topological editing is enabled - * \return + * \returns * 0 in case of success, * 4 if there is a selection but no feature split */ @@ -163,7 +163,7 @@ class CORE_EXPORT QgsVectorLayerEditUtils /** 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 - * \return 0 in case of success + * \returns 0 in case of success */ int addTopologicalPoints( const QgsGeometry &geom ); @@ -172,21 +172,21 @@ class CORE_EXPORT QgsVectorLayerEditUtils * no additional vertex is inserted. This method is useful for topological * editing. * \param p position of the vertex - * \return 0 in case of success + * \returns 0 in case of success */ int addTopologicalPoints( const QgsPoint &p ); /** Inserts vertices to the snapped segments. * This is useful for topological editing if snap to segment is enabled. * \param snapResults results collected from the snapping operation - * \return 0 in case of success + * \returns 0 in case of success */ int insertSegmentVerticesForSnap( const QList &snapResults ); protected: /** Little helper function that gives bounding box from a list of points. - \return 0 in case of success */ + \returns 0 in case of success */ int boundingBoxFromPointList( const QList &list, double &xmin, double &ymin, double &xmax, double &ymax ) const; QgsVectorLayer *L = nullptr; diff --git a/src/core/qgsvectorlayerjoinbuffer.h b/src/core/qgsvectorlayerjoinbuffer.h index eb8c6bdca2b..6fe54fde305 100644 --- a/src/core/qgsvectorlayerjoinbuffer.h +++ b/src/core/qgsvectorlayerjoinbuffer.h @@ -38,7 +38,7 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject /** Joins another vector layer to this layer \param joinInfo join object containing join layer id, target and source field - \return (since 2.6) whether the join was successfully added */ + \returns (since 2.6) whether the join was successfully added */ bool addJoin( const QgsVectorLayerJoinInfo &joinInfo ); /** Removes a vector layer join diff --git a/src/core/qgsvectorlayerlabelprovider.h b/src/core/qgsvectorlayerlabelprovider.h index 5866ffab9cc..7891f9e379f 100644 --- a/src/core/qgsvectorlayerlabelprovider.h +++ b/src/core/qgsvectorlayerlabelprovider.h @@ -56,7 +56,7 @@ class CORE_EXPORT QgsVectorLayerLabelProvider : public QgsAbstractLabelProvider * Prepare for registration of features. Must be called after provider has been added to engine (uses its map settings) * \param context render context. * \param attributeNames list of attribute names to which additional required attributes shall be added - * \return Whether the preparation was successful - if not, the provider shall not be used + * \returns Whether the preparation was successful - if not, the provider shall not be used */ virtual bool prepare( const QgsRenderContext &context, QSet &attributeNames ); diff --git a/src/core/qgsvectorlayertools.h b/src/core/qgsvectorlayertools.h index 4cbac1c4c9a..6dafd237e25 100644 --- a/src/core/qgsvectorlayertools.h +++ b/src/core/qgsvectorlayertools.h @@ -48,7 +48,7 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject * \param defaultValues Default values for the feature to add * \param defaultGeometry A default geometry to add to the feature * \param feature Updated feature after adding will be written back to this - * \return True in case of success, False if the operation failed/was aborted + * \returns True in case of success, False if the operation failed/was aborted * * TODO QGIS 3: remove const qualifier */ @@ -61,7 +61,7 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject * * \param layer The layer on which to start an edit session * - * \return True, if the editing session was started + * \returns True, if the editing session was started * * TODO QGIS 3: remove const qualifier */ @@ -73,7 +73,7 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject * * \param layer The layer to commit * \param allowCancel True if a cancel button should be offered - * \return True if successful + * \returns True if successful * * TODO QGIS 3: remove const qualifier */ @@ -83,7 +83,7 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject * Should be called, when the features should be committed but the editing session is not ended. * * \param layer The layer to commit - * \return True if successful + * \returns True if successful * * TODO QGIS 3: remove const qualifier */ @@ -97,7 +97,7 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject * \param dx The translation on x * \param dy The translation on y * \param errorMsg If given, it will contain the error message - * \return True if all features could be copied. + * \returns True if all features could be copied. * * TODO QGIS 3: remove const qualifier */ diff --git a/src/core/raster/qgshillshaderenderer.h b/src/core/raster/qgshillshaderenderer.h index 87e9ba6d5b9..2a0fd2b1a72 100644 --- a/src/core/raster/qgshillshaderenderer.h +++ b/src/core/raster/qgshillshaderenderer.h @@ -51,7 +51,7 @@ class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer * @brief Factory method to create a new renderer * \param elem A DOM element to create the renderer from. * \param input The raster input interface. - * \return A new QgsHillshadeRenderer. + * \returns A new QgsHillshadeRenderer. */ static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ); diff --git a/src/core/raster/qgsrasterblock.h b/src/core/raster/qgsrasterblock.h index 873f4beb1ba..b185b9ad5d3 100644 --- a/src/core/raster/qgsrasterblock.h +++ b/src/core/raster/qgsrasterblock.h @@ -49,7 +49,7 @@ class CORE_EXPORT QgsRasterBlock * \param dataType raster data type * \param width width of data matrix * \param height height of data matrix - * \return true on success + * \returns true on success */ bool reset( Qgis::DataType dataType, int width, int height ); @@ -126,7 +126,7 @@ class CORE_EXPORT QgsRasterBlock static Qgis::DataType typeWithNoDataValue( Qgis::DataType dataType, double *noDataValue ); /** True if the block has no data value. - * \return 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; } @@ -134,7 +134,7 @@ class CORE_EXPORT QgsRasterBlock /** 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(). - * \return true if the block may contain no data */ + * \returns true if the block may contain no data */ bool hasNoData() const; /** Sets cell value that will be considered as "no data". @@ -152,7 +152,7 @@ class CORE_EXPORT QgsRasterBlock /** Return no data value. If the block does not have a no data value the * returned value is undefined. - * \return No data value + * \returns No data value * @see hasNoDataValue(), setNoDataValue(), resetNoDataValue() */ double noDataValue() const { return mNoDataValue; } @@ -160,87 +160,87 @@ class CORE_EXPORT QgsRasterBlock /** Get byte array representing a value. * \param dataType data type * \param value value - * \return byte array representing the 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, * returned value is undefined. * \param row row index * \param column column index - * \return value */ + * \returns value */ double value( int row, int column ) const; /** \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) - * \return value */ + * \returns value */ double value( qgssize index ) const; /** \brief Read a single color * \param row row index * \param column column index - * \return color */ + * \returns color */ QRgb color( int row, int column ) const; /** \brief Read a single value * \param index data matrix index (long type in Python) - * \return color */ + * \returns color */ QRgb color( qgssize index ) const; /** \brief Check if value at position is no data * \param row row index * \param column column index - * \return true if value is no data */ + * \returns true if value is no data */ bool isNoData( int row, int column ); /** \brief Check if value at position is no data * \param index data matrix index (long type in Python) - * \return true if value is no data */ + * \returns true if value is no data */ bool isNoData( qgssize index ); /** \brief Set value on position * \param row row index * \param column column index * \param value the value to be set - * \return true on success */ + * \returns true on success */ bool setValue( int row, int column, double value ); /** \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 - * \return true on success */ + * \returns true on success */ bool setValue( qgssize index, double value ); /** \brief Set color on position * \param row row index * \param column column index * \param color the color to be set, QRgb value - * \return true on success */ + * \returns true on success */ bool setColor( int row, int column, QRgb color ); /** \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 - * \return true on success */ + * \returns true on success */ bool setColor( qgssize index, QRgb color ); /** \brief Set no data on pixel * \param row row index * \param column column index - * \return true on success */ + * \returns true on success */ bool setIsNoData( int row, int column ); /** \brief Set no data on pixel * \param index data matrix index (long type in Python) - * \return true on success */ + * \returns true on success */ bool setIsNoData( qgssize index ); /** \brief Set the whole block to no data - * \return true on success */ + * \returns true on success */ bool setIsNoData(); /** \brief Set the whole block to no data except specified rectangle - * \return true on success */ + * \returns true on success */ bool setIsNoDataExcept( QRect exceptRect ); /** \brief Remove no data flag on pixel. If the raster block does not have an explicit @@ -283,20 +283,20 @@ class CORE_EXPORT QgsRasterBlock /** \brief Get pointer to data * \param row row index * \param column column index - * \return pointer to data + * \returns pointer to data * \note not available in Python bindings */ char *bits( int row, int column ); /** \brief Get pointer to data * \param index data matrix index (long type in Python) - * \return pointer to data + * \returns pointer to data * \note not available in Python bindings */ char *bits( qgssize index ); /** \brief Get pointer to data - * \return pointer to data + * \returns pointer to data * \note not available in Python bindings */ char *bits(); @@ -304,13 +304,13 @@ class CORE_EXPORT QgsRasterBlock /** \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 - * \return string representing the value*/ + * \returns string representing the value*/ static QString printValue( double value ); /** \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 - * \return string representing the value + * \returns string representing the value * \since QGIS 2.16 * \note not available in Python bindings */ @@ -318,16 +318,16 @@ class CORE_EXPORT QgsRasterBlock /** \brief Convert data to different type. * \param destDataType dest data type - * \return true on success */ + * \returns true on success */ bool convert( Qgis::DataType destDataType ); /** \brief Get image if type is color. - * \return image */ + * \returns image */ QImage image() const; /** \brief set image. * \param image image - * \return true on success */ + * \returns true on success */ bool setImage( const QImage *image ); //! \note not available in Python bindings @@ -357,7 +357,7 @@ class CORE_EXPORT QgsRasterBlock * \param width numbers of columns in theExtent * \param height numbers of rows in theExtent * \param subExtent extent, usually smaller than theExtent - * \return the rectangle covered by sub extent + * \returns the rectangle covered by sub extent */ static QRect subRect( const QgsRectangle &extent, int width, int height, const QgsRectangle &subExtent ); @@ -380,16 +380,16 @@ class CORE_EXPORT QgsRasterBlock /** Test if value is nodata comparing to noDataValue * \param value tested value * \param noDataValue no data value - * \return true if value is nodata */ + * \returns true if value is nodata */ static bool isNoDataValue( double value, double noDataValue ); /** Test if value is nodata for specific band * \param value tested value - * \return true if value is nodata */ + * \returns true if value is nodata */ bool isNoDataValue( double value ) const; /** Allocate no data bitmap - * \return true on success */ + * \returns true on success */ bool createNoDataBitmap(); /** \brief Convert block of data from one type to another. Original block memory @@ -398,7 +398,7 @@ class CORE_EXPORT QgsRasterBlock * \param srcDataType source data type * \param destDataType dest data type * \param size block size (width * height) - * \return block of data in destDataType */ + * \returns block of data in destDataType */ static void *convert( void *srcData, Qgis::DataType srcDataType, Qgis::DataType destDataType, qgssize size ); // Valid diff --git a/src/core/raster/qgsrasterdataprovider.h b/src/core/raster/qgsrasterdataprovider.h index c4db130025c..ef129034ecd 100644 --- a/src/core/raster/qgsrasterdataprovider.h +++ b/src/core/raster/qgsrasterdataprovider.h @@ -245,7 +245,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast * \param mapSettings map settings for legend providers supporting * contextual legends. * - * \return a download handler or null if the provider does not support + * \returns a download handler or null if the provider does not support * legend at all. Ownership of the returned object is transferred * to caller. * @@ -308,7 +308,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast * \param width context width * \param height context height * \param dpi context dpi - * \return QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers + * \returns QgsRaster::IdentifyFormatValue: map of values for each band, keys are band numbers * (from 1). * QgsRaster::IdentifyFormatFeature: map of QgsRasterFeatureList for each sublayer * (WMS) - TODO: it is not consistent with QgsRaster::IdentifyFormatValue. diff --git a/src/core/raster/qgsrasterinterface.h b/src/core/raster/qgsrasterinterface.h index f340db4831c..6d70a6c4201 100644 --- a/src/core/raster/qgsrasterinterface.h +++ b/src/core/raster/qgsrasterinterface.h @@ -201,7 +201,7 @@ class CORE_EXPORT QgsRasterInterface int sampleSize = 0, QgsRasterBlockFeedback *feedback = nullptr ); /** \brief Returns true if histogram is available (cached, already calculated). * The parameters are the same as in bandStatistics() - * \return true if statistics are available (ready to use) + * \returns true if statistics are available (ready to use) */ virtual bool hasStatistics( int bandNo, int stats = QgsRasterBandStats::All, diff --git a/src/core/raster/qgsrasteriterator.h b/src/core/raster/qgsrasteriterator.h index b6adbb5b3f7..127ac075b70 100644 --- a/src/core/raster/qgsrasteriterator.h +++ b/src/core/raster/qgsrasteriterator.h @@ -52,7 +52,7 @@ class CORE_EXPORT QgsRasterIterator \param block address of block pointer \param topLeftCol top left column \param topLeftRow top left row - \return false if the last part was already returned*/ + \returns false if the last part was already returned*/ bool readNextRasterPart( int bandNumber, int &nCols, int &nRows, QgsRasterBlock **block, diff --git a/src/core/raster/qgsrasterprojector.h b/src/core/raster/qgsrasterprojector.h index 20cea852749..bd8384292f5 100644 --- a/src/core/raster/qgsrasterprojector.h +++ b/src/core/raster/qgsrasterprojector.h @@ -127,7 +127,7 @@ class ProjectorData /** \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. - \return true if inside source + \returns true if inside source */ bool srcRowCol( int destRow, int destCol, int *srcRow, int *srcCol ); diff --git a/src/core/raster/qgsrasterrange.h b/src/core/raster/qgsrasterrange.h index c95dbd1b7e7..acbb0196c2f 100644 --- a/src/core/raster/qgsrasterrange.h +++ b/src/core/raster/qgsrasterrange.h @@ -57,7 +57,7 @@ class CORE_EXPORT QgsRasterRange /** \brief Test if value is within the list of ranges * \param value value * \param rangeList list of ranges - * \return true if value is in at least one of ranges + * \returns true if value is in at least one of ranges * \note not available in Python bindings */ static bool contains( double value, const QgsRasterRangeList &rangeList ); diff --git a/src/core/symbology-ng/qgsarrowsymbollayer.h b/src/core/symbology-ng/qgsarrowsymbollayer.h index 95321b4b73f..306bf0e4e30 100644 --- a/src/core/symbology-ng/qgsarrowsymbollayer.h +++ b/src/core/symbology-ng/qgsarrowsymbollayer.h @@ -37,7 +37,7 @@ class CORE_EXPORT QgsArrowSymbolLayer : public QgsLineSymbolLayer * * \param properties A property map to deserialize saved information from properties() * - * \return A new QgsArrowSymbolLayer + * \returns A new QgsArrowSymbolLayer */ static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ); diff --git a/src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h b/src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h index 506156e118a..20981b2cbbb 100644 --- a/src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h +++ b/src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h @@ -43,7 +43,7 @@ class CORE_EXPORT QgsGeometryGeneratorSymbolLayer : public QgsSymbolLayer * Access the symbol type. This defines the type of geometry * that is created by this generator. * - * \return Symbol type + * \returns Symbol type */ QgsSymbol::SymbolType symbolType() const { return mSymbolType; } diff --git a/src/core/symbology-ng/qgslinesymbollayer.h b/src/core/symbology-ng/qgslinesymbollayer.h index 57c1f1a1989..b6844cb6160 100644 --- a/src/core/symbology-ng/qgslinesymbollayer.h +++ b/src/core/symbology-ng/qgslinesymbollayer.h @@ -173,7 +173,7 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer * * \param properties A property map to deserialize saved information from properties() * - * \return A new MarkerLineSymbolLayerV2 + * \returns A new MarkerLineSymbolLayerV2 */ static QgsSymbolLayer *create( const QgsStringMap &properties = QgsStringMap() ); @@ -182,7 +182,7 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer * * \param element An SLD XML DOM element * - * \return A new MarkerLineSymbolLayerV2 + * \returns A new MarkerLineSymbolLayerV2 */ static QgsSymbolLayer *createFromSld( QDomElement &element ); @@ -220,7 +220,7 @@ class CORE_EXPORT QgsMarkerLineSymbolLayer : public QgsLineSymbolLayer /** * Shall the marker be rotated. * - * \return True if the marker should be rotated. + * \returns True if the marker should be rotated. */ bool rotateMarker() const { return mRotateMarker; } diff --git a/src/core/symbology-ng/qgsmarkersymbollayer.h b/src/core/symbology-ng/qgsmarkersymbollayer.h index 3c39e498f53..f2c3db7451f 100644 --- a/src/core/symbology-ng/qgsmarkersymbollayer.h +++ b/src/core/symbology-ng/qgsmarkersymbollayer.h @@ -105,7 +105,7 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer * shape. * \param name encoded shape name * \param ok if specified, will be set to true if shape was successfully decoded - * \return decoded name + * \returns decoded name * @see encodeShape() */ static Shape decodeShape( const QString &name, bool *ok = nullptr ); diff --git a/src/core/symbology-ng/qgsrenderer.h b/src/core/symbology-ng/qgsrenderer.h index 3747ccfd5a9..56aaa40b03d 100644 --- a/src/core/symbology-ng/qgsrenderer.h +++ b/src/core/symbology-ng/qgsrenderer.h @@ -97,7 +97,7 @@ class CORE_EXPORT QgsFeatureRenderer * Must be called between startRender() and stopRender() calls. * \param feature feature * \param context render context - * \return returns pointer to symbol or 0 if symbol was not found + * \returns returns pointer to symbol or 0 if symbol was not found * \since QGIS 2.12 */ virtual QgsSymbol *symbolForFeature( QgsFeature &feature, QgsRenderContext &context ) = 0; @@ -121,7 +121,7 @@ class CORE_EXPORT QgsFeatureRenderer * * \param context Additional information passed to the renderer about the job which will be rendered * \param fields The fields available for rendering - * \return Information passed back from the renderer that can e.g. be used to reduce the amount of requested features + * \returns Information passed back from the renderer that can e.g. be used to reduce the amount of requested features */ virtual void startRender( QgsRenderContext &context, const QgsFields &fields ) = 0; @@ -139,7 +139,7 @@ class CORE_EXPORT QgsFeatureRenderer * You do not need to specify the extent in here, this is taken care of separately and * will be combined with a filter returned from this method. * - * \return An expression used as where clause + * \returns An expression used as where clause */ virtual QString filter( const QgsFields &fields = QgsFields() ) { Q_UNUSED( fields ); return QString::null; } @@ -147,7 +147,7 @@ class CORE_EXPORT QgsFeatureRenderer * Return a list of attributes required by this renderer. Attributes not listed in here may * not have been requested from the provider at rendering time. * - * \return A set of attributes + * \returns A set of attributes */ virtual QSet usedAttributes( const QgsRenderContext &context ) const = 0; @@ -162,7 +162,7 @@ class CORE_EXPORT QgsFeatureRenderer * Create a deep copy of this renderer. Should be implemented by all subclasses * and generate a proper subclass. * - * \return A copy of this renderer + * \returns A copy of this renderer */ virtual QgsFeatureRenderer *clone() const = 0; @@ -236,7 +236,7 @@ class CORE_EXPORT QgsFeatureRenderer * Symbolizer elements * \param errorMessage it will contain the error message if something * went wrong - * \return the renderer + * \returns the renderer */ static QgsFeatureRenderer *loadSld( const QDomNode &node, QgsWkbTypes::GeometryType geomType, QString &errorMessage ); diff --git a/src/core/symbology-ng/qgsrulebasedrenderer.h b/src/core/symbology-ng/qgsrulebasedrenderer.h index 3aca5463bfb..3cddf0f7bdb 100644 --- a/src/core/symbology-ng/qgsrulebasedrenderer.h +++ b/src/core/symbology-ng/qgsrulebasedrenderer.h @@ -132,13 +132,13 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer /** * Dump for debug purpose * \param indent How many characters to indent. Will increase by two with every of the recursive calls - * \return A string representing this rule + * \returns A string representing this rule */ QString dump( int indent = 0 ) const; /** * Return the attributes used to evaluate the expression of this rule - * \return A set of attribute names + * \returns A set of attribute names */ QSet usedAttributes( const QgsRenderContext &context ) const; @@ -161,7 +161,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer * * \param f The feature to test * \param context The context in which the rendering happens - * \return True if the feature shall be rendered + * \returns True if the feature shall be rendered */ bool isFilterOK( QgsFeature &f, QgsRenderContext *context = nullptr ) const; @@ -169,7 +169,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer * Check if this rule applies for a given scale * \param scale The scale to check. If set to 0, it will always return true. * - * \return If the rule will be evaluated at this scale + * \returns If the rule will be evaluated at this scale */ bool isScaleOK( double scale ) const; @@ -181,27 +181,27 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer /** * A filter that will check if this rule applies - * \return An expression + * \returns An expression */ QgsExpression *filter() const { return mFilter; } /** * A filter that will check if this rule applies - * \return An expression + * \returns An expression */ QString filterExpression() const { return mFilterExp; } /** * A human readable description for this rule * - * \return Description + * \returns Description */ QString description() const { return mDescription; } /** * Returns if this rule is active * - * \return True if the rule is active + * \returns True if the rule is active */ bool active() const { return mIsActive; } @@ -280,7 +280,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer * \param featToRender The feature to render * \param context The rendering context * \param renderQueue The rendering queue to which the feature should be added - * \return The result of the rendering. In explicit if the feature is added to the queue or + * \returns The result of the rendering. In explicit if the feature is added to the queue or * the reason for not rendering the feature. */ RenderResult renderFeature( FeatureToRender &featToRender, QgsRenderContext &context, RenderQueue &renderQueue ); @@ -312,28 +312,28 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer * \param ruleElem The XML rule element * \param symbolMap Symbol map * - * \return A new rule + * \returns A new rule */ static Rule *create( QDomElement &ruleElem, QgsSymbolMap &symbolMap ); /** * Return all children rules of this rule * - * \return A list of rules + * \returns A list of rules */ RuleList &children() { return mChildren; } /** * Returns all children, grand-children, grand-grand-children, grand-gra... you get it * - * \return A list of descendant rules + * \returns A list of descendant rules */ RuleList descendants() const { RuleList l; Q_FOREACH ( Rule *c, mChildren ) { l += c; l += c->descendants(); } return l; } /** * The parent rule * - * \return Parent rule + * \returns Parent rule */ Rule *parent() { return mParent; } @@ -369,7 +369,7 @@ class CORE_EXPORT QgsRuleBasedRenderer : public QgsFeatureRenderer /** * Check if this rule is an ELSE rule * - * \return True if this rule is an else rule + * \returns True if this rule is an else rule */ bool isElse() { return mElseRule; } diff --git a/src/core/symbology-ng/qgsstyle.h b/src/core/symbology-ng/qgsstyle.h index ddeba17d15f..ed9edecdb10 100644 --- a/src/core/symbology-ng/qgsstyle.h +++ b/src/core/symbology-ng/qgsstyle.h @@ -86,7 +86,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param name is the name of the symbol being added or updated * \param symbol is the Vector symbol * \param update set to true when the style DB has to be updated, by default it is false - * \return success status of the operation + * \returns success status of the operation */ bool addSymbol( const QString &name, QgsSymbol *symbol, bool update = false ); @@ -95,14 +95,14 @@ class CORE_EXPORT QgsStyle : public QObject * \param name is the name of the color ramp being added or updated * \param colorRamp is the color ramp. Ownership is transferred. * \param update set to true when the style DB has to be updated, by default it is false - * \return success status of the operation + * \returns success status of the operation */ bool addColorRamp( const QString &name, QgsColorRamp *colorRamp, bool update = false ); /** Adds a new tag and returns the tag's id * * \param tagName the name of the new tag to be created - * \return returns an int, which is the DB id of the new tag created, 0 if the tag couldn't 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 ); @@ -152,7 +152,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or colorramp as QString * \param tags is the list of the tags that are to be applied as QStringList - * \return returns the success state of the operation + * \returns returns the success state of the operation */ bool tagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags ); @@ -162,7 +162,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or colorramp * \param tags is the list of tags that are to be removed as QStringList - * \return returns the success state of the operation + * \returns returns the success state of the operation */ bool detagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags ); @@ -171,7 +171,7 @@ class CORE_EXPORT QgsStyle : public QObject * Removes all tags for the specified symbol or colorramp * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or colorramp - * \return returns the success state of the operation + * \returns returns the success state of the operation */ bool detagSymbol( StyleEntity type, const QString &symbol ); @@ -205,7 +205,7 @@ class CORE_EXPORT QgsStyle : public QObject /** Returns the symbol names which are flagged as favorite * * \param type is either SymbolEntity or ColorampEntity - * \return A QStringList of the symbol or colorramp names flagged as favorite + * \returns A QStringList of the symbol or colorramp names flagged as favorite */ QStringList symbolsOfFavorite( StyleEntity type ) const; @@ -213,7 +213,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity or ColorampEntity * \param tagid is id of the tag which has been applied over the symbol as int - * \return A QStringList of the symbol or colorramp names for the given tag id + * \returns A QStringList of the symbol or colorramp names for the given tag id */ QStringList symbolsWithTag( StyleEntity type, int tagid ) const; @@ -221,7 +221,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity of ColorrampEntity * \param name is the name of the symbol or coloramp whose is to be added to favorites - * \return returns the success state as bool + * \returns returns the success state as bool */ bool addFavorite( StyleEntity type, const QString &name ); @@ -229,7 +229,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity of ColorrampEntity * \param name is the name of the symbol or coloramp whose is to be removed from favorites - * \return returns the success state as bool + * \returns returns the success state as bool */ bool removeFavorite( StyleEntity type, const QString &name ); @@ -254,7 +254,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param symbol is the pointer to the new QgsSymbol being saved * \param favorite is a boolean value to specify whether the symbol should be added to favorites * \param tags is a list of tags that are associated with the symbol as a QStringList. - * \return returns the success state of the save operation + * \returns returns the success state of the save operation */ bool saveSymbol( const QString &name, QgsSymbol *symbol, bool favorite, const QStringList &tags ); @@ -264,7 +264,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param ramp is the pointer to the new QgsColorRamp being saved * \param favorite is a boolean value to specify whether the colorramp should be added to favorites * \param tags is a list of tags that are associated with the color ramp as a QStringList. - * \return returns the success state of the save operation + * \returns returns the success state of the save operation */ bool saveColorRamp( const QString &name, QgsColorRamp *ramp, bool favorite, const QStringList &tags ); @@ -277,7 +277,7 @@ class CORE_EXPORT QgsStyle : public QObject /** Creates an on-disk database * * This function creates a new on-disk permanent style database. - * \return returns the success state of the database creation + * \returns returns the success state of the database creation * \since QGIS 3.0 * \see createMemoryDb() */ @@ -286,7 +286,7 @@ class CORE_EXPORT QgsStyle : public QObject /** 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. - * \return returns the success state of the temporary memory database creation + * \returns returns the success state of the temporary memory database creation * \since QGIS 3.0 * \see createDb() */ @@ -295,7 +295,7 @@ class CORE_EXPORT QgsStyle : public QObject /** Creates tables structure for new database * * This function is used to create the tables structure in a newly-created database. - * \return returns the success state of the temporary memory database creation + * \returns returns the success state of the temporary memory database creation * \since QGIS 3.0 * \see createDB(), createMemoryDB() */ @@ -305,7 +305,7 @@ class CORE_EXPORT QgsStyle : public QObject * * This function will load an on-disk database and populate styles. * \param filename location of the database to load styles from - * \return returns the success state of the database being loaded + * \returns returns the success state of the database being loaded */ bool load( const QString &filename ); @@ -322,7 +322,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity or ColorrampEntity * \param qword is the query string to search the symbols or colorramps. - * \return A QStringList of the matched symbols or colorramps + * \returns A QStringList of the matched symbols or colorramps * */ QStringList findSymbols( StyleEntity type, const QString &qword ); @@ -330,7 +330,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or color ramp - * \return A QStringList of the tags that have been applied to that symbol/colorramp + * \returns A QStringList of the tags that have been applied to that symbol/colorramp */ QStringList tagsOfSymbol( StyleEntity type, const QString &symbol ); @@ -339,7 +339,7 @@ class CORE_EXPORT QgsStyle : public QObject * \param type is either SymbolEntity or ColorrampEntity * \param symbol is the name of the symbol or color ramp * \param tag the name of the tag to look for - * \return A boolean value identicating whether a tag was found attached to the symbol + * \returns A boolean value identicating whether a tag was found attached to the symbol */ bool symbolHasTag( StyleEntity type, const QString &symbol, const QString &tag ); @@ -394,7 +394,7 @@ class CORE_EXPORT QgsStyle : public QObject * * \param query query to run * \param freeQuery release query memory - * \return success true on success + * \returns success true on success */ bool runEmptyQuery( char *query, bool freeQuery = true ); @@ -409,7 +409,7 @@ class CORE_EXPORT QgsStyle : public QObject * \note This should not be called separately, only called through addSymbol or addColorRamp * \param type is either SymbolEntity or ColorrampEntity * \param name is the name of an existing symbol or a color ramp - * \return Success state of the update operation + * \returns Success state of the update operation */ bool updateSymbol( StyleEntity type, const QString &name ); diff --git a/src/core/symbology-ng/qgssymbol.h b/src/core/symbology-ng/qgssymbol.h index 372a76906ba..a29312c288b 100644 --- a/src/core/symbology-ng/qgssymbol.h +++ b/src/core/symbology-ng/qgssymbol.h @@ -130,7 +130,7 @@ class CORE_EXPORT QgsSymbol * Ownership will be transferred. * \param index The index at which the layer should be added * \param layer The symbol layer to add - * \return True if the layer is added, False if the index or the layer is bad + * \returns True if the layer is added, False if the index or the layer is bad */ bool insertSymbolLayer( int index, QgsSymbolLayer *layer ); @@ -138,7 +138,7 @@ class CORE_EXPORT QgsSymbol * Append symbol layer at the end of the list * Ownership will be transferred. * \param layer The layer to add - * \return True if the layer is added, False if the layer is bad + * \returns True if the layer is added, False if the layer is bad */ bool appendSymbolLayer( QgsSymbolLayer *layer ); @@ -149,7 +149,7 @@ class CORE_EXPORT QgsSymbol * Remove symbol layer from the list and return pointer to it. * Ownership is handed to the caller. * \param index The index of the layer to remove - * \return A pointer to the removed layer + * \returns A pointer to the removed layer */ QgsSymbolLayer *takeSymbolLayer( int index ); @@ -285,7 +285,7 @@ class CORE_EXPORT QgsSymbol /** * Returns the symbol render context. Only valid between startRender and stopRender calls. * - * \return The symbol render context + * \returns The symbol render context */ QgsSymbolRenderContext *symbolRenderContext(); @@ -486,7 +486,7 @@ class CORE_EXPORT QgsSymbolRenderContext /** * This scope is always available when a symbol of this type is being rendered. * - * \return An expression scope for details about this symbol + * \returns An expression scope for details about this symbol */ QgsExpressionContextScope *expressionContextScope(); diff --git a/src/core/symbology-ng/qgssymbollayer.h b/src/core/symbology-ng/qgssymbollayer.h index 1cfa89daa14..1a4a370d240 100644 --- a/src/core/symbology-ng/qgssymbollayer.h +++ b/src/core/symbology-ng/qgssymbollayer.h @@ -610,7 +610,7 @@ class CORE_EXPORT QgsMarkerSymbolLayer : public QgsSymbolLayer /** Adjusts a marker offset to account for rotation. * \param offset offset prior to rotation * \param angle rotation angle in degrees clockwise from north - * \return adjusted offset + * \returns adjusted offset */ static QPointF _rotatedOffset( QPointF offset, double angle ); diff --git a/src/core/symbology-ng/qgssymbollayerutils.h b/src/core/symbology-ng/qgssymbollayerutils.h index ccdc11abada..17eb640579d 100644 --- a/src/core/symbology-ng/qgssymbollayerutils.h +++ b/src/core/symbology-ng/qgssymbollayerutils.h @@ -328,7 +328,7 @@ class CORE_EXPORT QgsSymbolLayerUtils * \param doc The document owning the element * \param element The element parent * \param function The expression to be encoded - * \return + * \returns */ static bool createExpressionElement( QDomDocument &doc, QDomElement &element, const QString &function ); static bool createFunctionElement( QDomDocument &doc, QDomElement &element, const QString &function ); diff --git a/src/gui/attributetable/qgsattributetablefiltermodel.h b/src/gui/attributetable/qgsattributetablefiltermodel.h index 895caae23ac..438daa3b646 100644 --- a/src/gui/attributetable/qgsattributetablefiltermodel.h +++ b/src/gui/attributetable/qgsattributetablefiltermodel.h @@ -98,7 +98,7 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub /** * Returns if selected features are currently shown on top * - * \return True if selected are shown on top + * \returns True if selected are shown on top */ bool selectedOnTop(); @@ -113,7 +113,7 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub /** * Get a list of currently filtered feature ids * - * \return A list of feature ids + * \returns A list of feature ids */ QgsFeatureIds filteredFeatures(); @@ -132,21 +132,21 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub /** * Returns the layer this filter acts on. * - * \return Abovementioned layer + * \returns Abovementioned layer */ inline QgsVectorLayer *layer() const { return masterModel()->layer(); } /** * Returns the layerCache this filter acts on. * - * \return The layer cache + * \returns The layer cache */ inline QgsVectorLayerCache *layerCache() const { return masterModel()->layerCache(); } /** * Returns the table model this filter is using * - * \return the table model in quesion + * \returns the table model in quesion */ inline QgsAttributeTableModel *masterModel() const { return mTableModel; } @@ -155,7 +155,7 @@ class GUI_EXPORT QgsAttributeTableFilterModel: public QSortFilterProxyModel, pub * * \param row A model index of the row in question * - * \return The feature id of the feature visible in the provided row + * \returns The feature id of the feature visible in the provided row */ QgsFeatureId rowToId( const QModelIndex &row ); diff --git a/src/gui/attributetable/qgsattributetablemodel.h b/src/gui/attributetable/qgsattributetablemodel.h index 9d367a569c4..7c9a25bc12a 100644 --- a/src/gui/attributetable/qgsattributetablemodel.h +++ b/src/gui/attributetable/qgsattributetablemodel.h @@ -182,7 +182,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel /** * Return the feature attributes at given model index - * \return feature attributes at given model index + * \returns feature attributes at given model index */ QgsFeature feature( const QModelIndex &idx ) const; @@ -235,7 +235,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel * Returns the context in which this table is shown. * Will be forwarded to any editor widget created when editing data on this model. * - * \return The context + * \returns The context */ const QgsAttributeEditorContext &editorContext() const { return mEditorContext; } @@ -350,7 +350,7 @@ class GUI_EXPORT QgsAttributeTableModel: public QAbstractTableModel * * \param fid feature id * - * \return feature exists + * \returns feature exists */ virtual bool loadFeatureAtId( QgsFeatureId fid ) const; diff --git a/src/gui/attributetable/qgsattributetableview.h b/src/gui/attributetable/qgsattributetableview.h index 3aa4a9d05fc..7cb4f240cc5 100644 --- a/src/gui/attributetable/qgsattributetableview.h +++ b/src/gui/attributetable/qgsattributetableview.h @@ -65,7 +65,7 @@ class GUI_EXPORT QgsAttributeTableView : public QTableView * \param object The object which is the target of the event. * \param event The intercepted event * - * \return Returns always false, so the event gets processed + * \returns Returns always false, so the event gets processed */ virtual bool eventFilter( QObject *object, QEvent *event ) override; diff --git a/src/gui/attributetable/qgsdualview.h b/src/gui/attributetable/qgsdualview.h index 7dda44421fc..d37e19119c0 100644 --- a/src/gui/attributetable/qgsdualview.h +++ b/src/gui/attributetable/qgsdualview.h @@ -111,7 +111,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Get the filter mode * - * \return the filter mode + * \returns the filter mode */ QgsAttributeTableFilterModel::FilterMode filterMode() { return mFilterModel->filterMode(); } @@ -126,7 +126,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Returns the number of features on the layer. * - * \return Number of features + * \returns Number of features */ int featureCount(); @@ -134,7 +134,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas * Returns the number of features which are currently visible, according to the * filter restrictions * - * \return Number of features + * \returns Number of features */ int filteredFeatureCount(); @@ -154,7 +154,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Returns the model which has the information about all features (not only filtered) * - * \return The master model + * \returns The master model */ QgsAttributeTableModel *masterModel() const { return mMasterModel; } @@ -175,7 +175,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * Returns the table view * - * \return The table view + * \returns The table view */ QgsAttributeTableView *tableView() { return mTableView; } @@ -214,7 +214,7 @@ class GUI_EXPORT QgsDualView : public QStackedWidget, private Ui::QgsDualViewBas /** * @brief saveEditChanges * - * \return true if the saving was ok. false is possible due to connected + * \returns true if the saving was ok. false is possible due to connected * validation logic. */ bool saveEditChanges(); diff --git a/src/gui/attributetable/qgsfeaturelistmodel.h b/src/gui/attributetable/qgsfeaturelistmodel.h index 7786a17c415..c227dc34c4a 100644 --- a/src/gui/attributetable/qgsfeaturelistmodel.h +++ b/src/gui/attributetable/qgsfeaturelistmodel.h @@ -75,7 +75,7 @@ class GUI_EXPORT QgsFeatureListModel : public QAbstractProxyModel, public QgsFea /** * @brief Returns the current state of null value injection - * \return If a NULL value is added + * \returns If a NULL value is added * \since QGIS 2.9 */ bool injectNull(); @@ -84,7 +84,7 @@ class GUI_EXPORT QgsFeatureListModel : public QAbstractProxyModel, public QgsFea /** * \param expression A {@link QgsExpression} compatible string. - * \return true if the expression could be set, false if there was a parse error. + * \returns true if the expression could be set, false if there was a parse error. * If it fails, the old expression will still be applied. Call {@link parserErrorString()} * for a meaningful error message. */ @@ -92,7 +92,7 @@ class GUI_EXPORT QgsFeatureListModel : public QAbstractProxyModel, public QgsFea /** * @brief Returns a detailed message about errors while parsing a QgsExpression. - * \return A message containing information about the parser error. + * \returns A message containing information about the parser error. */ QString parserErrorString(); diff --git a/src/gui/attributetable/qgsfeaturelistview.h b/src/gui/attributetable/qgsfeaturelistview.h index f99aeafde9c..b468bfac617 100644 --- a/src/gui/attributetable/qgsfeaturelistview.h +++ b/src/gui/attributetable/qgsfeaturelistview.h @@ -55,7 +55,7 @@ class GUI_EXPORT QgsFeatureListView : public QListView /** * Returns the layer cache - * \return the layer cache used as backend + * \returns the layer cache used as backend */ QgsVectorLayerCache *layerCache(); @@ -69,7 +69,7 @@ class GUI_EXPORT QgsFeatureListView : public QListView /** * Get the featureListModel used by this view * - * \return The model in use + * \returns The model in use */ QgsFeatureListModel *featureListModel() { return mModel; } @@ -86,7 +86,7 @@ class GUI_EXPORT QgsFeatureListView : public QListView /** * Returns the expression which is currently used to render the features. * - * \return A string containing the currend display expression + * \returns A string containing the currend display expression * * @see QgsExpression */ @@ -95,14 +95,14 @@ class GUI_EXPORT QgsFeatureListView : public QListView /** * Returns a detailed message about errors while parsing a QgsExpression. * - * \return A message containing information about the parser error. + * \returns A message containing information about the parser error. */ QString parserErrorString(); /** * Get the currentEditSelection * - * \return A list of edited feature ids + * \returns A list of edited feature ids */ QgsFeatureIds currentEditSelection(); diff --git a/src/gui/attributetable/qgsfeatureselectionmodel.h b/src/gui/attributetable/qgsfeatureselectionmodel.h index 4af4d80794a..36cd572304f 100644 --- a/src/gui/attributetable/qgsfeatureselectionmodel.h +++ b/src/gui/attributetable/qgsfeatureselectionmodel.h @@ -49,7 +49,7 @@ class GUI_EXPORT QgsFeatureSelectionModel : public QItemSelectionModel * * \param fid The featureid to determine the selection status of * - * \return The selection status + * \returns The selection status */ virtual bool isSelected( QgsFeatureId fid ); @@ -59,7 +59,7 @@ class GUI_EXPORT QgsFeatureSelectionModel : public QItemSelectionModel * * \param index The index to determine the selection status of * - * \return The selection status + * \returns The selection status */ virtual bool isSelected( const QModelIndex &index ); diff --git a/src/gui/attributetable/qgsfieldconditionalformatwidget.h b/src/gui/attributetable/qgsfieldconditionalformatwidget.h index 23d3821a471..01295ad3254 100644 --- a/src/gui/attributetable/qgsfieldconditionalformatwidget.h +++ b/src/gui/attributetable/qgsfieldconditionalformatwidget.h @@ -76,7 +76,7 @@ class GUI_EXPORT QgsFieldConditionalFormatWidget : public QWidget, private Ui::Q /** * @brief The default presets for the widget. Normally set when the widget is * created however called setPresets will override the default styles. - * \return List of default presets. + * \returns List of default presets. */ QList defaultPresets() const; diff --git a/src/gui/attributetable/qgsifeatureselectionmanager.h b/src/gui/attributetable/qgsifeatureselectionmanager.h index 084b6587a5c..825fba4f4ec 100644 --- a/src/gui/attributetable/qgsifeatureselectionmanager.h +++ b/src/gui/attributetable/qgsifeatureselectionmanager.h @@ -38,7 +38,7 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject /** * The number of features that are selected in this layer * - * \return See description + * \returns See description */ virtual int selectedFeatureCount() = 0; @@ -68,7 +68,7 @@ class GUI_EXPORT QgsIFeatureSelectionManager : public QObject /** * Return reference to identifiers of selected features * - * \return A list of { @link QgsFeatureId } 's + * \returns A list of { @link QgsFeatureId } 's * @see selectedFeatures() */ virtual const QgsFeatureIds &selectedFeatureIds() const = 0; diff --git a/src/gui/attributetable/qgsvectorlayerselectionmanager.h b/src/gui/attributetable/qgsvectorlayerselectionmanager.h index f1675f599a8..53de53d0cd4 100644 --- a/src/gui/attributetable/qgsvectorlayerselectionmanager.h +++ b/src/gui/attributetable/qgsvectorlayerselectionmanager.h @@ -35,7 +35,7 @@ class GUI_EXPORT QgsVectorLayerSelectionManager : public QgsIFeatureSelectionMan /** * The number of features that are selected in this layer * - * \return See description + * \returns See description */ virtual int selectedFeatureCount() override; @@ -65,7 +65,7 @@ class GUI_EXPORT QgsVectorLayerSelectionManager : public QgsIFeatureSelectionMan /** * Return reference to identifiers of selected features * - * \return A list of { @link QgsFeatureIds } + * \returns A list of { @link QgsFeatureIds } * @see selectedFeatures() */ virtual const QgsFeatureIds &selectedFeatureIds() const override; diff --git a/src/gui/editorwidgets/core/qgseditorconfigwidget.h b/src/gui/editorwidgets/core/qgseditorconfigwidget.h index d0f8e8aed1b..1b0359678fe 100644 --- a/src/gui/editorwidgets/core/qgseditorconfigwidget.h +++ b/src/gui/editorwidgets/core/qgseditorconfigwidget.h @@ -49,7 +49,7 @@ class GUI_EXPORT QgsEditorConfigWidget : public QWidget, public QgsExpressionCon /** * @brief Create a configuration from the current GUI state * - * \return A widget configuration + * \returns A widget configuration */ virtual QVariantMap config() = 0; @@ -63,14 +63,14 @@ class GUI_EXPORT QgsEditorConfigWidget : public QWidget, public QgsExpressionCon /** * Returns the field for which this configuration widget applies * - * \return The field index + * \returns The field index */ int field(); /** * Returns the layer for which this configuration widget applies * - * \return The layer + * \returns The layer */ QgsVectorLayer *layer(); diff --git a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h index 9b659ee4ea2..940c425db97 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetautoconf.h @@ -41,7 +41,7 @@ class GUI_EXPORT QgsEditorWidgetAutoConfPlugin * \param fieldName The field name on the specified layer for which this widget will be created * \param score Where the score is returned (default to 0) * - * \return and integer value rating how good is the setup provided by this plugin. + * \returns and integer value rating how good is the setup provided by this plugin. */ virtual QgsEditorWidgetSetup editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName, int &score ) const = 0; @@ -73,7 +73,7 @@ class GUI_EXPORT QgsEditorWidgetAutoConf * \param vl The vector layer for which this widget will be created * \param fieldName The field name on the specified layer for which this widget will be created * - * \return The best widget setup that was found + * \returns The best widget setup that was found */ QgsEditorWidgetSetup editorWidgetSetup( const QgsVectorLayer *vl, const QString &fieldName ) const; diff --git a/src/gui/editorwidgets/core/qgseditorwidgetfactory.h b/src/gui/editorwidgets/core/qgseditorwidgetfactory.h index ca66e71509a..e48b3cd1f04 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetfactory.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetfactory.h @@ -60,7 +60,7 @@ class GUI_EXPORT QgsEditorWidgetFactory * \param editor An editor widget if already existent. If NULL is provided, a new widget will be created. * \param parent The parent for the wrapper class and any created widget. * - * \return A new widget wrapper + * \returns A new widget wrapper */ virtual QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent ) const = 0; @@ -69,7 +69,7 @@ class GUI_EXPORT QgsEditorWidgetFactory /** * Return The human readable identifier name of this widget type * - * \return a name + * \returns a name */ QString name(); @@ -81,7 +81,7 @@ class GUI_EXPORT QgsEditorWidgetFactory * \param fieldIdx The field index for which the widget will be created * \param parent The parent widget of the created config widget * - * \return A configuration widget + * \returns A configuration widget */ virtual QgsEditorConfigWidget *configWidget( QgsVectorLayer *vl, int fieldIdx, QWidget *parent ) const = 0; @@ -90,7 +90,7 @@ class GUI_EXPORT QgsEditorWidgetFactory * * \param vl The layer * \param fieldIdx The field index - * \return True if the type is supported for this field + * \returns True if the type is supported for this field * * @see fieldScore( const QgsVectorLayer* vl, ind fieldIdx ) */ @@ -101,7 +101,7 @@ class GUI_EXPORT QgsEditorWidgetFactory * Each widget type can have a priority value attached, the factory with the highest one * will be used. * - * \return A map of widget type names and weight values + * \returns A map of widget type names and weight values * \note not available in Python bindings */ virtual QHash supportedWidgetTypes() { return QHash(); } @@ -119,7 +119,7 @@ class GUI_EXPORT QgsEditorWidgetFactory * * \param vl * \param fieldIdx - * \return 0 if the field is not supported or a bigger number if it can (the widget with the biggest number will be + * \returns 0 if the field is not supported or a bigger number if it can (the widget with the biggest number will be * taken by default). The default implementation returns 5.. * * @see supportsField( QgsVectorLayer* vl, fieldIdx ) diff --git a/src/gui/editorwidgets/core/qgseditorwidgetregistry.h b/src/gui/editorwidgets/core/qgseditorwidgetregistry.h index 2c70dc37855..26d500e38d1 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetregistry.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetregistry.h @@ -46,7 +46,7 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * This class is a singleton and has therefore to be accessed with this method instead * of a constructor. * - * \return The one and only instance of the editor widget registry + * \returns The one and only instance of the editor widget registry */ static QgsEditorWidgetRegistry *instance(); @@ -75,7 +75,7 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * \param vl The vector layer for which this widget will be created * \param fieldName The field name on the specified layer for which this widget will be created * - * \return The id of the widget type to use and its config + * \returns The id of the widget type to use and its config */ QgsEditorWidgetSetup findBest( const QgsVectorLayer *vl, const QString &fieldName ) const; @@ -91,7 +91,7 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * \param parent The parent which will be used for the created wrapper and the created widget * \param context The editor context (not available in Python bindings) * - * \return A new widget wrapper + * \returns A new widget wrapper */ QgsEditorWidgetWrapper *create( const QString &widgetId, QgsVectorLayer *vl, @@ -111,7 +111,7 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * \param parent The parent which will be used for the created wrapper and the created widget * \param context The editor context (not available in Python bindings) * - * \return A new widget wrapper + * \returns A new widget wrapper */ QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, @@ -134,7 +134,7 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * \param fieldIdx The field index on the specified layer for which this widget will be created * \param parent The parent widget for the created widget * - * \return A new configuration widget + * \returns A new configuration widget */ QgsEditorConfigWidget *createConfigWidget( const QString &widgetId, QgsVectorLayer *vl, int fieldIdx, QWidget *parent ); @@ -143,21 +143,21 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * * \param widgetId The widget type to get the name for * - * \return A human readable name + * \returns A human readable name */ QString name( const QString &widgetId ); /** * Get access to all registered factories * - * \return All ids and factories + * \returns All ids and factories */ QMap factories(); /** * Get a factory for the given widget type id. * - * \return A factory or Null if not existent + * \returns A factory or Null if not existent */ QgsEditorWidgetFactory *factory( const QString &widgetId ); @@ -167,7 +167,7 @@ class GUI_EXPORT QgsEditorWidgetRegistry : public QObject * \param widgetId The id which will be used later to refer to this widget type * \param widgetFactory The factory which will create this widget type * - * \return true, if successful, false, if the widgetId is already in use or widgetFactory is NULL + * \returns true, if successful, false, if the widgetId is already in use or widgetFactory is NULL */ bool registerWidget( const QString &widgetId, QgsEditorWidgetFactory *widgetFactory ); diff --git a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h index 08cf23d64b4..777b48b9714 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h @@ -70,14 +70,14 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper * If an invalid variant is returned this will be interpreted as no change. * Be sure to return a NULL QVariant if it should be set to NULL. * - * \return The current value the widget represents + * \returns The current value the widget represents */ virtual QVariant value() const = 0; /** * Access the field index. * - * \return The index of the field you are working on + * \returns The index of the field you are working on * * @see layer() */ @@ -86,7 +86,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Access the field. * - * \return The field you are working on + * \returns The field you are working on * * @see layer() */ @@ -95,7 +95,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Access the default value of the field. * - * \return the default value of the field + * \returns the default value of the field * * @see layer() */ @@ -104,14 +104,14 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Will return a wrapper for a given widget * \param widget The widget which was created by a wrapper - * \return The wrapper for the widget or NULL + * \returns The wrapper for the widget or NULL */ static QgsEditorWidgetWrapper *fromWidget( QWidget *widget ); /** * Check if the given widget or one of its parent is a QTableView. * \param parent the widget to check - * \return true if yes + * \returns true if yes */ static bool isInTable( const QWidget *parent ); @@ -139,7 +139,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper /** * Get the current constraint status. - * \return true if the constraint is valid or if there's no constraint, + * \returns true if the constraint is valid or if there's no constraint, * false otherwise * \since QGIS 2.16 * @see constraintFailureReason() diff --git a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h index e4776116fc2..fac719210b9 100644 --- a/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgssearchwidgetwrapper.h @@ -108,7 +108,7 @@ class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper * If an invalid variant is returned this will be interpreted as no change. * Be sure to return a NULL QVariant if it should be set to NULL. * - * \return The current value the widget represents + * \returns The current value the widget represents */ virtual QString expression() = 0; diff --git a/src/gui/editorwidgets/core/qgswidgetwrapper.h b/src/gui/editorwidgets/core/qgswidgetwrapper.h index f8c3731365c..87dd7b2526f 100644 --- a/src/gui/editorwidgets/core/qgswidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgswidgetwrapper.h @@ -68,7 +68,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject /** * @brief Access the widget managed by this wrapper * - * \return The widget + * \returns The widget */ QWidget *widget(); @@ -76,7 +76,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * @brief Access the widget managed by this wrapper and cast it to a given type * Example: QPushButton* pb = wrapper->widget(); * - * \return The widget as template type or NULL, if it cannot be cast to this type. + * \returns The widget as template type or NULL, if it cannot be cast to this type. */ template T *widget() { return dynamic_cast( mWidget ); } @@ -101,28 +101,28 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * \param key The configuration option you want to load * \param defaultVal Default value * - * \return the value assigned to this configuration option + * \returns the value assigned to this configuration option */ QVariant config( const QString &key, const QVariant &defaultVal = QVariant() ) const; /** * Returns the whole config * - * \return The configuration + * \returns The configuration */ QVariantMap config() const; /** * Returns information about the context in which this widget is shown * - * \return context information + * \returns context information */ const QgsAttributeEditorContext &context() const; /** * Access the QgsVectorLayer, you are working on * - * \return The layer + * \returns The layer * * @see field() */ @@ -131,7 +131,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject /** * Will return a wrapper for a given widget * \param widget The widget which was created by a wrapper - * \return The wrapper for the widget or NULL + * \returns The wrapper for the widget or NULL */ static QgsWidgetWrapper *fromWidget( QWidget *widget ); @@ -142,7 +142,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * If it cannot be used this is a hint to the caller that he may try to find * another suitable widget type instead. * - * \return Validity status of this widget. + * \returns Validity status of this widget. * * \since QGIS 2.12 */ @@ -179,7 +179,7 @@ class GUI_EXPORT QgsWidgetWrapper : public QObject * in {@link initWidget(QWidget*)}. * * \param parent You should set this parent on the created widget. - * \return A new widget + * \returns A new widget */ virtual QWidget *createWidget( QWidget *parent ) = 0; diff --git a/src/gui/editorwidgets/qgsrelationreferencefactory.h b/src/gui/editorwidgets/qgsrelationreferencefactory.h index 48059d38bd2..34c655ce36d 100644 --- a/src/gui/editorwidgets/qgsrelationreferencefactory.h +++ b/src/gui/editorwidgets/qgsrelationreferencefactory.h @@ -43,7 +43,7 @@ class GUI_EXPORT QgsRelationReferenceFactory : public QgsEditorWidgetFactory * \param editor An editor widget if already existent. If NULL is provided, a new widget will be created. * \param parent The parent for the wrapper class and any created widget. * - * \return A new widget wrapper + * \returns A new widget wrapper */ virtual QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent ) const override; @@ -57,7 +57,7 @@ class GUI_EXPORT QgsRelationReferenceFactory : public QgsEditorWidgetFactory * \param fieldIdx The field index for which the widget will be created * \param parent The parent widget of the created config widget * - * \return A configuration widget + * \returns A configuration widget */ virtual QgsEditorConfigWidget *configWidget( QgsVectorLayer *vl, int fieldIdx, QWidget *parent ) const override; diff --git a/src/gui/editorwidgets/qgsrelationreferencewidget.h b/src/gui/editorwidgets/qgsrelationreferencewidget.h index 99f94b1ebb5..5d847661307 100644 --- a/src/gui/editorwidgets/qgsrelationreferencewidget.h +++ b/src/gui/editorwidgets/qgsrelationreferencewidget.h @@ -100,7 +100,7 @@ class GUI_EXPORT QgsRelationReferenceWidget : public QWidget /** * Determines if the filters are chained * - * \return True if filters are chained + * \returns True if filters are chained */ bool chainFilters() const { return mChainFilters; } diff --git a/src/gui/qgisgui.h b/src/gui/qgisgui.h index 80b66ab9e17..2718f16d1a8 100644 --- a/src/gui/qgisgui.h +++ b/src/gui/qgisgui.h @@ -97,7 +97,7 @@ namespace QgisGui * \param parent widget that should act as the parent for the file dialog * \param message the message to display to the user * \param defaultFilename default file name (empty by default) - * \return QPair where first is the file name and second is + * \returns QPair where first is the file name and second is * the file type */ QPair GUI_EXPORT getSaveAsImageName( QWidget *parent, const QString &message, const QString &defaultFilename = QString::null ); @@ -116,7 +116,7 @@ namespace QgisGui * Create file filters suitable for use with QFileDialog * * \param format extension e.g. "png" - * \return QString e.g. "PNG format (*.png, *.PNG)" + * \returns QString e.g. "PNG format (*.png, *.PNG)" */ QString GUI_EXPORT createFileFilter_( QString const &format ); @@ -125,7 +125,7 @@ namespace QgisGui * \param ok true on ok, false on cancel * \param initial initial font * \param title optional dialog title - * \return QFont the selected fon + * \returns QFont the selected fon */ QFont GUI_EXPORT getFont( bool &ok, const QFont &initial, const QString &title = QString() ); } diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h index c74e2029da1..55423a0306d 100644 --- a/src/gui/qgisinterface.h +++ b/src/gui/qgisinterface.h @@ -170,7 +170,7 @@ class GUI_EXPORT QgisInterface : public QObject * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addToolBarWidget( QWidget *widget ) = 0; @@ -183,7 +183,7 @@ class GUI_EXPORT QgisInterface : public QObject * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addRasterToolBarWidget( QWidget *widget ) = 0; @@ -202,7 +202,7 @@ class GUI_EXPORT QgisInterface : public QObject * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addVectorToolBarWidget( QWidget *widget ) = 0; @@ -218,7 +218,7 @@ class GUI_EXPORT QgisInterface : public QObject * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addDatabaseToolBarWidget( QWidget *widget ) = 0; @@ -234,7 +234,7 @@ class GUI_EXPORT QgisInterface : public QObject * with the returned QAction. * * \param widget widget to add. The toolbar will take ownership of this widget - * \return the QAction you can use to remove this widget from the toolbar + * \returns the QAction you can use to remove this widget from the toolbar */ virtual QAction *addWebToolBarWidget( QWidget *widget ) = 0; @@ -617,7 +617,7 @@ class GUI_EXPORT QgisInterface : public QObject * \param l The layer for which the dialog will be created * \param f The feature for which the dialog will be created * - * \return A feature form + * \returns A feature form */ virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *l, QgsFeature &f ) = 0; @@ -626,7 +626,7 @@ class GUI_EXPORT QgisInterface : public QObject * With the help of this you can access methods like addFeature, startEditing * or stopEditing while giving the user the appropriate dialogs. * - * \return An instance of the vector layer tools + * \returns An instance of the vector layer tools */ virtual QgsVectorLayerTools *vectorLayerTools() = 0; diff --git a/src/gui/qgsadvanceddigitizingdockwidget.h b/src/gui/qgsadvanceddigitizingdockwidget.h index 4db14ef2609..82b2425d7fc 100644 --- a/src/gui/qgsadvanceddigitizingdockwidget.h +++ b/src/gui/qgsadvanceddigitizingdockwidget.h @@ -119,7 +119,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** * The current lock mode of this constraint - * \return Lock mode + * \returns Lock mode */ LockMode lockMode() const { return mLockMode; } @@ -216,7 +216,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private * Will react on a canvas press event * * \param e A mouse event (may be modified) - * \return If the event is hidden (construction mode hides events from the maptool) + * \returns If the event is hidden (construction mode hides events from the maptool) */ bool canvasPressEvent( QgsMapMouseEvent *e ); @@ -225,7 +225,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private * * \param e A mouse event (may be modified) * \param mode determines if the dock has to record one, two or many points. - * \return If the event is hidden (construction mode hides events from the maptool) + * \returns If the event is hidden (construction mode hides events from the maptool) */ bool canvasReleaseEvent( QgsMapMouseEvent *e, AdvancedDigitizingMode mode ); @@ -233,7 +233,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private * Will react on a canvas move event * * \param e A mouse event (may be modified) - * \return If the event is hidden (construction mode hides events from the maptool) + * \returns If the event is hidden (construction mode hides events from the maptool) */ bool canvasMoveEvent( QgsMapMouseEvent *e ); @@ -241,12 +241,12 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private * Filter key events to e.g. toggle construction mode or adapt constraints * * \param e A mouse event (may be modified) - * \return If the event is hidden (construction mode hides events from the maptool) + * \returns If the event is hidden (construction mode hides events from the maptool) */ 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. - //! \return false if no solution was found (invalid constraints) + //! \returns false if no solution was found (invalid constraints) virtual bool applyConstraints( QgsMapMouseEvent *e ); /** @@ -256,7 +256,7 @@ class GUI_EXPORT QgsAdvancedDigitizingDockWidget : public QgsDockWidget, private /** * The snapping mode - * \return Snapping mode + * \returns Snapping mode */ QgsMapMouseEvent::SnappingMode snappingMode() { return mSnappingMode; } diff --git a/src/gui/qgsattributedialog.h b/src/gui/qgsattributedialog.h index 4c61045d216..bbfab0f9b0c 100644 --- a/src/gui/qgsattributedialog.h +++ b/src/gui/qgsattributedialog.h @@ -76,7 +76,7 @@ class GUI_EXPORT QgsAttributeDialog : public QDialog /** * Is this dialog editable? * - * \return returns true, if this dialog was created in an editable manner. + * \returns returns true, if this dialog was created in an editable manner. */ bool editable() { return mAttributeForm->editable(); } @@ -99,7 +99,7 @@ class GUI_EXPORT QgsAttributeDialog : public QDialog * * \param e The event * - * \return The same as the parent QDialog + * \returns The same as the parent QDialog */ virtual bool event( QEvent *e ) override; diff --git a/src/gui/qgsattributeform.h b/src/gui/qgsattributeform.h index 70ca03d65ff..d2920782c93 100644 --- a/src/gui/qgsattributeform.h +++ b/src/gui/qgsattributeform.h @@ -96,14 +96,14 @@ class GUI_EXPORT QgsAttributeForm : public QWidget /** * Returns the layer for which this form is shown * - * \return Layer + * \returns Layer */ QgsVectorLayer *layer() { return mLayer; } /** * Returns if the form is currently in editable mode. * - * \return Editable mode of this form + * \returns Editable mode of this form */ bool editable(); @@ -133,7 +133,7 @@ class GUI_EXPORT QgsAttributeForm : public QWidget * \param object The object for which the event has been sent * \param event The event which is being filtered * - * \return true if the event has been handled (key was ESC) + * \returns true if the event has been handled (key was ESC) */ bool eventFilter( QObject *object, QEvent *event ) override; @@ -218,7 +218,7 @@ class GUI_EXPORT QgsAttributeForm : public QWidget /** * Save all the values from the editors to the layer. * - * \return True if successful + * \returns True if successful */ bool save(); diff --git a/src/gui/qgsattributetypeloaddialog.h b/src/gui/qgsattributetypeloaddialog.h index a91ce53c0c8..2a7e4c5eeb0 100644 --- a/src/gui/qgsattributetypeloaddialog.h +++ b/src/gui/qgsattributetypeloaddialog.h @@ -52,14 +52,14 @@ class GUI_EXPORT QgsAttributeTypeLoadDialog: public QDialog, private Ui::QgsAttr /** * Getter to value map which is currently active - * \return value map of vlues selected from layer + * \returns value map of vlues selected from layer */ QMap &valueMap(); /** * Returns true if the "Add NULL value" checkbox has been checked. * - * \return true if the "Add NULL value" checkbox has been checked. + * \returns true if the "Add NULL value" checkbox has been checked. */ bool insertNull(); diff --git a/src/gui/qgscolordialog.h b/src/gui/qgscolordialog.h index 3a01cde675d..8f8d71e832a 100644 --- a/src/gui/qgscolordialog.h +++ b/src/gui/qgscolordialog.h @@ -68,7 +68,7 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase * \param parent parent widget * \param title the title of the dialog. * \param allowAlpha set to true to allow modification of color alpha value (transparency) - * \return Selected color on accepted() or initialColor on rejected(). + * \returns Selected color on accepted() or initialColor on rejected(). * @see getColor */ static QColor getLiveColor( const QColor &initialColor, QObject *updateObject, const char *updateSlot, @@ -81,7 +81,7 @@ class GUI_EXPORT QgsColorDialog : public QDialog, private Ui::QgsColorDialogBase * \param parent parent widget * \param title the title of the dialog. * \param allowAlpha set to true to allow modification of color alpha value (transparency) - * \return Selected color on accepted() or initialColor on rejected(). + * \returns Selected color on accepted() or initialColor on rejected(). * @see getLiveColor */ static QColor getColor( const QColor &initialColor, QWidget *parent, const QString &title = QString(), diff --git a/src/gui/qgsexpressionbuilderwidget.h b/src/gui/qgsexpressionbuilderwidget.h index 6449557679f..1c7e73dc0ff 100644 --- a/src/gui/qgsexpressionbuilderwidget.h +++ b/src/gui/qgsexpressionbuilderwidget.h @@ -70,7 +70,7 @@ class QgsExpressionItem : public QStandardItem /** Get the help text that is associated with this expression item. * - * \return The help text. + * \returns The help text. */ QString getHelpText() const { return mHelpText; } @@ -82,7 +82,7 @@ class QgsExpressionItem : public QStandardItem /** Get the type of expression item, e.g., header, field, ExpressionNode. * - * \return The QgsExpressionItem::ItemType + * \returns The QgsExpressionItem::ItemType */ QgsExpressionItem::ItemType getItemType() const { return mType; } diff --git a/src/gui/qgsexpressionselectiondialog.h b/src/gui/qgsexpressionselectiondialog.h index 37b3c8ff9e6..ee3a8e6e328 100644 --- a/src/gui/qgsexpressionselectiondialog.h +++ b/src/gui/qgsexpressionselectiondialog.h @@ -46,7 +46,7 @@ class GUI_EXPORT QgsExpressionSelectionDialog : public QDialog, private Ui::QgsE /** * The builder widget that is used by the dialog - * \return The builder widget that is used by the dialog + * \returns The builder widget that is used by the dialog */ QgsExpressionBuilderWidget *expressionBuilder(); @@ -58,7 +58,7 @@ class GUI_EXPORT QgsExpressionSelectionDialog : public QDialog, private Ui::QgsE /** * Returns the current expression text - * \return The expression text + * \returns The expression text */ QString expressionText(); diff --git a/src/gui/qgsfeatureselectiondlg.h b/src/gui/qgsfeatureselectiondlg.h index b9f29b2dd03..22f02e1872d 100644 --- a/src/gui/qgsfeatureselectiondlg.h +++ b/src/gui/qgsfeatureselectiondlg.h @@ -34,7 +34,7 @@ class GUI_EXPORT QgsFeatureSelectionDlg : public QDialog, private Ui::QgsFeature /** * Get the selected features * - * \return The selected feature ids + * \returns The selected feature ids */ const QgsFeatureIds &selectedFeatures(); diff --git a/src/gui/qgsfilterlineedit.h b/src/gui/qgsfilterlineedit.h index b142b506cae..9fecd727d51 100644 --- a/src/gui/qgsfilterlineedit.h +++ b/src/gui/qgsfilterlineedit.h @@ -145,7 +145,7 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit * in the widget matches the current nullValue() then the returned value will be * a null string. * - * \return Current text (or null string if it matches the nullValue() property ) + * \returns Current text (or null string if it matches the nullValue() property ) * @see setValue() */ QString value() const { return isNull() ? QString::null : text(); } @@ -153,7 +153,7 @@ class GUI_EXPORT QgsFilterLineEdit : public QLineEdit /** * Determine if the current text represents null. * - * \return True if the widget's value is null. + * \returns True if the widget's value is null. * @see nullValue() */ inline bool isNull() const { return text() == mNullValue; } diff --git a/src/gui/qgskeyvaluewidget.h b/src/gui/qgskeyvaluewidget.h index 3c4b73358ed..661cd4d9f92 100644 --- a/src/gui/qgskeyvaluewidget.h +++ b/src/gui/qgskeyvaluewidget.h @@ -76,7 +76,7 @@ class GUI_EXPORT QgsKeyValueWidget: public QgsTableWidgetBase /** * Get the edit value. - * \return the QVariantMap + * \returns the QVariantMap */ QVariantMap map() const { return mModel.map(); } diff --git a/src/gui/qgslistwidget.h b/src/gui/qgslistwidget.h index 5383b824413..8db60879b4c 100644 --- a/src/gui/qgslistwidget.h +++ b/src/gui/qgslistwidget.h @@ -76,13 +76,13 @@ class GUI_EXPORT QgsListWidget: public QgsTableWidgetBase /** * Get the edit value. - * \return the QVariantList + * \returns the QVariantList */ QVariantList list() const { return mModel.list(); } /** * Check the content is valid - * \return true if valid + * \returns true if valid */ bool valid() const { return mModel.valid(); } diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h index b824ebb6cdf..3db8c2e9be9 100644 --- a/src/gui/qgsmapcanvas.h +++ b/src/gui/qgsmapcanvas.h @@ -833,7 +833,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView \param layer the layer \param bbox out: bounding box \param errorMsg error message in case of error - \return true in case of success*/ + \returns true in case of success*/ bool boundingBoxOfFeatureIds( const QgsFeatureIds &ids, QgsVectorLayer *layer, QgsRectangle &bbox, QString &errorMsg ) const; void setLayersPrivate( const QList &layers ); diff --git a/src/gui/qgsmapcanvasitem.h b/src/gui/qgsmapcanvasitem.h index 425a0816ceb..82093b2eac3 100644 --- a/src/gui/qgsmapcanvasitem.h +++ b/src/gui/qgsmapcanvasitem.h @@ -50,7 +50,7 @@ class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem /** Sets render context parameters \param p painter for rendering \param context out: configured context - \return true in case of success */ + \returns true in case of success */ bool setRenderContextVariables( QPainter *p, QgsRenderContext &context ) const; public: diff --git a/src/gui/qgsmapcanvassnapper.h b/src/gui/qgsmapcanvassnapper.h index 1b80ee6dad4..a7d08cb4241 100644 --- a/src/gui/qgsmapcanvassnapper.h +++ b/src/gui/qgsmapcanvassnapper.h @@ -69,7 +69,7 @@ class GUI_EXPORT QgsMapCanvasSnapper * \param p start point of the snap (in pixel coordinates) * \param results snapped points * \param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position - * \return 0 in case of success + * \returns 0 in case of success */ int snapToBackgroundLayers( QPoint p, QList &results, const QList &excludePoints = QList() ); diff --git a/src/gui/qgsmaplayerconfigwidgetfactory.h b/src/gui/qgsmaplayerconfigwidgetfactory.h index 7fc45e62828..fe324c4cd2d 100644 --- a/src/gui/qgsmaplayerconfigwidgetfactory.h +++ b/src/gui/qgsmaplayerconfigwidgetfactory.h @@ -42,7 +42,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory /** * @brief The icon that will be shown in the UI for the panel. - * \return A QIcon for the panel icon. + * \returns A QIcon for the panel icon. */ virtual QIcon icon() const { return mIcon; } @@ -55,7 +55,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory /** * @brief The title of the panel. * \note This may or may not be shown to the user. - * \return Title of the panel + * \returns Title of the panel */ virtual QString title() const { return mTitle; } @@ -69,7 +69,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory /** * Flag if widget is supported for use in style dock. - * \return True if supported + * \returns True if supported */ virtual bool supportsStyleDock() const { return false; } @@ -81,7 +81,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory /** * Flag if widget is supported for use in layer properties dialog. - * \return True if supported + * \returns True if supported */ virtual bool supportLayerPropertiesDialog() const { return false; } @@ -93,7 +93,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory /** * @brief Check if the layer is supported for this widget. - * \return True if this layer is supported for this widget + * \returns True if this layer is supported for this widget */ virtual bool supportsLayer( QgsMapLayer *layer ) const; @@ -104,7 +104,7 @@ class GUI_EXPORT QgsMapLayerConfigWidgetFactory * \param canvas The map canvas. * \param dockWidget True of the widget will be shown a dock style widget. * \param parent The parent of the widget. - * \return A new QgsMapStylePanel which is shown in the map style dock. + * \returns A new QgsMapStylePanel which is shown in the map style dock. */ virtual QgsMapLayerConfigWidget *createWidget( QgsMapLayer *layer, QgsMapCanvas *canvas, bool dockWidget = true, QWidget *parent = 0 ) const = 0; diff --git a/src/gui/qgsmapmouseevent.h b/src/gui/qgsmapmouseevent.h index 283afab4b0f..85bd7bf4f90 100644 --- a/src/gui/qgsmapmouseevent.h +++ b/src/gui/qgsmapmouseevent.h @@ -83,19 +83,19 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent * Returns true if there is a snapped point cached. * Will only be useful after snapPoint has previously been called. * - * \return True if there is a snapped point cached. + * \returns True if there is a snapped point cached. */ bool isSnapped() const { return mSnapMatch.isValid(); } /** * @brief mapPoint returns the point in coordinates - * \return the point in map coordinates, after snapping if requested in the event. + * \returns the point in map coordinates, after snapping if requested in the event. */ inline QgsPoint mapPoint() const { return mMapPoint; } /** * Returns the matching data from the most recently snapped point. - * \return the snapping data structure + * \returns the snapping data structure * \since QGIS 2.14 */ QgsPointLocator::Match mapPointMatch() const { return mSnapMatch; } @@ -111,14 +111,14 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent /** * Returns the original, unmodified map point of the mouse cursor. * - * \return The cursor position in map coordinates. + * \returns The cursor position in map coordinates. */ QgsPoint originalMapPoint() const { return mMapPoint; } /** * The snapped mouse cursor in pixel coordinates. * - * \return The snapped mouse cursor position in pixel coordinates. + * \returns The snapped mouse cursor position in pixel coordinates. */ QPoint pixelPoint() const { return mPixelPoint; } @@ -126,7 +126,7 @@ class GUI_EXPORT QgsMapMouseEvent : public QMouseEvent * The unsnapped, real mouse cursor position in pixel coordinates. * Alias to pos() * - * \return Mouse position in pixel coordinates + * \returns Mouse position in pixel coordinates */ QPoint originalPixelPoint() const { return pos(); } diff --git a/src/gui/qgsmaptooladvanceddigitizing.h b/src/gui/qgsmaptooladvanceddigitizing.h index caf183dfe37..025f03e0f43 100644 --- a/src/gui/qgsmaptooladvanceddigitizing.h +++ b/src/gui/qgsmaptooladvanceddigitizing.h @@ -62,7 +62,7 @@ class GUI_EXPORT QgsMapToolAdvancedDigitizing : public QgsMapToolEdit /** * The capture mode * - * \return Capture mode + * \returns Capture mode */ CaptureMode mode() const { return mCaptureMode; } diff --git a/src/gui/qgsmaptoolcapture.h b/src/gui/qgsmaptoolcapture.h index 225fbc1c04c..b2f1a8f1108 100644 --- a/src/gui/qgsmaptoolcapture.h +++ b/src/gui/qgsmaptoolcapture.h @@ -52,7 +52,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** * Get the capture curve * - * \return Capture curve + * \returns Capture curve */ const QgsCompoundCurve *captureCurve() const { return &mCaptureCurve; } @@ -84,7 +84,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** Converts a map point to layer coordinates * \param mapPoint the point in map coordinates * \param[in,out] layerPoint the point in layer coordinates - * \return + * \returns * 0 in case of success * 1 if the current layer is null or not a vector layer * 2 if the transformation failed @@ -96,7 +96,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing * \param p the input point * \param[in,out] layerPoint the point in layer coordinates * \param[in,out] mapPoint the point in map coordinates - * \return + * \returns * 0 in case of success * 1 if the current layer is null or not a vector layer * 2 if the transformation failed @@ -106,14 +106,14 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** Fetches the original point from the source layer if it has the same * CRS as the current layer. - * \return 0 in case of success, 1 if not applicable (CRS mismatch), 2 in case of failure + * \returns 0 in case of success, 1 if not applicable (CRS mismatch), 2 in case of failure * \since QGIS 2.14 */ // TODO QGIS 3.0 returns an enum instead of a magic constant int fetchLayerPoint( const QgsPointLocator::Match &match, QgsPointV2 &layerPoint ); /** Adds a point to the rubber band (in map coordinates) and to the capture list (in layer coordinates) - * \return 0 in case of success, 1 if current layer is not a vector layer, 2 if coordinate transformation failed + * \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 QgsPoint &point ); @@ -136,7 +136,7 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** * Are we currently capturing? * - * \return Is the tool in capture mode? + * \returns Is the tool in capture mode? */ bool isCapturing() const; @@ -148,13 +148,13 @@ class GUI_EXPORT QgsMapToolCapture : public QgsMapToolAdvancedDigitizing /** * Number of points digitized * - * \return Number of points + * \returns Number of points */ int size(); /** * List of digitized points - * \return List of points + * \returns List of points */ QList points(); diff --git a/src/gui/qgsmaptooledit.h b/src/gui/qgsmaptooledit.h index 7d6a90f0fbf..72204d536e1 100644 --- a/src/gui/qgsmaptooledit.h +++ b/src/gui/qgsmaptooledit.h @@ -67,7 +67,7 @@ class GUI_EXPORT QgsMapToolEdit: public QgsMapTool /** 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) - * \return 0 in case of success + * \returns 0 in case of success */ int addTopologicalPoints( const QList &geom ); diff --git a/src/gui/qgsmaptoolidentify.h b/src/gui/qgsmaptoolidentify.h index b1f634f9990..df5f3ebe1d6 100644 --- a/src/gui/qgsmaptoolidentify.h +++ b/src/gui/qgsmaptoolidentify.h @@ -105,7 +105,7 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool \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. \param mode Identification mode. Can use Qgis default settings or a defined mode. Default mode is DefaultQgsSetting. - \return a list of IdentifyResult*/ + \returns a list of IdentifyResult*/ QList identify( int x, int y, const QList &layerList = QList(), IdentifyMode mode = DefaultQgsSetting ); /** Performs the identification. @@ -115,7 +115,7 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool \param y y coordinates of mouseEvent \param mode Identification mode. Can use Qgis default settings or a defined mode. \param layerType Only performs identification in a certain type of layers (raster, vector). Default value is AllLayers. - \return a list of IdentifyResult*/ + \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 @@ -140,7 +140,7 @@ class GUI_EXPORT QgsMapToolIdentify : public QgsMapTool \param mode Identification mode. Can use Qgis default settings or a defined mode. \param layerList Performs the identification within the given list of layers. \param layerType Only performs identification in a certain type of layers (raster, vector). - \return a list of IdentifyResult*/ + \returns a list of IdentifyResult*/ QList identify( int x, int y, IdentifyMode mode, const QList &layerList, LayerType layerType = AllLayers ); QgsIdentifyMenu *mIdentifyMenu = nullptr; diff --git a/src/gui/qgsmessagebar.h b/src/gui/qgsmessagebar.h index fe64e4f6345..cd0a51a1bad 100644 --- a/src/gui/qgsmessagebar.h +++ b/src/gui/qgsmessagebar.h @@ -75,7 +75,7 @@ class GUI_EXPORT QgsMessageBar: public QFrame /** 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 - * \return true if the widget was removed, false otherwise + * \returns true if the widget was removed, false otherwise */ bool popWidget( QgsMessageBarItem *item ); @@ -104,12 +104,12 @@ class GUI_EXPORT QgsMessageBar: public QFrame /** Remove the currently displayed widget from the bar and * display the next in the stack if any or hide the bar. - * \return true if the widget was removed, false otherwise + * \returns true if the widget was removed, false otherwise */ bool popWidget(); /** Remove all items from the bar's widget list - * \return true if all items were removed, false otherwise + * \returns true if all items were removed, false otherwise */ bool clearWidgets(); diff --git a/src/gui/qgsnewnamedialog.h b/src/gui/qgsnewnamedialog.h index e21520116a6..0394becacd2 100644 --- a/src/gui/qgsnewnamedialog.h +++ b/src/gui/qgsnewnamedialog.h @@ -91,7 +91,7 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog QString conflictingNameWarning() const { return mConflictingNameWarning; } /** Name entered by user. - * \return new name + * \returns new name */ QString name() const; @@ -100,7 +100,7 @@ class GUI_EXPORT QgsNewNameDialog : public QgsDialog * \param extensions base name extensions * \param existing existing names * \param cs case sensitivity for new name to existing names comparison - * \return true if name exists + * \returns true if name exists */ static bool exists( const QString &name, const QStringList &extensions, const QStringList &existing, Qt::CaseSensitivity cs = Qt::CaseSensitive ); diff --git a/src/gui/qgsoptionsdialogbase.h b/src/gui/qgsoptionsdialogbase.h index a14f044b3cc..09da6723251 100644 --- a/src/gui/qgsoptionsdialogbase.h +++ b/src/gui/qgsoptionsdialogbase.h @@ -64,7 +64,7 @@ class GUI_EXPORT QgsSearchHighlightOptionWidget : public QObject /** * search for a text pattern and highlight the widget if the text is found - * \return true if the text pattern is found + * \returns true if the text pattern is found */ bool searchHighlight( const QString &searchText ); diff --git a/src/gui/qgsoptionswidgetfactory.h b/src/gui/qgsoptionswidgetfactory.h index 8019aec4c2d..dd95ae4c12a 100644 --- a/src/gui/qgsoptionswidgetfactory.h +++ b/src/gui/qgsoptionswidgetfactory.h @@ -69,7 +69,7 @@ class GUI_EXPORT QgsOptionsWidgetFactory /** * @brief The icon that will be shown in the UI for the panel. - * \return A QIcon for the panel icon. + * \returns A QIcon for the panel icon. * @see setIcon() */ virtual QIcon icon() const { return mIcon; } @@ -95,7 +95,7 @@ class GUI_EXPORT QgsOptionsWidgetFactory /** * @brief Factory function to create the widget on demand as needed by the options dialog. * \param parent The parent of the widget. - * \return A new widget to show as a page in the options dialog. + * \returns A new widget to show as a page in the options dialog. */ virtual QgsOptionsPageWidget *createWidget( QWidget *parent = nullptr ) const = 0; diff --git a/src/gui/qgsowssourceselect.h b/src/gui/qgsowssourceselect.h index 11bd7d195e9..0c2818e4dc1 100644 --- a/src/gui/qgsowssourceselect.h +++ b/src/gui/qgsowssourceselect.h @@ -115,7 +115,7 @@ class GUI_EXPORT QgsOWSSourceSelect : public QDialog, public Ui::QgsOWSSourceSel /** * List of image formats (encodings) supported by provider - * \return list of format/label pairs + * \returns list of format/label pairs */ virtual QList providerFormats(); diff --git a/src/gui/qgspanelwidget.h b/src/gui/qgspanelwidget.h index 5df962da0ef..133bab6d63f 100644 --- a/src/gui/qgspanelwidget.h +++ b/src/gui/qgspanelwidget.h @@ -42,7 +42,7 @@ class GUI_EXPORT QgsPanelWidget : public QWidget /** * The title of the panel. - * \return The title pf the panel. + * \returns The title pf the panel. */ QString panelTitle() { return mPanelTitle; } @@ -73,7 +73,7 @@ class GUI_EXPORT QgsPanelWidget : public QWidget /** * Return the dock mode state. - * \return True if in dock mode. If in dock mode the widget + * \returns True if in dock mode. If in dock mode the widget * will emit the showPanel signal to handle panel opening * If false it will open dialogs when openPanel is called. */ @@ -190,7 +190,7 @@ class GUI_EXPORT QgsPanelWidgetWrapper: public QgsPanelWidget /** * Returns the internal widget that is wrapped in this panel. - * \return The internal widget. Can be nullptr. + * \returns The internal widget. Can be nullptr. */ QWidget *widget() { return mWidget; } diff --git a/src/gui/qgspanelwidgetstack.h b/src/gui/qgspanelwidgetstack.h index 4cae44864d0..7e987421801 100644 --- a/src/gui/qgspanelwidgetstack.h +++ b/src/gui/qgspanelwidgetstack.h @@ -58,7 +58,7 @@ class GUI_EXPORT QgsPanelWidgetStack : public QWidget, private Ui::QgsRendererWi /** * The main panel widget that is set in the stack. The main widget can not be closed * and doesn't display a back button. - * \return The main QgsPanelWidget that is active in the stack. + * \returns The main QgsPanelWidget that is active in the stack. * @see setMainPanel() */ QgsPanelWidget *mainPanel(); @@ -66,7 +66,7 @@ class GUI_EXPORT QgsPanelWidgetStack : public QWidget, private Ui::QgsRendererWi /** * Removes the main panel widget from the stack and transfers ownsership to the * caller. - * \return The main widget that is set in the stack. + * \returns The main widget that is set in the stack. * \note Calling this will clear out any current stacked panels by accepting * each panel in turn. * @see mainPanel() diff --git a/src/gui/qgspixmaplabel.h b/src/gui/qgspixmaplabel.h index 059f90c9648..b4d80620b99 100644 --- a/src/gui/qgspixmaplabel.h +++ b/src/gui/qgspixmaplabel.h @@ -34,14 +34,14 @@ class GUI_EXPORT QgsPixmapLabel : public QLabel * Calculates the height for the given width. * * \param width The width for the widget - * \return An appropriate height + * \returns An appropriate height */ virtual int heightForWidth( int width ) const override; /** * An optimal size for the widget. Effectively using the height * determined from the width with the given aspect ratio. - * \return A size hint + * \returns A size hint */ virtual QSize sizeHint() const override; diff --git a/src/gui/qgsprojectionselectiontreewidget.h b/src/gui/qgsprojectionselectiontreewidget.h index 42891f19fd3..f2ad0d93d2d 100644 --- a/src/gui/qgsprojectionselectiontreewidget.h +++ b/src/gui/qgsprojectionselectiontreewidget.h @@ -161,7 +161,7 @@ class GUI_EXPORT QgsProjectionSelectionTreeWidget : public QWidget, private Ui:: * 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. - * \return The string made safe for SQL statements. + * \returns The string made safe for SQL statements. */ const QString sqlSafeString( const QString &theSQL ); diff --git a/src/gui/qgsrubberband.h b/src/gui/qgsrubberband.h index 815642953e2..e83408741a6 100644 --- a/src/gui/qgsrubberband.h +++ b/src/gui/qgsrubberband.h @@ -215,7 +215,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Returns number of vertices in feature part * \param geometryIndex The index of the feature part (in case of multipart geometries) - * \return number of vertices + * \returns number of vertices */ int partSize( int geometryIndex ) const; @@ -257,13 +257,13 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Returns number of geometries - * \return number of geometries + * \returns number of geometries */ int size() const; /** * Returns count of vertices in all lists of mPoint - * \return The total number of vertices + * \returns The total number of vertices */ int numberOfVertices() const; @@ -276,7 +276,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem /** * Returns the rubberband as a Geometry - * \return A geometry object which reflects the current state of the rubberband. + * \returns A geometry object which reflects the current state of the rubberband. */ QgsGeometry asGeometry() const; diff --git a/src/gui/qgssearchquerybuilder.h b/src/gui/qgssearchquerybuilder.h index 4701d535dc7..bee15f580a9 100644 --- a/src/gui/qgssearchquerybuilder.h +++ b/src/gui/qgssearchquerybuilder.h @@ -104,7 +104,7 @@ class GUI_EXPORT QgsSearchQueryBuilder : public QDialog, private Ui::QgsQueryBui void setupListViews(); /** Get the number of records that would be returned by the current SQL - * \return Number of records or -1 if an error was encountered + * \returns Number of records or -1 if an error was encountered */ long countRecords( const QString &sql ); diff --git a/src/gui/qgssourceselectdialog.h b/src/gui/qgssourceselectdialog.h index 13b33cae65c..4ec80f05fd5 100644 --- a/src/gui/qgssourceselectdialog.h +++ b/src/gui/qgssourceselectdialog.h @@ -87,7 +87,7 @@ class GUI_EXPORT QgsSourceSelectDialog : public QDialog, protected Ui::QgsSource 1. project CRS if contained in the set 2. WGS84 if contained in the set 3. the first entry in the set else - \return the authority id of the crs or an empty string in case of error*/ + \returns the authority id of the crs or an empty string in case of error*/ QString getPreferredCrs( const QSet &crsSet ) const; private slots: diff --git a/src/gui/raster/qgshillshaderendererwidget.h b/src/gui/raster/qgshillshaderendererwidget.h index 4da558705ed..2f2e32e68c7 100644 --- a/src/gui/raster/qgshillshaderendererwidget.h +++ b/src/gui/raster/qgshillshaderendererwidget.h @@ -49,7 +49,7 @@ class GUI_EXPORT QgsHillshadeRendererWidget: public QgsRasterRendererWidget, pri /** * @brief The renderer for the widget. - * \return A new renderer for the the config in the widget + * \returns A new renderer for the the config in the widget */ QgsRasterRenderer *renderer() override; diff --git a/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h b/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h index bd6db2e8013..dd9328cd553 100644 --- a/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h +++ b/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h @@ -95,7 +95,7 @@ class GUI_EXPORT QgsCategorizedSymbolRendererWidget : public QgsRendererWidget, /** Replaces category symbols with the symbols from a style that have a matching * name. * \param style style containing symbols to match with - * \return number of symbols matched + * \returns number of symbols matched * @see matchToSymbolsFromLibrary * @see matchToSymbolsFromXml * \since QGIS 2.9 diff --git a/src/gui/symbology-ng/qgsrulebasedrendererwidget.h b/src/gui/symbology-ng/qgsrulebasedrendererwidget.h index d9c512a076d..af745083beb 100644 --- a/src/gui/symbology-ng/qgsrulebasedrendererwidget.h +++ b/src/gui/symbology-ng/qgsrulebasedrendererwidget.h @@ -195,7 +195,7 @@ class GUI_EXPORT QgsRendererRulePropsWidget : public QgsPanelWidget, private Ui: /** * Return the current set rule. - * \return The current rule. + * \returns The current rule. */ QgsRuleBasedRenderer::Rule *rule() { return mRule; } diff --git a/src/gui/symbology-ng/qgssymbolselectordialog.h b/src/gui/symbology-ng/qgssymbolselectordialog.h index 81753280ee4..fc1e3485c66 100644 --- a/src/gui/symbology-ng/qgssymbolselectordialog.h +++ b/src/gui/symbology-ng/qgssymbolselectordialog.h @@ -114,7 +114,7 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs /** * @brief Return the symbol that is currently active in the widget. Can be null. - * \return The active symbol. + * \returns The active symbol. */ QgsSymbol *symbol() { return mSymbol; } @@ -148,7 +148,7 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs /** * The current symbol layer that is active in the interface. - * \return The active symbol layer. + * \returns The active symbol layer. */ QgsSymbolLayer *currentLayer(); @@ -268,7 +268,7 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog /** * @brief Return the symbol that is currently active in the widget. Can be null. - * \return The active symbol. + * \returns The active symbol. */ QgsSymbol *symbol(); diff --git a/src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h b/src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h index ae747e3021c..875f847f182 100644 --- a/src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h +++ b/src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h @@ -35,7 +35,7 @@ namespace QgsGeometryCheckerUtils /** * @brief Return the number of points in a polyline, accounting for duplicate start and end point if the polyline is closed * \param polyLine The polyline - * \return The number of distinct points of the polyline + * \returns The number of distinct points of the polyline */ inline int polyLineSize( const QgsAbstractGeometry *geom, int iPart, int iRing, bool *isClosed = nullptr ) { @@ -64,7 +64,7 @@ namespace QgsGeometryCheckerUtils * \param p1 The first point * \param p2 The second point * \param tol The tolerance - * \return Whether the points are equal + * \returns Whether the points are equal */ inline bool pointsFuzzyEqual( const QgsPointV2 &p1, const QgsPointV2 &p2, double tol ) { diff --git a/src/plugins/georeferencer/qgsgeorefplugingui.h b/src/plugins/georeferencer/qgsgeorefplugingui.h index 23e827ddff2..931763f7c16 100644 --- a/src/plugins/georeferencer/qgsgeorefplugingui.h +++ b/src/plugins/georeferencer/qgsgeorefplugingui.h @@ -193,7 +193,7 @@ class QgsGeorefPluginGui : public QMainWindow, private Ui::QgsGeorefPluginGuiBas * Note that the RMSE measure is adjusted for the degrees of freedom of the * used polynomial transform. * \param error out: the mean error - * \return true in case of success + * \returns true in case of success */ bool calculateMeanError( double &error ) const; diff --git a/src/plugins/grass/qgsgrassmoduleoptions.h b/src/plugins/grass/qgsgrassmoduleoptions.h index acad53587f2..e8424ec2f27 100644 --- a/src/plugins/grass/qgsgrassmoduleoptions.h +++ b/src/plugins/grass/qgsgrassmoduleoptions.h @@ -186,7 +186,7 @@ class QgsGrassModuleStandardOptions: public QWidget, public QgsGrassModuleOption QDomDocument readInterfaceDescription( const QString &xname, QStringList &errors ); /** Get region for currently selected map. It will show warning dialog if region could not be read. - * \return true if region was successfully read + * \returns true if region was successfully read */ bool getCurrentMapRegion( QgsGrassModuleInput *param, struct Cell_head *window ); diff --git a/src/plugins/grass/qtermwidget/Character.h b/src/plugins/grass/qtermwidget/Character.h index f3b36ee7229..313666a4ffe 100644 --- a/src/plugins/grass/qtermwidget/Character.h +++ b/src/plugins/grass/qtermwidget/Character.h @@ -199,7 +199,7 @@ public: * \param length This variable is set to the length of the * character sequence. * - * \return A unicode character sequence of size @p length. + * \returns A unicode character sequence of size @p length. */ ushort* lookupExtendedChar(ushort hash , ushort& length) const; diff --git a/src/plugins/grass/qtermwidget/ColorScheme.h b/src/plugins/grass/qtermwidget/ColorScheme.h index 93997647540..3bd2d2b906b 100644 --- a/src/plugins/grass/qtermwidget/ColorScheme.h +++ b/src/plugins/grass/qtermwidget/ColorScheme.h @@ -324,7 +324,7 @@ public: * findColorScheme() methods after this call if loaded successfully. * * \param[in] path The path to KDE 4 .colorscheme or KDE 3 .schema. - * \return Whether the color scheme is loaded successfully. + * \returns Whether the color scheme is loaded successfully. */ bool loadCustomColorScheme(const QString& path); private: diff --git a/src/plugins/grass/qtermwidget/kprocess.h b/src/plugins/grass/qtermwidget/kprocess.h index 046950399cc..1185b200706 100644 --- a/src/plugins/grass/qtermwidget/kprocess.h +++ b/src/plugins/grass/qtermwidget/kprocess.h @@ -100,7 +100,7 @@ public: /** * Query how the output channels of the child process are handled. * - * \return the output channel handling mode + * \returns the output channel handling mode */ OutputChannelMode outputChannelMode() const; @@ -180,7 +180,7 @@ public: * This function must be called before starting the process, obviously. * * \param arg the argument to add - * \return a reference to this KProcess + * \returns a reference to this KProcess */ KProcess &operator<<(const QString& arg); @@ -188,7 +188,7 @@ public: * @overload * * \param args the arguments to add - * \return a reference to this KProcess + * \returns a reference to this KProcess */ KProcess &operator<<(const QStringList& args); @@ -222,7 +222,7 @@ public: /** * Obtain the currently set program and arguments. * - * \return a list, the first element being the program, the remaining ones + * \returns a list, the first element being the program, the remaining ones * being command line arguments to the program. */ QStringList program() const; @@ -248,7 +248,7 @@ public: * so the process can be parametrized properly and talked to. * * \param msecs time to wait for process to exit before killing it - * \return -2 if the process could not be started, -1 if it crashed, + * \returns -2 if the process could not be started, -1 if it crashed, * otherwise its exit code */ int execute(int msecs = -1); @@ -260,7 +260,7 @@ public: * \param args the command line arguments for the program, * one per list element * \param msecs time to wait for process to exit before killing it - * \return -2 if the process could not be started, -1 if it crashed, + * \returns -2 if the process could not be started, -1 if it crashed, * otherwise its exit code */ static int execute(const QString &exe, const QStringList &args = QStringList(), int msecs = -1); @@ -271,7 +271,7 @@ public: * \param argv the program to execute and the command line arguments * for the program, one per list element * \param msecs time to wait for process to exit before killing it - * \return -2 if the process could not be started, -1 if it crashed, + * \returns -2 if the process could not be started, -1 if it crashed, * otherwise its exit code */ static int execute(const QStringList &argv, int msecs = -1); @@ -288,7 +288,7 @@ public: * The KProcess object may be re-used immediately after calling this * function. * - * \return the PID of the started process or 0 on error + * \returns the PID of the started process or 0 on error */ int startDetached(); @@ -298,7 +298,7 @@ public: * \param exe the program to start * \param args the command line arguments for the program, * one per list element - * \return the PID of the started process or 0 on error + * \returns the PID of the started process or 0 on error */ static int startDetached(const QString &exe, const QStringList &args = QStringList()); @@ -307,7 +307,7 @@ public: * * \param argv the program to start and the command line arguments * for the program, one per list element - * \return the PID of the started process or 0 on error + * \returns the PID of the started process or 0 on error */ static int startDetached(const QStringList &argv); @@ -319,7 +319,7 @@ public: * This function can be called only while the process is running. * It cannot be applied to detached processes. * - * \return the process ID + * \returns the process ID */ int pid() const; diff --git a/src/plugins/grass/qtermwidget/kpty.h b/src/plugins/grass/qtermwidget/kpty.h index 480bd1c593f..fe1bf9ac4a7 100644 --- a/src/plugins/grass/qtermwidget/kpty.h +++ b/src/plugins/grass/qtermwidget/kpty.h @@ -50,7 +50,7 @@ class KPty { /** * Create a pty master/slave pair. * - * \return true if a pty pair was successfully opened + * \returns true if a pty pair was successfully opened */ bool open(); @@ -110,7 +110,7 @@ class KPty { * Note: when declaring ttmode, @c struct @c ::termios must be used - * without the '::' some version of HP-UX thinks, this declares * the struct in your class, in your method. - * \return @c true on success, false otherwise + * \returns @c true on success, false otherwise */ bool tcGetAttr(struct ::termios * ttmode) const; @@ -120,7 +120,7 @@ class KPty { * This function can be used only while the PTY is open. * * \param ttmode a pointer to a termios structure. - * \return @c true on success, false otherwise. Note that success means + * \returns @c true on success, false otherwise. Note that success means * that @em at @em least @em one attribute could be set. */ bool tcSetAttr(struct ::termios * ttmode); @@ -133,7 +133,7 @@ class KPty { * * \param lines the number of rows * \param columns the number of columns - * \return @c true on success, false otherwise + * \returns @c true on success, false otherwise */ bool setWinSize(int lines, int columns); @@ -147,26 +147,26 @@ class KPty { * This function can be used only while the PTY is open. * * \param echo true if input should be echoed. - * \return @c true on success, false otherwise + * \returns @c true on success, false otherwise */ bool setEcho(bool echo); /** - * \return the name of the slave pty device. + * \returns the name of the slave pty device. * * This function should be called only while the pty is open. */ const char * ttyName() const; /** - * \return the file descriptor of the master pty + * \returns the file descriptor of the master pty * * This function should be called only while the pty is open. */ int masterFd() const; /** - * \return the file descriptor of the slave pty + * \returns the file descriptor of the slave pty * * This function should be called only while the pty slave is open. */ diff --git a/src/plugins/grass/qtermwidget/kptydevice.h b/src/plugins/grass/qtermwidget/kptydevice.h index a25a494bd7c..aba476649d3 100644 --- a/src/plugins/grass/qtermwidget/kptydevice.h +++ b/src/plugins/grass/qtermwidget/kptydevice.h @@ -68,7 +68,7 @@ public: /** * Create a pty master/slave pair. * - * \return true if a pty pair was successfully opened + * \returns true if a pty pair was successfully opened */ virtual bool open(OpenMode mode = ReadWrite | Unbuffered); @@ -83,7 +83,7 @@ public: * * \param fd an open pty master file descriptor. * \param mode the device mode to open the pty with. - * \return true if a pty pair was successfully opened + * \returns true if a pty pair was successfully opened */ bool open(int fd, OpenMode mode = ReadWrite | Unbuffered); @@ -117,7 +117,7 @@ public: bool isSuspended() const; /** - * \return always true + * \returns always true */ virtual bool isSequential() const; diff --git a/src/plugins/grass/qtermwidget/kptyprocess.h b/src/plugins/grass/qtermwidget/kptyprocess.h index a2ec65c3009..c3f9f143ac0 100644 --- a/src/plugins/grass/qtermwidget/kptyprocess.h +++ b/src/plugins/grass/qtermwidget/kptyprocess.h @@ -109,7 +109,7 @@ public: /** * Query to which channels the PTY is assigned. * - * \return the output channel handling mode + * \returns the output channel handling mode */ PtyChannels ptyChannels() const; @@ -129,14 +129,14 @@ public: /** * Get whether to register the process as a TTY login in utmp. * - * \return whether to register in utmp + * \returns whether to register in utmp */ bool isUseUtmp() const; /** * Get the PTY device of this process. * - * \return the PTY device + * \returns the PTY device */ KPtyDevice *pty() const; diff --git a/src/plugins/grass/qtermwidget/qtermwidget.h b/src/plugins/grass/qtermwidget/qtermwidget.h index 360dacccf28..287cf26241f 100644 --- a/src/plugins/grass/qtermwidget/qtermwidget.h +++ b/src/plugins/grass/qtermwidget/qtermwidget.h @@ -162,13 +162,13 @@ public: * This method may return a nullptr if no hotspot is available. * * \param[in] pos The point of interest in the QTermWidget coordinates. - * \return Hotspot for the given position, or nullptr if no hotspot. + * \returns Hotspot for the given position, or nullptr if no hotspot. */ Filter::HotSpot* getHotSpotAt(const QPoint& pos) const; /** Returns the available hotspots for the given row and column. * - * \return Hotspot for the given position, or nullptr if no hotspot. + * \returns Hotspot for the given position, or nullptr if no hotspot. */ Filter::HotSpot* getHotSpotAt(int row, int column) const; diff --git a/src/providers/delimitedtext/qgsdelimitedtextfile.h b/src/providers/delimitedtext/qgsdelimitedtextfile.h index edf2047ecf8..95d868e0435 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextfile.h +++ b/src/providers/delimitedtext/qgsdelimitedtextfile.h @@ -104,7 +104,7 @@ class QgsDelimitedTextFile : public QObject void setFileName( const QString &filename ); /** Return the filename - * \return filename the name of the file + * \returns filename the name of the file */ QString fileName() { @@ -117,7 +117,7 @@ class QgsDelimitedTextFile : public QObject void setEncoding( const QString &encoding ); /** Return the file encoding - * \return encoding The file encoding + * \returns encoding The file encoding */ QString encoding() { return mEncoding; } @@ -132,7 +132,7 @@ class QgsDelimitedTextFile : public QObject bool setFromUrl( const QUrl &url ); /** Encode the parser settings into a QUrl - * \return url The url into which the delimiter and delimiterType items are set + * \returns url The url into which the delimiter and delimiterType items are set */ QUrl url(); @@ -159,7 +159,7 @@ class QgsDelimitedTextFile : public QObject void setSkipLines( int skiplines ); /** Return the number of header lines to skip - * \return skiplines The maximum lines to skip + * \returns skiplines The maximum lines to skip */ int skipLines() { @@ -172,7 +172,7 @@ class QgsDelimitedTextFile : public QObject void setUseHeader( bool useheader = true ); /** Return the option for reading field names from the first record - * \return useheaders Field names will be read if true + * \returns useheaders Field names will be read if true */ bool useHeader() { @@ -185,7 +185,7 @@ class QgsDelimitedTextFile : public QObject void setDiscardEmptyFields( bool discardEmptyFields = true ); /** Return the option for discarding empty fields - * \return useheaders Empty fields will be discarded if true + * \returns useheaders Empty fields will be discarded if true */ bool discardEmptyFields() { @@ -198,7 +198,7 @@ class QgsDelimitedTextFile : public QObject void setTrimFields( bool trimFields = true ); /** Return the option for trimming empty fields - * \return useheaders Empty fields will be trimmed if true + * \returns useheaders Empty fields will be trimmed if true */ bool trimFields() { @@ -212,7 +212,7 @@ class QgsDelimitedTextFile : public QObject void setMaxFields( int maxFields ); /** Return the maximum number of fields that will be read - * \return maxFields The maximum number of fields that will be read + * \returns maxFields The maximum number of fields that will be read */ int maxFields() { return mMaxFields; } @@ -230,21 +230,21 @@ class QgsDelimitedTextFile : public QObject * not been read then the field names are empty until records have * been read. The list may be expanded as the file is read and records * with more fields are loaded. - * \return names A list of field names in the file + * \returns names A list of field names in the file */ QStringList &fieldNames(); /** 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). - * \return index The zero based index of the field name, or -1 if the field + * \returns index The zero based index of the field name, or -1 if the field * name does not exist or cannot be inferred */ int fieldIndex( const QString &name ); /** Reads the next record from the stream splits into string fields. * \param fields The string list to populate with the fields - * \return status The result of trying to parse a record. RecordOk + * \returns status The result of trying to parse a record. RecordOk * if read successfully, RecordEOF if reached the end of the * file, RecordEmpty if no data on the next line, and * RecordInvalid if the record is ill-formatted. @@ -252,7 +252,7 @@ class QgsDelimitedTextFile : public QObject Status nextRecord( QStringList &fields ); /** Return the line number of the start of the last record read - * \return linenumber The line number of the start of the record + * \returns linenumber The line number of the start of the record */ int recordId() { @@ -261,13 +261,13 @@ class QgsDelimitedTextFile : public QObject /** Set the index of the next record to return. * \param nextRecordId The id to set the next record to - * \return valid True if the next record can be located + * \returns valid True if the next record can be located */ bool setNextRecordId( long nextRecordId ); /** Number record number of records visited. After scanning the file * serves as a record count. - * \return maxRecordNumber The maximum record number + * \returns maxRecordNumber The maximum record number */ long recordCount() { return mMaxRecordNumber; } @@ -276,27 +276,27 @@ class QgsDelimitedTextFile : public QObject Status reset(); /** Return a string defining the type of the delimiter as a string - * \return type The delimiter type as a string + * \returns type The delimiter type as a string */ QString type(); /** Check that provider is valid (filename and definition valid) * - * \return valid True if the provider is valid + * \returns valid True if the provider is valid */ bool isValid(); /** Encode characters - used to convert delimiter/quote/escape characters to * encoded form (e.g., replace tab with \t) * \param string The unencoded string - * \return encstring The encoded string + * \returns encstring The encoded string */ static QString encodeChars( QString string ); /** Encode characters - used to encoded character strings to * decoded form (e.g., replace \t with tab) * \param string The unencoded string - * \return decstring The decoded string + * \returns decstring The decoded string */ static QString decodeChars( QString string ); @@ -322,7 +322,7 @@ class QgsDelimitedTextFile : public QObject /** Open the file * - * \return valid True if the file is successfully opened + * \returns valid True if the file is successfully opened */ bool open(); diff --git a/src/providers/delimitedtext/qgsdelimitedtextprovider.h b/src/providers/delimitedtext/qgsdelimitedtextprovider.h index bb2b3a9e528..011b4b7e9ea 100644 --- a/src/providers/delimitedtext/qgsdelimitedtextprovider.h +++ b/src/providers/delimitedtext/qgsdelimitedtextprovider.h @@ -92,13 +92,13 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider /** * Get feature type. - * \return int representing the feature type + * \returns int representing the feature type */ virtual QgsWkbTypes::Type wkbType() const override; /** * Number of features in the layer - * \return long containing number of features + * \returns long containing number of features */ virtual long featureCount() const override; @@ -112,7 +112,7 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider virtual QgsVectorDataProvider::Capabilities capabilities() const override; /** Creates a spatial index on the data - * \return indexCreated Returns true if a spatial index is created + * \returns indexCreated Returns true if a spatial index is created */ virtual bool createSpatialIndex() override; @@ -169,7 +169,7 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider * rectangle * \param x X value of point * \param y Y value of point - * \return True if point is within the rectangle + * \returns True if point is within the rectangle */ bool boundsCheck( double x, double y ); @@ -179,7 +179,7 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider * rectangle * \param geom geometry to test against bounds * \param y Y value of point - * \return True if point is within the rectangle + * \returns True if point is within the rectangle */ bool boundsCheck( QgsGeometry *geom ); @@ -187,7 +187,7 @@ class QgsDelimitedTextProvider : public QgsVectorDataProvider * Try to read field types from CSVT (or equivalent xxxT) file. * \param filename The name of the file from which to read the field types * \param message Pointer to a string to receive a status message - * \return A list of field type strings, empty if not found or not valid + * \returns A list of field type strings, empty if not found or not valid */ QStringList readCsvtFieldTypes( const QString &filename, QString *message = nullptr ); diff --git a/src/providers/grass/qgsgrass.h b/src/providers/grass/qgsgrass.h index cc9e34269d2..a9e7d4cf1fa 100644 --- a/src/providers/grass/qgsgrass.h +++ b/src/providers/grass/qgsgrass.h @@ -102,7 +102,7 @@ class GRASS_LIB_EXPORT QgsGrassObject void setName( const QString &name ) { mName = name; } /** Return full name (map@mapset) - * \return full name or empty string if map name is empty */ + * \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 @@ -236,7 +236,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static void setMapset( const QgsGrassObject &grassObject ); /** Check if mapset is in search pat set by g.mapsets - * \return true if in search path + * \returns true if in search path */ bool isMapsetInSearchPath( const QString &mapset ); @@ -271,7 +271,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject /** Open existing GRASS mapset. * Emits signal mapsetChanged(). - * \return Empty string or error message + * \returns Empty string or error message */ static QString openMapset( const QString &gisdbase, const QString &location, const QString &mapset ); @@ -280,7 +280,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject * Delete GISRC, lock and temporary directory. * Emits signal mapsetChanged(). * \param showError show error dialog on error - * \return Empty string or error message + * \returns Empty string or error message */ static QString closeMapset(); @@ -392,7 +392,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject struct Cell_head *target ); /** Initialize GRASS library. This has to be called before any other function is used. - * \return true if successfully initialized */ + * \returns true if successfully initialized */ static bool init( void ); //! test if the directory is location @@ -410,7 +410,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject /** 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 - * \return full path including extension or empty string */ + * \returns full path including extension or empty string */ static QString findModule( QString module ); /** Start a GRASS module in any gisdbase/location/mapset. @@ -494,7 +494,7 @@ class GRASS_LIB_EXPORT QgsGrass : public QObject static bool deleteObject( const QgsGrassObject &object ); /** Ask user confirmation to delete a map - * \return true if confirmed + * \returns true if confirmed */ static bool deleteObjectDialog( const QgsGrassObject &object ); diff --git a/src/providers/grass/qgsgrassprovider.h b/src/providers/grass/qgsgrassprovider.h index 3241ee8e9e0..ea0b1a2bfeb 100644 --- a/src/providers/grass/qgsgrassprovider.h +++ b/src/providers/grass/qgsgrassprovider.h @@ -115,21 +115,21 @@ 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 - * \return true the layer editable - * \return false the is not editable + * \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) - * \return true in update mode - * \return false not edited + * \returns true in update mode + * \returns false not edited */ bool isEdited(); /** Returns true if the layer is currently froze, i.e. a module * from GRASS Tools is writing to this vector - * \return true in update mode - * \return false not edited + * \returns true in update mode + * \returns false not edited */ bool isFrozen(); @@ -146,18 +146,18 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider /** 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 - * \return true success - * \return false failed to close vector or vector was not in update mode + * \returns true success + * \returns false failed to close vector or vector was not in update mode */ bool closeEdit( bool newMap = false, QgsVectorLayer *vectorLayer = 0 ); /** Get current number of lines. - * \return number of lines + * \returns number of lines */ int numLines( void ); /** Get current number of nodes. - * \return number of nodes + * \returns number of nodes */ int numNodes( void ); @@ -165,86 +165,86 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider * \param Points pointer to existing structure or NULL * \param Cats pointer to existing structure or NULL * \param line line number - * \return line type - * \return <0 deadline or error + * \returns line type + * \returns <0 deadline or error */ int readLine( struct line_pnts *Points, struct line_cats *Cats, int line ); /** Read node coordinates * \param line line number - * \return true node is alive - * \return false node is dead + * \returns true node is alive + * \returns false node is dead */ bool nodeCoor( int node, double *x, double *y ); /** Read line nodes * \param line line number - * \return true line is alive - * \return false line is dead + * \returns true line is alive + * \returns false line is dead */ bool lineNodes( int line, int *node1, int *node2 ); /** Read boundary areas * \param line line number - * \return true line is alive - * \return false line is dead + * \returns true line is alive + * \returns false line is dead */ bool lineAreas( int line, int *left, int *right ); /** Get isle area * \param isle number - * \return area number + * \returns area number */ int isleArea( int isle ); /** Get centroid area * \param centroid line number - * \return area number (negative for island) + * \returns area number (negative for island) */ int centroidArea( int centroid ); /** Get number of lines at node * \param node node number - * \return number of lines at node (including dead lines) + * \returns number of lines at node (including dead lines) */ int nodeNLines( int node ); /** Get line number of line at node for given line index * \param node node number * \param idx line index - * \return line number + * \returns line number */ int nodeLine( int node, int idx ); /** True if line is alive * \param line line number - * \return true alive - * \return false dead + * \returns true alive + * \returns false dead */ int lineAlive( int line ); /** True if node is alive * \param node node number - * \return true alive - * \return false dead + * \returns true alive + * \returns false dead */ int nodeAlive( int node ); /** Write a new line into vector. - * \return line number - * \return -1 error + * \returns line number + * \returns -1 error */ int writeLine( int type, struct line_pnts *Points, struct line_cats *Cats ); /** Rewrite line. - * \return line number - * \return -1 error + * \returns line number + * \returns -1 error */ int rewriteLine( int lid, int type, struct line_pnts *Points, struct line_cats *Cats ); /** Delete line - * \return 0 OK - * \return -1 error + * \returns 0 OK + * \returns -1 error */ int deleteLine( int line ); @@ -266,15 +266,15 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider /** Find nearest line * \param threshold maximum distance - * \return line number - * \return 0 nothing found + * \returns line number + * \returns 0 nothing found */ int findLine( double x, double y, int type, double threshold ); /** Find nearest node * \param threshold maximum distance - * \return node number - * \return 0 nothing found + * \returns node number + * \returns 0 nothing found */ int findNode( double x, double y, double threshold ); @@ -283,24 +283,24 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider /** Read attributes from DB * \param field * \param cat - * \return vector of attributes + * \returns vector of attributes */ QgsAttributeMap *attributes( int field, int cat ); /** Key (cat) column name * \param field - * \return Key column name or empty string + * \returns Key column name or empty string */ QString key( int field ); /** Get number of db links - * \return number of links + * \returns number of links */ int numDbLinks( void ); /** Get db link field * \param link - * \return field number or 0 + * \returns field number or 0 */ int dbLinkField( int link ); @@ -408,7 +408,7 @@ class GRASS_LIB_EXPORT QgsGrassProvider : public QgsVectorDataProvider * \param layerId * \param category (key) * \param column column number ( < nColumns ) - * \return pointer to string representation of the value or NULL, this value must not be changed + * \returns pointer to string representation of the value or NULL, this value must not be changed */ static char *attribute( int layerId, int cat, int column ); diff --git a/src/providers/grass/qgsgrassvector.h b/src/providers/grass/qgsgrassvector.h index a40b9c296a3..54ea1aa288b 100644 --- a/src/providers/grass/qgsgrassvector.h +++ b/src/providers/grass/qgsgrassvector.h @@ -89,14 +89,14 @@ class GRASS_LIB_EXPORT QgsGrassVector : public QObject QList layers() const { return mLayers; } /** Get numbers of primitives - * \return type/count pairs */ + * \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). - * \return max layer number or 0 if no layer exists */ + * \returns max layer number or 0 if no layer exists */ int maxLayerNumber() const; //! Get number of nodes diff --git a/src/providers/grass/qgsgrassvectormap.h b/src/providers/grass/qgsgrassvectormap.h index 42607dbc7d1..b94518c14aa 100644 --- a/src/providers/grass/qgsgrassvectormap.h +++ b/src/providers/grass/qgsgrassvectormap.h @@ -63,7 +63,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject int userCount() const; /** Get current number of lines. - * \return number of lines */ + * \returns number of lines */ int numLines(); int numAreas(); // 3D map with z coordinates @@ -89,7 +89,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject QMap > &undoCommands() { return mUndoCommands; } /** Get geometry of line. - * \return geometry (point,line or polygon(GV_FACE)) or 0 */ + * \returns geometry (point,line or polygon(GV_FACE)) or 0 */ QgsAbstractGeometry *lineGeometry( int id ); QgsAbstractGeometry *nodeGeometry( int id ); QgsAbstractGeometry *areaGeometry( int id ); @@ -115,7 +115,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMap : public QObject /** Get layer, layer is created and loaded if not yet. * \param field - * \return pointer to layer or 0 if layer doe not exist */ + * \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 @@ -228,7 +228,7 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapStore /** Open map. * \param grassObject - * \return map, the map may be invalide */ + * \returns map, the map may be invalide */ QgsGrassVectorMap *openMap( const QgsGrassObject &grassObject ); private: diff --git a/src/providers/grass/qgsgrassvectormaplayer.h b/src/providers/grass/qgsgrassvectormaplayer.h index 5d9665b3d67..40d7fec2098 100644 --- a/src/providers/grass/qgsgrassvectormaplayer.h +++ b/src/providers/grass/qgsgrassvectormaplayer.h @@ -134,14 +134,14 @@ class GRASS_LIB_EXPORT QgsGrassVectorMapLayer : public QObject /** Check if a database row exists * \param cat * \param error set to error if happens - * \return true if cat is orphan + * \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) * \param cat * \param error set to error if happens - * \return true if cat is orphan + * \returns true if cat is orphan */ bool isOrphan( int cat, QString &error ); diff --git a/src/providers/postgres/qgspostgresprovider.h b/src/providers/postgres/qgspostgresprovider.h index 0fcff485473..2485b94a68e 100644 --- a/src/providers/postgres/qgspostgresprovider.h +++ b/src/providers/postgres/qgspostgresprovider.h @@ -177,7 +177,7 @@ class QgsPostgresProvider : public QgsVectorDataProvider * \param type the wanted type * \param subType if type is a collection, the wanted element type * \param value the value to convert - * \return a QVariant of the given type or a null QVariant + * \returns a QVariant of the given type or a null QVariant */ static QVariant convertValue( QVariant::Type type, QVariant::Type subType, const QString &value ); @@ -247,20 +247,20 @@ class QgsPostgresProvider : public QgsVectorDataProvider /** 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 - \return true in case of success and fals in case of error (e.g. if the type is not an enum type)*/ + \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) * \param enumValues Reference to list that receives enum values * \param attributeName Name of the domain type attribute - * \return 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) + * \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 * * \param fld the field to determine PK type of - * \return the PrimaryKeyType + * \returns the PrimaryKeyType * * \note that this only makes sense for single-field primary keys, * whereas multi-field keys always need the PktFidMap diff --git a/src/providers/spatialite/qgsspatialiteconnection.h b/src/providers/spatialite/qgsspatialiteconnection.h index c50d2687416..cc99914fd1c 100644 --- a/src/providers/spatialite/qgsspatialiteconnection.h +++ b/src/providers/spatialite/qgsspatialiteconnection.h @@ -86,7 +86,7 @@ class QgsSpatiaLiteConnection : public QObject int checkHasMetadataTables( sqlite3 *handle ); /** Inserts information about the spatial tables into mTables - \return true if querying of tables was successful, false on error */ + \returns true if querying of tables was successful, false on error */ bool getTableInfo( sqlite3 *handle, bool loadGeometrylessTables ); #ifdef SPATIALITE_VERSION_GE_4_0_0 diff --git a/src/providers/wcs/qgswcscapabilities.h b/src/providers/wcs/qgswcscapabilities.h index f41cd89fdab..92ec83abcc4 100644 --- a/src/providers/wcs/qgswcscapabilities.h +++ b/src/providers/wcs/qgswcscapabilities.h @@ -265,7 +265,7 @@ class QgsWcsCapabilities : public QObject //! Retrieve the best WCS version supported by server and QGIS bool retrieveServerCapabilities(); - //! \return false if the capabilities document could not be parsed - see lastError() for more info + //! \returns false if the capabilities document could not be parsed - see lastError() for more info bool parseCapabilitiesDom( QByteArray const &xml, QgsWcsCapabilitiesProperty &capabilities ); // ------------- 1.0 -------------------- diff --git a/src/providers/wfs/qgswfsprovider.h b/src/providers/wfs/qgswfsprovider.h index e4a72e40893..124f2464472 100644 --- a/src/providers/wfs/qgswfsprovider.h +++ b/src/providers/wfs/qgswfsprovider.h @@ -161,7 +161,7 @@ class QgsWFSProvider : public QgsVectorDataProvider //helper methods for WFS-T /** Sends the transaction document to the server using HTTP POST - \return true if transmission to the server succeeded, otherwise false + \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/qgswfssourceselect.h b/src/providers/wfs/qgswfssourceselect.h index 37f9c7e2215..6cceae88893 100644 --- a/src/providers/wfs/qgswfssourceselect.h +++ b/src/providers/wfs/qgswfssourceselect.h @@ -77,7 +77,7 @@ class QgsWFSSourceSelect: public QDialog, private Ui::QgsWFSSourceSelectBase 1. project CRS if contained in the set 2. WGS84 if contained in the set 3. the first entry in the set else - \return the authority id of the crs or an empty string in case of error*/ + \returns the authority id of the crs or an empty string in case of error*/ QString getPreferredCrs( const QSet &crsSet ) const; private slots: diff --git a/src/python/qgspythonutils.h b/src/python/qgspythonutils.h index 0a8e1d0a63f..473f297da00 100644 --- a/src/python/qgspythonutils.h +++ b/src/python/qgspythonutils.h @@ -67,17 +67,17 @@ class PYTHON_EXPORT QgsPythonUtils /* console */ //! run a statement, show an error message on error - //! \return true if no error occurred + //! \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 - //! \return true if no error occurred + //! \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 - //! \return false if there was no Python error + //! \returns false if there was no Python error virtual bool getError( QString &errorClassName, QString &errorText ) = 0; /* plugins */ diff --git a/src/python/qgspythonutilsimpl.h b/src/python/qgspythonutilsimpl.h index 6d4c09e21f3..1d552d8783e 100644 --- a/src/python/qgspythonutilsimpl.h +++ b/src/python/qgspythonutilsimpl.h @@ -57,20 +57,20 @@ class QgsPythonUtilsImpl : public QgsPythonUtils //! 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 - //! \return true if no error occurred + //! \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 - //! \return true if no error occurred + //! \returns true if no error occurred bool runStringUnsafe( const QString &command, bool single = true ) override; bool evalString( const QString &command, QString &result ) override; - //! \return object's type name as a string + //! \returns object's type name as a string QString getTypeAsString( PyObject *obj ); //! get information about error to the supplied arguments - //! \return false if there was no Python error + //! \returns false if there was no Python error bool getError( QString &errorClassName, QString &errorText ) override; /* plugins related functions */ @@ -120,10 +120,10 @@ class QgsPythonUtilsImpl : public QgsPythonUtils void init(); //! check qgis imports and plugins - //\return true if all imports worked + //\returns true if all imports worked bool checkSystemImports(); - //\return true if qgis.user could be imported + //\returns true if qgis.user could be imported bool checkQgisUser(); //! import custom user and global Python code (startup scripts) diff --git a/src/server/qgsaccesscontrol.h b/src/server/qgsaccesscontrol.h index 04d1f7e7c83..de660fda071 100644 --- a/src/server/qgsaccesscontrol.h +++ b/src/server/qgsaccesscontrol.h @@ -69,57 +69,57 @@ class SERVER_EXPORT QgsAccessControl : public QgsFeatureFilterProvider void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures ) const; /** Return a clone of the object - * \return A clone + * \returns A clone */ QgsFeatureFilterProvider *clone() const; /** Return an additional subset string (typically SQL) filter * \param layer the layer to control - * \return the subset string to use + * \returns the subset string to use */ QString extraSubsetString( const QgsVectorLayer *layer ) const; /** Return the layer read right * \param layer the layer to control - * \return true if it can be read + * \returns true if it can be read */ bool layerReadPermission( const QgsMapLayer *layer ) const; /** Return the layer insert right * \param layer the layer to control - * \return true if we can insert on it + * \returns true if we can insert on it */ bool layerInsertPermission( const QgsVectorLayer *layer ) const; /** Return the layer update right * \param layer the layer to control - * \return true if we can do an update + * \returns true if we can do an update */ bool layerUpdatePermission( const QgsVectorLayer *layer ) const; /** Return the layer delete right * \param layer the layer to control - * \return true if we can do a delete + * \returns true if we can do a delete */ bool layerDeletePermission( const QgsVectorLayer *layer ) const; /** Return the authorized layer attributes * \param layer the layer to control * \param attributes the list of attribute - * \return the list of visible attributes + * \returns the list of visible attributes */ QStringList layerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const; /** Are we authorized to modify the following geometry * \param layer the layer to control * \param feature the concerned feature - * \return true if we are allowed to edit the 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 * \param cacheKey the list to fill with a cache variant - * \return false if we can't create a cache + * \returns false if we can't create a cache */ bool fillCacheKey( QStringList &cacheKey ) const; diff --git a/src/server/qgsaccesscontrolfilter.h b/src/server/qgsaccesscontrolfilter.h index 6c6e391fb2d..6c44c07b3b3 100644 --- a/src/server/qgsaccesscontrolfilter.h +++ b/src/server/qgsaccesscontrolfilter.h @@ -72,38 +72,38 @@ class SERVER_EXPORT QgsAccessControlFilter /** Return an additional expression filter * \param layer the layer to control - * \return the filter expression + * \returns the filter expression */ virtual QString layerFilterExpression( const QgsVectorLayer *layer ) const; /** Return an additional subset string (typically SQL) filter * \param layer the layer to control - * \return the subset string + * \returns the subset string */ virtual QString layerFilterSubsetString( const QgsVectorLayer *layer ) const; /** Return the layer permissions * \param layer the layer to control - * \return the permission to use on the layer + * \returns the permission to use on the layer */ virtual LayerPermissions layerPermissions( const QgsMapLayer *layer ) const; /** Return the authorized layer attributes * \param layer the layer to control * \param attributes the current list of visible attribute - * \return the new list of visible attributes + * \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 * \param layer the layer to control * \param feature the concerned feature - * \return true if we are allowed to edit + * \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 - * \return the cache key, "" for no cache + * \returns the cache key, "" for no cache */ virtual QString cacheKey() const; diff --git a/src/server/qgsftptransaction.h b/src/server/qgsftptransaction.h index 643bac017f6..14729535b4b 100644 --- a/src/server/qgsftptransaction.h +++ b/src/server/qgsftptransaction.h @@ -31,7 +31,7 @@ class QgsFtpTransaction: public QObject /** 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 - \return 0 in case of success*/ + \returns 0 in case of success*/ Q_DECL_DEPRECATED int get( const QString &ftpUrl, QByteArray &ba ); public slots: diff --git a/src/server/qgshttptransaction.h b/src/server/qgshttptransaction.h index e95ac4f36ec..27b6b8b5e61 100644 --- a/src/server/qgshttptransaction.h +++ b/src/server/qgshttptransaction.h @@ -74,7 +74,7 @@ class QgsHttpTransaction : public QObject \param postData data to send with the http message. This is only used for HTTP POST. If 0 then the request is done with HTTP GET. - \return true in case of success + \returns true in case of success */ bool getSynchronously( QByteArray &respondedContent, int redirections = 0, const QByteArray *postData = nullptr ); @@ -89,7 +89,7 @@ class QgsHttpTransaction : public QObject QString errorString(); /** Apply proxy settings from QSettings to a http object - \return true if proxy settings was applied, false else*/ + \returns true if proxy settings was applied, false else*/ static bool applyProxySettings( QHttp &http, const QString &url ); //! Set the credentials (username and password) diff --git a/src/server/qgsinterpolationlayerbuilder.h b/src/server/qgsinterpolationlayerbuilder.h index 11c7678fa9d..6fc43799f29 100644 --- a/src/server/qgsinterpolationlayerbuilder.h +++ b/src/server/qgsinterpolationlayerbuilder.h @@ -34,7 +34,7 @@ class QgsInterpolationLayerBuilder: public QgsMSLayerBuilder \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 \param allowCaching flag if layers are allowed to be fetched from layer cache or not - \return the created layer or 0 in case of error*/ + \returns the created layer or 0 in case of error*/ QgsMapLayer *createMapLayer( const QDomElement &elem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const override; private: diff --git a/src/server/qgsmslayerbuilder.h b/src/server/qgsmslayerbuilder.h index 92ee6951b00..f2ab764615e 100644 --- a/src/server/qgsmslayerbuilder.h +++ b/src/server/qgsmslayerbuilder.h @@ -40,7 +40,7 @@ class QgsMSLayerBuilder \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 \param allowCaching flag if layers are allowed to be fetched from layer cache or not - \return the created layer or 0 in case of error*/ + \returns the created layer or 0 in case of error*/ virtual QgsMapLayer *createMapLayer( const QDomElement &elem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const = 0; protected: //! Tries to create a suitable layer name from a URL. diff --git a/src/server/qgsmslayercache.h b/src/server/qgsmslayercache.h index 8e0ab5389f4..97b80c04976 100644 --- a/src/server/qgsmslayercache.h +++ b/src/server/qgsmslayercache.h @@ -71,7 +71,7 @@ class QgsMSLayerCache: public QObject 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. - \return a pointer to the layer or 0 if no such layer*/ + \returns a pointer to the layer or 0 if no such layer*/ QgsMapLayer *searchLayer( const QString &url, const QString &layerName, const QString &configFile = QString() ); int projectsMaxLayers() const { return mProjectMaxLayers; } diff --git a/src/server/qgsremotedatasourcebuilder.h b/src/server/qgsremotedatasourcebuilder.h index b4a1ce662f4..e6284734abe 100644 --- a/src/server/qgsremotedatasourcebuilder.h +++ b/src/server/qgsremotedatasourcebuilder.h @@ -36,7 +36,7 @@ class QgsRemoteDataSourceBuilder: public QgsMSLayerBuilder QgsVectorLayer *vectorLayerFromRemoteVDS( const QDomElement &remoteVDSElem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const; /** Loads data from http or ftp - \return 0 in case of success*/ + \returns 0 in case of success*/ int loadData( const QString &url, QByteArray &data ) const; }; diff --git a/src/server/qgssentdatasourcebuilder.h b/src/server/qgssentdatasourcebuilder.h index 0d91abbacac..7ef54301992 100644 --- a/src/server/qgssentdatasourcebuilder.h +++ b/src/server/qgssentdatasourcebuilder.h @@ -34,7 +34,7 @@ class QgsSentDataSourceBuilder: public QgsMSLayerBuilder \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 \param allowCaching flag if layers are allowed to be fetched from layer cache or not - \return the created layer or 0 in case of error*/ + \returns the created layer or 0 in case of error*/ QgsMapLayer *createMapLayer( const QDomElement &elem, const QString &layerName, QList &filesToRemove, QList &layersToRemove, bool allowCaching = true ) const override; private: diff --git a/src/server/qgsserver.h b/src/server/qgsserver.h index 0466cb4f20a..638a7a9059d 100644 --- a/src/server/qgsserver.h +++ b/src/server/qgsserver.h @@ -79,7 +79,7 @@ class SERVER_EXPORT QgsServer * variable. * * \param queryString QString containing the query string - * \return the response headers and body QPair of QByteArray + * \returns the response headers and body QPair of QByteArray */ QPair handleRequest( const QString &queryString ); diff --git a/src/server/qgsserverexception.h b/src/server/qgsserverexception.h index 45d86b66b0a..5f2edddbec4 100644 --- a/src/server/qgsserverexception.h +++ b/src/server/qgsserverexception.h @@ -37,14 +37,14 @@ class SERVER_EXPORT QgsServerException : public QgsException QgsServerException( const QString &message, int responseCode = 500 ); /** - * \return the return HTTP response code associated with this exception + * \returns the return HTTP response code associated with this exception */ int responseCode() const { return mResponseCode; } /** Format the exception for sending to client * * \param responseFormat QString to store the content type of the response format. - * \return QByteArray the fermatted response. + * \returns QByteArray the fermatted response. * * The defaolt implementation return text/xml format. */ @@ -70,13 +70,13 @@ class SERVER_EXPORT QgsOgcServiceException : public QgsServerException QgsOgcServiceException( const QString &code, const QString &message, const QString &locator = QString(), int responseCode = 200, const QString &version = QStringLiteral( "1.3.0" ) ); - //! \return message + //! \returns message QString message() const { return mMessage; } - //! \return code + //! \returns code QString code() const { return mCode; } - //! \return locator + //! \returns locator QString locator() const { return mLocator; } //!return exception version diff --git a/src/server/qgsserverinterface.h b/src/server/qgsserverinterface.h index d9aef19c728..6e26571d724 100644 --- a/src/server/qgsserverinterface.h +++ b/src/server/qgsserverinterface.h @@ -76,13 +76,13 @@ class SERVER_EXPORT QgsServerInterface /** * Get pointer to the capabiblities cache - * \return QgsCapabilitiesCache + * \returns QgsCapabilitiesCache */ virtual QgsCapabilitiesCache *capabilitiesCache() = 0; /** * Get pointer to the request handler - * \return QgsRequestHandler + * \returns QgsRequestHandler */ virtual QgsRequestHandler *requestHandler() = 0; @@ -101,7 +101,7 @@ class SERVER_EXPORT QgsServerInterface /** * Return the list of current QgsServerFilter - * \return QgsServerFiltersMap list of QgsServerFilter + * \returns QgsServerFiltersMap list of QgsServerFilter */ virtual QgsServerFiltersMap filters() = 0; @@ -119,7 +119,7 @@ class SERVER_EXPORT QgsServerInterface /** * Return the configuration file path - * \return QString containing the configuration file path + * \returns QString containing the configuration file path */ virtual QString configFilePath() = 0; @@ -143,13 +143,13 @@ class SERVER_EXPORT QgsServerInterface /** * Return the service registry - * \return QgsServiceResgistry + * \returns QgsServiceResgistry */ virtual QgsServiceRegistry *serviceRegistry() = 0; /** * Return the server settings - * \return QgsServerSettings + * \returns QgsServerSettings * * \note not available in Python bindings */ diff --git a/src/server/qgsserverinterfaceimpl.h b/src/server/qgsserverinterfaceimpl.h index d5b81546f92..a93f81fbbfa 100644 --- a/src/server/qgsserverinterfaceimpl.h +++ b/src/server/qgsserverinterfaceimpl.h @@ -54,7 +54,7 @@ class QgsServerInterfaceImpl : public QgsServerInterface void registerAccessControl( QgsAccessControlFilter *accessControl, int priority = 0 ) override; /** Gets the helper over all the registered access control filters - * \return the access control helper + * \returns the access control helper */ QgsAccessControl *accessControls() const override { return mAccessControls; } QString getEnv( const QString &name ) const override; diff --git a/src/server/qgsserverlogger.h b/src/server/qgsserverlogger.h index 2815eaccdf1..dab2d551ac4 100644 --- a/src/server/qgsserverlogger.h +++ b/src/server/qgsserverlogger.h @@ -38,7 +38,7 @@ class QgsServerLogger: public QObject /** * Get the current log level - * \return the log level + * \returns the log level * \since QGIS 3.0 */ QgsMessageLog::MessageLevel logLevel() const { return mLogLevel; } diff --git a/src/server/qgsserverplugins.h b/src/server/qgsserverplugins.h index 5adf2dba142..ead9711058c 100644 --- a/src/server/qgsserverplugins.h +++ b/src/server/qgsserverplugins.h @@ -35,7 +35,7 @@ class SERVER_EXPORT QgsServerPlugins /** * Initialize the Python plugins * \param interface QgsServerInterface - * \return bool true on success + * \returns bool true on success */ static bool initPlugins( QgsServerInterface *interface ); //! List of available server plugin names diff --git a/src/server/qgsserverprojectparser.h b/src/server/qgsserverprojectparser.h index 737eee0469d..dc8fcdd37b3 100644 --- a/src/server/qgsserverprojectparser.h +++ b/src/server/qgsserverprojectparser.h @@ -51,7 +51,7 @@ class SERVER_EXPORT QgsServerProjectParser QString convertToAbsolutePath( const QString &file ) const; /** Creates a maplayer object from element. The layer cash owns the maplayer, so don't delete it - \return the maplayer or 0 in case of error*/ + \returns the maplayer or 0 in case of error*/ QgsMapLayer *createLayerFromElement( const QDomElement &elem, bool useCache = true ) const; QgsMapLayer *mapLayerFromLayerId( const QString &lId, bool useCache = true ) const; @@ -102,7 +102,7 @@ class SERVER_EXPORT QgsServerProjectParser QList< QPair< QString, QgsDatumTransformStore::Entry > > layerCoordinateTransforms() const; /** Returns the text of the element for a layer element - \return name or a null string in case of error*/ + \returns name or a null string in case of error*/ QString layerName( const QDomElement &layerElem ) const; QStringList wfsLayers() const; @@ -116,11 +116,11 @@ class SERVER_EXPORT QgsServerProjectParser void addGetFeatureLayers( const QDomElement &layerElem ) const; /** Returns the text of the element for a layer element - \return id or a null string in case of error*/ + \returns id or a null string in case of error*/ QString layerId( const QDomElement &layerElem ) const; /** Returns the text of the element for a layer element - \return id or a null string in case of error*/ + \returns id or a null string in case of error*/ QString layerShortName( const QDomElement &layerElem ) const; QgsRectangle projectExtent() const; diff --git a/src/server/qgsserverprojectutils.h b/src/server/qgsserverprojectutils.h index 2d378c9c78e..5c1c5a5dfd4 100644 --- a/src/server/qgsserverprojectutils.h +++ b/src/server/qgsserverprojectutils.h @@ -31,109 +31,109 @@ namespace QgsServerProjectUtils /** Returns if owsService capabilities are enabled. * \param project the QGIS project - * \return if owsService capabilities are enabled. + * \returns if owsService capabilities are enabled. */ SERVER_EXPORT bool owsServiceCapabilities( const QgsProject &project ); /** Returns the owsService title defined in project. * \param project the QGIS project - * \return the owsService title if defined in project. + * \returns the owsService title if defined in project. */ SERVER_EXPORT QString owsServiceTitle( const QgsProject &project ); /** Returns the owsService abstract defined in project. * \param project the QGIS project - * \return the owsService abstract if defined in project. + * \returns the owsService abstract if defined in project. */ SERVER_EXPORT QString owsServiceAbstract( const QgsProject &project ); /** Returns the owsService keywords defined in project. * \param project the QGIS project - * \return the owsService keywords if defined in project. + * \returns the owsService keywords if defined in project. */ SERVER_EXPORT QStringList owsServiceKeywords( const QgsProject &project ); /** Returns the owsService online resource defined in project. * \param project the QGIS project - * \return the owsService online resource if defined in 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. * \param project the QGIS project - * \return the owsService contact organization if defined in 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. * \param project the QGIS project - * \return the owsService contact position if defined in 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. * \param project the QGIS project - * \return the owsService contact person if defined in 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. * \param project the QGIS project - * \return the owsService contact mail if defined in 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. * \param project the QGIS project - * \return the owsService contact phone if defined in project. + * \returns the owsService contact phone if defined in project. */ SERVER_EXPORT QString owsServiceContactPhone( const QgsProject &project ); /** Returns the owsService fees defined in project. * \param project the QGIS project - * \return the owsService fees if defined in project. + * \returns the owsService fees if defined in project. */ SERVER_EXPORT QString owsServiceFees( const QgsProject &project ); /** Returns the owsService access constraints defined in project. * \param project the QGIS project - * \return the owsService access constraints if defined in 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. * \param project the QGIS project - * \return width if defined in project, -1 otherwise. + * \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. * \param project the QGIS project - * \return height if defined in project, -1 otherwise. + * \returns height if defined in project, -1 otherwise. */ SERVER_EXPORT int wmsMaxHeight( const QgsProject &project ); /** Returns the WMS service url defined in a QGIS project. * \param project the QGIS project - * \return url if defined in project, an empty string otherwise. + * \returns url if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wmsServiceUrl( const QgsProject &project ); /** Returns the WFS service url defined in a QGIS project. * \param project the QGIS project - * \return url if defined in project, an empty string otherwise. + * \returns url if defined in project, an empty string otherwise. */ SERVER_EXPORT QString wfsServiceUrl( const QgsProject &project ); /** Returns the WCS service url defined in a QGIS project. * \param project the QGIS project - * \return url if defined in project, an empty string otherwise. + * \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. * \param project the QGIS project - * \return the Layer ids list. + * \returns the Layer ids list. */ SERVER_EXPORT QStringList wcsLayers( const QgsProject &project ); }; diff --git a/src/server/qgsserverrequest.h b/src/server/qgsserverrequest.h index 900fa73d1e8..197cfb3879f 100644 --- a/src/server/qgsserverrequest.h +++ b/src/server/qgsserverrequest.h @@ -74,12 +74,12 @@ class SERVER_EXPORT QgsServerRequest virtual ~QgsServerRequest() = default; /** - * \return the request url + * \returns the request url */ QUrl url() const; /** - * \return the request method + * \returns the request method */ Method method() const; @@ -112,7 +112,7 @@ class SERVER_EXPORT QgsServerRequest virtual QByteArray data() const; /** - * \return the value of the header field for that request + * \returns the value of the header field for that request */ virtual QString getHeader( const QString &name ) const; diff --git a/src/server/qgsserverresponse.h b/src/server/qgsserverresponse.h index e3538a75a27..241f46e89a4 100644 --- a/src/server/qgsserverresponse.h +++ b/src/server/qgsserverresponse.h @@ -104,7 +104,7 @@ class SERVER_EXPORT QgsServerResponse * Write chunk of data * This is a convenient method that will write directly * to the underlying I/O device - * \return the number of bytes that were actually written + * \returns the number of bytes that were actually written */ virtual qint64 write( const QByteArray &byteArray ); @@ -113,7 +113,7 @@ class SERVER_EXPORT QgsServerResponse * * This is a convenient method that will write directly * to the underlying I/O device - * \return the number of bytes written + * \returns the number of bytes written * * \note not available in Python bindings */ @@ -124,7 +124,7 @@ class SERVER_EXPORT QgsServerResponse * * This is a convenient method that will write directly * to the underlying I/O device - * \return the number of bytes written + * \returns the number of bytes written * * \note not available in Python bindings */ diff --git a/src/server/qgsserversettings.h b/src/server/qgsserversettings.h index abe49c878af..c4284f07a69 100644 --- a/src/server/qgsserversettings.h +++ b/src/server/qgsserversettings.h @@ -87,7 +87,7 @@ class SERVER_EXPORT QgsServerSettings void load(); /** Load setting for a specific environment variable name. - * \return true if loading is successful, false in case of an invalid name. + * \returns true if loading is successful, false in case of an invalid name. */ bool load( const QString &envVarName ); @@ -96,48 +96,48 @@ class SERVER_EXPORT QgsServerSettings void logSummary() const; /** Returns the ini file loaded by QSetting. - * \return the path of the ini file or an empty string if none is loaded. + * \returns the path of the ini file or an empty string if none is loaded. */ QString iniFile() const; /** Returns parallel rendering setting. - * \return true if parallel rendering is activated, false otherwise. + * \returns true if parallel rendering is activated, false otherwise. */ bool parallelRendering() const; /** Returns the maximum number of threads to use. - * \return the number of threads. + * \returns the number of threads. */ int maxThreads() const; /** * Returns the maximum number of cached layers. - * \return the number of cached layers. + * \returns the number of cached layers. */ int maxCacheLayers() const; /** Returns the log level. - * \return the log level. + * \returns the log level. */ QgsMessageLog::MessageLevel logLevel() const; /** Returns the QGS project file to use. - * \return the path of the QGS project or an empty string if none is defined. + * \returns the path of the QGS project or an empty string if none is defined. */ QString projectFile() const; /** Returns the log file. - * \return the path of the log file or an empty string if none is defined. + * \returns the path of the log file or an empty string if none is defined. */ QString logFile() const; /** Returns the cache size. - * \return the cache size. + * \returns the cache size. */ qint64 cacheSize() const; /** Returns the cache directory. - * \return the directory. + * \returns the directory. */ QString cacheDirectory() const; diff --git a/src/server/qgsservice.h b/src/server/qgsservice.h index c3c46cdb616..1da1ec4d553 100644 --- a/src/server/qgsservice.h +++ b/src/server/qgsservice.h @@ -47,12 +47,12 @@ class SERVER_EXPORT QgsService virtual ~QgsService() = default; /** - * \return the name of the service + * \returns the name of the service */ virtual QString name() const = 0; /** - * \return the version of the service + * \returns the version of the service */ virtual QString version() const = 0; diff --git a/src/server/qgsservicenativeloader.h b/src/server/qgsservicenativeloader.h index 6853c33b9e0..5c7229950f7 100644 --- a/src/server/qgsservicenativeloader.h +++ b/src/server/qgsservicenativeloader.h @@ -65,7 +65,7 @@ class SERVER_EXPORT QgsServiceNativeLoader * Load the native module from path * * \param location QString location holding the module relalive path - * \return a qgsservicemodule instance + * \returns a qgsservicemodule instance */ QgsServiceModule *loadNativeModule( const QString &location ); @@ -76,7 +76,7 @@ class SERVER_EXPORT QgsServiceNativeLoader /** * Find module * \param path the module path - * \return a module hook entry + * \returns a module hook entry */ QgsServiceNativeModuleEntry *findModuleEntry( const QString &path ); diff --git a/src/server/qgsserviceregistry.h b/src/server/qgsserviceregistry.h index 041b22f772a..65cc6b10fe7 100644 --- a/src/server/qgsserviceregistry.h +++ b/src/server/qgsserviceregistry.h @@ -58,7 +58,7 @@ class SERVER_EXPORT QgsServiceRegistry * Retrieve a service from its name * \param name the name of the service * \param version the version string (optional) - * \return QgsService + * \returns QgsService * * If the version is not provided the higher version of the service is returned */ @@ -81,7 +81,7 @@ class SERVER_EXPORT QgsServiceRegistry * * \param name the tame of the service * \param version (optional) the specific version to unload - * \return the number of services unregistered + * \returns the number of services unregistered * * If the version is not specified then all versions from the specified service * are unloaded diff --git a/src/server/qgssldconfigparser.h b/src/server/qgssldconfigparser.h index b88523167e3..9278e5452dc 100644 --- a/src/server/qgssldconfigparser.h +++ b/src/server/qgssldconfigparser.h @@ -176,15 +176,15 @@ class SERVER_EXPORT QgsSLDConfigParser : public QgsWmsConfigParser QgsFeatureRenderer *rendererFromUserStyle( const QDomElement &userStyleElement, QgsVectorLayer *vec ) const; /** Searches for a element and applies the settings to the vector layer - \return true if settings have been applied, false in case of element not present or error*/ + \returns true if settings have been applied, false in case of element not present or error*/ bool labelSettingsFromUserStyle( const QDomElement &userStyleElement, QgsVectorLayer *vec ) const; /** Searches for a element and applies the settings to the raster layer - \return true if settings have been applied, false in case of error*/ + \returns true if settings have been applied, false in case of error*/ bool rasterSymbologyFromUserStyle( const QDomElement &userStyleElement, QgsRasterLayer *r ) const; /** Creates a line layer (including renderer) from contour symboliser - \return the layer or 0 if no layer could be created*/ + \returns the layer or 0 if no layer could be created*/ QgsVectorLayer *contourLayerFromRaster( const QDomElement &userStyleElem, QgsRasterLayer *rasterLayer ) const; //! Returns the dom node or a null node in case of failure @@ -192,7 +192,7 @@ class SERVER_EXPORT QgsSLDConfigParser : public QgsWmsConfigParser /** Creates a vector layer from a tag. \param layerName the WMS layer name. This is only necessary for the fallback SLD parser - \return 0 in case of error. + \returns 0 in case of error. Delegates the work to specific methods for , or */ QgsMapLayer *mapLayerFromUserLayer( const QDomElement &userLayerElem, const QString &layerName, bool allowCaching = true ) const; diff --git a/src/server/services/wms/qgsmaprendererjobproxy.h b/src/server/services/wms/qgsmaprendererjobproxy.h index 9f4d1d17555..985758336fa 100644 --- a/src/server/services/wms/qgsmaprendererjobproxy.h +++ b/src/server/services/wms/qgsmaprendererjobproxy.h @@ -49,7 +49,7 @@ namespace QgsWms void render( const QgsMapSettings &mapSettings, QImage *image ); /** Take ownership of the painter used for rendering. - * \return painter + * \returns painter */ QPainter *takePainter(); diff --git a/src/server/services/wms/qgswmsrenderer.h b/src/server/services/wms/qgswmsrenderer.h index c8ce51df323..8e4a9475a75 100644 --- a/src/server/services/wms/qgswmsrenderer.h +++ b/src/server/services/wms/qgswmsrenderer.h @@ -101,7 +101,7 @@ namespace QgsWms /** Returns printed page as binary \param formatString out: format of the print output (e.g. pdf, svg, png, ...) - \return printed page as binary or 0 in case of error*/ + \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. @@ -115,7 +115,7 @@ namespace QgsWms * \param layersList out: list with WMS layer names * \param stylesList out: list with WMS style names * \param layerIdList out: list with QGIS layer ids - * \return image configured. The calling function takes ownership of the image + * \returns image configured. The calling function takes ownership of the image * may throw an exception */ QImage *initializeRendering( QStringList &layersList, QStringList &stylesList, QStringList &layerIdList, QgsMapSettings &mapSettings ); @@ -124,7 +124,7 @@ namespace QgsWms * \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 - * \return a non null pointer + * \returns a non null pointer * may throw an exception */ QImage *createImage( int width = -1, int height = -1, bool useBbox = true ) const; @@ -145,7 +145,7 @@ namespace QgsWms /** 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 - \return true in case of success*/ + \returns true in case of success*/ bool featureInfoFromVectorLayer( QgsVectorLayer *layer, const QgsPoint *infoPoint, int nFeatures, @@ -197,13 +197,13 @@ namespace QgsWms #endif /** Tests if a filter sql string is allowed (safe) - \return true in case of success, false if string seems unsafe*/ + \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 ); /** Select vector features with ids specified in parameter SELECTED, e.g. ...&SELECTED=layer1:1,2,9;layer2:3,5,10&... - \return list with layer ids where selections have been created*/ + \returns list with layer ids where selections have been created*/ QStringList applyFeatureSelections( const QStringList &layerList ) const; //! Clear all feature selections in the given layers void clearFeatureSelections( const QStringList &layerIds ) const; @@ -222,7 +222,7 @@ namespace QgsWms QList< QPair< QgsVectorLayer *, double > > &labelBufferTransparencies ); /** Checks WIDTH/HEIGHT values against MaxWidth and MaxHeight - \return true if width/height values are okay*/ + \returns true if width/height values are okay*/ bool checkMaximumWidthHeight() const; //! Converts a feature info xml document to SIA2045 norm diff --git a/src/server/services/wms/qgswmsutils.h b/src/server/services/wms/qgswmsutils.h index 136ca106173..9ea52ac68aa 100644 --- a/src/server/services/wms/qgswmsutils.h +++ b/src/server/services/wms/qgswmsutils.h @@ -64,7 +64,7 @@ namespace QgsWms QgsWmsConfigParser *getConfigParser( QgsServerInterface *serverIface ); /** Parse image format parameter - * \return OutputFormat + * \returns OutputFormat */ ImageOutputFormat parseImageFormat( const QString &format ); @@ -76,7 +76,7 @@ namespace QgsWms /** * Parse bbox parameter * \param bboxstr the bbox string as comma separated values - * \return QgsRectangle + * \returns QgsRectangle * * If the parsing fail then an empty bbox is returned */