Add more package lines for the docs

This commit is contained in:
Jeroen van Rijn
2025-10-09 14:41:22 +02:00
parent c3d4b1f0b5
commit 5a154a1775
6 changed files with 17 additions and 11 deletions

View File

@@ -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
*/

View File

@@ -0,0 +1,2 @@
// package shoco is an implementation of the shoco short string compressor.
package compress_shoco

View File

@@ -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,

View File

@@ -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"

View File

@@ -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
*/

View File

@@ -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
*/