diff options
Diffstat (limited to 'core/encoding')
| -rw-r--r-- | core/encoding/base64/doc.odin | 2 | ||||
| -rw-r--r-- | core/encoding/cbor/doc.odin | 2 | ||||
| -rw-r--r-- | core/encoding/endian/doc.odin | 3 | ||||
| -rw-r--r-- | core/encoding/entity/entity.odin | 18 | ||||
| -rw-r--r-- | core/encoding/hex/hex.odin | 1 | ||||
| -rw-r--r-- | core/encoding/hxa/doc.odin | 3 | ||||
| -rw-r--r-- | core/encoding/ini/ini.odin | 1 | ||||
| -rw-r--r-- | core/encoding/json/doc.odin | 2 | ||||
| -rw-r--r-- | core/encoding/uuid/doc.odin | 3 | ||||
| -rw-r--r-- | core/encoding/varint/doc.odin | 2 | ||||
| -rw-r--r-- | core/encoding/xml/doc.odin | 2 |
11 files changed, 21 insertions, 18 deletions
diff --git a/core/encoding/base64/doc.odin b/core/encoding/base64/doc.odin index 902cf660e..0eab8ae09 100644 --- a/core/encoding/base64/doc.odin +++ b/core/encoding/base64/doc.odin @@ -1,2 +1,2 @@ -// package base64 implements Base64 encoding and decoding +// package base64 implements Base64 encoding and decoding. package encoding_base64
\ No newline at end of file diff --git a/core/encoding/cbor/doc.odin b/core/encoding/cbor/doc.odin index 92f0fa02d..f0388daa9 100644 --- a/core/encoding/cbor/doc.odin +++ b/core/encoding/cbor/doc.odin @@ -1,4 +1,4 @@ -// package cbor implements encoding, decoding, marshaling and unmarshaling types from/into RCF 8949 compatible CBOR binary. +// package cbor implements encoding and decoding types from/into RCF 8949 compatible CBOR binary. package encoding_cbor /* Package cbor encodes, decodes, marshals and unmarshals types from/into RCF 8949 compatible CBOR binary. diff --git a/core/encoding/endian/doc.odin b/core/encoding/endian/doc.odin index 0b43e3097..0c397b29f 100644 --- a/core/encoding/endian/doc.odin +++ b/core/encoding/endian/doc.odin @@ -1,6 +1,5 @@ /* - Package endian implements a simple translation between bytes and numbers with - specific endian encodings. + Package endian implements a simple translation between bytes and numbers with specific endian encodings. Example: buf: [100]u8 diff --git a/core/encoding/entity/entity.odin b/core/encoding/entity/entity.odin index cb8fa8611..45841d125 100644 --- a/core/encoding/entity/entity.odin +++ b/core/encoding/entity/entity.odin @@ -1,13 +1,5 @@ /* - 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. + package entity implements a unicode `&entity;` encoder and decoder. This code has several procedures to map unicode runes to/from different textual encodings. - SGML/XML/HTML entity @@ -21,6 +13,14 @@ */ package encoding_unicode_entity +/* + Copyright 2021 Jeroen van Rijn <nom@duclavier.com>. + Made available under Odin's BSD-3 license. + + List of contributors: + Jeroen van Rijn: Initial implementation. +*/ + import "core:unicode/utf8" import "core:unicode" import "core:strings" diff --git a/core/encoding/hex/hex.odin b/core/encoding/hex/hex.odin index c1753003e..9e0837450 100644 --- a/core/encoding/hex/hex.odin +++ b/core/encoding/hex/hex.odin @@ -1,3 +1,4 @@ +// package hex implements encoding and decoding of hex-encoded binary, e.g. `0x23` -> `#`. package encoding_hex import "core:io" diff --git a/core/encoding/hxa/doc.odin b/core/encoding/hxa/doc.odin index b696bef7e..bfca89d3c 100644 --- a/core/encoding/hxa/doc.odin +++ b/core/encoding/hxa/doc.odin @@ -1,5 +1,6 @@ /* -Implementation of the HxA 3D asset format +package hxa implements Eskil Steenberg's HxA 3D asset interchange format. + HxA is a interchangeable graphics asset format. Designed by Eskil Steenberg. @quelsolaar / eskil 'at' obsession 'dot' se / www.quelsolaar.com diff --git a/core/encoding/ini/ini.odin b/core/encoding/ini/ini.odin index c32b1deb5..f58aaed4d 100644 --- a/core/encoding/ini/ini.odin +++ b/core/encoding/ini/ini.odin @@ -1,3 +1,4 @@ +// package ini implements a variant of the `.ini` file format with `key = value` entries in `[sections]`. package encoding_ini import "base:runtime" diff --git a/core/encoding/json/doc.odin b/core/encoding/json/doc.odin new file mode 100644 index 000000000..04c38d142 --- /dev/null +++ b/core/encoding/json/doc.odin @@ -0,0 +1,2 @@ +// package json implements encoding and decoding JSON in strict JSON, JSON5 and BitSquid variants. +package encoding_json
\ No newline at end of file diff --git a/core/encoding/uuid/doc.odin b/core/encoding/uuid/doc.odin index f910c33d8..373740a8e 100644 --- a/core/encoding/uuid/doc.odin +++ b/core/encoding/uuid/doc.odin @@ -1,6 +1,5 @@ /* -package uuid implements Universally Unique Identifiers according to the -standard originally outlined in RFC 4122 with additions from RFC 9562. +package uuid implements Universally Unique Identifiers according to RFC 4122, with additions from RFC 9562. The UUIDs are textually represented and read in the following string format: `00000000-0000-v000-V000-000000000000` diff --git a/core/encoding/varint/doc.odin b/core/encoding/varint/doc.odin index a00cfed15..ccc9493cd 100644 --- a/core/encoding/varint/doc.odin +++ b/core/encoding/varint/doc.odin @@ -1,5 +1,5 @@ /* -Implementation of the LEB128 variable integer encoding as used by DWARF encoding and DEX files, among others. +package varint implements LEB128 variable integer encoding and decoding, as used by DWARF & DEX files. Author of this Odin package: Jeroen van Rijn diff --git a/core/encoding/xml/doc.odin b/core/encoding/xml/doc.odin index 10d9f78be..8746fae02 100644 --- a/core/encoding/xml/doc.odin +++ b/core/encoding/xml/doc.odin @@ -1,5 +1,5 @@ /* -XML 1.0 / 1.1 parser +package xml implements 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 ]]. |