diff options
| author | gingerBill <gingerBill@users.noreply.github.com> | 2024-09-04 21:37:48 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-04 21:37:48 +0100 |
| commit | a4fd0c133e824e349f830cad171d46fc210faab4 (patch) | |
| tree | 8c869bc49609d68c5cd9e4e53a2b2f03b92f6297 /core/encoding/xml | |
| parent | ce018b4e6fc21356f5236449d90712fc5d0adc3e (diff) | |
| parent | 288312a8126d71fae26c9d62a8cd342d830e1c5f (diff) | |
Merge pull request #4191 from laytan/improve-package-doc-comments
core: improve package doc comments for the documentation generator
Diffstat (limited to 'core/encoding/xml')
| -rw-r--r-- | core/encoding/xml/doc.odin | 23 | ||||
| -rw-r--r-- | core/encoding/xml/xml_reader.odin | 28 |
2 files changed, 28 insertions, 23 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 diff --git a/core/encoding/xml/xml_reader.odin b/core/encoding/xml/xml_reader.odin index b9656900f..b8c8b13a4 100644 --- a/core/encoding/xml/xml_reader.odin +++ b/core/encoding/xml/xml_reader.odin @@ -1,29 +1,11 @@ /* - XML 1.0 / 1.1 parser + 2021-2022 Jeroen van Rijn <nom@duclavier.com>. + available under Odin's BSD-3 license. - 2021-2022 Jeroen van Rijn <nom@duclavier.com>. - available under Odin's BSD-3 license. - - 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? - -List of contributors: -- Jeroen van Rijn: Initial implementation. + List of contributors: + - Jeroen van Rijn: Initial implementation. */ + package encoding_xml // An XML 1.0 / 1.1 parser |