Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add way to regenerate the list
  • Loading branch information
sbrunner authored and m-kuhn committed Mar 22, 2016
1 parent 3b4a250 commit 1f9f133
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
9 changes: 9 additions & 0 deletions tests/src/python/test_qgsdoccoverage.py
Expand Up @@ -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):

Expand Down
5 changes: 5 additions & 0 deletions tests/src/python/utilities.py
Expand Up @@ -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:
Expand Down

0 comments on commit 1f9f133

Please sign in to comment.