66 Commits

Author SHA1 Message Date
Nyall Dawson
1395dc0e9c Add missing license headers 2018-06-04 11:30:32 +10:00
Nyall Dawson
23c3731121 Fix path to licensecheck in test 2018-06-04 11:30:32 +10:00
Nyall Dawson
4bb572f4d0 Move licensecheck to external folder 2018-06-04 11:30:32 +10:00
Nyall Dawson
4e0845b4c6 Include licensecheck.pl script in code_layout test folder
Seems to be the only way to get this functional under Travis.

TODO: remove when Travis is upgraded to a reasonably modern
Ubuntu version
2018-06-04 11:30:32 +10:00
Nyall Dawson
48b117e0db Fail check if licensecheck missing 2018-06-04 11:30:32 +10:00
Nyall Dawson
d16ec3e257 Add unit test for license headers 2018-06-04 11:30:32 +10:00
Denis Rouzaud
e5b02cd2a8 use dedicated files for auto additions 2018-06-03 11:07:09 -08:00
Denis Rouzaud
637f59ded1 fix server/app files and sipify test 2018-05-28 10:39:34 -08:00
Denis Rouzaud
6772f0d74e fix test 2018-05-28 10:39:34 -08:00
Denis Rouzaud
70f8266495 add test to check that \since and \deprecated are at the end of command blocks 2018-05-28 10:39:34 -08:00
Nyall Dawson
f8bc97030b Remove extra space added before first line of docstring 2018-05-28 08:22:11 +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
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
a3c543dfda Fix test result 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
14cf46cdf6 Update list of acceptable missing docs 2018-05-23 11:53:52 +10:00
Nyall Dawson
48489d634f Sort list of acceptable missing docs 2018-05-23 11:53:52 +10:00
Denis Rouzaud
7440220e05 [sipify] complete test to check the __init__.py core files are up to date 2018-05-17 23:14:42 -04:00
Denis Rouzaud
847f0e1829 adapt sipify scripts and test to place auto generated sip files in dedicated folder 2018-05-14 10:44:11 -04:00
Nyall Dawson
1bf1058210 Followup fcacb0d, fix doxygen tests
Also:
- move doxygen comments to header files so that they get included
in Python docstrings
- remove duplicate doxygen implemented in both header and footer
- remove some redundant doxygen for overridden methods
- add some missing docs
2018-04-03 09:49:00 +10:00
Juergen E. Fischer
fcacb0db7c doxygen fixes 2018-04-02 22:48:40 +02:00
Denis Rouzaud
9580a88514 fix sipify test 2018-03-02 08:33:45 -09:00
Loïc Bartoletti
5d5927aca4 Add shapeDigitizeToolbar to acceptable missing doc 2018-02-21 22:34:32 +01:00
Denis Rouzaud
3dc3d9d1b2 unite QgsMessageLog::Level and QgsMessageBar::MessageLevel in Qgis::MessageLevel
make enum items lower case
remove unused QgsMessageLog::None and All
2018-02-06 08:56:40 -04:00
Harrissou Sant-anna
91a80759bf Fully replace node* by vertex* 2018-01-31 04:51:20 +01:00
Denis Rouzaud
4a0eedde2e version compare is not strict
also fix sipify test
2018-01-17 10:16:37 -04:00
Denis Rouzaud
f952fe62da rmove entry from acceptable missing doc 2018-01-15 11:55:23 -04:00
Matthias Kuhn
168c469b32 Rename QgsGPS prefixed classes to QgsGps 2018-01-15 11:55:23 -04:00
Denis Rouzaud
8a5d53325c [doxygen] add test to ensure code snippet use \code command 2017-12-19 21:19:45 -04:00
Denis Rouzaud
e6f657cf81 add a test to check that returns are placed before since and note in Doxygen 2017-12-16 10:45:52 -04:00
Denis Rouzaud
92751d47e2 make sipfiles test macos compatible 2017-12-16 10:45:52 -04:00
Denis Rouzaud
5a34558e3e fix sipify test 2017-12-15 22:13:44 -04:00
Denis Rouzaud
60e9b26d64 fix sipify test 2017-12-15 22:13:44 -04:00
Denis Rouzaud
0618071ed5 fix sipify test 2017-12-15 11:12:19 -04:00
Matthias Kuhn
394c53154f Update for nose2 0.7.0 2017-11-05 23:03:16 +01:00
Denis Rouzaud
8a8e2e3a14 fix sipify test 2017-10-09 09:51:40 +02:00
Nyall Dawson
04a9cd9211 Add more consistency to doxygen formatting 2017-10-06 08:19:00 +10:00
rldhont
48514d2e84 Add tests for fixedAspectRatio in SVG marker 2017-09-28 12:25:21 +02:00
rldhont
60cf7bdaf7 Configure and use fixedAspectRatio in QgsSvgSymbolLayerWidget and QgsSvgSymbolLayer 2017-09-28 12:25:19 +02: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
Matthias Kuhn
55cdc89a11 Merge pull request #5004 from jgrocha/helpviewer
[needs-docs] Refactoring of all help calls, deprecating QgsContextHelp+Helpviewer
2017-08-16 18:30:59 +02:00