Add way to regenerate the list

sbrunner · m-kuhn · commit 1f9f133e4db6 · 2016-03-22T09:29:01.000+01:00
diff --git a/tests/src/python/test_qgsdoccoverage.py b/tests/src/python/test_qgsdoccoverage.py
@@ -18,6 +18,15 @@
 from utilities import printImportant, DoxygenParser
 from acceptable_missing_doc import ACCEPTABLE_MISSING_DOCS
 
+# TO regenerate the list:
+# uncomment the lines under the `# GEN LIST`
+# $ export PYTHONPATH=build/output/python
+# $ export QGIS_PREFIX_PATH=build/output
+# $ python tests/src/python/test_qgsdoccoverage.py
+# copy the output to the file:
+# tests/src/python/acceptable_missing_doc.py
+# in `ACCEPTABLE_MISSING_DOCS = { <past> }`.
+
 
 class TestQgsDocCoverage(unittest.TestCase):
 
diff --git a/tests/src/python/utilities.py b/tests/src/python/utilities.py
@@ -386,6 +386,11 @@ def parseFile(self, f):
                         documented_members += documented
                         class_name = elem.find('compoundname').text
                         acceptable_missing = self.acceptable_missing.get(class_name, [])
+
+                        # GEN LIST
+                        # if len(undocumented) > 0:
+                        #     print('"%s": [%s],' % (class_name, ", ".join(['"%s"' % e.replace('"', '\\"') for e in undocumented])))
+
                         unacceptable_undocumented = undocumented - set(acceptable_missing)
 
                         if len(unacceptable_undocumented) > 0:
