summaryrefslogtreecommitdiffstats
path: root/addon/doxmlparser/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'addon/doxmlparser/README.md')
-rw-r--r--addon/doxmlparser/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/addon/doxmlparser/README.md b/addon/doxmlparser/README.md
new file mode 100644
index 0000000..ced4018
--- /dev/null
+++ b/addon/doxmlparser/README.md
@@ -0,0 +1,10 @@
+Doxmlparser
+===========
+
+This is a python package to make it easier to parse the XML output produced by doxygen.
+
+The API is generated from the index.xsd and compound.xsd XML schema files using
+Dave Kuhlman's generateDS https://www.davekuhlman.org/generateDS.html
+
+See the examples directory to get an idea how to use the python module
+