ソースを参照

Add more package lines for the docs

Jeroen van Rijn 3 日 前
コミット
5a154a1775

+ 3 - 2
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 <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -86,5 +88,4 @@ Example:
 		}
 		bytes.buffer_destroy(&buf)
 	}
-*/
-package compress_gzip
+*/

+ 2 - 0
core/compress/shoco/doc.odin

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

+ 2 - 2
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,

+ 3 - 3
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 <[email protected]>.
 	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"
 

+ 3 - 2
core/compress/zlib/doc.odin

@@ -1,3 +1,5 @@
+// package zlib implements Deflate decompression
+package compress_zlib
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	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
+*/

+ 4 - 2
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
+*/