hare

commit 87453cdee279df7777bce553c09396dc75ce3132
parent 20b9e2041709c467652799bef5ac10f580b5ca40
Author: Drew DeVault <sir@cmpwn.com>
Date:   Sat, 12 Mar 2022 13:44:07 +0100

hash::crc*: document sum32/sum64

Signed-off-by: Drew DeVault <sir@cmpwn.com>

Diffstat:
M
hash/crc32/crc32.ha
 | 
1
+
M
hash/crc64/crc64.ha
 | 
1
+

2 files changed, 2 insertions(+), 0 deletions(-)
diff --git a/hash/crc32/crc32.ha b/hash/crc32/crc32.ha
@@ -224,6 +224,7 @@ fn sum(h: *hash::hash, buf: []u8) void = {
 	endian::host.putu32(buf, ~h.cval);
 };
 
+// Returns the computed 32-bit CRC.
 export fn sum32(h: *hash::hash) u32 = {
 	assert(h.reset == &reset);
 	let h = h: *state;
diff --git a/hash/crc64/crc64.ha b/hash/crc64/crc64.ha
@@ -256,6 +256,7 @@ fn sum(h: *hash::hash, buf: []u8) void = {
 	endian::host.putu64(buf, ~h.cval);
 };
 
+// Returns the 64-bit computed CRC.
 export fn sum64(h: *hash::hash) u64 = {
 	assert(h.reset == &reset);
 	let h = h: *state;