aboutsummaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorJeroen van Rijn <Kelimion@users.noreply.github.com>2025-10-09 14:41:22 +0200
committerJeroen van Rijn <Kelimion@users.noreply.github.com>2025-10-09 14:41:22 +0200
commit5a154a1775449a839d713e9adba8ebea4d6e06de (patch)
tree942ac8263e187fc3b5df1ca3fb03f697712149ed /core
parentc3d4b1f0b5b0c0fb765b425d19033195ce4588a8 (diff)
Add more package lines for the docs
Diffstat (limited to 'core')
-rw-r--r--core/compress/gzip/doc.odin5
-rw-r--r--core/compress/shoco/doc.odin2
-rw-r--r--core/compress/shoco/model.odin4
-rw-r--r--core/compress/shoco/shoco.odin6
-rw-r--r--core/compress/zlib/doc.odin5
-rw-r--r--core/container/bit_array/doc.odin6
6 files changed, 17 insertions, 11 deletions
diff --git a/core/compress/gzip/doc.odin b/core/compress/gzip/doc.odin
index fd7ef5a19..745d020c5 100644
--- a/core/compress/gzip/doc.odin
+++ b/core/compress/gzip/doc.odin
@@ -1,3 +1,5 @@
+// package gzip implements a small GZIP implementation as an example.
+package compress_gzip
/*
Copyright 2021 Jeroen van Rijn <nom@duclavier.com>.
Made available under Odin's BSD-3 license.
@@ -86,5 +88,4 @@ Example:
}
bytes.buffer_destroy(&buf)
}
-*/
-package compress_gzip
+*/ \ No newline at end of file
diff --git a/core/compress/shoco/doc.odin b/core/compress/shoco/doc.odin
new file mode 100644
index 000000000..78ab01776
--- /dev/null
+++ b/core/compress/shoco/doc.odin
@@ -0,0 +1,2 @@
+// package shoco is an implementation of the shoco short string compressor.
+package compress_shoco \ No newline at end of file
diff --git a/core/compress/shoco/model.odin b/core/compress/shoco/model.odin
index 919563441..bca58386b 100644
--- a/core/compress/shoco/model.odin
+++ b/core/compress/shoco/model.odin
@@ -1,11 +1,11 @@
+package compress_shoco
+
/*
This file was generated, so don't edit this by hand.
Transliterated from https://github.com/Ed-von-Schleck/shoco/blob/master/shoco_model.h,
which is an English word model.
*/
-package compress_shoco
-
DEFAULT_MODEL :: Shoco_Model {
min_char = 39,
max_char = 122,
diff --git a/core/compress/shoco/shoco.odin b/core/compress/shoco/shoco.odin
index b393b8356..d8810e532 100644
--- a/core/compress/shoco/shoco.odin
+++ b/core/compress/shoco/shoco.odin
@@ -1,3 +1,6 @@
+// package shoco is an implementation of the shoco short string compressor.
+package compress_shoco
+
/*
Copyright 2022 Jeroen van Rijn <nom@duclavier.com>.
Made available under Odin's BSD-3 license.
@@ -8,9 +11,6 @@
An implementation of [shoco](https://github.com/Ed-von-Schleck/shoco) by Christian Schramm.
*/
-// package shoco is an implementation of the shoco short string compressor.
-package compress_shoco
-
import "base:intrinsics"
import "core:compress"
diff --git a/core/compress/zlib/doc.odin b/core/compress/zlib/doc.odin
index 6ae537a87..19ef1c045 100644
--- a/core/compress/zlib/doc.odin
+++ b/core/compress/zlib/doc.odin
@@ -1,3 +1,5 @@
+// package zlib implements Deflate decompression
+package compress_zlib
/*
Copyright 2021 Jeroen van Rijn <nom@duclavier.com>.
Made available under Odin's BSD-3 license.
@@ -47,5 +49,4 @@ Example:
fmt.printf("Input: %v bytes, output (%v bytes):\n%v\n", len(ODIN_DEMO), len(s), s)
assert(len(s) == OUTPUT_SIZE)
}
-*/
-package compress_zlib
+*/ \ No newline at end of file
diff --git a/core/container/bit_array/doc.odin b/core/container/bit_array/doc.odin
index 36bf90002..6d35d48d1 100644
--- a/core/container/bit_array/doc.odin
+++ b/core/container/bit_array/doc.odin
@@ -1,3 +1,6 @@
+// package bit_array implements a dynamically-sized array of bits
+package container_dynamic_bit_array
+
/*
The Bit Array can be used in several ways:
@@ -48,5 +51,4 @@ Example:
fmt.printf("Get(Negative_Test): %v, %v\n", get(bits, Foo.Negative_Test))
fmt.printf("Freed.\n")
}
-*/
-package container_dynamic_bit_array
+*/ \ No newline at end of file