summaryrefslogtreecommitdiffstats
path: root/doc/tools/doxybuilder_funcs.py
diff options
context:
space:
mode:
authorBen Kaduk <kaduk@mit.edu>2012-12-12 13:23:03 -0500
committerBen Kaduk <kaduk@mit.edu>2012-12-14 11:05:43 -0500
commit060b1eb1e38b294495adab784da32ca4e9871d20 (patch)
treea50d6414788ad41b04ed88aac610d586db29b331 /doc/tools/doxybuilder_funcs.py
parent311347e5e9d9208e2d341b8f8aed37791a4de090 (diff)
downloadkrb5-060b1eb1e38b294495adab784da32ca4e9871d20.tar.gz
krb5-060b1eb1e38b294495adab784da32ca4e9871d20.tar.xz
krb5-060b1eb1e38b294495adab784da32ca4e9871d20.zip
Better names for doxygen-Sphinx bridge functions
It is confusing when the codepath for the production doc build involves calling functions with names like "test". Rename things which are in active use so that routines which are actually only used for testing are more discernable as such. ticket: 7505 (new) tags: pullup target_version: 1.11
Diffstat (limited to 'doc/tools/doxybuilder_funcs.py')
-rw-r--r--doc/tools/doxybuilder_funcs.py19
1 files changed, 8 insertions, 11 deletions
diff --git a/doc/tools/doxybuilder_funcs.py b/doc/tools/doxybuilder_funcs.py
index c9b690185..bfcadfdf2 100644
--- a/doc/tools/doxybuilder_funcs.py
+++ b/doc/tools/doxybuilder_funcs.py
@@ -573,25 +573,22 @@ class DoxyFuncs(XML2AST):
-class DoxyFuncsTest(DoxyFuncs):
+class DoxyBuilderFuncs(DoxyFuncs):
def __init__(self, xmlpath, rstpath):
- super(DoxyFuncsTest,self).__init__(xmlpath)
+ super(DoxyBuilderFuncs,self).__init__(xmlpath)
self.target_dir = rstpath
outfile = '%s/%s' % (self.target_dir, 'out.txt')
self.tmp = open(outfile, 'w')
- def run_tests(self):
- self.test_save()
-
- def test_run(self):
- self.run()
-
- def test_save(self):
+ def run_all(self):
self.run()
templates = {'function': 'func_document.tmpl'}
self.save(templates, self.target_dir)
+ def test_run(self):
+ self.run()
+
if __name__ == '__main__':
- tester = DoxyFuncsTest(xmlpath, rstpath)
- tester.run_tests()
+ builder = DoxyBuilderFuncs(xmlpath, rstpath)
+ builder.run_all()