Browse Source

Package lines for core:container.

Jeroen van Rijn 4 days ago
parent
commit
9c7fe1d8a7

+ 4 - 2
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.
 Package list implements an intrusive doubly-linked list.
 
 
@@ -45,5 +48,4 @@ Example:
 Output:
 Output:
 	Hello
 	Hello
 	World
 	World
-*/
-package container_intrusive_list
+*/

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

+ 2 - 0
core/container/priority_queue/doc.odin

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

+ 2 - 0
core/container/queue/doc.odin

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

+ 2 - 0
core/container/rbtree/doc.odin

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

+ 0 - 1
core/container/rbtree/rbtree.odin

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

+ 4 - 5
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
 The Small_Array type is optimal for scenarios where you need
 a container for a fixed number of elements of a specific type,
 a container for a fixed number of elements of a specific type,
 with the total number known at compile time but the exact
 with the total number known at compile time but the exact
@@ -51,5 +51,4 @@ Output:
 
 
 	Hellope
 	Hellope
 
 
-*/
-package container_small_array
+*/

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

+ 6 - 3
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
 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:intrinsics"
 import "base:runtime"
 import "base:runtime"
 _ :: intrinsics
 _ :: intrinsics