Skip to content

Commit cfb1895

Browse files
committed
Reenable Doxygen ingroup test
1 parent 5cf733b commit cfb1895

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

tests/src/python/test_qgsdoccoverage.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ def testCoverage(self):
5151

5252
assert len(parser.undocumented_string) == 0, 'FAIL: new undocumented members have been introduced, please add documentation for these members'
5353

54-
#self.assertTrue(len(parser.classes_missing_group) == 0, 'FAIL: {} classes have been added without Doxygen group tags ("/ingroup"):\n{}'.format(len(parser.classes_missing_group), '\n'.join(parser.classes_missing_group)))
54+
self.assertTrue(len(parser.classes_missing_group) == 0, 'FAIL: {} classes have been added without Doxygen group tags ("\ingroup"):\n{}'.format(len(parser.classes_missing_group), '\n'.join(parser.classes_missing_group)))
5555

5656
self.assertTrue(len(parser.classes_missing_version_added) == 0, 'FAIL: {} classes have been added without a version added doxygen note ("@note added in QGIS x.xx"):\n{}'.format(len(parser.classes_missing_version_added), '\n'.join(parser.classes_missing_version_added)))
5757

tests/src/python/utilities.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,18 @@ def __init__(self, path, acceptable_missing={}, acceptable_missing_added_note=[]
363363
self.groups = {}
364364
self.classes_missing_group = []
365365
self.classes_missing_version_added = []
366+
# for some reason the Doxygen generation on Travis refuses to assign these classes to groups
367+
self.acceptable_missing_group = ['QgsOgcUtils::LayerProperties',
368+
'QgsSQLStatement::Node',
369+
'QgsSQLStatement::NodeBinaryOperator',
370+
'QgsSQLStatement::NodeColumnRef',
371+
'QgsSQLStatement::NodeFunction',
372+
'QgsSQLStatement::NodeInOperator',
373+
'QgsSQLStatement::NodeList',
374+
'QgsSQLStatement::NodeLiteral',
375+
'QgsSQLStatement::NodeUnaryOperator',
376+
'QgsRuleBasedLabeling::Rule',
377+
'QgsSQLStatement::Visitor']
366378
self.parseFiles(path)
367379

368380
def parseFiles(self, path):
@@ -426,7 +438,7 @@ def parseFile(self, f):
426438
class_name = elem.find('compoundname').text
427439
acceptable_missing = self.acceptable_missing.get(class_name, [])
428440

429-
if not self.hasGroup(class_name):
441+
if not self.hasGroup(class_name) and not class_name in self.acceptable_missing_group:
430442
self.classes_missing_group.append(class_name)
431443
if not class_name in self.acceptable_missing_added_note and not found_version_added:
432444
self.classes_missing_version_added.append(class_name)

0 commit comments

Comments
 (0)