Skip to content
Permalink
Browse files
@see -> \see
  • Loading branch information
nyalldawson committed Apr 3, 2017
1 parent e47073b commit dfb5f56f807289c3e70361ff8dda704b4b0da70f
Showing with 3,723 additions and 3,723 deletions.
  1. +2 −2 src/analysis/openstreetmap/qgsosmimport.h
  2. +6 −6 src/analysis/raster/qgskde.h
  3. +6 −6 src/app/composer/qgscomposerimageexportoptionsdialog.h
  4. +1 −1 src/app/dwg/libdxfrw/drw_interface.h
  5. +6 −6 src/app/ogr/qgsvectorlayersaveasdialog.h
  6. +1 −1 src/app/qgisapp.h
  7. +2 −2 src/app/qgisappinterface.h
  8. +2 −2 src/app/qgsdecorationitem.h
  9. +16 −16 src/app/qgsmapcanvasdockwidget.h
  10. +2 −2 src/app/qgsmaptoolselectutils.h
  11. +8 −8 src/app/qgspointmarkeritem.h
  12. +1 −1 src/app/qgstip.h
  13. +1 −1 src/app/qgstipfactory.h
  14. +36 −36 src/core/annotations/qgsannotation.h
  15. +9 −9 src/core/annotations/qgsannotationmanager.h
  16. +2 −2 src/core/annotations/qgshtmlannotation.h
  17. +2 −2 src/core/annotations/qgssvgannotation.h
  18. +2 −2 src/core/annotations/qgstextannotation.h
  19. +2 −2 src/core/auth/qgsauthmanager.h
  20. +25 −25 src/core/composer/qgsatlascomposition.h
  21. +26 −26 src/core/composer/qgscomposerarrow.h
  22. +11 −11 src/core/composer/qgscomposerattributetablemodelv2.h
  23. +35 −35 src/core/composer/qgscomposerattributetablev2.h
  24. +7 −7 src/core/composer/qgscomposerframe.h
  25. +34 −34 src/core/composer/qgscomposerhtml.h
  26. +78 −78 src/core/composer/qgscomposeritem.h
  27. +6 −6 src/core/composer/qgscomposerlabel.h
  28. +25 −25 src/core/composer/qgscomposerlegend.h
  29. +39 −39 src/core/composer/qgscomposermap.h
  30. +126 −126 src/core/composer/qgscomposermapgrid.h
  31. +19 −19 src/core/composer/qgscomposermapitem.h
  32. +22 −22 src/core/composer/qgscomposermapoverview.h
  33. +35 −35 src/core/composer/qgscomposermodel.h
  34. +22 −22 src/core/composer/qgscomposermultiframe.h
  35. +15 −15 src/core/composer/qgscomposerobject.h
  36. +37 −37 src/core/composer/qgscomposerpicture.h
  37. +45 −45 src/core/composer/qgscomposerscalebar.h
  38. +24 −24 src/core/composer/qgscomposertablecolumn.h
  39. +86 −86 src/core/composer/qgscomposertablev2.h
  40. +1 −1 src/core/composer/qgscomposertexttable.h
  41. +30 −30 src/core/composer/qgscomposerutils.h
  42. +61 −61 src/core/composer/qgscomposition.h
  43. +1 −1 src/core/composer/qgsgroupungroupitemscommand.h
  44. +9 −9 src/core/composer/qgslayoutmanager.h
  45. +9 −9 src/core/dxf/qgsdxfexport.h
  46. +10 −10 src/core/effects/qgsblureffect.h
  47. +30 −30 src/core/effects/qgscoloreffect.h
  48. +2 −2 src/core/effects/qgseffectstack.h
  49. +38 −38 src/core/effects/qgsgloweffect.h
  50. +1 −1 src/core/effects/qgsimageoperation.h
  51. +29 −29 src/core/effects/qgspainteffect.h
  52. +8 −8 src/core/effects/qgspainteffectregistry.h
  53. +30 −30 src/core/effects/qgsshadoweffect.h
  54. +57 −57 src/core/effects/qgstransformeffect.h
  55. +52 −52 src/core/geometry/qgsabstractgeometry.h
  56. +4 −4 src/core/geometry/qgscurve.h
  57. +4 −4 src/core/geometry/qgscurvepolygon.h
  58. +29 −29 src/core/geometry/qgsgeometry.h
  59. +2 −2 src/core/geometry/qgsgeos.h
  60. +6 −6 src/core/geometry/qgslinestring.h
  61. +30 −30 src/core/geometry/qgspointv2.h
  62. +29 −29 src/core/geometry/qgswkbtypes.h
  63. +6 −6 src/core/gps/info.h
  64. +1 −1 src/core/gps/nmeatime.h
  65. +13 −13 src/core/layertree/qgslayertree.h
  66. +3 −3 src/core/layertree/qgslayertreemodel.h
  67. +4 −4 src/core/layertree/qgslayertreemodellegendnode.h
  68. +1 −1 src/core/layertree/qgslayertreenode.h
  69. +2 −2 src/core/pal/feature.h
  70. +4 −4 src/core/pal/labelposition.h
  71. +21 −21 src/core/pal/layer.h
  72. +13 −13 src/core/processing/qgsprocessingfeedback.h
  73. +4 −4 src/core/processing/qgsprocessingprovider.h
  74. +3 −3 src/core/processing/qgsprocessingregistry.h
  75. +6 −6 src/core/qgis.h
  76. +1 −1 src/core/qgsaction.h
  77. +8 −8 src/core/qgsaggregatecalculator.h
  78. +1 −1 src/core/qgsanimatedicon.h
  79. +8 −8 src/core/qgsapplication.h
  80. +4 −4 src/core/qgsattributetableconfig.h
  81. +2 −2 src/core/qgsbrowsermodel.h
  82. +2 −2 src/core/qgscachedfeatureiterator.h
  83. +40 −40 src/core/qgscolorramp.h
  84. +4 −4 src/core/qgscolorscheme.h
  85. +11 −11 src/core/qgscolorschemeregistry.h
  86. +18 −18 src/core/qgscoordinatereferencesystem.h
  87. +10 −10 src/core/qgscoordinatetransform.h
  88. +8 −8 src/core/qgsdataitem.h
  89. +6 −6 src/core/qgsdatetimestatisticalsummary.h
  90. +44 −44 src/core/qgsdiagramrenderer.h
  91. +44 −44 src/core/qgsdistancearea.h
  92. +1 −1 src/core/qgseditformconfig.h
  93. +26 −26 src/core/qgsexpression.h
  94. +81 −81 src/core/qgsexpressioncontext.h
  95. +23 −23 src/core/qgsfeature.h
  96. +11 −11 src/core/qgsfeaturerequest.h
  97. +6 −6 src/core/qgsfeedback.h
  98. +10 −10 src/core/qgsfield.h
  99. +19 −19 src/core/qgsfieldconstraints.h
  100. +3 −3 src/core/qgsfields.h
  101. +7 −7 src/core/qgsfontutils.h
  102. +2 −2 src/core/qgshistogram.h
  103. +16 −16 src/core/qgsinterval.h
  104. +25 −25 src/core/qgsjsonutils.h
  105. +27 −27 src/core/qgslabelfeature.h
  106. +2 −2 src/core/qgslabelingengine.h
  107. +3 −3 src/core/qgslayerdefinition.h
  108. +20 −20 src/core/qgslegendsettings.h
  109. +2 −2 src/core/qgsmaphittest.h
  110. +75 −75 src/core/qgsmaplayer.h
  111. +8 −8 src/core/qgsmaplayermodel.h
  112. +2 −2 src/core/qgsmaplayerproxymodel.h
  113. +6 −6 src/core/qgsmaprenderercache.h
  114. +2 −2 src/core/qgsmaprendererjob.h
  115. +10 −10 src/core/qgsmapsettings.h
  116. +6 −6 src/core/qgsmapthemecollection.h
  117. +2 −2 src/core/qgsmaptopixel.h
  118. +14 −14 src/core/qgsmargins.h
  119. +14 −14 src/core/qgsnetworkdiskcache.h
  120. +8 −8 src/core/qgsogrutils.h
  121. +7 −7 src/core/qgspallabeling.h
  122. +4 −4 src/core/qgspoint.h
  123. +56 −56 src/core/qgsproject.h
  124. +8 −8 src/core/qgsprojectproperty.h
  125. +42 −42 src/core/qgsproperty.h
  126. +46 −46 src/core/qgspropertycollection.h
  127. +52 −52 src/core/qgspropertytransformer.h
  128. +7 −7 src/core/qgsrelation.h
  129. +2 −2 src/core/qgsrelationmanager.h
  130. +18 −18 src/core/qgsrendercontext.h
  131. +2 −2 src/core/qgssqlexpressioncompiler.h
  132. +4 −4 src/core/qgssqlstatement.h
  133. +20 −20 src/core/qgsstatisticalsummary.h
  134. +14 −14 src/core/qgsstringstatisticalsummary.h
  135. +6 −6 src/core/qgsstringutils.h
  136. +12 −12 src/core/qgstaskmanager.h
  137. +209 −209 src/core/qgstextrenderer.h
  138. +16 −16 src/core/qgsunittypes.h
  139. +2 −2 src/core/qgsvector.h
  140. +6 −6 src/core/qgsvectordataprovider.h
  141. +2 −2 src/core/qgsvectorfilewriter.h
  142. +59 −59 src/core/qgsvectorlayer.h
  143. +6 −6 src/core/qgsvectorlayercache.h
  144. +10 −10 src/core/qgsvectorlayereditbuffer.h
  145. +2 −2 src/core/qgsvectorlayerutils.h
  146. +2 −2 src/core/qgswebpage.h
  147. +2 −2 src/core/qgsxmlutils.h
  148. +4 −4 src/core/raster/qgscolorrampshader.h
  149. +9 −9 src/core/raster/qgshillshaderenderer.h
  150. +6 −6 src/core/raster/qgsrasterblock.h
  151. +5 −5 src/core/raster/qgsrasterdataprovider.h
  152. +4 −4 src/core/raster/qgsrasterinterface.h
  153. +1 −1 src/core/raster/qgssinglebandpseudocolorrenderer.h
  154. +9 −9 src/core/symbology-ng/qgscategorizedsymbolrenderer.h
  155. +10 −10 src/core/symbology-ng/qgsellipsesymbollayer.h
  156. +126 −126 src/core/symbology-ng/qgsfillsymbollayer.h
  157. +7 −7 src/core/symbology-ng/qgsgraduatedsymbolrenderer.h
  158. +26 −26 src/core/symbology-ng/qgsheatmaprenderer.h
  159. +1 −1 src/core/symbology-ng/qgsinvertedpolygonrenderer.h
  160. +1 −1 src/core/symbology-ng/qgslegendsymbolitem.h
  161. +22 −22 src/core/symbology-ng/qgslinesymbollayer.h
  162. +42 −42 src/core/symbology-ng/qgsmarkersymbollayer.h
  163. +2 −2 src/core/symbology-ng/qgspointclusterrenderer.h
  164. +14 −14 src/core/symbology-ng/qgspointdisplacementrenderer.h
  165. +36 −36 src/core/symbology-ng/qgspointdistancerenderer.h
  166. +12 −12 src/core/symbology-ng/qgsrenderer.h
  167. +1 −1 src/core/symbology-ng/qgsstyle.h
  168. +44 −44 src/core/symbology-ng/qgssymbol.h
  169. +66 −66 src/core/symbology-ng/qgssymbollayer.h
  170. +23 −23 src/core/symbology-ng/qgssymbollayerutils.h
  171. +2 −2 src/core/symbology-ng/qgsvectorfieldsymbollayer.h
  172. +1 −1 src/gui/attributetable/qgsattributetablefiltermodel.h
  173. +1 −1 src/gui/attributetable/qgsattributetablemodel.h
  174. +2 −2 src/gui/attributetable/qgsdualview.h
  175. +2 −2 src/gui/attributetable/qgsfeaturelistview.h
  176. +2 −2 src/gui/attributetable/qgsfeatureselectionmodel.h
  177. +1 −1 src/gui/attributetable/qgsifeatureselectionmanager.h
  178. +1 −1 src/gui/attributetable/qgsvectorlayerselectionmanager.h
  179. +1 −1 src/gui/editorwidgets/core/qgseditorconfigwidget.h
  180. +2 −2 src/gui/editorwidgets/core/qgseditorwidgetfactory.h
  181. +7 −7 src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
  182. +4 −4 src/gui/editorwidgets/core/qgssearchwidgetwrapper.h
  183. +4 −4 src/gui/editorwidgets/core/qgswidgetwrapper.h
  184. +4 −4 src/gui/editorwidgets/qgsdoublespinbox.h
  185. +10 −10 src/gui/editorwidgets/qgsmultiedittoolbutton.h
  186. +21 −21 src/gui/editorwidgets/qgssearchwidgettoolbutton.h
  187. +4 −4 src/gui/editorwidgets/qgsspinbox.h
  188. +2 −2 src/gui/effects/qgseffectstackpropertieswidget.h
  189. +1 −1 src/gui/layertree/qgscustomlayerorderwidget.h
  190. +2 −2 src/gui/layertree/qgslayertreeembeddedwidgetregistry.h
  191. +2 −2 src/gui/layertree/qgslayertreeview.h
  192. +1 −1 src/gui/layertree/qgslayertreeviewdefaultactions.h
  193. +2 −2 src/gui/qgisgui.h
  194. +19 −19 src/gui/qgisinterface.h
  195. +1 −1 src/gui/qgsadvanceddigitizingcanvasitem.h
  196. +2 −2 src/gui/qgsadvanceddigitizingdockwidget.h
  197. +4 −4 src/gui/qgsattributeeditorcontext.h
  198. +2 −2 src/gui/qgsattributeform.h
  199. +3 −3 src/gui/qgsattributeformeditorwidget.h
  200. +1 −1 src/gui/qgsbrowsertreeview.h
  201. +1 −1 src/gui/qgscollapsiblegroupbox.h
  202. +4 −4 src/gui/qgscolorbrewercolorrampdialog.h
  203. +43 −43 src/gui/qgscolorbutton.h
  204. +2 −2 src/gui/qgscolordialog.h
  205. +32 −32 src/gui/qgscolorrampbutton.h
  206. +13 −13 src/gui/qgscolorschemelist.h
  207. +12 −12 src/gui/qgscolorswatchgrid.h
  208. +24 −24 src/gui/qgscolorwidgets.h
  209. +5 −5 src/gui/qgscomposeritemcombobox.h
  210. +4 −4 src/gui/qgscomposerview.h
  211. +12 −12 src/gui/qgscurveeditorwidget.h
  212. +1 −1 src/gui/qgsdetaileditemdelegate.h
  213. +1 −1 src/gui/qgsdetaileditemwidget.h
  214. +10 −10 src/gui/qgsdockwidget.h
  215. +2 −2 src/gui/qgsexpressionbuilderdialog.h
  216. +2 −2 src/gui/qgsexpressionbuilderwidget.h
  217. +5 −5 src/gui/qgsexpressionlineedit.h
  218. +1 −1 src/gui/qgsexternalresourcewidget.h
  219. +5 −5 src/gui/qgsfieldcombobox.h
  220. +2 −2 src/gui/qgsfieldexpressionwidget.h
  221. +12 −12 src/gui/qgsfieldmodel.h
  222. +2 −2 src/gui/qgsfieldproxymodel.h
  223. +8 −8 src/gui/qgsfieldvalueslineedit.h
  224. +16 −16 src/gui/qgsfilterlineedit.h
  225. +6 −6 src/gui/qgsfloatingwidget.h
  226. +2 −2 src/gui/qgsformannotation.h
  227. +4 −4 src/gui/qgsgradientcolorrampdialog.h
  228. +16 −16 src/gui/qgsgradientstopeditor.h
  229. +24 −24 src/gui/qgshistogramwidget.h
  230. +5 −5 src/gui/qgsidentifymenu.h
  231. +4 −4 src/gui/qgslimitedrandomcolorrampdialog.h
  232. +30 −30 src/gui/qgsmapcanvas.h
  233. +10 −10 src/gui/qgsmaplayercombobox.h
  234. +2 −2 src/gui/qgsmaptooladvanceddigitizing.h
  235. +4 −4 src/gui/qgsmaptoolidentify.h
  236. +1 −1 src/gui/qgsmaptoolpan.h
  237. +1 −1 src/gui/qgsmaptoolzoom.h
  238. +2 −2 src/gui/qgsnewmemorylayerdialog.h
  239. +6 −6 src/gui/qgsnewnamedialog.h
  240. +2 −2 src/gui/qgsnewvectorlayerdialog.h
  241. +4 −4 src/gui/qgsoptionswidgetfactory.h
  242. +7 −7 src/gui/qgspanelwidgetstack.h
  243. +4 −4 src/gui/qgspresetcolorrampdialog.h
  244. +2 −2 src/gui/qgsprevieweffect.h
  245. +4 −4 src/gui/qgsprojectionselectiondialog.h
  246. +4 −4 src/gui/qgsprojectionselectiontreewidget.h
  247. +2 −2 src/gui/qgsprojectionselectionwidget.h
  248. +5 −5 src/gui/qgspropertyoverridebutton.h
  249. +2 −2 src/gui/qgsrasterformatsaveoptionswidget.h
  250. +38 −38 src/gui/qgsshortcutsmanager.h
  251. +4 −4 src/gui/qgssubstitutionlistwidget.h
  252. +4 −4 src/gui/qgstaskmanagerwidget.h
  253. +10 −10 src/gui/qgstextpreview.h
  254. +4 −4 src/gui/qgstreewidgetitem.h
  255. +6 −6 src/gui/qgsunitselectionwidget.h
  256. +7 −7 src/gui/qgsvariableeditorwidget.h
  257. +8 −8 src/gui/qgsvertexmarker.h
  258. +8 −8 src/gui/raster/qgshillshaderendererwidget.h
  259. +3 −3 src/gui/raster/qgsrasterminmaxwidget.h
  260. +3 −3 src/gui/raster/qgsrasterrendererwidget.h
  261. +6 −6 src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h
  262. +2 −2 src/gui/symbology-ng/qgscptcitycolorrampdialog.h
  263. +2 −2 src/gui/symbology-ng/qgslayerpropertieswidget.h
  264. +4 −4 src/gui/symbology-ng/qgsrendererwidget.h
  265. +3 −3 src/gui/symbology-ng/qgssymbollayerwidget.h
  266. +4 −4 src/gui/symbology-ng/qgssymbolselectordialog.h
  267. +2 −2 src/gui/symbology-ng/qgssymbolslistwidget.h
  268. +7 −7 src/gui/symbology-ng/qgssymbolwidgetcontext.h
  269. +5 −5 src/plugins/grass/qtermwidget/Screen.h
  270. +3 −3 src/plugins/grass/qtermwidget/TerminalDisplay.h
  271. +1 −1 src/plugins/grass/qtermwidget/kprocess.h
@@ -44,13 +44,13 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject

/**
* Sets the filename for the output database.
* @see outputDatabaseFileName()
* \see outputDatabaseFileName()
*/
void setOutputDatabaseFileName( const QString &fileName ) { mDbFileName = fileName; }

/**
* Returns the filename for the output database.
* @see setOutputDatabaseFileName()
* \see setOutputDatabaseFileName()
*/
QString outputDatabaseFileName() const { return mDbFileName; }

@@ -110,22 +110,22 @@ class ANALYSIS_EXPORT QgsKernelDensityEstimation
/**
* Prepares the output file for writing and setups up the surface calculation. This must be called
* before adding features via addFeature().
* @see addFeature()
* @see finalise()
* \see addFeature()
* \see finalise()
*/
Result prepare();

/**
* Adds a single feature to the KDE surface. prepare() must be called before adding features.
* @see prepare()
* @see finalise()
* \see prepare()
* \see finalise()
*/
Result addFeature( const QgsFeature &feature );

/**
* Finalises the output file. Must be called after adding all features via addFeature().
* @see prepare()
* @see addFeature()
* \see prepare()
* \see addFeature()
*/
Result finalise();

@@ -41,13 +41,13 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos

/** Sets the initial resolution displayed in the dialog.
* \param resolution default resolution in DPI
* @see resolution()
* \see resolution()
*/
void setResolution( int resolution );

/** Returns the selected resolution from the dialog.
* \returns image resolution in DPI
* @see setResolution()
* \see setResolution()
*/
int resolution() const;

@@ -58,23 +58,23 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos
void setImageSize( QSizeF size );

/** Returns the user-set image width in pixels.
* @see imageHeight
* \see imageHeight
*/
int imageWidth() const;

/** Returns the user-set image height in pixels.
* @see imageWidth
* \see imageWidth
*/
int imageHeight() const;

/** Sets whether the crop to contents option should be checked in the dialog
* \param crop set to true to check crop to contents
* @see cropToContents()
* \see cropToContents()
*/
void setCropToContents( bool crop );

/** Returns whether the crop to contents option is checked in the dialog.
* @see setCropToContents()
* \see setCropToContents()
*/
bool cropToContents() const;

@@ -56,7 +56,7 @@ class DRW_Interface
* Called for every block. Note: all entities added after this
* command go into this block until endBlock() is called.
*
* @see endBlock()
* \see endBlock()
*/
virtual void addBlock( const DRW_Block &data ) = 0;

@@ -74,19 +74,19 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec
bool onlySelected() const;

/** Returns the selected flat geometry type for the export.
* @see automaticGeometryType()
* @see forceMulti()
* @see includeZ()
* \see automaticGeometryType()
* \see forceMulti()
* \see includeZ()
*/
QgsWkbTypes::Type geometryType() const;

/** Returns true if geometry type is set to automatic.
* @see geometryType()
* \see geometryType()
*/
bool automaticGeometryType() const;

/** Returns true if force multi geometry type is checked.
* @see includeZ()
* \see includeZ()
*/
bool forceMulti() const;

@@ -95,7 +95,7 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec
void setForceMulti( bool checked );

/** Returns true if include z dimension is checked.
* @see forceMulti()
* \see forceMulti()
*/
bool includeZ() const;

@@ -364,7 +364,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QMenu *createPopupMenu() override;

/**
* Access the vector layer tools. This will be an instance of {@see QgsGuiVectorLayerTools}
* Access the vector layer tools. This will be an instance of {\see QgsGuiVectorLayerTools}
* by default.
* \returns The vector layer tools
*/
@@ -296,12 +296,12 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* \since QGIS 3.0
* \note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* @see unregisterCustomDropHandler() */
* \see unregisterCustomDropHandler() */
virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) override;

/** Unregister a previously registered custom drop handler.
* \since QGIS 3.0
* @see registerCustomDropHandler() */
* \see registerCustomDropHandler() */
virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) override;

/** Accessors for inserting items into menus and toolbars.
@@ -49,12 +49,12 @@ class APP_EXPORT QgsDecorationItem: public QObject
bool enabled() const { return mEnabled; }

/** Returns the current placement for the item.
* @see setPlacement()
* \see setPlacement()
*/
Placement placement() const { return mPlacement; }

/** Sets the placement of the item.
* @see placement()
* \see placement()
*/
void setPlacement( Placement placement ) { mPlacement = placement; }

@@ -56,77 +56,77 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM

/**
* Sets whether the view center should be synchronized with the main canvas center.
* @see isViewCenterSynchronized()
* \see isViewCenterSynchronized()
*/
void setViewCenterSynchronized( bool enabled );

/**
* Returns true if the view extent is synchronized with the main canvas extent.
* @see setViewCenterSynchronized()
* \see setViewCenterSynchronized()
*/
bool isViewCenterSynchronized() const;

/**
* Sets whether the cursor position marker is visible.
* @see isCursorMarkerVisible()
* \see isCursorMarkerVisible()
*/
void setCursorMarkerVisible( bool visible );

/**
* Returns true if the cursor position marker is visible.
* @see setCursorMarkerVisible()
* \see setCursorMarkerVisible()
*/
bool isCursorMarkerVisible() const;

/**
* Sets whether the main canvas extent is visible.
* @see isMainCanvasExtentVisible()
* \see isMainCanvasExtentVisible()
*/
void setMainCanvasExtentVisible( bool visible );

/**
* Returns true if the main canvas extent is visible.
* @see setMainCanvasExtentVisible()
* \see setMainCanvasExtentVisible()
*/
bool isMainCanvasExtentVisible() const;

/**
* Returns the scaling factor for main canvas scale to view scale.
* @see setScaleFactor()
* @see isViewScaleSynchronized()
* \see setScaleFactor()
* \see isViewScaleSynchronized()
*/
double scaleFactor() const;

/**
* Sets the scaling \a factor for main canvas scale to view scale.
* @see scaleFactor()
* @see setViewScaleSynchronized()
* \see scaleFactor()
* \see setViewScaleSynchronized()
*/
void setScaleFactor( double factor );

/**
* Sets whether the view scale should be synchronized with the main canvas center.
* @see isViewScaleSynchronized()
* @see setScaleFactor()
* \see isViewScaleSynchronized()
* \see setScaleFactor()
*/
void setViewScaleSynchronized( bool enabled );

/**
* Returns true if the view scale is synchronized with the main canvas extent.
* @see setViewScaleSynchronized()
* @see scaleFactor()
* \see setViewScaleSynchronized()
* \see scaleFactor()
*/
bool isViewScaleSynchronized() const;

/**
* Sets whether labels should be rendered in the view.
* @see labelsVisible()
* \see labelsVisible()
*/
void setLabelsVisible( bool enabled );

/**
* Returns whether labels are rendered in the view.
* @see setLabelsVisible()
* \see setLabelsVisible()
*/
bool labelsVisible() const;

@@ -73,7 +73,7 @@ namespace QgsMapToolSelectUtils
\param e MouseEvents are used to determine the current selection
operations (add, subtract, contains)
\since QGIS 2.16
@see selectSingleFeature()
\see selectSingleFeature()
*/
void selectMultipleFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, QMouseEvent *e );

@@ -85,7 +85,7 @@ namespace QgsMapToolSelectUtils
must be in terms of the canvas coordinate system.
\param e MouseEvents are used to determine the current selection
operations (add, subtract, contains)
@see selectMultipleFeatures()
\see selectMultipleFeatures()
*/
void selectSingleFeature( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, QMouseEvent *e );

@@ -47,26 +47,26 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem
/** Sets the marker symbol to use for rendering the point. Note - you may need to call
* updateSize() after setting the symbol.
* \param symbol marker symbol. Ownership is transferred to item.
* @see symbol()
* @see updateSize()
* \see symbol()
* \see updateSize()
*/
void setSymbol( QgsMarkerSymbol *symbol );

/** Returns the marker symbol used for rendering the point.
* @see setSymbol()
* \see setSymbol()
*/
QgsMarkerSymbol *symbol();

/** Sets the feature used for rendering the marker symbol. The feature's attributes
* may affect the rendered symbol if data defined overrides are in place.
* \param feature feature for symbol
* @see feature()
* @see updateSize()
* \see feature()
* \see updateSize()
*/
void setFeature( const QgsFeature &feature );

/** Returns the feature used for rendering the marker symbol.
* @see setFeature()
* \see setFeature()
*/
QgsFeature feature() const { return mFeature; }

@@ -78,14 +78,14 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem
/** Sets the transparency for the marker.
* \param transparency double between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see transparency()
* \see transparency()
*/
void setTransparency( double transparency );

/** Returns the transparency for the marker.
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see setTransparency()
* \see setTransparency()
*/
double transparency() const;

@@ -25,7 +25,7 @@
* Tips can be generic, in which case they make no mention of
* gui dialogs etc, or gui-specific in which case they may allude
* to features of the graphical user interface.
* @see also QgsTipOfTheDay, QgsTipFactory
* \see also QgsTipOfTheDay, QgsTipFactory
*/

class APP_EXPORT QgsTip
@@ -25,7 +25,7 @@
* Tips can be generic, in which case they make no mention of
* gui dialogs etc, or gui-specific in which case they may allude
* to features of the graphical user interface.
* @see also QgsTipOfTheDay, QgsTip
* \see also QgsTipOfTheDay, QgsTip
*/

class APP_EXPORT QgsTipFactory : public QObject
Loading

0 comments on commit dfb5f56

Please sign in to comment.