aboutsummaryrefslogtreecommitdiff
path: root/core/hash
diff options
context:
space:
mode:
authorLaytan Laats <laytanlaats@hotmail.com>2024-09-03 19:59:04 +0200
committerLaytan Laats <laytanlaats@hotmail.com>2024-09-03 19:59:04 +0200
commit288312a8126d71fae26c9d62a8cd342d830e1c5f (patch)
treeaa56a083e0222975888a24cf8d755b7d0a4f1bc0 /core/hash
parent0e6109e171d24b3bb17289219ae3b482c24f2460 (diff)
core: improve package doc comments for the documentation generator
Diffstat (limited to 'core/hash')
-rw-r--r--core/hash/xxhash/common.odin3
-rw-r--r--core/hash/xxhash/streaming.odin3
-rw-r--r--core/hash/xxhash/xxhash_3.odin1
-rw-r--r--core/hash/xxhash/xxhash_32.odin1
-rw-r--r--core/hash/xxhash/xxhash_64.odin1
5 files changed, 7 insertions, 2 deletions
diff --git a/core/hash/xxhash/common.odin b/core/hash/xxhash/common.odin
index bbeb60db3..adfc1bac2 100644
--- a/core/hash/xxhash/common.odin
+++ b/core/hash/xxhash/common.odin
@@ -1,5 +1,4 @@
/*
- An implementation of Yann Collet's [xxhash Fast Hash Algorithm](https://cyan4973.github.io/xxHash/).
Copyright 2021 Jeroen van Rijn <nom@duclavier.com>.
Made available under Odin's BSD-3 license, based on the original C code.
@@ -7,6 +6,8 @@
List of contributors:
Jeroen van Rijn: Initial implementation.
*/
+
+// An implementation of Yann Collet's [[ xxhash Fast Hash Algorithm; https://cyan4973.github.io/xxHash/ ]].
package xxhash
import "base:intrinsics"
diff --git a/core/hash/xxhash/streaming.odin b/core/hash/xxhash/streaming.odin
index f68862f67..f77edf3e9 100644
--- a/core/hash/xxhash/streaming.odin
+++ b/core/hash/xxhash/streaming.odin
@@ -7,6 +7,7 @@
List of contributors:
Jeroen van Rijn: Initial implementation.
*/
+
package xxhash
import "core:mem"
@@ -371,4 +372,4 @@ XXH3_generate_secret :: proc(secret_buffer: []u8, custom_seed: []u8) {
mem_copy(&secret_buffer[segment_start], &segment, size_of(segment))
}
}
-} \ No newline at end of file
+}
diff --git a/core/hash/xxhash/xxhash_3.odin b/core/hash/xxhash/xxhash_3.odin
index 9e159260b..293e98528 100644
--- a/core/hash/xxhash/xxhash_3.odin
+++ b/core/hash/xxhash/xxhash_3.odin
@@ -7,6 +7,7 @@
List of contributors:
Jeroen van Rijn: Initial implementation.
*/
+
package xxhash
import "base:intrinsics"
diff --git a/core/hash/xxhash/xxhash_32.odin b/core/hash/xxhash/xxhash_32.odin
index 3ea1c3cf2..28cd4e177 100644
--- a/core/hash/xxhash/xxhash_32.odin
+++ b/core/hash/xxhash/xxhash_32.odin
@@ -7,6 +7,7 @@
List of contributors:
Jeroen van Rijn: Initial implementation.
*/
+
package xxhash
import "base:intrinsics"
diff --git a/core/hash/xxhash/xxhash_64.odin b/core/hash/xxhash/xxhash_64.odin
index c2976fb3b..87e8916d6 100644
--- a/core/hash/xxhash/xxhash_64.odin
+++ b/core/hash/xxhash/xxhash_64.odin
@@ -7,6 +7,7 @@
List of contributors:
Jeroen van Rijn: Initial implementation.
*/
+
package xxhash
import "base:intrinsics"