aboutsummaryrefslogtreecommitdiff
path: root/core/encoding/entity
diff options
context:
space:
mode:
authorLaytan Laats <laytanlaats@hotmail.com>2024-09-03 19:59:04 +0200
committerLaytan Laats <laytanlaats@hotmail.com>2024-09-03 19:59:04 +0200
commit288312a8126d71fae26c9d62a8cd342d830e1c5f (patch)
treeaa56a083e0222975888a24cf8d755b7d0a4f1bc0 /core/encoding/entity
parent0e6109e171d24b3bb17289219ae3b482c24f2460 (diff)
core: improve package doc comments for the documentation generator
Diffstat (limited to 'core/encoding/entity')
-rw-r--r--core/encoding/entity/entity.odin26
1 files changed, 14 insertions, 12 deletions
diff --git a/core/encoding/entity/entity.odin b/core/encoding/entity/entity.odin
index f5208ad6f..d2f1d46b2 100644
--- a/core/encoding/entity/entity.odin
+++ b/core/encoding/entity/entity.odin
@@ -1,23 +1,25 @@
-package encoding_unicode_entity
/*
- A unicode entity encoder/decoder
-
Copyright 2021 Jeroen van Rijn <nom@duclavier.com>.
Made available under Odin's BSD-3 license.
+ List of contributors:
+ Jeroen van Rijn: Initial implementation.
+*/
+
+/*
+ A unicode entity encoder/decoder.
+
This code has several procedures to map unicode runes to/from different textual encodings.
- SGML/XML/HTML entity
- -- &#<decimal>;
- -- &#x<hexadecimal>;
- -- &<entity name>; (If the lookup tables are compiled in).
- Reference: https://www.w3.org/2003/entities/2007xml/unicode.xml
+ - &#<decimal>;
+ - &#x<hexadecimal>;
+ - &<entity name>; (If the lookup tables are compiled in).
+ Reference: [[ https://www.w3.org/2003/entities/2007xml/unicode.xml ]]
- URL encode / decode %hex entity
- Reference: https://datatracker.ietf.org/doc/html/rfc3986/#section-2.1
-
- List of contributors:
- Jeroen van Rijn: Initial implementation.
+ Reference: [[ https://datatracker.ietf.org/doc/html/rfc3986/#section-2.1 ]]
*/
+package encoding_unicode_entity
import "core:unicode/utf8"
import "core:unicode"
@@ -353,4 +355,4 @@ _handle_xml_special :: proc(t: ^Tokenizer, builder: ^strings.Builder, options: X
}
return false, .None
-} \ No newline at end of file
+}