diff options
| author | Laytan Laats <laytanlaats@hotmail.com> | 2024-09-03 19:59:04 +0200 |
|---|---|---|
| committer | Laytan Laats <laytanlaats@hotmail.com> | 2024-09-03 19:59:04 +0200 |
| commit | 288312a8126d71fae26c9d62a8cd342d830e1c5f (patch) | |
| tree | aa56a083e0222975888a24cf8d755b7d0a4f1bc0 /core/encoding/xml/doc.odin | |
| parent | 0e6109e171d24b3bb17289219ae3b482c24f2460 (diff) | |
core: improve package doc comments for the documentation generator
Diffstat (limited to 'core/encoding/xml/doc.odin')
| -rw-r--r-- | core/encoding/xml/doc.odin | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/core/encoding/xml/doc.odin b/core/encoding/xml/doc.odin new file mode 100644 index 000000000..10d9f78be --- /dev/null +++ b/core/encoding/xml/doc.odin @@ -0,0 +1,23 @@ +/* +XML 1.0 / 1.1 parser + +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 |