Further overhaul of package line comments.

This commit is contained in:
Jeroen van Rijn
2025-10-09 23:05:29 +02:00
parent 2bc409eab5
commit 7a9ea3ee6d
147 changed files with 155 additions and 186 deletions
+1 -5
View File
@@ -1,8 +1,4 @@
/*
package avl implements an AVL tree.
The implementation is non-intrusive, and non-recursive.
*/
// A non-intrusive and non-recursive implementation of `AVL` trees.
package container_avl
@(require) import "base:intrinsics"
+1 -1
View File
@@ -1,4 +1,4 @@
// package bit_array implements a dynamically-sized array of bits.
// A dynamically-sized array of bits.
package container_dynamic_bit_array
/*
+1 -1
View File
@@ -1,4 +1,4 @@
// package list implements an intrusive doubly-linked list.
// An intrusive doubly-linked list.
package container_intrusive_list
/*
-2
View File
@@ -1,2 +0,0 @@
// package lru implements an LRU cache. It automatically removes older entries if its capacity is reached.
package container_lru
+1
View File
@@ -1,3 +1,4 @@
// A least-recently-used (`LRU`) cache. It automatically removes older entries if its capacity is reached.
package container_lru
import "base:runtime"
-2
View File
@@ -1,2 +0,0 @@
// package priority_queue implements a Priority Queue data structure.
package container_priority_queue
@@ -1,3 +1,4 @@
// A priority queue data structure.
package container_priority_queue
import "base:builtin"
-2
View File
@@ -1,2 +0,0 @@
// package queue implements a dynamically resizable double-ended queue/ring-buffer.
package container_queue
+1
View File
@@ -1,3 +1,4 @@
// A dynamically resizable double-ended queue/ring-buffer.
package container_queue
import "base:builtin"
-2
View File
@@ -1,2 +0,0 @@
// package rbtree implements a red-black tree.
package container_rbtree
+1
View File
@@ -1,3 +1,4 @@
// A red-black tree with the same API as our AVL tree.
package container_rbtree
@(require) import "base:intrinsics"
+1 -1
View File
@@ -1,4 +1,4 @@
// package small_array implements a dynamic array-like interface on a stack-allocated, fixed-size array.
// A dynamic array-like interface on a stack-allocated, fixed-size array.
package container_small_array
/*
-2
View File
@@ -1,2 +0,0 @@
// package topological_sort implements a generic O(V+E) topological sorter.
package container_topological_sort
@@ -1,11 +1,7 @@
// A generic `O(V+E)` topological sorter implementation. This is the fastest known method for topological sorting.
// 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