Merge branch 'master' of https://github.com/odin-lang/Odin

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

core/compress/shoco/doc.odin

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

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,

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"
 

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

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

core/container/intrusive/list/doc.odin

@@ -1,3 +1,6 @@
+// package list implements an intrusive doubly-linked list.
+package container_intrusive_list
+
 /*
 Package list implements an intrusive doubly-linked list.
 
@@ -45,5 +48,4 @@ Example:
 Output:
 	Hello
 	World
-*/
-package container_intrusive_list
+*/

core/container/lru/doc.odin

@@ -0,0 +1,2 @@
+// package lru implements an LRU cache. It automatically removes older entries if its capacity is reached.
+package container_lru

core/container/priority_queue/doc.odin

@@ -0,0 +1,2 @@
+// package priority_queue implements a Priority Queue data structure
+package container_priority_queue

core/container/queue/doc.odin

@@ -0,0 +1,2 @@
+// package queue implements a dynamically resizable double-ended queue/ring-buffer.
+package container_queue

core/container/rbtree/doc.odin

@@ -0,0 +1,2 @@
+// package rbtree implements a red-black tree
+package container_rbtree

core/container/rbtree/rbtree.odin

@@ -1,4 +1,3 @@
-// This package implements a red-black tree
 package container_rbtree
 
 @(require) import "base:intrinsics"

core/container/small_array/doc.odin

@@ -1,7 +1,7 @@
-/*
-Package small_array implements a dynamic array like
-interface on a stack-allocated, fixed-size array.
+// package small_array implements a dynamic array-like interface on a stack-allocated, fixed-size array.
+package container_small_array
 
+/*
 The Small_Array type is optimal for scenarios where you need
 a container for a fixed number of elements of a specific type,
 with the total number known at compile time but the exact
@@ -51,5 +51,4 @@ Output:
 
 	Hellope
 
-*/
-package container_small_array
+*/

core/container/topological_sort/doc.odin

@@ -0,0 +1,2 @@
+// package topological_sort implements a generic O(V+E) topological sorter.
+package container_topological_sort

core/container/topological_sort/topological_sort.odin

@@ -1,8 +1,11 @@
-// The following is a generic O(V+E) topological sorter implementation.
-// This is the fastest known method for topological sorting and Odin's
-// map type is being used to accelerate lookups.
 package container_topological_sort
 
+/*
+	The following is a generic O(V+E) topological sorter implementation.
+	This is the fastest known method for topological sorting and Odin's
+	map type is being used to accelerate lookups.
+*/
+
 import "base:intrinsics"
 import "base:runtime"
 _ :: intrinsics

core/debug/trace/doc.odin

@@ -1,6 +1,6 @@
+// package debug implements a stack trace library. Only works when debug symbols are enabled `-debug`.
+package debug_trace
 /*
-A debug stack trace library. Only works when debug symbols are enabled `-debug`.
-
 Example:
 	import "base:runtime"
 	import "core:debug/trace"
@@ -47,5 +47,4 @@ Example:
 		...
 	}
 
-*/
-package debug_trace
+*/

core/dynlib/doc.odin

@@ -1,5 +1,5 @@
 /*
-Package `core:dynlib` implements loading of shared libraries/DLLs and their symbols.
+package dynlib implements loading of shared libraries/DLLs and their symbols.
 
 The behaviour of dynamically loaded libraries is specific to the target platform of the program.
 For in depth detail on the underlying behaviour please refer to your target platform's documentation.