Skip to content
Permalink
Browse files
Change doxygen @note to \note
  • Loading branch information
nyalldawson committed Apr 3, 2017
1 parent 97611fe commit 0326f7142d25e1abe48db3b9a67e5456ad592d63
Showing with 769 additions and 769 deletions.
  1. +1 −1 src/analysis/interpolation/DualEdgeTriangulation.h
  2. +1 −1 src/analysis/interpolation/NormVecDecorator.h
  3. +1 −1 src/analysis/interpolation/qgsinterpolator.h
  4. +2 −2 src/analysis/network/qgsgraphbuilderinterface.h
  5. +1 −1 src/analysis/network/qgsgraphdirector.h
  6. +8 −8 src/analysis/openstreetmap/qgsosmdatabase.h
  7. +1 −1 src/analysis/openstreetmap/qgsosmimport.h
  8. +3 −3 src/analysis/raster/qgsalignraster.h
  9. +1 −1 src/analysis/raster/qgsrastercalcnode.h
  10. +3 −3 src/analysis/raster/qgsrastermatrix.h
  11. +4 −4 src/app/qgisapp.h
  12. +1 −1 src/app/qgisappinterface.h
  13. +2 −2 src/app/qgisappstylesheet.h
  14. +1 −1 src/app/qgsclipboard.h
  15. +3 −3 src/app/qgsmaptooloffsetpointsymbol.h
  16. +1 −1 src/app/qgsprojectproperties.h
  17. +1 −1 src/app/qgsselectbyformdialog.h
  18. +11 −11 src/core/auth/qgsauthcertutils.h
  19. +7 −7 src/core/auth/qgsauthconfig.h
  20. +13 −13 src/core/auth/qgsauthmanager.h
  21. +6 −6 src/core/auth/qgsauthmethod.h
  22. +6 −6 src/core/composer/qgsatlascomposition.h
  23. +5 −5 src/core/composer/qgscomposerattributetablev2.h
  24. +14 −14 src/core/composer/qgscomposeritem.h
  25. +11 −11 src/core/composer/qgscomposermap.h
  26. +6 −6 src/core/composer/qgscomposermapgrid.h
  27. +5 −5 src/core/composer/qgscomposermapitem.h
  28. +5 −5 src/core/composer/qgscomposermapoverview.h
  29. +1 −1 src/core/composer/qgscomposerobject.h
  30. +3 −3 src/core/composer/qgscomposerpicture.h
  31. +5 −5 src/core/composer/qgscomposerscalebar.h
  32. +6 −6 src/core/composer/qgscomposertablecolumn.h
  33. +4 −4 src/core/composer/qgscomposertablev2.h
  34. +2 −2 src/core/composer/qgscomposertexttable.h
  35. +8 −8 src/core/composer/qgscomposition.h
  36. +12 −12 src/core/dxf/qgsdxfexport.h
  37. +1 −1 src/core/dxf/qgsdxfpaintdevice.h
  38. +2 −2 src/core/dxf/qgsdxfpallabeling.h
  39. +2 −2 src/core/effects/qgsimageoperation.h
  40. +6 −6 src/core/effects/qgspainteffectregistry.h
  41. +10 −10 src/core/geometry/qgsgeometry.h
  42. +13 −13 src/core/geometry/qgsgeometryutils.h
  43. +1 −1 src/core/geometry/qgsgeos.h
  44. +1 −1 src/core/geometry/qgsinternalgeometryengine.h
  45. +6 −6 src/core/geometry/qgspointv2.h
  46. +2 −2 src/core/geometry/qgstriangle.h
  47. +3 −3 src/core/gps/qgsqtlocationconnection.h
  48. +3 −3 src/core/layertree/qgslayertree.h
  49. +3 −3 src/core/layertree/qgslayertreemodel.h
  50. +1 −1 src/core/layertree/qgslayertreeutils.h
  51. +1 −1 src/core/pal/labelposition.h
  52. +1 −1 src/core/pal/layer.h
  53. +2 −2 src/core/qgis.h
  54. +1 −1 src/core/qgsactionmanager.h
  55. +2 −2 src/core/qgsanimatedicon.h
  56. +11 −11 src/core/qgsapplication.h
  57. +2 −2 src/core/qgsattributes.h
  58. +1 −1 src/core/qgsbrowsermodel.h
  59. +1 −1 src/core/qgsclipper.h
  60. +1 −1 src/core/qgscolorramp.h
  61. +1 −1 src/core/qgscolorschemeregistry.h
  62. +23 −23 src/core/qgscoordinatereferencesystem.h
  63. +5 −5 src/core/qgscoordinatetransform.h
  64. +2 −2 src/core/qgsdataitem.h
  65. +5 −5 src/core/qgsdataprovider.h
  66. +1 −1 src/core/qgsdatasourceuri.h
  67. +2 −2 src/core/qgsdatetimestatisticalsummary.h
  68. +5 −5 src/core/qgsdiagramrenderer.h
  69. +4 −4 src/core/qgsdistancearea.h
  70. +1 −1 src/core/qgsexception.h
  71. +19 −19 src/core/qgsexpression.h
  72. +1 −1 src/core/qgsexpressioncontext.h
  73. +13 −13 src/core/qgsfeature.h
  74. +3 −3 src/core/qgsfeatureiterator.h
  75. +6 −6 src/core/qgsfields.h
  76. +3 −3 src/core/qgsfontutils.h
  77. +2 −2 src/core/qgsgml.h
  78. +4 −4 src/core/qgshistogram.h
  79. +4 −4 src/core/qgsinterval.h
  80. +6 −6 src/core/qgsjsonutils.h
  81. +2 −2 src/core/qgslabelfeature.h
  82. +6 −6 src/core/qgslabelingengine.h
  83. +3 −3 src/core/qgslabelsearchtree.h
  84. +2 −2 src/core/qgslogger.h
  85. +3 −3 src/core/qgsmaphittest.h
  86. +8 −8 src/core/qgsmaplayer.h
  87. +1 −1 src/core/qgsmaplayermodel.h
  88. +1 −1 src/core/qgsmaplayerref.h
  89. +1 −1 src/core/qgsmaprenderercustompainterjob.h
  90. +10 −10 src/core/qgsmaprendererjob.h
  91. +3 −3 src/core/qgsmaprendererparalleljob.h
  92. +1 −1 src/core/qgsmapsettings.h
  93. +3 −3 src/core/qgsmapthemecollection.h
  94. +2 −2 src/core/qgsmaptopixel.h
  95. +1 −1 src/core/qgsmessageoutput.h
  96. +1 −1 src/core/qgsmultirenderchecker.h
  97. +1 −1 src/core/qgsnetworkdiskcache.h
  98. +7 −7 src/core/qgsogcutils.h
  99. +1 −1 src/core/qgsoptional.h
  100. +2 −2 src/core/qgspalgeometry.h
  101. +2 −2 src/core/qgspallabeling.h
  102. +39 −39 src/core/qgsproject.h
  103. +2 −2 src/core/qgsprojectproperty.h
  104. +2 −2 src/core/qgsproviderregistry.h
  105. +3 −3 src/core/qgsrelation.h
  106. +3 −3 src/core/qgsrenderchecker.h
  107. +3 −3 src/core/qgsrendercontext.h
  108. +6 −6 src/core/qgsrulebasedlabeling.h
  109. +1 −1 src/core/qgsruntimeprofiler.h
  110. +2 −2 src/core/qgsspatialindex.h
  111. +6 −6 src/core/qgssqlstatement.h
  112. +4 −4 src/core/qgsstatisticalsummary.h
  113. +4 −4 src/core/qgsstringstatisticalsummary.h
  114. +6 −6 src/core/qgstaskmanager.h
  115. +1 −1 src/core/qgstextlabelfeature.h
  116. +1 −1 src/core/qgsvectordataprovider.h
  117. +3 −3 src/core/qgsvectorfilewriter.h
  118. +17 −17 src/core/qgsvectorlayer.h
  119. +3 −3 src/core/qgsvectorlayercache.h
  120. +4 −4 src/core/qgsvectorlayerdiagramprovider.h
  121. +5 −5 src/core/qgsvectorlayereditutils.h
  122. +17 −17 src/core/qgsvectorlayerfeatureiterator.h
  123. +4 −4 src/core/qgsvectorlayerlabeling.h
  124. +2 −2 src/core/qgsvectorlayerlabelprovider.h
  125. +3 −3 src/core/qgsvectorlayerrenderer.h
  126. +1 −1 src/core/raster/qgsraster.h
  127. +7 −7 src/core/raster/qgsrasterblock.h
  128. +8 −8 src/core/raster/qgsrasterdataprovider.h
  129. +1 −1 src/core/raster/qgsrasterdrawer.h
  130. +1 −1 src/core/raster/qgsrasterfilewriter.h
  131. +1 −1 src/core/raster/qgsrasterhistogram.h
  132. +3 −3 src/core/raster/qgsrasterinterface.h
  133. +4 −4 src/core/raster/qgsrasterlayer.h
  134. +2 −2 src/core/raster/qgsrasterlayerrenderer.h
  135. +1 −1 src/core/raster/qgsrasterrange.h
  136. +1 −1 src/core/raster/qgssinglebandpseudocolorrenderer.h
  137. +1 −1 src/core/symbology-ng/qgscptcityarchive.h
  138. +5 −5 src/core/symbology-ng/qgsgraduatedsymbolrenderer.h
  139. +2 −2 src/core/symbology-ng/qgsheatmaprenderer.h
  140. +1 −1 src/core/symbology-ng/qgsinvertedpolygonrenderer.h
  141. +6 −6 src/core/symbology-ng/qgsmarkersymbollayer.h
  142. +1 −1 src/core/symbology-ng/qgspointdistancerenderer.h
  143. +5 −5 src/core/symbology-ng/qgsrenderer.h
  144. +7 −7 src/core/symbology-ng/qgsrendererregistry.h
  145. +3 −3 src/core/symbology-ng/qgsrulebasedrenderer.h
  146. +1 −1 src/core/symbology-ng/qgssvgcache.h
  147. +1 −1 src/core/symbology-ng/qgssymbol.h
  148. +2 −2 src/core/symbology-ng/qgssymbollayer.h
  149. +7 −7 src/core/symbology-ng/qgssymbollayerregistry.h
  150. +3 −3 src/core/symbology-ng/qgssymbollayerutils.h
  151. +1 −1 src/gui/attributetable/qgsattributetabledelegate.h
  152. +1 −1 src/gui/attributetable/qgsattributetablemodel.h
  153. +1 −1 src/gui/attributetable/qgsfeaturelistview.h
  154. +1 −1 src/gui/auth/qgsauthcertificateinfo.h
  155. +1 −1 src/gui/auth/qgsauthimportidentitydialog.h
  156. +1 −1 src/gui/auth/qgsauthmethodedit.h
  157. +1 −1 src/gui/auth/qgsauthsslconfigwidget.h
  158. +1 −1 src/gui/editorwidgets/core/qgseditorwidgetautoconf.h
  159. +1 −1 src/gui/editorwidgets/core/qgseditorwidgetfactory.h
  160. +1 −1 src/gui/editorwidgets/core/qgseditorwidgetregistry.h
  161. +3 −3 src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
  162. +1 −1 src/gui/editorwidgets/qgscheckboxsearchwidgetwrapper.h
  163. +3 −3 src/gui/editorwidgets/qgsdatetimeedit.h
  164. +2 −2 src/gui/editorwidgets/qgsdefaultsearchwidgetwrapper.h
  165. +1 −1 src/gui/editorwidgets/qgskeyvaluewidgetfactory.h
  166. +1 −1 src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h
  167. +1 −1 src/gui/editorwidgets/qgslistwidgetfactory.h
  168. +1 −1 src/gui/editorwidgets/qgslistwidgetwrapper.h
  169. +1 −1 src/gui/effects/qgseffectstackpropertieswidget.h
  170. +1 −1 src/gui/layertree/qgslayertreeembeddedconfigwidget.h
  171. +2 −2 src/gui/layertree/qgslayertreeembeddedwidgetregistry.h
  172. +1 −1 src/gui/layertree/qgslayertreeembeddedwidgetsimpl.h
  173. +1 −1 src/gui/qgisgui.h
  174. +6 −6 src/gui/qgisinterface.h
  175. +3 −3 src/gui/qgsadvanceddigitizingdockwidget.h
  176. +3 −3 src/gui/qgsattributeform.h
  177. +5 −5 src/gui/qgsattributeformeditorwidget.h
  178. +1 −1 src/gui/qgsattributeformlegacyinterface.h
  179. +3 −3 src/gui/qgscollapsiblegroupbox.h
  180. +5 −5 src/gui/qgscolorbutton.h
  181. +4 −4 src/gui/qgscolorschemelist.h
  182. +2 −2 src/gui/qgscolorswatchgrid.h
  183. +2 −2 src/gui/qgscolorwidgets.h
  184. +2 −2 src/gui/qgscredentialdialog.h
  185. +1 −1 src/gui/qgsdetaileditemdata.h
  186. +3 −3 src/gui/qgsexpressionbuilderwidget.h
  187. +1 −1 src/gui/qgsfilewidget.h
  188. +6 −6 src/gui/qgsidentifymenu.h
  189. +1 −1 src/gui/qgskeyvaluewidget.h
  190. +1 −1 src/gui/qgslistwidget.h
  191. +2 −2 src/gui/qgsmapcanvas.h
  192. +1 −1 src/gui/qgsmapcanvasmap.h
  193. +1 −1 src/gui/qgsmapcanvassnapper.h
  194. +1 −1 src/gui/qgsmaplayeractionregistry.h
  195. +1 −1 src/gui/qgsmaplayerconfigwidget.h
  196. +3 −3 src/gui/qgsmaplayerconfigwidgetfactory.h
  197. +1 −1 src/gui/qgsmapmouseevent.h
  198. +1 −1 src/gui/qgsmaptool.h
  199. +2 −2 src/gui/qgsmaptooladvanceddigitizing.h
  200. +1 −1 src/gui/qgsowssourceselect.h
  201. +4 −4 src/gui/qgspanelwidget.h
  202. +2 −2 src/gui/qgspanelwidgetstack.h
  203. +1 −1 src/gui/qgspropertyassistantwidget.h
  204. +1 −1 src/gui/qgspropertyoverridebutton.h
  205. +1 −1 src/gui/qgsscalewidget.h
  206. +3 −3 src/gui/qgssqlcomposerdialog.h
  207. +1 −1 src/gui/qgsunitselectionwidget.h
  208. +1 −1 src/gui/raster/qgsrasterhistogramwidget.h
  209. +1 −1 src/gui/raster/qgsrasterminmaxwidget.h
  210. +1 −1 src/gui/symbology-ng/qgsrendererpropertiesdialog.h
  211. +1 −1 src/gui/symbology-ng/qgsrendererwidget.h
  212. +1 −1 src/gui/symbology-ng/qgsrulebasedrendererwidget.h
  213. +2 −2 src/gui/symbology-ng/qgssmartgroupeditordialog.h
  214. +3 −3 src/gui/symbology-ng/qgssymbollevelsdialog.h
  215. +6 −6 src/gui/symbology-ng/qgssymbolselectordialog.h
  216. +1 −1 src/plugins/grass/qtermwidget/kprocess.h
  217. +2 −2 src/providers/delimitedtext/qgsdelimitedtextprovider.h
  218. +2 −2 src/providers/grass/qgsgrassrasterprovider.h
  219. +1 −1 src/providers/ogr/qgsogrconnpool.h
  220. +1 −1 src/providers/oracle/qgsoracleprovider.h
  221. +1 −1 src/providers/postgres/qgspostgresconn.h
  222. +2 −2 src/providers/postgres/qgspostgresprovider.h
  223. +1 −1 src/providers/spatialite/qgsspatialiteprovider.h
  224. +1 −1 src/server/qgshttptransaction.h
  225. +1 −1 src/server/qgsrequesthandler.h
  226. +3 −3 src/server/qgsserverinterface.h
  227. +2 −2 src/server/qgsserverresponse.h
  228. +1 −1 src/server/services/wms/qgswmsrenderer.h
@@ -59,7 +59,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
//! Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)
int getOppositePoint( int p1, int p2 ) override;
//! Finds out, in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'
//! @note not available in Python bindings
//! \note not available in Python bindings
virtual bool getTriangle( double x, double y, Point3D *p1, int *n1, Point3D *p2, int *n2, Point3D *p3, int *n3 ) override;
//! Finds out, in which triangle the point with coordinates x and y is and assigns addresses to the points at the vertices to 'p1', 'p2' and 'p3
virtual bool getTriangle( double x, double y, Point3D *p1, Point3D *p2, Point3D *p3 ) override;
@@ -55,7 +55,7 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator
bool getTriangle( double x, double y, Point3D *p1, Vector3D *v1, Point3D *p2, Vector3D *v2, Point3D *p3, Vector3D *v3 );

/** This function behaves similar to the one above. Additionally, the numbers of the points are returned (ptn1, ptn2, ptn3) as well as the PointStates of the triangle points (state1, state2, state3)
* @note not available in Python bindings
* \note not available in Python bindings
*/
bool getTriangle( double x, double y, Point3D *p1, int *ptn1, Vector3D *v1, PointState *state1, Point3D *p2, int *ptn2, Vector3D *v2, PointState *state2, Point3D *p3, int *ptn3, Vector3D *v3, PointState *state3 );
//! Returns the state of the point with the number 'pointno'
@@ -66,7 +66,7 @@ class ANALYSIS_EXPORT QgsInterpolator
@return 0 in case of success*/
virtual int interpolatePoint( double x, double y, double &result ) = 0;

//! @note not available in Python bindings
//! \note not available in Python bindings
QList<LayerData> layerData() const { return mLayerData; }

protected:
@@ -82,7 +82,7 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface
* Add vertex to the graph
* @param id vertex identifier
* @param pt vertex coordinates
* @note id and pt are redundant. You can use pt or id to identify the vertex
* \note id and pt are redundant. You can use pt or id to identify the vertex
*/
virtual void addVertex( int id, const QgsPoint &pt )
{
@@ -97,7 +97,7 @@ class ANALYSIS_EXPORT QgsGraphBuilderInterface
* @param pt2id second vertex identificator
* @param pt2 second vertex coordinates
* @param strategies optimization strategies
* @note pt1id, pt1 and pt2id, pt2 is a redundant interface. You can use vertex coordinates or their identificators.
* \note pt1id, pt1 and pt2id, pt2 is a redundant interface. You can use vertex coordinates or their identificators.
*/
virtual void addEdge( int pt1id, const QgsPoint &pt1, int pt2id, const QgsPoint &pt2, const QVector< QVariant > &strategies )
{
@@ -50,7 +50,7 @@ class ANALYSIS_EXPORT QgsGraphDirector : public QObject
* @param builder the graph builder
* @param additionalPoints list of points that should be snapped to the graph
* @param snappedPoints list of snapped points
* @note if snappedPoints[i] == QgsPoint(0.0,0.0) then snapping failed.
* \note if snappedPoints[i] == QgsPoint(0.0,0.0) then snapping failed.
*/
virtual void makeGraph( QgsGraphBuilderInterface *builder,
const QVector< QgsPoint > &additionalPoints,
@@ -69,10 +69,10 @@ class ANALYSIS_EXPORT QgsOSMDatabase
int countNodes() const;
int countWays() const;

//! @note not available in Python bindings
//! \note not available in Python bindings
QgsOSMNodeIterator listNodes() const;

//! @note not available in Python bindings
//! \note not available in Python bindings
QgsOSMWayIterator listWays() const;

QgsOSMNode node( QgsOSMId id ) const;
@@ -81,7 +81,7 @@ class ANALYSIS_EXPORT QgsOSMDatabase

QgsOSMTags tags( bool way, QgsOSMId id ) const;

//! @note available in Python bindings
//! \note available in Python bindings
QList<QgsOSMTagCountPair> usedTags( bool ways ) const;

QgsPolyline wayPoints( QgsOSMId id ) const;
@@ -98,7 +98,7 @@ class ANALYSIS_EXPORT QgsOSMDatabase
int runCountStatement( const char *sql ) const;

/**
* @note not available in Python bindings
* \note not available in Python bindings
*/
void deleteStatement( sqlite3_stmt *&stmt );

@@ -131,7 +131,7 @@ class ANALYSIS_EXPORT QgsOSMDatabase

/** \ingroup analysis
* Encapsulate iteration over table of nodes/
* @note not available in Python bindings
* \note not available in Python bindings
*/
class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three
{
@@ -143,7 +143,7 @@ class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three

protected:

/** @note not available in Python bindings
/** \note not available in Python bindings
*/
QgsOSMNodeIterator( sqlite3 *handle );

@@ -157,7 +157,7 @@ class ANALYSIS_EXPORT QgsOSMNodeIterator // clazy:exclude=rule-of-three

/** \ingroup analysis
* Encapsulate iteration over table of ways
* @note not available in Python bindings
* \note not available in Python bindings
*/
class ANALYSIS_EXPORT QgsOSMWayIterator // clazy:exclude=rule-of-three
{
@@ -169,7 +169,7 @@ class ANALYSIS_EXPORT QgsOSMWayIterator // clazy:exclude=rule-of-three

protected:

/** @note not available in Python bindings
/** \note not available in Python bindings
*/
QgsOSMWayIterator( sqlite3 *handle );

@@ -71,7 +71,7 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject
bool createDatabase();
bool closeDatabase();

//! @note not available in Python bindings
//! \note not available in Python bindings
void deleteStatement( sqlite3_stmt *&stmt );

bool createIndexes();
@@ -96,7 +96,7 @@ class ANALYSIS_EXPORT QgsAlignRaster


//! Resampling algorithm to be used (equivalent to GDAL's enum GDALResampleAlg)
//! @note RA_Max, RA_Min, RA_Median, RA_Q1 and RA_Q3 are available on GDAL >= 2.0 builds only
//! \note RA_Max, RA_Min, RA_Median, RA_Q1 and RA_Q3 are available on GDAL >= 2.0 builds only
enum ResampleAlg
{
RA_NearestNeighbour = 0, //!< Nearest neighbour (select on one input pixel)
@@ -205,10 +205,10 @@ class ANALYSIS_EXPORT QgsAlignRaster
bool checkInputParameters();

//! Return expected size of the resulting aligned raster
//! @note first need to run checkInputParameters() which returns with success
//! \note first need to run checkInputParameters() which returns with success
QSize alignedRasterSize() const;
//! Return expected extent of the resulting aligned raster
//! @note first need to run checkInputParameters() which returns with success
//! \note first need to run checkInputParameters() which returns with success
QgsRectangle alignedRasterExtent() const;

//! Run the alignment process
@@ -94,7 +94,7 @@ class ANALYSIS_EXPORT QgsRasterCalcNode
* @param row optional row number to calculate for calculating result by rows, or -1 to
* calculate entire result
* \since QGIS 2.10
* @note not available in Python bindings
* \note not available in Python bindings
*/
bool calculate( QMap<QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row = -1 ) const;

@@ -60,7 +60,7 @@ class ANALYSIS_EXPORT QgsRasterMatrix

//! Takes ownership of data array
QgsRasterMatrix();
//! @note note available in Python bindings
//! \note note available in Python bindings
QgsRasterMatrix( int nCols, int nRows, double *data, double nodataValue );
QgsRasterMatrix( const QgsRasterMatrix &m );
~QgsRasterMatrix();
@@ -70,10 +70,10 @@ class ANALYSIS_EXPORT QgsRasterMatrix
double number() const { return mData[0]; }

//! Returns data array (but not ownership)
//! @note not available in Python bindings
//! \note not available in Python bindings
double *data() { return mData; }
//! Returns data and ownership. Sets data and nrows, ncols of this matrix to 0
//! @note not available in Python bindings
//! \note not available in Python bindings
double *takeData();

void setData( int cols, int rows, double *data, double nodataValue );
@@ -186,7 +186,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow

/** Open a raster layer for the given file
@returns false if unable to open a raster layer for rasterFile
@note
\note
This is essentially a simplified version of the above
*/
QgsRasterLayer *addRasterLayer( const QString &rasterFile, const QString &baseName, bool guiWarning = true );
@@ -372,7 +372,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow

/** Notify the user by using the system tray notifications
*
* @note usage of the system tray notifications should be limited
* \note usage of the system tray notifications should be limited
* to long running tasks and to when the user needs to be notified
* about interaction with OS services, like the password manager.
*
@@ -1475,15 +1475,15 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void keyPressed( QKeyEvent *e );

/** Emitted when a project file is successfully read
@note
\note
This is useful for plug-ins that store properties with project files. A
plug-in can connect to this signal. When it is emitted, the plug-in
knows to then check the project properties for any relevant state.
*/
void projectRead();

/** Emitted when starting an entirely new project
@note
\note
This is similar to projectRead(); plug-ins might want to be notified
that they're in a new project. Yes, projectRead() could have been
overloaded to be used in the case of new projects instead. However,
@@ -294,7 +294,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface

/** Register a new custom drop handler.
* \since QGIS 3.0
* @note Ownership of the factory is not transferred, and the factory must
* \note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* @see unregisterCustomDropHandler() */
virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) override;
@@ -39,7 +39,7 @@ class APP_EXPORT QgisAppStyleSheet: public QObject

/** Generate stylesheet
* @param opts generated default option values, or a changed copy of them
* @note on success emits appStyleSheetChanged
* \note on success emits appStyleSheetChanged
*/
void buildStyleSheet( const QMap<QString, QVariant> &opts );

@@ -52,7 +52,7 @@ class APP_EXPORT QgisAppStyleSheet: public QObject
signals:

/** Signal the successful stylesheet build results
* @note connect to (app|widget)->setStyleSheet or similar custom slot
* \note connect to (app|widget)->setStyleSheet or similar custom slot
*/
void appStyleSheetChanged( const QString &appStyleSheet );

@@ -169,7 +169,7 @@ class APP_EXPORT QgsClipboard : public QObject

/** Attempts to parse the clipboard contents and return a QgsFields object representing the fields
* present in the clipboard.
* @note Only valid for text based clipboard contents
* \note Only valid for text based clipboard contents
*/
QgsFields retrieveFields() const;

@@ -75,16 +75,16 @@ class APP_EXPORT QgsMapToolOffsetPointSymbol: public QgsMapToolPointSymbol
void createPreviewItem( QgsMarkerSymbol *markerSymbol );

//! Calculates the new values for offset attributes, respecting the symbol's offset units
//! @note start and end point are in map units
//! \note start and end point are in map units
QMap< int, QVariant > calculateNewOffsetAttributes( const QgsPoint &startPoint, const QgsPoint &endPoint ) const;

/** Updates the preview item to reflect a new offset.
* @note start and end points are in map units
* \note start and end points are in map units
*/
void updateOffsetPreviewItem( const QgsPoint &startPoint, const QgsPoint &endPoint );

//! Calculates the required offset from the start to end points, in the specified unit
//! @note start and end points are in map units
//! \note start and end points are in map units
QPointF calculateOffset( const QgsPoint &startPoint, const QgsPoint &endPoint, QgsUnitTypes::RenderUnit unit ) const;

//! Adjusts the calculated offset to account for the symbol's rotation
@@ -33,7 +33,7 @@ class QgsLayerTreeGroup;

/** Dialog to set project level properties
@note actual state is stored in QgsProject singleton instance
\note actual state is stored in QgsProject singleton instance
*/
class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui::QgsProjectPropertiesBase
@@ -28,7 +28,7 @@ class QgsMapCanvas;
/** \ingroup app
* \class QgsSelectByFormDialog
* A dialog for selecting features from a layer, using a form based off the layer's editor widgets.
* @note introduced in QGIS 2.16
* \note introduced in QGIS 2.16
*/

class APP_EXPORT QgsSelectByFormDialog : public QDialog
@@ -86,7 +86,7 @@ class CORE_EXPORT QgsAuthCertUtils
static QMap<QString, QSslCertificate> mapDigestToCerts( const QList<QSslCertificate> &certs );

/** Map certificates to their oraganization.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QMap< QString, QList<QSslCertificate> > certsGroupedByOrg( const QList<QSslCertificate> &certs );

@@ -95,7 +95,7 @@ class CORE_EXPORT QgsAuthCertUtils
static QMap<QString, QgsAuthConfigSslServer> mapDigestToSslConfigs( const QList<QgsAuthConfigSslServer> &configs );

/** Map SSL custom configs' certificates to their oraganization.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QMap< QString, QList<QgsAuthConfigSslServer> > sslConfigsGroupedByOrg( const QList<QgsAuthConfigSslServer> &configs );

@@ -159,7 +159,7 @@ class CORE_EXPORT QgsAuthCertUtils
* @param qcert Qt SSL cert object
* @param acert QCA SSL cert object to add more info to the output
* @param issuer Whether to return cert's subject or issuer combined name
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QString getCertDistinguishedName( const QSslCertificate &qcert,
const QCA::Certificate &acert = QCA::Certificate(),
@@ -178,37 +178,37 @@ class CORE_EXPORT QgsAuthCertUtils
static QString shaHexForCert( const QSslCertificate &cert, bool formatted = false );

/** Convert a QSslCertificate to a QCA::Certificate.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QCA::Certificate qtCertToQcaCert( const QSslCertificate &cert );

/** Convert a QList of QSslCertificate to a QCA::CertificateCollection.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QCA::CertificateCollection qtCertsToQcaCollection( const QList<QSslCertificate> &certs );

/** PKI key/cert bundle from file path, e.g. from .p12 or pfx files.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QCA::KeyBundle qcaKeyBundle( const QString &path, const QString &pass );

/** Certificate validity check messages per enum.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QString qcaValidityMessage( QCA::Validity validity );

/** Certificate signature algorithm strings per enum.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QString qcaSignatureAlgorithm( QCA::SignatureAlgorithm algorithm );

/** Certificate well-known constraint strings per enum.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QString qcaKnownConstraint( QCA::ConstraintTypeKnown constraint );

/** Certificate usage type strings per enum
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QString certificateUsageTypeString( QgsAuthCertUtils::CertUsageType usagetype );

@@ -234,7 +234,7 @@ class CORE_EXPORT QgsAuthCertUtils
static QString sslErrorEnumString( QSslError::SslError errenum );

/** Get short strings describing SSL errors.
* @note not available in Python bindings
* \note not available in Python bindings
*/
static QList<QPair<QSslError::SslError, QString> > sslErrorEnumStrings();

Loading

0 comments on commit 0326f71

Please sign in to comment.