Nyall Dawson
b56f1132fc
[processing] Add some more tags and icons to stats algs
2018-05-28 11:09:42 +10:00
Nyall Dawson
b6f2f7bd40
Don't use QgsVectorLayer::selectedFeatures() to check for a selection
...
in a layer
This is incredibly inefficient, because selectedFeatures() actually
fetches a full copy of all selected features (including all
attributes and geometry). Instead use selectedFeatureIds(), which
is just a list of numbers.
Add warning note to docs cautioning against this practice.
Fixes massive ui lockup when right clicking on a layer with
selected features in the layer tree
2018-05-28 10:59:48 +10:00
Nyall Dawson
e552ce62be
Add warning note to QgsLayoutPageCollection::shouldExportPage
2018-05-28 10:06:23 +10:00
Nyall Dawson
5cf33969ae
Cleaner conditional generation of pyi typehint stub files
2018-05-28 10:04:38 +10:00
Alexander Bruy
b150f41f12
fix build with SIP < 4.18
2018-05-28 10:04:38 +10:00
Nyall Dawson
a804a33bc7
Remove some useless \returns dox
2018-05-28 09:48:46 +10:00
Harrissou Sant-anna
f0b72ae62e
Set the dpi default to -1 to use layout dpi
2018-05-28 08:56:32 +10:00
Nyall Dawson
f8bc97030b
Remove extra space added before first line of docstring
2018-05-28 08:22:11 +10:00
Nyall Dawson
ea0c1d8cbc
Typo
2018-05-28 08:22:11 +10:00
Juergen E. Fischer
499459be4b
fix build with SIP <4.19
2018-05-27 19:17:12 +02:00
Nyall Dawson
7a1a787c0a
Fix incorrect returns docstring when doxygen \returns has extra trailing spaces or uses tabs
2018-05-27 18:54:09 +10:00
Nyall Dawson
0e75f6ef85
Don't indent multiline versionadded/deprecated tags
...
Turns out there isn't any valid ones anyway - the only
multiline versionadded tags are due to incorrect ordering
of brief/since tags (which is fixed in a different PR)
2018-05-27 18:54:09 +10:00
Nyall Dawson
9f650fead9
Fix incorrect param docstring when doxygen \param has extra
...
trailing spaces or uses tabs
2018-05-27 18:54:09 +10:00
Nyall Dawson
4b1b752633
Fix bad regex
2018-05-27 18:54:09 +10:00
Nyall Dawson
71107d1d2f
Sipify
2018-05-27 18:54:09 +10:00
Nyall Dawson
3b5ada15f7
Move class since annotation to after brief
...
Lots of classes do this, but it messes with the python docstrings.
TODO: add a unit test preventing this behavior
2018-05-27 18:54:09 +10:00
Nyall Dawson
1edbca4978
Fix bad class docstring
2018-05-27 18:54:09 +10:00
Nyall Dawson
3d6ea5972b
Remove some junk lines from docstrings
2018-05-27 18:54:09 +10:00
Nyall Dawson
38850bdb94
[pyqgis] Ensure that multiline param tags are indented for additional lines
2018-05-27 18:54:09 +10:00
Nyall Dawson
c864d22d1f
Add "get ..." to doxygen compliance blacklist
...
Should be "gets ..." for consistent tense, or better yet
"returns ..." for consistency.
2018-05-27 14:05:06 +10:00
Nyall Dawson
17500c455f
Fix some interface doxygen
2018-05-27 14:05:06 +10:00
Nyall Dawson
b6b08e96a0
Add 'accessor for' to doxygen compliance blacklist
...
Use "Returns the..." instead
2018-05-27 14:05:06 +10:00
Nyall Dawson
4bb7f82fcb
Remove some incorrect 'not available in Python bindings' notes
2018-05-26 16:51:58 +10:00
Nyall Dawson
94cf3fc788
Use "customize" instead of "customise"
...
Since we default to US spelling, we should always be using "customize"
2018-05-26 15:44:04 +10:00
Nyall Dawson
fa5a7d2ae2
Typo
2018-05-26 15:44:04 +10:00
Nyall Dawson
ff55cfc99d
Add missing getters to QgsContrastEnhancementFunction
2018-05-26 15:44:04 +10:00
Nyall Dawson
8f770c3f60
Add 'mutator for ' to doxygen compliance blacklist
2018-05-26 15:44:04 +10:00
Nyall Dawson
80e44c1364
Speed up map to pixel simplification by directly accessing x/y vertex data
2018-05-26 11:00:43 +10:00
Matthias Kuhn
cb4d11787c
Remove redundant virtual on override
2018-05-26 06:11:37 +10:00
Nyall Dawson
99b6194e3c
Improve docs for single symbol renderer, add missing SIP_FACTORY
2018-05-25 17:12:24 +10:00
Nyall Dawson
43928d8c9c
Don't crash when a null task is added to task manager
2018-05-25 16:53:51 +10:00
Nyall Dawson
5e360f90e8
Add unit test to prevent deprecated methods without description
...
And add missing descriptions
2018-05-25 16:31:03 +10:00
Nyall Dawson
8bb45b935a
Typo
2018-05-25 15:09:00 +10:00
Nyall Dawson
1c615c15cc
More documentation compliance
...
Use Qt style "returns .." tense instead of "return ..", and lock
this in with a documentation compliance unit test
2018-05-25 15:09:00 +10:00
Nyall Dawson
bcaad3a5dc
Fix documentation warning
2018-05-25 11:40:57 +10:00
Nyall Dawson
b813a6715e
Fix API breaks
2018-05-25 11:40:57 +10:00
Nyall Dawson
44630b47ed
Add QgsDataProvider::ProviderOptions struct to constructors
...
for data providers
Allows a way to pass generic settings to providers, e.g.
passing a datum transform context for use in provider's
constructors.
2018-05-25 11:40:57 +10:00
Nyall Dawson
bb995202fd
Fix more broken links
2018-05-25 11:16:18 +10:00
Nyall Dawson
2cb8a33884
Fix broken see also links
2018-05-25 11:16:18 +10:00
Harrissou Sant-anna
c7538702f9
Fix typo
2018-05-25 09:17:24 +10:00
Martin Dobias
61f84ce7f6
Merge pull request #7008 from PeterPetrik/qgsmeshlayer_2_scalar_vector_datasets
...
[mesh] Rendering of scalar and vector datasets
2018-05-24 07:43:14 -04:00
Peter Petrik
882d8ed79b
tiny doc change
2018-05-24 08:16:11 +02:00
Nyall Dawson
e906a2c9ce
[python] Generate type hint stub files
...
Causes sip to generate the type hinting stub (".pyi") files
alongside the generated python modules.
This allows editors like PyCharm to become aware of the
types of objects returned by functions, making the autocompletion
much more useful (e.g. by showing all the members available
for a returned type). It also fixes a bunch of incorrect
warnings highlighted in PyCharm for things like calling
static methods in a class (and, generates some new, but valid,
warnings when unexpected types are passed to functions!)
TODO: work out why PyCharm can't show the docstrings
for methods when the pyi file is present.
2018-05-24 06:56:16 +10:00
Matthias Kuhn
2bbacb635f
Merge pull request #7054 from nyalldawson/compliant
...
Add compliance test to doxygen test
2018-05-23 11:03:15 +02:00
Alessandro Pasotti
f41daee1cb
Fix docstring for setEditFormConfig
2018-05-23 09:27:44 +02:00
Nyall Dawson
afa04d9b5b
Fix non-compliant docstrings
2018-05-23 16:55:11 +10:00
nirvn
45aca2f942
fix unclosed strings not style in python console & script editor
2018-05-23 10:08:02 +07:00
Nyall Dawson
6165e4c8d6
Add some SIP_THROW( QgsCsException ) annotations
...
Incomplete, but allows proper QgsCsException catching
for these methods
2018-05-23 07:55:30 +10:00
Nyall Dawson
f82b639604
Fix outdated docs
...
Fixes #19004
2018-05-23 06:55:22 +10:00
Peter Petrik
81bf510c09
fix typo
2018-05-22 18:59:06 +02:00
