Skip to content
Permalink
Browse files
\return -> \returns (for consistency)
  • Loading branch information
nyalldawson committed Apr 3, 2017
1 parent e4daf8e commit e47073b1e1df67ccef671f2579768270ffe370e9
Showing with 1,083 additions and 1,083 deletions.
  1. +1 −1 src/analysis/interpolation/DualEdgeTriangulation.h
  2. +1 −1 src/analysis/interpolation/NormVecDecorator.h
  3. +2 −2 src/analysis/interpolation/Triangulation.h
  4. +1 −1 src/analysis/interpolation/qgsgridfilewriter.h
  5. +1 −1 src/analysis/interpolation/qgsidwinterpolator.h
  6. +3 −3 src/analysis/interpolation/qgsinterpolator.h
  7. +2 −2 src/analysis/interpolation/qgstininterpolator.h
  8. +1 −1 src/analysis/network/qgsgraph.h
  9. +1 −1 src/analysis/network/qgsnetworkstrategy.h
  10. +2 −2 src/analysis/openstreetmap/qgsosmdownload.h
  11. +1 −1 src/analysis/openstreetmap/qgsosmimport.h
  12. +4 −4 src/analysis/raster/qgsalignraster.h
  13. +3 −3 src/analysis/raster/qgsninecellfilter.h
  14. +3 −3 src/analysis/raster/qgsrastercalculator.h
  15. +5 −5 src/analysis/raster/qgsrelief.h
  16. +1 −1 src/analysis/vector/qgspointsample.h
  17. +2 −2 src/analysis/vector/qgstransectsample.h
  18. +2 −2 src/analysis/vector/qgszonalstatistics.h
  19. +1 −1 src/app/dwg/libdxfrw/libdxfrw.h
  20. +5 −5 src/app/gps/qwtpolar-0.1/qwt_polar_curve.h
  21. +2 −2 src/app/gps/qwtpolar-1.0/qwt_polar_curve.h
  22. +2 −2 src/app/gps/qwtpolar-1.1.1/qwt_polar_curve.h
  23. +3 −3 src/app/nodetool/qgsmaptoolnodetool.h
  24. +4 −4 src/app/nodetool/qgsselectedfeature.h
  25. +9 −9 src/app/qgisapp.h
  26. +7 −7 src/app/qgisappinterface.h
  27. +1 −1 src/app/qgsattributetypedialog.h
  28. +2 −2 src/app/qgsdecorationgrid.h
  29. +1 −1 src/app/qgsfeatureaction.h
  30. +2 −2 src/app/qgsfieldsproperties.h
  31. +4 −4 src/app/qgsguivectorlayertools.h
  32. +11 −11 src/app/qgsmaptoollabel.h
  33. +1 −1 src/app/qgsmaptoolselectutils.h
  34. +1 −1 src/app/qgsmergeattributesdialog.h
  35. +1 −1 src/app/qgsstatusbarscalewidget.h
  36. +4 −4 src/app/qgstipfactory.h
  37. +2 −2 src/app/qgsvectorlayerproperties.h
  38. +3 −3 src/core/auth/qgsauthcertutils.h
  39. +1 −1 src/core/auth/qgsauthconfig.h
  40. +11 −11 src/core/auth/qgsauthmanager.h
  41. +3 −3 src/core/auth/qgsauthmethod.h
  42. +2 −2 src/core/auth/qgsauthmethodregistry.h
  43. +1 −1 src/core/composer/qgscomposeritem.h
  44. +2 −2 src/core/composer/qgscomposermapgrid.h
  45. +2 −2 src/core/composer/qgscomposernodesitem.h
  46. +3 −3 src/core/composer/qgscomposition.h
  47. +3 −3 src/core/diagram/qgsdiagram.h
  48. +1 −1 src/core/diagram/qgstextdiagram.h
  49. +4 −4 src/core/geometry/qgsabstractgeometry.h
  50. +1 −1 src/core/geometry/qgscircularstring.h
  51. +2 −2 src/core/geometry/qgscompoundcurve.h
  52. +1 −1 src/core/geometry/qgscurvepolygon.h
  53. +26 −26 src/core/geometry/qgsgeometry.h
  54. +1 −1 src/core/geometry/qgsgeometrycollection.h
  55. +2 −2 src/core/geometry/qgsgeometryeditutils.h
  56. +7 −7 src/core/geometry/qgsgeometryutils.h
  57. +3 −3 src/core/geometry/qgsgeos.h
  58. +1 −1 src/core/geometry/qgsinternalgeometryengine.h
  59. +1 −1 src/core/geometry/qgslinestring.h
  60. +1 −1 src/core/geometry/qgsmultilinestring.h
  61. +1 −1 src/core/geometry/qgsmultipolygon.h
  62. +2 −2 src/core/geometry/qgspointv2.h
  63. +1 −1 src/core/geometry/qgspolygon.h
  64. +18 −18 src/core/geometry/qgstriangle.h
  65. +1 −1 src/core/geometry/qgswkbtypes.h
  66. +3 −3 src/core/gps/qextserialport/qextserialenumerator.h
  67. +1 −1 src/core/gps/qextserialport/qextserialport.h
  68. +2 −2 src/core/layertree/qgslayertreemodellegendnode.h
  69. +2 −2 src/core/pal/feature.h
  70. +1 −1 src/core/pal/geomfunction.h
  71. +6 −6 src/core/pal/labelposition.h
  72. +1 −1 src/core/pal/layer.h
  73. +5 −5 src/core/pal/pal.h
  74. +2 −2 src/core/qgsapplication.h
  75. +9 −9 src/core/qgsattributeeditorelement.h
  76. +1 −1 src/core/qgsattributes.h
  77. +1 −1 src/core/qgsbrowsermodel.h
  78. +7 −7 src/core/qgscachedfeatureiterator.h
  79. +1 −1 src/core/qgscacheindex.h
  80. +1 −1 src/core/qgsclipper.h
  81. +17 −17 src/core/qgsconditionalstyle.h
  82. +1 −1 src/core/qgsconnectionpool.h
  83. +18 −18 src/core/qgscoordinatereferencesystem.h
  84. +7 −7 src/core/qgscoordinatetransform.h
  85. +1 −1 src/core/qgsdataitem.h
  86. +4 −4 src/core/qgsdataprovider.h
  87. +1 −1 src/core/qgsdistancearea.h
  88. +2 −2 src/core/qgseditformconfig.h
  89. +3 −3 src/core/qgseditorwidgetsetup.h
  90. +3 −3 src/core/qgserror.h
  91. +7 −7 src/core/qgsexpression.h
  92. +5 −5 src/core/qgsfeature.h
  93. +1 −1 src/core/qgsfeaturefilterprovider.h
  94. +3 −3 src/core/qgsfeatureiterator.h
  95. +8 −8 src/core/qgsfeaturerequest.h
  96. +5 −5 src/core/qgsfield.h
  97. +1 −1 src/core/qgsfieldformatter.h
  98. +4 −4 src/core/qgsfields.h
  99. +5 −5 src/core/qgsgml.h
  100. +3 −3 src/core/qgsgmlschema.h
  101. +2 −2 src/core/qgshistogram.h
  102. +1 −1 src/core/qgslabelsearchtree.h
  103. +35 −35 src/core/qgsmaplayer.h
  104. +5 −5 src/core/qgsmaplayerstylemanager.h
  105. +1 −1 src/core/qgsmaprenderercache.h
  106. +1 −1 src/core/qgsmaprendererjob.h
  107. +7 −7 src/core/qgsmapsettings.h
  108. +3 −3 src/core/qgsmaptopixel.h
  109. +2 −2 src/core/qgsmultirenderchecker.h
  110. +5 −5 src/core/qgsnetworkreplyparser.h
  111. +16 −16 src/core/qgsogcutils.h
  112. +1 −1 src/core/qgsogrutils.h
  113. +1 −1 src/core/qgspallabeling.h
  114. +4 −4 src/core/qgspoint.h
  115. +4 −4 src/core/qgsproject.h
  116. +1 −1 src/core/qgsprojectproperty.h
  117. +3 −3 src/core/qgsproviderregistry.h
  118. +2 −2 src/core/qgsrectangle.h
  119. +18 −18 src/core/qgsrelation.h
  120. +5 −5 src/core/qgsrelationmanager.h
  121. +5 −5 src/core/qgsrenderchecker.h
  122. +1 −1 src/core/qgsrendercontext.h
  123. +15 −15 src/core/qgsrulebasedlabeling.h
  124. +2 −2 src/core/qgsruntimeprofiler.h
  125. +2 −2 src/core/qgsscalecalculator.h
  126. +2 −2 src/core/qgsscaleutils.h
  127. +1 −1 src/core/qgssnapper.h
  128. +2 −2 src/core/qgssnappingconfig.h
  129. +3 −3 src/core/qgssqlstatement.h
  130. +1 −1 src/core/qgsstringutils.h
  131. +1 −1 src/core/qgstextrenderer.h
  132. +5 −5 src/core/qgstolerance.h
  133. +1 −1 src/core/qgstracer.h
  134. +1 −1 src/core/qgstransactiongroup.h
  135. +1 −1 src/core/qgsunittypes.h
  136. +16 −16 src/core/qgsvectordataprovider.h
  137. +3 −3 src/core/qgsvectorfilewriter.h
  138. +47 −47 src/core/qgsvectorlayer.h
  139. +6 −6 src/core/qgsvectorlayercache.h
  140. +1 −1 src/core/qgsvectorlayerdiagramprovider.h
  141. +1 −1 src/core/qgsvectorlayereditbuffer.h
  142. +11 −11 src/core/qgsvectorlayereditutils.h
  143. +1 −1 src/core/qgsvectorlayerjoinbuffer.h
  144. +1 −1 src/core/qgsvectorlayerlabelprovider.h
  145. +5 −5 src/core/qgsvectorlayertools.h
  146. +1 −1 src/core/raster/qgshillshaderenderer.h
  147. +32 −32 src/core/raster/qgsrasterblock.h
  148. +2 −2 src/core/raster/qgsrasterdataprovider.h
  149. +1 −1 src/core/raster/qgsrasterinterface.h
  150. +1 −1 src/core/raster/qgsrasteriterator.h
  151. +1 −1 src/core/raster/qgsrasterprojector.h
  152. +1 −1 src/core/raster/qgsrasterrange.h
  153. +1 −1 src/core/symbology-ng/qgsarrowsymbollayer.h
  154. +1 −1 src/core/symbology-ng/qgsgeometrygeneratorsymbollayer.h
  155. +3 −3 src/core/symbology-ng/qgslinesymbollayer.h
  156. +1 −1 src/core/symbology-ng/qgsmarkersymbollayer.h
  157. +6 −6 src/core/symbology-ng/qgsrenderer.h
  158. +14 −14 src/core/symbology-ng/qgsrulebasedrenderer.h
  159. +21 −21 src/core/symbology-ng/qgsstyle.h
  160. +5 −5 src/core/symbology-ng/qgssymbol.h
  161. +1 −1 src/core/symbology-ng/qgssymbollayer.h
  162. +1 −1 src/core/symbology-ng/qgssymbollayerutils.h
  163. +6 −6 src/gui/attributetable/qgsattributetablefiltermodel.h
  164. +3 −3 src/gui/attributetable/qgsattributetablemodel.h
  165. +1 −1 src/gui/attributetable/qgsattributetableview.h
  166. +6 −6 src/gui/attributetable/qgsdualview.h
  167. +3 −3 src/gui/attributetable/qgsfeaturelistmodel.h
  168. +5 −5 src/gui/attributetable/qgsfeaturelistview.h
  169. +2 −2 src/gui/attributetable/qgsfeatureselectionmodel.h
  170. +1 −1 src/gui/attributetable/qgsfieldconditionalformatwidget.h
  171. +2 −2 src/gui/attributetable/qgsifeatureselectionmanager.h
  172. +2 −2 src/gui/attributetable/qgsvectorlayerselectionmanager.h
  173. +3 −3 src/gui/editorwidgets/core/qgseditorconfigwidget.h
  174. +2 −2 src/gui/editorwidgets/core/qgseditorwidgetautoconf.h
  175. +6 −6 src/gui/editorwidgets/core/qgseditorwidgetfactory.h
  176. +9 −9 src/gui/editorwidgets/core/qgseditorwidgetregistry.h
  177. +7 −7 src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
  178. +1 −1 src/gui/editorwidgets/core/qgssearchwidgetwrapper.h
  179. +9 −9 src/gui/editorwidgets/core/qgswidgetwrapper.h
  180. +2 −2 src/gui/editorwidgets/qgsrelationreferencefactory.h
  181. +1 −1 src/gui/editorwidgets/qgsrelationreferencewidget.h
  182. +3 −3 src/gui/qgisgui.h
  183. +7 −7 src/gui/qgisinterface.h
  184. +7 −7 src/gui/qgsadvanceddigitizingdockwidget.h
  185. +2 −2 src/gui/qgsattributedialog.h
  186. +4 −4 src/gui/qgsattributeform.h
  187. +2 −2 src/gui/qgsattributetypeloaddialog.h
  188. +2 −2 src/gui/qgscolordialog.h
  189. +2 −2 src/gui/qgsexpressionbuilderwidget.h
  190. +2 −2 src/gui/qgsexpressionselectiondialog.h
  191. +1 −1 src/gui/qgsfeatureselectiondlg.h
  192. +2 −2 src/gui/qgsfilterlineedit.h
  193. +1 −1 src/gui/qgskeyvaluewidget.h
  194. +2 −2 src/gui/qgslistwidget.h
  195. +1 −1 src/gui/qgsmapcanvas.h
  196. +1 −1 src/gui/qgsmapcanvasitem.h
  197. +1 −1 src/gui/qgsmapcanvassnapper.h
  198. +6 −6 src/gui/qgsmaplayerconfigwidgetfactory.h
  199. +6 −6 src/gui/qgsmapmouseevent.h
  200. +1 −1 src/gui/qgsmaptooladvanceddigitizing.h
  201. +8 −8 src/gui/qgsmaptoolcapture.h
  202. +1 −1 src/gui/qgsmaptooledit.h
  203. +3 −3 src/gui/qgsmaptoolidentify.h
  204. +3 −3 src/gui/qgsmessagebar.h
  205. +2 −2 src/gui/qgsnewnamedialog.h
  206. +1 −1 src/gui/qgsoptionsdialogbase.h
  207. +2 −2 src/gui/qgsoptionswidgetfactory.h
  208. +1 −1 src/gui/qgsowssourceselect.h
  209. +3 −3 src/gui/qgspanelwidget.h
  210. +2 −2 src/gui/qgspanelwidgetstack.h
  211. +2 −2 src/gui/qgspixmaplabel.h
  212. +1 −1 src/gui/qgsprojectionselectiontreewidget.h
  213. +4 −4 src/gui/qgsrubberband.h
  214. +1 −1 src/gui/qgssearchquerybuilder.h
  215. +1 −1 src/gui/qgssourceselectdialog.h
  216. +1 −1 src/gui/raster/qgshillshaderendererwidget.h
  217. +1 −1 src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h
  218. +1 −1 src/gui/symbology-ng/qgsrulebasedrendererwidget.h
  219. +3 −3 src/gui/symbology-ng/qgssymbolselectordialog.h
  220. +2 −2 src/plugins/geometry_checker/utils/qgsgeometrycheckerutils.h
  221. +1 −1 src/plugins/georeferencer/qgsgeorefplugingui.h
  222. +1 −1 src/plugins/grass/qgsgrassmoduleoptions.h
  223. +1 −1 src/plugins/grass/qtermwidget/Character.h
  224. +1 −1 src/plugins/grass/qtermwidget/ColorScheme.h
  225. +11 −11 src/plugins/grass/qtermwidget/kprocess.h
  226. +8 −8 src/plugins/grass/qtermwidget/kpty.h
  227. +3 −3 src/plugins/grass/qtermwidget/kptydevice.h
  228. +3 −3 src/plugins/grass/qtermwidget/kptyprocess.h
  229. +2 −2 src/plugins/grass/qtermwidget/qtermwidget.h
  230. +19 −19 src/providers/delimitedtext/qgsdelimitedtextfile.h
  231. +6 −6 src/providers/delimitedtext/qgsdelimitedtextprovider.h
  232. +7 −7 src/providers/grass/qgsgrass.h
  233. +41 −41 src/providers/grass/qgsgrassprovider.h
  234. +2 −2 src/providers/grass/qgsgrassvector.h
  235. +4 −4 src/providers/grass/qgsgrassvectormap.h
  236. +2 −2 src/providers/grass/qgsgrassvectormaplayer.h
  237. +4 −4 src/providers/postgres/qgspostgresprovider.h
  238. +1 −1 src/providers/spatialite/qgsspatialiteconnection.h
  239. +1 −1 src/providers/wcs/qgswcscapabilities.h
  240. +1 −1 src/providers/wfs/qgswfsprovider.h
  241. +1 −1 src/providers/wfs/qgswfssourceselect.h
  242. +3 −3 src/python/qgspythonutils.h
  243. +6 −6 src/python/qgspythonutilsimpl.h
  244. +9 −9 src/server/qgsaccesscontrol.h
  245. +6 −6 src/server/qgsaccesscontrolfilter.h
  246. +1 −1 src/server/qgsftptransaction.h
  247. +2 −2 src/server/qgshttptransaction.h
  248. +1 −1 src/server/qgsinterpolationlayerbuilder.h
  249. +1 −1 src/server/qgsmslayerbuilder.h
  250. +1 −1 src/server/qgsmslayercache.h
  251. +1 −1 src/server/qgsremotedatasourcebuilder.h
  252. +1 −1 src/server/qgssentdatasourcebuilder.h
  253. +1 −1 src/server/qgsserver.h
  254. +5 −5 src/server/qgsserverexception.h
  255. +6 −6 src/server/qgsserverinterface.h
  256. +1 −1 src/server/qgsserverinterfaceimpl.h
  257. +1 −1 src/server/qgsserverlogger.h
  258. +1 −1 src/server/qgsserverplugins.h
  259. +4 −4 src/server/qgsserverprojectparser.h
  260. +18 −18 src/server/qgsserverprojectutils.h
  261. +3 −3 src/server/qgsserverrequest.h
  262. +3 −3 src/server/qgsserverresponse.h
  263. +10 −10 src/server/qgsserversettings.h
  264. +2 −2 src/server/qgsservice.h
  265. +2 −2 src/server/qgsservicenativeloader.h
  266. +2 −2 src/server/qgsserviceregistry.h
  267. +4 −4 src/server/qgssldconfigparser.h
  268. +1 −1 src/server/services/wms/qgsmaprendererjobproxy.h
  269. +7 −7 src/server/services/wms/qgswmsrenderer.h
  270. +2 −2 src/server/services/wms/qgswmsutils.h
@@ -101,7 +101,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
virtual QList<int> *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:
@@ -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:
@@ -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;
};
@@ -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 );

@@ -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;}
@@ -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<vertexData> 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 );
};

@@ -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 );
};

@@ -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;

@@ -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(); }

@@ -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();

@@ -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();

@@ -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.
@@ -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:
@@ -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
@@ -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<int> &breaks, double *frequencies );
@@ -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:
@@ -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
@@ -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;

@@ -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;}
@@ -117,21 +117,21 @@ 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;
}

/*!
\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
{
@@ -143,15 +143,15 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem
PrivateData *d_data;
};

//! \return the curve data
//! \returns the curve data
inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const
{
return d_series;
}

/*!
\param i index
\return point at position i
\returns point at position i
*/
inline QwtPointPolar QwtPolarCurve::sample( int i ) const
{
@@ -141,15 +141,15 @@ class QWT_POLAR_EXPORT QwtPolarCurve: public QwtPolarItem
PrivateData *d_data;
};

//! \return the the curve data
//! \returns the the curve data
inline const QwtSeriesData<QwtPointPolar> *QwtPolarCurve::data() const
{
return d_series;
}

/*!
\param i index
\return point at position i
\returns point at position i
*/
inline QwtPointPolar QwtPolarCurve::sample( int i ) const
{