aboutsummaryrefslogtreecommitdiff
path: root/src/wav/xml/doc.odin
diff options
context:
space:
mode:
authorSan Jacobs2025-12-11 20:44:02 +0100
committerSan Jacobs2025-12-11 20:44:02 +0100
commitcb7ef81fd339199c69eccd93105c13d2a1f41f71 (patch)
tree7109109bd690e91ff74ef2c09605e5626c1d9179 /src/wav/xml/doc.odin
parent00121d7c14a3bfa03c5eeb6c28b5edf060baf029 (diff)
downloadbetter-report-cb7ef81fd339199c69eccd93105c13d2a1f41f71.tar.gz
better-report-cb7ef81fd339199c69eccd93105c13d2a1f41f71.tar.bz2
better-report-cb7ef81fd339199c69eccd93105c13d2a1f41f71.zip
We can now generate reports straight from the WAVs! No CSV needed!
Diffstat (limited to 'src/wav/xml/doc.odin')
-rw-r--r--src/wav/xml/doc.odin23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/wav/xml/doc.odin b/src/wav/xml/doc.odin
new file mode 100644
index 0000000..9030cd4
--- /dev/null
+++ b/src/wav/xml/doc.odin
@@ -0,0 +1,23 @@
+/*
+A parser for a useful subset of the `XML` specification.
+
+A from-scratch `XML` implementation, loosely modelled on the [[ spec; https://www.w3.org/TR/2006/REC-xml11-20060816 ]].
+
+Features:
+- Supports enough of the XML 1.0/1.1 spec to handle the 99.9% of XML documents in common current usage.
+- Simple to understand and use. Small.
+
+Caveats:
+- We do NOT support HTML in this package, as that may or may not be valid XML.
+ If it works, great. If it doesn't, that's not considered a bug.
+
+- We do NOT support `UTF-16`. If you have a `UTF-16` XML file, please convert it to `UTF-8` first. Also, our condolences.
+- `<[!ELEMENT` and `<[!ATTLIST` are not supported, and will be either ignored or return an error depending on the parser options.
+
+MAYBE:
+- XML writer?
+- Serialize/deserialize Odin types?
+
+For a full example, see: [[ core/encoding/xml/example; https://github.com/odin-lang/Odin/tree/master/core/encoding/xml/example ]]
+*/
+package encoding_xml