Germán Carrillo
6faf4553d2
Update the new doc_test.json (previously known as acceptable_missing_docs.py) file, with the docs that this PR is completing
2025-05-05 12:59:47 -05:00
Nyall Dawson
d8e2e77047
Regenerate missing docs lists
2025-05-04 07:42:19 +10:00
Nyall Dawson
53edd25dc3
Move doc test config to json file
2025-05-04 07:42:19 +10:00
Alex
4a0ea094fb
show right file
2025-04-22 11:37:22 +10:00
Bernard Teo
c55a567070
Open and load --code file in C++
2025-04-16 00:30:00 +08:00
Alexander Bruy
dfe0e16660
harmonize terminology related to creation options with GDAL
2025-04-12 11:00:41 +01:00
Nyall Dawson
c585d3366e
Fix sipify test
2025-04-02 11:11:10 +10:00
Nyall Dawson
362f2dd20a
Fix sipify test
2025-04-01 09:44:00 +10:00
Nyall Dawson
19755421f6
Make doxygen check enfore full sentences, sentence case for class briefs
...
Some of this needs to be checked in sipify, as doxygen internally
appends a trailing '.' to briefs when they aren't present.
2025-04-01 09:44:00 +10:00
Nyall Dawson
6e2a82c60a
Catch more class documentation anti-patterns
2025-04-01 09:44:00 +10:00
Nyall Dawson
44904ebfe6
Also prevent class brief starting with 'a class', 'it', 'this is'...
2025-03-30 20:48:07 +10:00
Nyall Dawson
9b633720f8
Enfore short brief descriptions, not starting with 'This class'
2025-03-30 20:48:07 +10:00
Nyall Dawson
602ef6c691
Don't start class briefs with "This class contains settings..."
...
It's unncessarily verbose, use just "Contains settings..." instead.
2025-03-30 20:48:07 +10:00
Nyall Dawson
57a49d212b
Add compliance test for class brief documentation
...
Don't allow class brief to start with 'The MyClass ...' or 'MyClass ...'
2025-03-30 20:48:07 +10:00
Nyall Dawson
739bf854bd
Change doxygen "3d" group to "qgis_3d"
...
Doxygen chokes on the initial digit in "3d", resulting in corrupted
documentation for classes in the 3d group
2025-03-30 04:40:32 +10:00
Nyall Dawson
2e47963658
Require brief documentation for everything
2025-03-28 14:23:56 +10:00
Nyall Dawson
150391f1c2
Fix detection of class brief documentation on some doxygen versions
2025-03-28 14:23:56 +10:00
David Koňařík
4d86676c35
Fix SIP build errors by using /NoTypeName/
...
The typedef is only present in the .sip file, but without this
annotation SIP assumes it also exists in QGIS headers. This didn't
completely break the build, since we concatenate multiple SIP headers
into larger files, so the typedefs from one part "fixed" another. Run
sip-build without --concatenate to see the issue clearly.
This fix is currently sadly not fully effective due to a SIP bug:
https://github.com/Python-SIP/sip/issues/66
2025-01-06 21:31:40 +01:00
Denis Rouzaud
0f032e5f2d
run pre-commit on all files
2024-11-29 15:38:02 +01:00
Nyall Dawson
6b3eefd115
Add test blocking any new introduction of QgsProject::instance() in core
2024-10-19 06:22:04 +10:00
Nyall Dawson
274734362c
Add banned keyword test for @annotation doxygen format
...
\annotation must be used for sipify to work correctly
2024-10-16 13:01:39 +10:00
Germán Carrillo
f81df2876c
[gui] Move Diagrams properties to a panel widget, showing tabs instead of a list when docked; harmonize stacked diagram configuration with rule-based labeling; allow QgsDiagramProperties to sync to renderers and diagram layer settings, in addition to syncing to layers; when editing a subdiagram of a stacked diagram, only show widgets for diagram layer settings if the subdiagram is the first one, for the rest, hide those widgets and show a note informing users; make sure stacked diagrams handle enabled and disabled subdiagrams (i.e., don't take into account disabled subdiagrams) and add a test for it; switching from single to stacked diagram: take the single diagram definition as the first stacked diagram; fix #58782 (calling twice the apply method for label rendering)
2024-09-17 23:57:00 -05:00
Germán Carrillo
e855941a34
[core] Introduce QgsStackedDiagramRenderer for rendering stacked diagrams. This allows subdiagrams to define their own sizes and legends; add tests for a stacked diagram composed of mixed renderers (single category and linearly interpolated categories), as well as nested stacked diagrams.
2024-09-17 23:56:31 -05:00
Germán Carrillo
43d5094f76
[gui] QgsStackedDiagramProperties: Move EngineSettingsButton from QgsDiagramProperties to the side of the main diagram type combobox
2024-09-17 23:56:31 -05:00
Germán Carrillo
4a3dfd79ec
[gui] In QgsStackedDiagramProperties, make tabs movable to redefine subdiagrams order
2024-09-17 23:56:31 -05:00
Germán Carrillo
614ce76156
[gui] Introduce StackedDiagramProperties and use it as dialog and as vector properties page. For the moment, it works with single diagrams, hiding controls for stacked diagrams
2024-09-17 23:56:22 -05:00
Nyall Dawson
1d83922171
Move constructors don't need documentation
2024-08-31 06:19:26 +10:00
Nyall Dawson
8b04562ba7
Avoid fragile reg for argument removal
2024-08-14 13:05:46 +10:00
Nyall Dawson
cda4105230
Update expected files
2024-08-13 20:28:55 +10:00
Nyall Dawson
a2048773e7
Fix test
2024-08-13 20:28:55 +10:00
Nyall Dawson
87e19bc5ae
Test update
2024-08-13 20:28:55 +10:00
Nyall Dawson
c2c75f3b19
More no-value dox removal
2024-07-25 09:04:22 +10:00
Nyall Dawson
04251e396c
Don't mandate documentation for other self-documenting operators
2024-07-25 04:02:55 +10:00
Nyall Dawson
d9fb464649
Don't mandate documentation for copy constructors
2024-07-25 04:02:55 +10:00
Nyall Dawson
9029ba99ae
Ignore =default constructors in doxygen check
...
There's no need to force documentation for these
2024-07-23 02:08:28 +10:00
Nyall Dawson
77dfdfa9ee
Update tests/code_layout/doxygen_parser.py
2024-06-25 12:42:16 +10:00
Nyall Dawson
17cb0d5678
Don't require since if a class is marked deprecated
...
Since these annotations are incompatible with each other, we must
accept either
2024-06-25 12:42:16 +10:00
Nyall Dawson
0e05d4c4d2
Fix doxytest on some newer doxygen versions
2024-06-25 12:42:16 +10:00
Even Rouault
a68422b982
Various typo fixes
...
Including 3 public methods, which are deprecated by this commit and replaced by a typo-fixed version
2024-02-29 06:03:03 +10:00
Even Rouault
812e2d6aff
acceptable_missing_doc.py: refresh due to removal of obsolete since mentions
2024-02-18 20:57:23 +01:00
Nyall Dawson
18a5eca5c2
Update test
2024-02-13 20:51:03 +10:00
Nyall Dawson
03afa96fd4
Fix indentation
2024-01-31 17:16:18 +10:00
Nyall Dawson
2dae72e388
Fix sipify test
2024-01-31 17:16:18 +10:00
Loïc Bartoletti
5b4449602b
rm clangtidy_checks.txt and it's usage since it's not needed, thanks to .clang-tidy file
2023-12-13 12:14:42 +01:00
Julien Cabieces
388de8cedd
Fix sip tests
2023-12-13 05:36:44 +10:00
Sandro Santilli
07345e52c4
Run doxygen layout checker in prepare-commit script, when possible
...
Helps preventing useless CI wait like in here:
https://github.com/qgis/QGIS/actions/runs/6518501862/job/17703989815?pr=54934
Allow passing list of files to check to test_doxygen_layout.sh script
2023-10-23 13:15:57 +10:00
Nyall Dawson
ed948bc114
Fix doxygen test
2023-10-19 17:30:10 +13:00
Sandro Santilli
b84393e37d
Run shellcheck only on modified shell files
2023-10-09 19:20:08 +02:00
Nyall Dawson
778f7de452
Add a test to ensure consistency of class names
2023-07-20 15:31:00 +10:00
Juergen E. Fischer
d802294787
more housekeeping after qtermwidget removal (followup bf1a8ffd68c4)
2023-07-02 22:17:09 +02:00
