Skip to content
Permalink
Browse files

Reenable Doxygen ingroup test

  • Loading branch information
nyalldawson committed Jul 5, 2016
1 parent 5cf733b commit cfb1895fffb0860ca892c5fb821a26b395b170ba
Showing with 14 additions and 2 deletions.
  1. +1 −1 tests/src/python/test_qgsdoccoverage.py
  2. +13 −1 tests/src/python/utilities.py
@@ -51,7 +51,7 @@ def testCoverage(self):

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

#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)))
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)))

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)))

@@ -363,6 +363,18 @@ def __init__(self, path, acceptable_missing={}, acceptable_missing_added_note=[]
self.groups = {}
self.classes_missing_group = []
self.classes_missing_version_added = []
# for some reason the Doxygen generation on Travis refuses to assign these classes to groups
self.acceptable_missing_group = ['QgsOgcUtils::LayerProperties',
'QgsSQLStatement::Node',
'QgsSQLStatement::NodeBinaryOperator',
'QgsSQLStatement::NodeColumnRef',
'QgsSQLStatement::NodeFunction',
'QgsSQLStatement::NodeInOperator',
'QgsSQLStatement::NodeList',
'QgsSQLStatement::NodeLiteral',
'QgsSQLStatement::NodeUnaryOperator',
'QgsRuleBasedLabeling::Rule',
'QgsSQLStatement::Visitor']
self.parseFiles(path)

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

if not self.hasGroup(class_name):
if not self.hasGroup(class_name) and not class_name in self.acceptable_missing_group:
self.classes_missing_group.append(class_name)
if not class_name in self.acceptable_missing_added_note and not found_version_added:
self.classes_missing_version_added.append(class_name)

0 comments on commit cfb1895

Please sign in to comment.
You can’t perform that action at this time.