summaryrefslogtreecommitdiffstats
path: root/addon/xmlread/README
diff options
context:
space:
mode:
Diffstat (limited to 'addon/xmlread/README')
-rw-r--r--addon/xmlread/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/addon/xmlread/README b/addon/xmlread/README
new file mode 100644
index 0000000..104917d
--- /dev/null
+++ b/addon/xmlread/README
@@ -0,0 +1,9 @@
+This is a small utility that is used to test and validate the
+XML output generated by doxygen (when GENERATE_XML = YES).
+
+It uses the Xerces-C XML parser/validator (see http://xml.apache.org)
+and expects the environment variable XERCES_ROOT to point to the root
+of the Xerces package.
+
+Currently is reads an XML file, validates it, and prints the class
+hierarchy contained in it.