summaryrefslogtreecommitdiffstats
path: root/addon/doxmlparser/README.md
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2021-02-02 20:21:27 (GMT)
committerDimitri van Heesch <doxygen@gmail.com>2021-02-02 20:34:58 (GMT)
commit095c5de5e4df192898f7f13e9b51524999615983 (patch)
tree2d04e5aacb490898ed8053100cc1eca334f6be4a /addon/doxmlparser/README.md
parentcd3c39c11084a326baee2e81420fe13a5dacb8e2 (diff)
downloadDoxygen-095c5de5e4df192898f7f13e9b51524999615983.zip
Doxygen-095c5de5e4df192898f7f13e9b51524999615983.tar.gz
Doxygen-095c5de5e4df192898f7f13e9b51524999615983.tar.bz2
Replace the C++ doxmlparser libary by a python based module
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
+