summaryrefslogtreecommitdiffstats
path: root/doc/tools/doxy.py
diff options
context:
space:
mode:
authorBen Kaduk <kaduk@mit.edu>2012-10-15 14:39:15 -0400
committerBen Kaduk <kaduk@mit.edu>2012-10-15 19:20:44 -0400
commite95f9f6875f4cbcae60fe96696eb83a6972bbf26 (patch)
treea56a1baa43cb89187aaba76ab1eb8836511effed /doc/tools/doxy.py
parentee26c4bbf4fc271ebf76d50a23ca27ef74220404 (diff)
downloadkrb5-e95f9f6875f4cbcae60fe96696eb83a6972bbf26.tar.gz
krb5-e95f9f6875f4cbcae60fe96696eb83a6972bbf26.tar.xz
krb5-e95f9f6875f4cbcae60fe96696eb83a6972bbf26.zip
Massive reST content rename
All of rst_source/ is now just in doc/. The krb_ prefix is stripped from the document sub-directories. rst_tools are now just tools. The section headers of kadmind, krb5kdc, and sserver match as conflict markers. bigredbutton: whitespace ticket: 7409
Diffstat (limited to 'doc/tools/doxy.py')
-rw-r--r--doc/tools/doxy.py64
1 files changed, 64 insertions, 0 deletions
diff --git a/doc/tools/doxy.py b/doc/tools/doxy.py
new file mode 100644
index 000000000..c8a4b9dad
--- /dev/null
+++ b/doc/tools/doxy.py
@@ -0,0 +1,64 @@
+'''
+ Copyright 2011 by the Massachusetts
+ Institute of Technology. All Rights Reserved.
+
+ Export of this software from the United States of America may
+ require a specific license from the United States Government.
+ It is the responsibility of any person or organization contemplating
+ export to obtain such a license before exporting.
+
+ WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
+ distribute this software and its documentation for any purpose and
+ without fee is hereby granted, provided that the above copyright
+ notice appear in all copies and that both that copyright notice and
+ this permission notice appear in supporting documentation, and that
+ the name of M.I.T. not be used in advertising or publicity pertaining
+ to distribution of the software without specific, written prior
+ permission. Furthermore if you modify this software you must label
+ your software as modified software and not distribute it in such a
+ fashion that it might be confused with the original M.I.T. software.
+ M.I.T. makes no representations about the suitability of
+ this software for any purpose. It is provided "as is" without express
+ or implied warranty.
+'''
+import sys
+import os
+import re
+from optparse import OptionParser
+
+
+from doxybuilder_types import *
+from doxybuilder_funcs import *
+
+
+def processOptions():
+ usage = "\n\t\t%prog -t type -i in_dir -o out_dir"
+ description = "Description:\n\tProcess doxygen output for c-types and/or functions"
+ parser = OptionParser(usage=usage, description=description)
+
+ parser.add_option("-t", "--type", type="string", dest="action_type", help="process typedef and/or function. Possible choices: typedef, func, all. Default: all.", default="all")
+ parser.add_option("-i", "--in", type="string", dest="in_dir", help="input directory")
+ parser.add_option("-o", "--out", type="string", dest= "out_dir", help="output directory. Note: The subdirectory ./types will be created for typedef")
+
+ (options, args) = parser.parse_args()
+ action = options.action_type
+ in_dir = options.in_dir
+ out_dir = options.out_dir
+
+
+ if in_dir is None or out_dir is None:
+ parser.error("Input and output directories are required")
+
+ if action == "all" or action == "typedef":
+ tester = DoxyTypesTest(in_dir, out_dir)
+ tester.run_tests()
+
+ if action == "all" or action == "func" or action == "function":
+ tester = DoxyFuncsTest(in_dir, out_dir)
+ tester.run_tests()
+
+
+if __name__ == '__main__':
+ parser = processOptions()
+
+