Skip to content
Permalink
Browse files

Add NULLPTR macro for use in doxygen comments

For the c++ api dox this expands to "\c nullptr" (the
\c directive indicates a code literal value), and for sipify/Python
it expands to ``None`` (`` is sphinx annotation for literal values)

Makes for nicer dox for both c++ and Python!
  • Loading branch information
nyalldawson committed Feb 26, 2019
1 parent a7ca087 commit 107b48a430d735fe0b1be97137a8904dd8455cdb
Showing with 574 additions and 573 deletions.
  1. +1 −1 cmake_templates/Doxyfile.in
  2. +3 −3 python/3d/auto_generated/qgsrulebased3drenderer.sip.in
  3. +2 −2 python/analysis/auto_generated/raster/qgsalignraster.sip.in
  4. +1 −1 python/analysis/auto_generated/vector/geometry_checker/qgsfeaturepool.sip.in
  5. +1 −1 python/core/auto_generated/3d/qgs3drendererregistry.sip.in
  6. +4 −4 python/core/auto_generated/effects/qgspainteffectregistry.sip.in
  7. +2 −2 python/core/auto_generated/expression/qgsexpression.sip.in
  8. +1 −1 python/core/auto_generated/expression/qgsexpressioncontextutils.sip.in
  9. +1 −1 python/core/auto_generated/geometry/qgsabstractgeometry.sip.in
  10. +1 −1 python/core/auto_generated/geometry/qgscurve.sip.in
  11. +1 −1 python/core/auto_generated/geometry/qgsgeometry.sip.in
  12. +2 −2 python/core/auto_generated/geometry/qgsgeometryengine.sip.in
  13. +2 −2 python/core/auto_generated/layertree/qgslayertreegroup.sip.in
  14. +2 −2 python/core/auto_generated/layertree/qgslayertreelayer.sip.in
  15. +8 −8 python/core/auto_generated/layertree/qgslayertreemodel.sip.in
  16. +3 −3 python/core/auto_generated/layertree/qgslayertreemodellegendnode.sip.in
  17. +1 −1 python/core/auto_generated/layertree/qgslayertreenode.sip.in
  18. +1 −1 python/core/auto_generated/layout/qgsabstractreportsection.sip.in
  19. +7 −7 python/core/auto_generated/layout/qgslayout.sip.in
  20. +1 −1 python/core/auto_generated/layout/qgslayoutexporter.sip.in
  21. +1 −1 python/core/auto_generated/layout/qgslayoutitempicture.sip.in
  22. +2 −2 python/core/auto_generated/layout/qgslayoutitemregistry.sip.in
  23. +1 −1 python/core/auto_generated/layout/qgslayoutmanager.sip.in
  24. +2 −2 python/core/auto_generated/layout/qgslayoutpagecollection.sip.in
  25. +1 −1 python/core/auto_generated/layout/qgsmasterlayoutinterface.sip.in
  26. +1 −1 python/core/auto_generated/mesh/qgsmeshlayerinterpolator.sip.in
  27. +1 −1 python/core/auto_generated/processing/models/qgsprocessingmodelchildalgorithm.sip.in
  28. +1 −1 python/core/auto_generated/processing/qgsprocessingalgorithm.sip.in
  29. +2 −2 python/core/auto_generated/processing/qgsprocessingcontext.sip.in
  30. +2 −2 python/core/auto_generated/processing/qgsprocessingparameters.sip.in
  31. +1 −1 python/core/auto_generated/processing/qgsprocessingprovider.sip.in
  32. +2 −2 python/core/auto_generated/processing/qgsprocessingregistry.sip.in
  33. +1 −1 python/core/auto_generated/qgsapplication.sip.in
  34. +1 −1 python/core/auto_generated/qgsauxiliarystorage.sip.in
  35. +1 −1 python/core/auto_generated/qgsbrowsermodel.sip.in
  36. +1 −1 python/core/auto_generated/qgsbrowserproxymodel.sip.in
  37. +1 −1 python/core/auto_generated/qgscolorschemeregistry.sip.in
  38. +4 −4 python/core/auto_generated/qgsdatadefinedsizelegend.sip.in
  39. +1 −1 python/core/auto_generated/qgsdataitem.sip.in
  40. +3 −3 python/core/auto_generated/qgsdataitemprovider.sip.in
  41. +1 −1 python/core/auto_generated/qgsdiagramrenderer.sip.in
  42. +4 −4 python/core/auto_generated/qgsexpressioncontext.sip.in
  43. +4 −4 python/core/auto_generated/qgsmaplayer.sip.in
  44. +1 −1 python/core/auto_generated/qgsmaplayerrenderer.sip.in
  45. +4 −4 python/core/auto_generated/qgsmaplayerstore.sip.in
  46. +1 −1 python/core/auto_generated/qgsmaplayerstylemanager.sip.in
  47. +3 −3 python/core/auto_generated/qgsmimedatautils.sip.in
  48. +1 −1 python/core/auto_generated/qgsnetworkcontentfetchertask.sip.in
  49. +1 −1 python/core/auto_generated/qgspallabeling.sip.in
  50. +4 −4 python/core/auto_generated/qgspluginlayerregistry.sip.in
  51. +5 −5 python/core/auto_generated/qgspointlocator.sip.in
  52. +6 −6 python/core/auto_generated/qgsproject.sip.in
  53. +2 −2 python/core/auto_generated/qgsprojectstorageregistry.sip.in
  54. +1 −1 python/core/auto_generated/qgsproperty.sip.in
  55. +3 −3 python/core/auto_generated/qgspropertytransformer.sip.in
  56. +5 −5 python/core/auto_generated/qgsproviderregistry.sip.in
  57. +3 −3 python/core/auto_generated/qgsrulebasedlabeling.sip.in
  58. +1 −1 python/core/auto_generated/qgssqlstatement.sip.in
  59. +1 −1 python/core/auto_generated/qgstaskmanager.sip.in
  60. +1 −1 python/core/auto_generated/qgstracer.sip.in
  61. +3 −3 python/core/auto_generated/qgsvectordataprovider.sip.in
  62. +2 −2 python/core/auto_generated/qgsvectorfilewriter.sip.in
  63. +2 −2 python/core/auto_generated/qgsvectorlayer.sip.in
  64. +1 −1 python/core/auto_generated/qgsvectorlayercache.sip.in
  65. +2 −2 python/core/auto_generated/qgsvectorlayerjoininfo.sip.in
  66. +1 −1 python/core/auto_generated/raster/qgsrasterdataprovider.sip.in
  67. +2 −2 python/core/auto_generated/raster/qgsrasterfilewriter.sip.in
  68. +4 −4 python/core/auto_generated/symbology/qgscategorizedsymbolrenderer.sip.in
  69. +2 −2 python/core/auto_generated/symbology/qgsgraduatedsymbolrenderer.sip.in
  70. +1 −1 python/core/auto_generated/symbology/qgsinvertedpolygonrenderer.sip.in
  71. +2 −2 python/core/auto_generated/symbology/qgslegendsymbolitem.sip.in
  72. +1 −1 python/core/auto_generated/symbology/qgsnullsymbolrenderer.sip.in
  73. +1 −1 python/core/auto_generated/symbology/qgspointclusterrenderer.sip.in
  74. +1 −1 python/core/auto_generated/symbology/qgspointdisplacementrenderer.sip.in
  75. +1 −1 python/core/auto_generated/symbology/qgsrenderer.sip.in
  76. +5 −5 python/core/auto_generated/symbology/qgsrendererregistry.sip.in
  77. +1 −1 python/core/auto_generated/symbology/qgsrulebasedrenderer.sip.in
  78. +3 −3 python/core/auto_generated/symbology/qgssinglesymbolrenderer.sip.in
  79. +1 −1 python/core/auto_generated/symbology/qgssymbol.sip.in
  80. +2 −2 python/core/auto_generated/symbology/qgssymbollayerregistry.sip.in
  81. +1 −1 python/core/auto_generated/symbology/qgssymbollayerutils.sip.in
  82. +1 −1 python/gui/auto_generated/editorwidgets/core/qgseditorwidgetfactory.sip.in
  83. +4 −4 python/gui/auto_generated/editorwidgets/core/qgseditorwidgetregistry.sip.in
  84. +2 −2 python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in
  85. +2 −2 python/gui/auto_generated/editorwidgets/core/qgswidgetwrapper.sip.in
  86. +1 −1 python/gui/auto_generated/editorwidgets/qgsqmlwidgetwrapper.sip.in
  87. +1 −1 python/gui/auto_generated/layertree/qgslayertreemapcanvasbridge.sip.in
  88. +3 −3 python/gui/auto_generated/layertree/qgslayertreeview.sip.in
  89. +5 −5 python/gui/auto_generated/layout/qgslayoutitemguiregistry.sip.in
  90. +2 −2 python/gui/auto_generated/layout/qgslayoutview.sip.in
  91. +1 −1 python/gui/auto_generated/layout/qgslayoutviewtool.sip.in
  92. +3 −3 python/gui/auto_generated/processing/qgsprocessingguiregistry.sip.in
  93. +4 −4 python/gui/auto_generated/processing/qgsprocessingtoolboxmodel.sip.in
  94. +2 −2 python/gui/auto_generated/processing/qgsprocessingtoolboxtreeview.sip.in
  95. +3 −3 python/gui/auto_generated/processing/qgsprocessingwidgetwrapper.sip.in
  96. +1 −1 python/gui/auto_generated/qgisinterface.sip.in
  97. +2 −2 python/gui/auto_generated/qgscolorrampbutton.sip.in
  98. +1 −1 python/gui/auto_generated/qgsconfigureshortcutsdialog.sip.in
  99. +1 −1 python/gui/auto_generated/qgsdatasourceselectdialog.sip.in
  100. +2 −2 python/gui/auto_generated/qgslegendfilterbutton.sip.in
  101. +1 −1 python/gui/auto_generated/qgsmapcanvas.sip.in
  102. +1 −1 python/gui/auto_generated/qgsmapcanvastracer.sip.in
  103. +2 −2 python/gui/auto_generated/qgsmaptool.sip.in
  104. +2 −2 python/gui/auto_generated/qgsmaptoolcapture.sip.in
  105. +1 −1 python/gui/auto_generated/qgsoptionsdialoghighlightwidget.sip.in
  106. +2 −2 python/gui/auto_generated/qgspanelwidget.sip.in
  107. +2 −2 python/gui/auto_generated/qgsrubberband.sip.in
  108. +5 −5 python/gui/auto_generated/qgsshortcutsmanager.sip.in
  109. +1 −1 python/gui/auto_generated/qgssourceselectprovider.sip.in
  110. +1 −1 python/gui/auto_generated/qgssourceselectproviderregistry.sip.in
  111. +1 −1 python/gui/auto_generated/qgsvariableeditorwidget.sip.in
  112. +1 −1 python/gui/auto_generated/qgswindowmanagerinterface.sip.in
  113. +1 −1 python/gui/auto_generated/raster/qgsrendererrasterpropertieswidget.sip.in
  114. +1 −1 python/gui/auto_generated/symbology/qgsdatadefinedsizelegendwidget.sip.in
  115. +2 −2 python/gui/auto_generated/symbology/qgsrendererwidget.sip.in
  116. +2 −2 python/gui/auto_generated/symbology/qgssymbolselectordialog.sip.in
  117. +2 −2 python/server/auto_generated/qgsconfigcache.sip.in
  118. +1 −1 python/server/auto_generated/qgsserver.sip.in
  119. +1 −0 scripts/sipify.pl
  120. +2 −2 src/3d/chunks/qgschunknode_p.h
  121. +1 −1 src/3d/qgs3dutils.h
  122. +1 −1 src/3d/qgslayoutitem3dmap.h
  123. +4 −4 src/3d/qgsrulebased3drenderer.h
  124. +1 −1 src/analysis/interpolation/NormVecDecorator.h
  125. +1 −1 src/analysis/mesh/qgsmeshcalcutils.h
  126. +2 −2 src/analysis/raster/qgsalignraster.h
  127. +1 −1 src/analysis/vector/geometry_checker/qgsfeaturepool.h
  128. +1 −1 src/app/3d/qgs3dmapcanvas.h
  129. +1 −1 src/app/3d/qgssymbol3dwidget.h
  130. +1 −1 src/app/qgisapp.h
  131. +1 −1 src/app/qgsappwindowmanager.h
  132. +1 −1 src/app/qgslabelingwidget.h
  133. +1 −1 src/app/qgsprojectlayergroupdialog.h
  134. +1 −1 src/core/3d/qgs3drendererregistry.h
  135. +1 −1 src/core/annotations/qgsannotation.h
  136. +1 −1 src/core/annotations/qgsannotationregistry.h
  137. +1 −1 src/core/auth/qgsauthmethodregistry.h
  138. +4 −4 src/core/effects/qgspainteffectregistry.h
  139. +2 −2 src/core/expression/qgsexpression.h
  140. +1 −1 src/core/expression/qgsexpressioncontextutils.h
  141. +1 −1 src/core/expression/qgsexpressionfunction.h
  142. +1 −1 src/core/geometry/qgsabstractgeometry.h
  143. +1 −1 src/core/geometry/qgscurve.h
  144. +1 −1 src/core/geometry/qgsgeometry.h
  145. +2 −2 src/core/geometry/qgsgeometryengine.h
  146. +1 −1 src/core/geometry/qgsgeos.h
  147. +2 −2 src/core/geometry/qgslinestring.h
  148. +2 −2 src/core/layertree/qgslayertreegroup.h
  149. +2 −2 src/core/layertree/qgslayertreelayer.h
  150. +10 −10 src/core/layertree/qgslayertreemodel.h
  151. +3 −3 src/core/layertree/qgslayertreemodellegendnode.h
  152. +1 −1 src/core/layertree/qgslayertreenode.h
  153. +1 −1 src/core/layout/qgsabstractreportsection.h
  154. +7 −7 src/core/layout/qgslayout.h
  155. +2 −2 src/core/layout/qgslayoutexporter.h
  156. +1 −1 src/core/layout/qgslayoutitemlegend.h
  157. +2 −2 src/core/layout/qgslayoutitempicture.h
  158. +2 −2 src/core/layout/qgslayoutitemregistry.h
  159. +1 −1 src/core/layout/qgslayoutmanager.h
  160. +2 −2 src/core/layout/qgslayoutmodel.h
  161. +3 −3 src/core/layout/qgslayoutpagecollection.h
  162. +1 −1 src/core/layout/qgsmasterlayoutinterface.h
  163. +5 −5 src/core/mesh/qgsmeshlayer.h
  164. +1 −1 src/core/mesh/qgsmeshlayerinterpolator.h
  165. +1 −1 src/core/pal/pointset.h
  166. +1 −1 src/core/processing/models/qgsprocessingmodelchildalgorithm.h
  167. +1 −1 src/core/processing/qgsprocessingalgorithm.h
  168. +2 −2 src/core/processing/qgsprocessingcontext.h
  169. +3 −3 src/core/processing/qgsprocessingparameters.h
  170. +1 −1 src/core/processing/qgsprocessingprovider.h
  171. +2 −2 src/core/processing/qgsprocessingregistry.h
  172. +1 −1 src/core/qgsapplication.h
  173. +1 −1 src/core/qgsauxiliarystorage.h
  174. +1 −1 src/core/qgsbrowsermodel.h
  175. +1 −1 src/core/qgsbrowserproxymodel.h
  176. +1 −1 src/core/qgscolorschemeregistry.h
  177. +2 −2 src/core/qgsconnectionpool.h
  178. +4 −4 src/core/qgsdatadefinedsizelegend.h
  179. +1 −1 src/core/qgsdataitem.h
  180. +3 −3 src/core/qgsdataitemprovider.h
  181. +1 −1 src/core/qgsdiagramrenderer.h
  182. +1 −1 src/core/qgsdistancearea.h
  183. +5 −5 src/core/qgsexpressioncontext.h
  184. +1 −1 src/core/qgslabelfeature.h
  185. +1 −1 src/core/qgslabelingengine.h
  186. +7 −7 src/core/qgslegendrenderer.h
  187. +5 −5 src/core/qgsmaplayer.h
  188. +3 −3 src/core/qgsmaplayerref.h
  189. +1 −1 src/core/qgsmaplayerrenderer.h
  190. +4 −4 src/core/qgsmaplayerstore.h
  191. +1 −1 src/core/qgsmaplayerstylemanager.h
  192. +3 −3 src/core/qgsmimedatautils.h
  193. +1 −1 src/core/qgsnetworkcontentfetcherregistry.h
  194. +1 −1 src/core/qgsnetworkcontentfetchertask.h
  195. +1 −1 src/core/qgsogcutils.h
  196. +1 −1 src/core/qgspallabeling.h
  197. +4 −4 src/core/qgspluginlayerregistry.h
  198. +5 −5 src/core/qgspointlocator.h
  199. +7 −7 src/core/qgsproject.h
  200. +2 −2 src/core/qgsprojectstorageregistry.h
  201. +1 −1 src/core/qgsproperty.h
  202. +3 −3 src/core/qgspropertytransformer.h
  203. +5 −5 src/core/qgsproviderregistry.h
  204. +2 −2 src/core/qgsrendercontext.h
  205. +4 −4 src/core/qgsrulebasedlabeling.h
  206. +1 −1 src/core/qgsspatialiteutils.h
  207. +1 −1 src/core/qgssqlstatement.h
  208. +1 −1 src/core/qgstaskmanager.h
  209. +1 −1 src/core/qgstracer.h
  210. +3 −3 src/core/qgsvectordataprovider.h
  211. +4 −4 src/core/qgsvectorfilewriter.h
  212. +1 −1 src/core/qgsvectorlayer.h
  213. +1 −1 src/core/qgsvectorlayercache.h
  214. +2 −2 src/core/qgsvectorlayerjoininfo.h
  215. +2 −2 src/core/qgsvectorlayerrenderer.h
  216. +2 −2 src/core/qgsvectorlayerutils.h
  217. +2 −2 src/core/raster/qgsrasterblock.h
  218. +1 −1 src/core/raster/qgsrasterdataprovider.h
  219. +2 −2 src/core/raster/qgsrasterfilewriter.h
  220. +4 −4 src/core/symbology/qgscategorizedsymbolrenderer.h
  221. +2 −2 src/core/symbology/qgsgraduatedsymbolrenderer.h
  222. +1 −1 src/core/symbology/qgsinvertedpolygonrenderer.h
  223. +2 −2 src/core/symbology/qgslegendsymbolitem.h
  224. +1 −1 src/core/symbology/qgsnullsymbolrenderer.h
  225. +1 −1 src/core/symbology/qgspointclusterrenderer.h
  226. +1 −1 src/core/symbology/qgspointdisplacementrenderer.h
  227. +1 −1 src/core/symbology/qgspointdistancerenderer.h
  228. +1 −1 src/core/symbology/qgsrenderer.h
  229. +5 −5 src/core/symbology/qgsrendererregistry.h
  230. +1 −1 src/core/symbology/qgsrulebasedrenderer.h
  231. +3 −3 src/core/symbology/qgssinglesymbolrenderer.h
  232. +1 −1 src/core/symbology/qgssymbol.h
  233. +2 −2 src/core/symbology/qgssymbollayerregistry.h
  234. +1 −1 src/core/symbology/qgssymbollayerutils.h
  235. +1 −1 src/gui/editorwidgets/core/qgseditorwidgetfactory.h
  236. +4 −4 src/gui/editorwidgets/core/qgseditorwidgetregistry.h
  237. +2 −2 src/gui/editorwidgets/core/qgseditorwidgetwrapper.h
  238. +3 −3 src/gui/editorwidgets/core/qgswidgetwrapper.h
  239. +1 −1 src/gui/editorwidgets/qgsbinarywidgetwrapper.h
  240. +1 −1 src/gui/editorwidgets/qgscheckboxwidgetwrapper.h
  241. +1 −1 src/gui/editorwidgets/qgsclassificationwidgetwrapper.h
  242. +1 −1 src/gui/editorwidgets/qgscolorwidgetwrapper.h
  243. +1 −1 src/gui/editorwidgets/qgsdatetimeeditwrapper.h
  244. +1 −1 src/gui/editorwidgets/qgsenumerationwidgetwrapper.h
  245. +1 −1 src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h
  246. +1 −1 src/gui/editorwidgets/qgshiddenwidgetwrapper.h
  247. +1 −1 src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h
  248. +1 −1 src/gui/editorwidgets/qgslistwidgetwrapper.h
  249. +1 −1 src/gui/editorwidgets/qgsqmlwidgetwrapper.h
  250. +1 −1 src/gui/editorwidgets/qgsrangewidgetwrapper.h
  251. +1 −1 src/gui/editorwidgets/qgsrelationreferencefactory.h
  252. +1 −1 src/gui/editorwidgets/qgstexteditwrapper.h
  253. +1 −1 src/gui/editorwidgets/qgsuniquevaluewidgetwrapper.h
  254. +1 −1 src/gui/editorwidgets/qgsuuidwidgetwrapper.h
  255. +1 −1 src/gui/editorwidgets/qgsvaluemapwidgetwrapper.h
  256. +1 −1 src/gui/editorwidgets/qgsvaluerelationwidgetwrapper.h
  257. +1 −1 src/gui/layertree/qgslayertreemapcanvasbridge.h
  258. +3 −3 src/gui/layertree/qgslayertreeview.h
  259. +6 −6 src/gui/layout/qgslayoutitemguiregistry.h
  260. +1 −1 src/gui/layout/qgslayoutruler.h
  261. +2 −2 src/gui/layout/qgslayoutview.h
  262. +1 −1 src/gui/layout/qgslayoutviewtool.h
  263. +3 −3 src/gui/processing/qgsprocessingguiregistry.h
  264. +4 −4 src/gui/processing/qgsprocessingtoolboxmodel.h
  265. +2 −2 src/gui/processing/qgsprocessingtoolboxtreeview.h
  266. +3 −3 src/gui/processing/qgsprocessingwidgetwrapper.h
  267. +1 −1 src/gui/qgisinterface.h
  268. +2 −2 src/gui/qgscolorrampbutton.h
  269. +1 −1 src/gui/qgsconfigureshortcutsdialog.h
  270. +1 −1 src/gui/qgsdatasourceselectdialog.h
  271. +2 −2 src/gui/qgslegendfilterbutton.h
  272. +1 −1 src/gui/qgsmapcanvas.h
  273. +1 −1 src/gui/qgsmapcanvastracer.h
  274. +2 −2 src/gui/qgsmaptool.h
  275. +2 −2 src/gui/qgsmaptoolcapture.h
  276. +1 −1 src/gui/qgsoptionsdialoghighlightwidget.h
  277. +2 −2 src/gui/qgspanelwidget.h
  278. +2 −2 src/gui/qgsrubberband.h
  279. +5 −5 src/gui/qgsshortcutsmanager.h
  280. +1 −1 src/gui/qgssourceselectprovider.h
  281. +1 −1 src/gui/qgssourceselectproviderregistry.h
  282. +1 −1 src/gui/qgstaskmanagerwidget.h
  283. +1 −1 src/gui/qgsvariableeditorwidget.h
  284. +1 −1 src/gui/qgswindowmanagerinterface.h
  285. +1 −1 src/gui/raster/qgsrendererrasterpropertieswidget.h
  286. +1 −1 src/gui/symbology/qgsdatadefinedsizelegendwidget.h
  287. +2 −2 src/gui/symbology/qgsrendererwidget.h
  288. +2 −2 src/gui/symbology/qgssymbolselectordialog.h
  289. +3 −3 src/plugins/grass/qtermwidget/qtermwidget.h
  290. +1 −1 src/providers/postgres/qgspostgreslistener.h
  291. +1 −1 src/providers/wms/qgswmscapabilities.h
  292. +2 −2 src/quickgui/qgsquickfeaturelayerpair.h
  293. +4 −4 src/quickgui/qgsquickidentifykit.h
  294. +2 −2 src/server/qgsconfigcache.h
  295. +1 −1 src/server/qgsserver.h
  296. +2 −2 src/server/services/wms/qgswmsrenderer.h
  297. +1 −1 tests/code_layout/sipifyheader.h
@@ -898,7 +898,7 @@ IMAGE_PATH =
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.

INPUT_FILTER = "sed -e 's/TRUE/\\c true/' -e 's/FALSE/\\c false/'"
INPUT_FILTER = "sed -e 's/TRUE/\\c true/' -e 's/FALSE/\\c false/'" -e 's/NULLPTR/\\c nullptr/'"

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
@@ -75,7 +75,7 @@ Similar to rule-based 2D renderer and rule-based labeling, it allows specificati
public:
Rule( QgsAbstract3DSymbol *symbol /Transfer/, const QString &filterExp = QString(), const QString &description = QString(), bool elseRule = false );
%Docstring
takes ownership of symbol, symbol may be None
takes ownership of symbol, symbol may be ``None``
%End
~Rule();

@@ -89,7 +89,7 @@ takes ownership of symbol, symbol may be None

QgsAbstract3DSymbol *symbol() const;
%Docstring
Returns the labeling settings. May return None.
Returns the labeling settings. May return ``None``.
%End

QString filterExpression() const;
@@ -127,7 +127,7 @@ Unique rule identifier (for identification of rule within labeling, used as prov

void setSymbol( QgsAbstract3DSymbol *symbol /Transfer/ );
%Docstring
Sets new symbol (or None). Deletes old symbol if any.
Sets new symbol (or ``None``). Deletes old symbol if any.
%End

void setFilterExpression( const QString &filterExp );
@@ -137,11 +137,11 @@ Method to be overridden for progress reporting.

void setProgressHandler( ProgressHandler *progressHandler );
%Docstring
Assign a progress handler instance. Does not take ownership. None can be passed.
Assign a progress handler instance. Does not take ownership. ``None`` can be passed.
%End
ProgressHandler *progressHandler() const;
%Docstring
Gets associated progress handler. May be None (default)
Gets associated progress handler. May be ``None`` (default)
%End

void setRasters( const List &list );
@@ -60,7 +60,7 @@ Implementations will remove the feature from the layer or from the data provider
QgsVectorLayer *layer() const;
%Docstring
Gets a pointer to the underlying layer.
May return a ``None`` if the layer has been deleted.
May return a ````None```` if the layer has been deleted.
This must only be called from the main thread.
%End

@@ -33,7 +33,7 @@ Returns unique identifier of the 3D renderer class

virtual QgsAbstract3DRenderer *createRenderer( QDomElement &elem, const QgsReadWriteContext &context ) = 0 /Factory/;
%Docstring
Returns new instance of the renderer given the DOM element. Returns None on error.
Returns new instance of the renderer given the DOM element. Returns ``None`` on error.
Pure virtual function: must be implemented in derived classes.
%End

@@ -68,7 +68,7 @@ Create a paint effect of this class given an encoded map of properties.

virtual QgsPaintEffectWidget *createWidget() /Factory/;
%Docstring
Create configuration widget for paint effect of this class. Can return None
Create configuration widget for paint effect of this class. Can return ``None``
if there's no GUI for the paint effect class.

:return: configuration widget
@@ -107,7 +107,7 @@ Returns the metadata for a specific effect.

:param name: unique string name for paint effect class

:return: paint effect metadata if found, otherwise None
:return: paint effect metadata if found, otherwise ``None``
%End

bool addEffectType( QgsPaintEffectAbstractMetadata *metadata /Transfer/ );
@@ -126,7 +126,7 @@ Creates a new paint effect given the effect name and properties map.
:param name: unique name representing paint effect class
:param properties: encoded string map of effect properties

:return: new paint effect of specified class, or None if matching
:return: new paint effect of specified class, or ``None`` if matching
paint effect could not be created
%End

@@ -137,7 +137,7 @@ properties.

:param element: encoded DOM element of effect properties

:return: new paint effect, or None if matching
:return: new paint effect, or ``None`` if matching
paint effect could not be created
%End

@@ -294,14 +294,14 @@ Returns calculator used for distance and area calculations
%Docstring
Sets the geometry calculator used for distance and area calculations in expressions.
(used by $length, $area and $perimeter functions only).
If the geometry calculator is set to None (default), prepare() will read variables
If the geometry calculator is set to ``None`` (default), prepare() will read variables
from the expression context ("project_ellipsoid", "_project_transform_context" and
"_layer_crs") to build a geometry calculator.
If these variables does not exist and if setGeomCalculator() is not called,
all distance and area calculations are performed using simple
Cartesian methods (ie no ellipsoidal calculations).

:param calc: geometry calculator. Ownership is not transferred. Set to a None to force
:param calc: geometry calculator. Ownership is not transferred. Set to ``None`` to force
Cartesian calculations.

.. seealso:: :py:func:`geomCalculator`
@@ -245,7 +245,7 @@ with the variables specified.
Creates a new scope which contains variables and functions relating to a :py:class:`QgsLayoutAtlas`.
For instance, current page name and number.

:param atlas: source atlas. If None, a set of default atlas variables will be added to the scope.
:param atlas: source atlas. If ``None``, a set of default atlas variables will be added to the scope.
%End

static QgsExpressionContextScope *layoutItemScope( const QgsLayoutItem *item ) /Factory/;
@@ -465,7 +465,7 @@ E.g. :py:class:`QgsLineString` -> :py:class:`QgsCompoundCurve`, :py:class:`QgsPo
Makes a new geometry with all the points or vertices snapped to the closest point of the grid.
Ownership is transferred to the caller.

If the gridified geometry could not be calculated a None will be returned.
If the gridified geometry could not be calculated ``None`` will be returned.
It may generate an invalid geometry (in some corner cases).
It can also be thought as rounding the edges and it may be useful for removing errors.
Example:
@@ -203,7 +203,7 @@ Returns an interpolated point on the curve at the specified ``distance``.
If z or m values are present, the output z and m will be interpolated using
the existing vertices' z or m values.

If distance is negative, or is greater than the length of the curve, a None
If distance is negative, or is greater than the length of the curve, ``None``
will be returned.

.. versionadded:: 3.4
@@ -1448,7 +1448,7 @@ 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 None if the conversion fails.
:return: the converted geometry or ``None`` if the conversion fails.

.. versionadded:: 2.2
%End
@@ -104,15 +104,15 @@ Calculate the symmetric difference of this and ``geom``.
virtual QgsPoint *centroid( QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
Calculates the centroid of this.
May return a `None`.
May return a ```None```.

.. versionadded:: 3.0
%End

virtual QgsPoint *pointOnSurface( QString *errorMsg = 0 ) const = 0 /Factory/;
%Docstring
Calculate a point that is guaranteed to be on the surface of this.
May return a `None`.
May return a ```None```.

.. versionadded:: 3.0
%End
@@ -136,13 +136,13 @@ Find all group layer nodes

static QgsLayerTreeGroup *readXml( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
%Docstring
Read group (tree) from XML element <layer-tree-group> and return the newly created group (or None on error).
Read group (tree) from XML element <layer-tree-group> and return the newly created group (or ``None`` on error).
Does not resolve textual references to layers. Call resolveReferences() afterwards to do it.
%End

static QgsLayerTreeGroup *readXml( QDomElement &element, const QgsProject *project, const QgsReadWriteContext &context ) /Factory/;
%Docstring
Read group (tree) from XML element <layer-tree-group> and return the newly created group (or None on error).
Read group (tree) from XML element <layer-tree-group> and return the newly created group (or ``None`` on error).
Also resolves textual references to layers from the project (calls resolveReferences() internally).

.. versionadded:: 3.0
@@ -51,9 +51,9 @@ Returns the map layer associated with this node.

.. warning::

This can be (and often is!) a None, e.g. in the case of a layer node representing a layer
This can be (and often is!) ``None``, e.g. in the case of a layer node representing a layer
which has not yet been fully loaded into a project, or a layer node representing a layer
with an invalid data source. The returned pointer must ALWAYS be checked to avoid dereferencing a None.
with an invalid data source. The returned pointer must ALWAYS be checked to avoid dereferencing ``None``.

.. seealso:: :py:func:`layerId`
%End
@@ -41,7 +41,7 @@ whether to allow changes to the layer tree.

explicit QgsLayerTreeModel( QgsLayerTree *rootNode, QObject *parent /TransferThis/ = 0 );
%Docstring
Construct a new tree model with given layer tree (root node must not be None).
Construct a new tree model with given layer tree (root node must not be ``None``).
The root node is not transferred by the model.
%End

@@ -112,7 +112,7 @@ Check whether a flag is enabled
QgsLayerTreeNode *index2node( const QModelIndex &index ) const;
%Docstring
Returns layer tree node for given index. Returns root node for invalid index.
Returns None if index does not refer to a layer tree node (e.g. it is a legend node)
Returns ``None`` if index does not refer to a layer tree node (e.g. it is a legend node)
%End
QModelIndex node2index( QgsLayerTreeNode *node ) const;
%Docstring
@@ -128,7 +128,7 @@ If ``skipInternal`` is ``True``, a node is included in the output list only if n

static QgsLayerTreeModelLegendNode *index2legendNode( const QModelIndex &index );
%Docstring
Returns legend node for given index. Returns None for invalid index
Returns legend node for given index. Returns ``None`` for invalid index

.. versionadded:: 2.6
%End
@@ -186,7 +186,7 @@ and rule key.

QgsLayerTree *rootGroup() const;
%Docstring
Returns pointer to the root node of the layer tree. Always a non None value.
Returns pointer to the root node of the layer tree. Always a non ``None`` value.
%End

void setRootGroup( QgsLayerTree *newRootGroup );
@@ -254,7 +254,7 @@ A scale <= 0 indicates that no scale filtering is being performed.
void setLegendFilterByMap( const QgsMapSettings *settings );
%Docstring
Force only display of legend nodes which are valid for given map settings.
Setting None or invalid map settings will disable the functionality.
Setting ``None`` or invalid map settings will disable the functionality.
Ownership of map settings pointer does not change, a copy is made.

.. versionadded:: 2.6
@@ -264,7 +264,7 @@ Ownership of map settings pointer does not change, a copy is made.
%Docstring
Filter display of legend nodes for given map settings

:param settings: Map settings. Setting a None or invalid settings will disable any filter. Ownership is not changed, a copy is made
:param settings: Map settings. Setting ``None`` or invalid settings will disable any filter. Ownership is not changed, a copy is made
:param useExtent: Whether to use the extent of the map settings as a first spatial filter on legend nodes
:param polygon: If not empty, this polygon will be used instead of the map extent to filter legend nodes
:param useExpressions: Whether to use legend node filter expressions
@@ -274,7 +274,7 @@ Filter display of legend nodes for given map settings

const QgsMapSettings *legendFilterMapSettings() const;
%Docstring
Returns the current map settings used for the current legend filter (or None if none is enabled)
Returns the current map settings used for the current legend filter (or ``None`` if none is enabled)

.. versionadded:: 2.14
%End
@@ -289,7 +289,7 @@ so that legend nodes that use map units can be scaled currectly

void legendMapViewData( double *mapUnitsPerPixel /Out/, int *dpi /Out/, double *scale /Out/ ) const;
%Docstring
Gets hints about map view - to be used in legend nodes. Arguments that are not None will receive values.
Gets hints about map view - to be used in legend nodes. Arguments that are not ``None`` will receive values.
If there are no valid map view data (from previous call to setLegendMapViewData()), returned values are zeros.

.. versionadded:: 2.6
@@ -93,15 +93,15 @@ Default implementation does nothing. *
Entry point called from QgsLegendRenderer to do the rendering.
Default implementation calls drawSymbol() and drawSymbolText() methods.

If ctx is None, this is just first stage when preparing layout - without actual rendering.
If ctx is ``None``, this is just first stage when preparing layout - without actual rendering.
%End

virtual QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const;
%Docstring
Draws symbol on the left side of the item

:param settings: Legend layout configuration
:param ctx: Context for rendering - may be None if only doing layout without actual rendering
:param ctx: Context for rendering - may be ``None`` 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)
@@ -112,7 +112,7 @@ Draws symbol on the left side of the item
Draws label on the right side of the item

:param settings: Legend layout configuration
:param ctx: Context for rendering - may be nullptrnullptr if only doing layout without actual rendering
:param ctx: Context for rendering - may be ``None`` 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)
@@ -89,7 +89,7 @@ Find out about type of the node. It is usually shorter to use convenience functi
%End
QgsLayerTreeNode *parent();
%Docstring
Gets pointer to the parent. If parent is None, the node is a root node
Gets pointer to the parent. If parent is ``None``, the node is a root node
%End
QList<QgsLayerTreeNode *> children();
%Docstring
@@ -143,7 +143,7 @@ section.

virtual QgsLayout *nextBody( bool &ok /Out/ );
%Docstring
Returns the next body layout to export, or a None if
Returns the next body layout to export, or ``None`` if
no body layout is required this iteration.

``ok`` will be set to ``False`` if no bodies remain for this section.
@@ -78,7 +78,7 @@ Calling this method removes all items and pages from the layout.
QgsProject *project() const;
%Docstring
The project associated with the layout. Used to get access to layers, map themes,
relations and various other bits. It is never None.
relations and various other bits. It is never ``None``.
%End

QgsLayoutModel *itemsModel();
@@ -177,7 +177,7 @@ which deferred z-order updates.

QgsLayoutItem *itemByUuid( const QString &uuid, bool includeTemplateUuids = false ) const;
%Docstring
Returns the layout item with matching ``uuid`` unique identifier, or a None
Returns the layout item with matching ``uuid`` unique identifier, or ``None``
if a matching item could not be found.

If ``includeTemplateUuids`` is ``True``, then item's template UUID
@@ -196,7 +196,7 @@ Note that template UUIDs are only available while a layout is being restored fro

QgsLayoutItem *itemByTemplateUuid( const QString &uuid ) const;
%Docstring
Returns the layout item with matching template ``uuid`` unique identifier, or a None
Returns the layout item with matching template ``uuid`` unique identifier, or ``None``
if a matching item could not be found. Unlike itemByUuid(), this method ONLY checks
template UUIDs for a match.

@@ -224,7 +224,7 @@ item found.

QgsLayoutMultiFrame *multiFrameByUuid( const QString &uuid, bool includeTemplateUuids = false ) const;
%Docstring
Returns the layout multiframe with matching ``uuid`` unique identifier, or a None
Returns the layout multiframe with matching ``uuid`` unique identifier, or ``None``
if a matching multiframe could not be found.

If ``includeTemplateUuids`` is ``True``, then the multiframe's :py:func:`QgsLayoutMultiFrame.templateUuid()`
@@ -438,7 +438,7 @@ Returns list of keys stored in custom properties for the layout.
%Docstring
Returns the map item which will be used to generate corresponding world files when the
layout is exported. If no map was explicitly set via setReferenceMap(), the largest
map in the layout will be returned (or None if there are no maps in the layout).
map in the layout will be returned (or ``None`` if there are no maps in the layout).

.. seealso:: :py:func:`setReferenceMap`
%End
@@ -587,7 +587,7 @@ and it's associated objects.
QgsLayoutItemGroup *groupItems( const QList<QgsLayoutItem *> &items );
%Docstring
Creates a new group from a list of layout ``items`` and adds the group to the layout.
If grouping was not possible, a None will be returned.
If grouping was not possible, ``None`` will be returned.

.. seealso:: :py:func:`ungroupItems`
%End
@@ -637,7 +637,7 @@ Emitted whenever the expression variables stored in the layout have been changed
void selectedItemChanged( QgsLayoutItem *selected );
%Docstring
Emitted whenever the selected item changes.
If None, no item is selected.
If ``None``, no item is selected.
%End

void refreshed();
@@ -326,7 +326,7 @@ an export.
%Docstring
Georeferences a ``file`` (image of PDF) exported from the layout.

The ``referenceMap`` argument specifies a map item to use for georeferencing. If left as None, the
The ``referenceMap`` argument specifies a map item to use for georeferencing. If left as ``None``, the
default layout QgsLayout.referenceMap() will be used.

The ``exportRegion`` argument can be set to a valid rectangle to indicate that only part of the layout was

0 comments on commit 107b48a

Please sign in to comment.
You can’t perform that action at this time.