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
150391f1c2
Fix detection of class brief documentation on some doxygen versions
2025-03-28 14:23:56 +10:00
Denis Rouzaud
0f032e5f2d
run pre-commit on all files
2024-11-29 15:38:02 +01:00
Nyall Dawson
1d83922171
Move constructors don't need documentation
2024-08-31 06:19:26 +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
Etienne Trimaille
651d2f01a6
Python - run isort and remove unused imports in the test folder
2023-02-03 15:38:17 +01:00
Etienne Trimaille
da8bb1db43
Python - Run pyupgrade on some Python files
2023-02-02 06:46:47 +10:00
Nyall Dawson
43f2ae7044
Fix doc test with final implementations
2020-11-13 02:59:05 +10:00
Nyall Dawson
83bcbc5d47
Flag use of TODO comments in the public doxygen docs
...
These should be c++ code comments only, we don't want to include
them in the API docs
2020-06-15 13:43:58 +10:00
Nyall Dawson
b6a7a10703
Fix some more python formatting issues, remove more flake exceptions
2020-05-11 11:41:50 +10:00
Matthias Kuhn
d084ad9ec5
Fix escaping errors
2020-05-05 22:55:44 +02:00
Nyall Dawson
4c8ce04bfe
Fix deprecation warnings in doxygen parser
2020-01-13 13:45:34 +13:00
Bas Couwenberg
2628c480c5
Don't include revision in sources.
...
Prevent changes to files that weren't changed between releases.
This eases review of the changes between releases significantly.
2019-05-17 16:47:47 +02: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
b6b08e96a0
Add 'accessor for' to doxygen compliance blacklist
...
Use "Returns the..." instead
2018-05-27 14:05:06 +10:00
Nyall Dawson
8f770c3f60
Add 'mutator for ' to doxygen compliance blacklist
2018-05-26 15:44:04 +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
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
2cb8a33884
Fix broken see also links
2018-05-25 11:16:18 +10:00
Nyall Dawson
fa912f5c1d
Doxygen test also checks for broken 'see also' links
2018-05-25 11:16:18 +10:00
Nyall Dawson
8b1bbfe8ae
Add compliance test to doxygen test
...
Tests for "non-compliant" doxygen strings, e.g. use of
- "getter for..." instead of "returns the..."
- "setter for..." instead of "sets the..."
Will be expanded in future to also test for:
- "return ..." instead of "returns ..."
- "set ..." instead of "sets ..."
2018-05-23 16:46:31 +10:00
Nyall Dawson
4082ef7fec
Standardize member signature when comparing against acceptable undocumented members
...
Seems different doxygen versions result in slightly different whitepace
*inside* the member's signatures!
2018-05-23 11:53:52 +10:00
Nyall Dawson
91a792b8d8
Try to fix handling of undocumented members on Travis
2018-05-23 11:53:52 +10:00
Nyall Dawson
6166d21289
Add missing docs
2017-09-11 21:43:15 +10:00
Nyall Dawson
c78ca050c0
Ignore =default during doxygen coverage test
2017-09-11 17:10:31 +10:00
Nyall Dawson
e4c1e1b905
Ignore Q_ENUM in doxygen test
2017-08-29 20:09:54 +10:00
Denis Rouzaud
518ffe3f62
fix doxygen test on Travis
...
it seems that doxygen 1.18.13 is not behaving the same as 1.1811 (Travis one).
one might need to remove some spaces in the signature as they are different depending on Doxygen's version
2017-08-06 23:57:14 +02:00
