From 248b0fe9e155e1a00a04cb7b1fc687601d401d7c Mon Sep 17 00:00:00 2001 From: Jeroen van Rijn Date: Thu, 9 Oct 2025 16:11:33 +0200 Subject: [PATCH] More package lines --- core/bytes/bytes.odin | 2 +- core/c/c.odin | 2 +- core/c/libc/doc.odin | 2 +- core/compress/common.odin | 7 +++---- core/compress/gzip/doc.odin | 2 +- core/compress/zlib/doc.odin | 2 +- core/container/bit_array/doc.odin | 2 +- core/container/priority_queue/doc.odin | 2 +- core/container/rbtree/doc.odin | 2 +- core/crypto/aead/doc.odin | 6 +++--- core/crypto/aegis/aegis.odin | 5 +++-- core/crypto/chacha20poly1305/chacha20poly1305.odin | 6 +++--- core/crypto/crypto.odin | 5 +---- core/crypto/deoxysii/deoxysii.odin | 3 +-- core/encoding/base32/doc.odin | 2 +- core/encoding/base64/doc.odin | 2 ++ core/encoding/cbor/doc.odin | 6 +++--- 17 files changed, 28 insertions(+), 30 deletions(-) create mode 100644 core/encoding/base64/doc.odin diff --git a/core/bytes/bytes.odin b/core/bytes/bytes.odin index 859f90318..d4a0804b5 100644 --- a/core/bytes/bytes.odin +++ b/core/bytes/bytes.odin @@ -1,4 +1,4 @@ -// package bytes implements procedures for manipulation of byte slices +// package bytes implements procedures for manipulation of byte slices. package bytes import "base:intrinsics" diff --git a/core/c/c.odin b/core/c/c.odin index 907b2f80f..c609cefd1 100644 --- a/core/c/c.odin +++ b/core/c/c.odin @@ -1,4 +1,4 @@ -// package c just defines the basic types used by C programs +// package c just defines the basic types used by C programs. package c import builtin "base:builtin" diff --git a/core/c/libc/doc.odin b/core/c/libc/doc.odin index 883a3dda5..29fb40a30 100644 --- a/core/c/libc/doc.odin +++ b/core/c/libc/doc.odin @@ -1,2 +1,2 @@ -// package libc declares the commonly used things in "libc" (C standard library) +// package libc declares the commonly used things in "libc" (C standard library). package libc diff --git a/core/compress/common.odin b/core/compress/common.odin index f4429b667..917dcfba5 100644 --- a/core/compress/common.odin +++ b/core/compress/common.odin @@ -1,3 +1,6 @@ +// package compress is a collection of utilities to aid with other compression packages. +package compress + /* Copyright 2021 Jeroen van Rijn . Made available under Odin's BSD-3 license. @@ -6,10 +9,6 @@ Jeroen van Rijn: Initial implementation, optimization. */ - -// package compress is a collection of utilities to aid with other compression packages -package compress - import "core:io" import "core:bytes" import "base:runtime" diff --git a/core/compress/gzip/doc.odin b/core/compress/gzip/doc.odin index 745d020c5..c35f205e5 100644 --- a/core/compress/gzip/doc.odin +++ b/core/compress/gzip/doc.odin @@ -1,4 +1,4 @@ -// package gzip implements a small GZIP implementation as an example. +// package gzip implements a small GZIP unpacker as an example. package compress_gzip /* Copyright 2021 Jeroen van Rijn . diff --git a/core/compress/zlib/doc.odin b/core/compress/zlib/doc.odin index 19ef1c045..f143073a3 100644 --- a/core/compress/zlib/doc.odin +++ b/core/compress/zlib/doc.odin @@ -1,4 +1,4 @@ -// package zlib implements Deflate decompression +// package zlib implements Deflate decompression. package compress_zlib /* Copyright 2021 Jeroen van Rijn . diff --git a/core/container/bit_array/doc.odin b/core/container/bit_array/doc.odin index 6d35d48d1..3ff6f5765 100644 --- a/core/container/bit_array/doc.odin +++ b/core/container/bit_array/doc.odin @@ -1,4 +1,4 @@ -// package bit_array implements a dynamically-sized array of bits +// package bit_array implements a dynamically-sized array of bits. package container_dynamic_bit_array /* diff --git a/core/container/priority_queue/doc.odin b/core/container/priority_queue/doc.odin index a71a9dd28..7cba4af8d 100644 --- a/core/container/priority_queue/doc.odin +++ b/core/container/priority_queue/doc.odin @@ -1,2 +1,2 @@ -// package priority_queue implements a Priority Queue data structure +// package priority_queue implements a Priority Queue data structure. package container_priority_queue \ No newline at end of file diff --git a/core/container/rbtree/doc.odin b/core/container/rbtree/doc.odin index 691442e8e..3ff154d18 100644 --- a/core/container/rbtree/doc.odin +++ b/core/container/rbtree/doc.odin @@ -1,2 +1,2 @@ -// package rbtree implements a red-black tree +// package rbtree implements a red-black tree. package container_rbtree \ No newline at end of file diff --git a/core/crypto/aead/doc.odin b/core/crypto/aead/doc.odin index 93be674a0..687b4deae 100644 --- a/core/crypto/aead/doc.odin +++ b/core/crypto/aead/doc.odin @@ -1,6 +1,6 @@ + /* -package aead provides a generic interface to the supported Authenticated -Encryption with Associated Data algorithms. +package aead implements a generic interface to Authenticated Encryption with Associated Data algorithms. Both a one-shot and context based interface are provided, with similar usage. If multiple messages are to be sealed/opened via the same key, @@ -54,4 +54,4 @@ Example: assert(bytes.equal(opened_pt, plaintext)) } */ -package aead +package aead \ No newline at end of file diff --git a/core/crypto/aegis/aegis.odin b/core/crypto/aegis/aegis.odin index adecce91f..c0d8bf4ee 100644 --- a/core/crypto/aegis/aegis.odin +++ b/core/crypto/aegis/aegis.odin @@ -1,6 +1,7 @@ /* -package aegis implements the AEGIS-128L and AEGIS-256 Authenticated -Encryption with Additional Data algorithms. +package aegis implements the AEGIS-128L and AEGIS-256 AEAD algorithms. + +Where AEAD stands for Authenticated Encryption with Additional Data. See: - [[ https://www.ietf.org/archive/id/draft-irtf-cfrg-aegis-aead-12.txt ]] diff --git a/core/crypto/chacha20poly1305/chacha20poly1305.odin b/core/crypto/chacha20poly1305/chacha20poly1305.odin index 6706b3820..f6f375a84 100644 --- a/core/crypto/chacha20poly1305/chacha20poly1305.odin +++ b/core/crypto/chacha20poly1305/chacha20poly1305.odin @@ -1,7 +1,7 @@ /* -package chacha20poly1305 implements the AEAD_CHACHA20_POLY1305 and -AEAD_XChaCha20_Poly1305 Authenticated Encryption with Additional Data -algorithms. +package chacha20poly1305 implements the CHACHA20_POLY1305 and XChaCha20_Poly1305 AEAD algorithms. + +Where AEAD stands for Authenticated Encryption with Additional Data. See: - [[ https://www.rfc-editor.org/rfc/rfc8439 ]] diff --git a/core/crypto/crypto.odin b/core/crypto/crypto.odin index 323cc45d6..52ccb00de 100644 --- a/core/crypto/crypto.odin +++ b/core/crypto/crypto.odin @@ -1,7 +1,4 @@ -/* -package crypto implements a selection of cryptography algorithms and useful -helper routines. -*/ +// package crypto implements a selection of cryptography algorithms and useful helper routines. package crypto import "base:runtime" diff --git a/core/crypto/deoxysii/deoxysii.odin b/core/crypto/deoxysii/deoxysii.odin index cead770e2..db72ff194 100644 --- a/core/crypto/deoxysii/deoxysii.odin +++ b/core/crypto/deoxysii/deoxysii.odin @@ -1,6 +1,5 @@ /* -package deoxysii implements the Deoxys-II-256 Authenticated Encryption -with Additional Data algorithm. +package deoxysii implements the Deoxys-II-256 Authenticated Encryption with Additional Data algorithm. - [[ https://sites.google.com/view/deoxyscipher ]] - [[ https://thomaspeyrin.github.io/web/assets/docs/papers/Jean-etal-JoC2021.pdf ]] diff --git a/core/encoding/base32/doc.odin b/core/encoding/base32/doc.odin index 8d6f57c88..34d12e657 100644 --- a/core/encoding/base32/doc.odin +++ b/core/encoding/base32/doc.odin @@ -1,2 +1,2 @@ -// package base32 implements Base32 encoding/decoding, as specified in RFC 4648. +// package base32 implements Base32 encoding and decoding, as specified in RFC 4648. package encoding_base32 \ No newline at end of file diff --git a/core/encoding/base64/doc.odin b/core/encoding/base64/doc.odin new file mode 100644 index 000000000..902cf660e --- /dev/null +++ b/core/encoding/base64/doc.odin @@ -0,0 +1,2 @@ +// 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 b3fa36130..92f0fa02d 100644 --- a/core/encoding/cbor/doc.odin +++ b/core/encoding/cbor/doc.odin @@ -1,3 +1,5 @@ +// package cbor implements encoding, decoding, marshaling and unmarshaling 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. Also provided are conversion to and from JSON and the CBOR diagnostic format. @@ -164,6 +166,4 @@ Output: "renamed :)": 123123.12500000, "str": "Hello, World!" } -*/ -package encoding_cbor - +*/ \ No newline at end of file