package lines for encoding

core/crypto/hkdf/hkdf.odin

@@ -1,6 +1,5 @@
 /*
-package hkdf implements the HKDF HMAC-based Extract-and-Expand Key
+package hkdf implements the HKDF HMAC-based Extract-and-Expand Key Derivation Function.
-Derivation Function.
 
 See: [[ https://www.rfc-editor.org/rfc/rfc5869 ]]
 */

core/crypto/x25519/x25519.odin

@@ -1,6 +1,5 @@
 /*
-package x25519 implements the X25519 (aka curve25519) Elliptic-Curve
+package x25519 implements the X25519 (aka curve25519) Elliptic-Curve Diffie-Hellman key exchange protocol.
-Diffie-Hellman key exchange protocol.
 
 See:
 - [[ https://www.rfc-editor.org/rfc/rfc7748 ]]

core/crypto/x448/x448.odin

@@ -1,6 +1,5 @@
 /*
-package x448 implements the X448 (aka curve448) Elliptic-Curve
+package x448 implements the X448 (aka curve448) Elliptic-Curve Diffie-Hellman key exchange protocol.
-Diffie-Hellman key exchange protocol.
 
 See:
 - [[ https://www.rfc-editor.org/rfc/rfc7748 ]]

core/debug/pe/doc.odin

@@ -1,2 +1,2 @@
-// package pe implements a reader for the PE executable format for debug purposes
+// package pe implements a reader for the PE executable format for debug purposes.
 package debug_pe

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

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.

core/encoding/endian/doc.odin

@@ -1,6 +1,5 @@
 /*
-    Package endian implements a simple translation between bytes and numbers with
+    Package endian implements a simple translation between bytes and numbers with specific endian encodings.
-    specific endian encodings.
 
 Example:
 	buf: [100]u8

core/encoding/entity/entity.odin

@@ -1,13 +1,5 @@
 /*
-	Copyright 2021 Jeroen van Rijn <nom@duclavier.com>.
+	package entity implements a unicode `&entity;` encoder and decoder.
-	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
@@ -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"

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"

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
 

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"

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

core/encoding/uuid/doc.odin

@@ -1,6 +1,5 @@
 /*
-package uuid implements Universally Unique Identifiers according to the
+package uuid implements Universally Unique Identifiers according to RFC 4122, with additions from RFC 9562.
-standard originally outlined in RFC 4122 with additions from RFC 9562.
 
 The UUIDs are textually represented and read in the following string format:
 `00000000-0000-v000-V000-000000000000`

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
 

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 ]].