Fix formatting of package documentation string

This commit is contained in:
Kostas Tsiligkiris
2024-01-17 07:04:00 +02:00
parent 5476d43441
commit 02c2aff41b
+18 -18
View File
@@ -1,28 +1,28 @@
/* /*
An XML 1.0 / 1.1 parser XML 1.0 / 1.1 parser
Copyright 2021-2022 Jeroen van Rijn <nom@duclavier.com>. 2021-2022 Jeroen van Rijn <nom@duclavier.com>.
Made available under Odin's BSD-3 license. available under Odin's BSD-3 license.
A from-scratch XML implementation, loosely modelled on the [spec](https://www.w3.org/TR/2006/REC-xml11-20060816). from-scratch XML implementation, loosely modelled on the [spec](https://www.w3.org/TR/2006/REC-xml11-20060816).
Features: Features:
- Supports enough of the XML 1.0/1.1 spec to handle the 99.9% of XML documents in common current usage. - 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. - Simple to understand and use. Small.
Caveats: Caveats:
- We do NOT support HTML in this package, as that may or may not be valid XML. - 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. 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. - 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. - <[!ELEMENT and <[!ATTLIST are not supported, and will be either ignored or return an error depending on the parser options.
MAYBE: MAYBE:
- XML writer? - XML writer?
- Serialize/deserialize Odin types? - Serialize/deserialize Odin types?
List of contributors: List of contributors:
Jeroen van Rijn: Initial implementation. - Jeroen van Rijn: Initial implementation.
*/ */
package xml package xml
// An XML 1.0 / 1.1 parser // An XML 1.0 / 1.1 parser
@@ -700,4 +700,4 @@ new_element :: proc(doc: ^Document) -> (id: Element_ID) {
cur := doc.element_count cur := doc.element_count
doc.element_count += 1 doc.element_count += 1
return cur return cur
} }