[linux-kernel] Update header comments

This commit is contained in:
Nick Terrell 2017-05-16 16:03:36 -07:00
parent 1d42ca8f6d
commit 90a1c94965
2 changed files with 13 additions and 13 deletions

View File

@ -78,7 +78,7 @@
/** /**
* xxh32() - calculate the 32-bit hash of the input with a given seed. * xxh32() - calculate the 32-bit hash of the input with a given seed.
* *
* @input: The data to hash. Must not be NULL. * @input: The data to hash.
* @length: The length of the data to hash. * @length: The length of the data to hash.
* @seed: The seed can be used to alter the result predictably. * @seed: The seed can be used to alter the result predictably.
* *
@ -89,9 +89,9 @@
uint32_t xxh32(const void *input, size_t length, uint32_t seed); uint32_t xxh32(const void *input, size_t length, uint32_t seed);
/** /**
* xxh32() - calculate the 64-bit hash of the input with a given seed. * xxh64() - calculate the 64-bit hash of the input with a given seed.
* *
* @input: The data to hash. Must not be NULL. * @input: The data to hash.
* @length: The length of the data to hash. * @length: The length of the data to hash.
* @seed: The seed can be used to alter the result predictably. * @seed: The seed can be used to alter the result predictably.
* *
@ -152,7 +152,7 @@ void xxh32_reset(struct xxh32_state *state, uint32_t seed);
* xxh32_update() - hash the data given and update the xxh32 state * xxh32_update() - hash the data given and update the xxh32 state
* *
* @state: The xxh32 state to update. * @state: The xxh32 state to update.
* @input: The data to hash. Must not be NULL. * @input: The data to hash.
* @length: The length of the data to hash. * @length: The length of the data to hash.
* *
* After calling xxh32_reset() call xxh32_update() as many times as necessary. * After calling xxh32_reset() call xxh32_update() as many times as necessary.
@ -177,7 +177,7 @@ uint32_t xxh32_digest(const struct xxh32_state *state);
/** /**
* xxh64_reset() - reset the xxh64 state to start a new hashing operation * xxh64_reset() - reset the xxh64 state to start a new hashing operation
* *
* @state: The xxh32 state to reset. * @state: The xxh64 state to reset.
* @seed: Initialize the hash state with this seed. * @seed: Initialize the hash state with this seed.
*/ */
void xxh64_reset(struct xxh64_state *state, uint64_t seed); void xxh64_reset(struct xxh64_state *state, uint64_t seed);
@ -185,7 +185,7 @@ void xxh64_reset(struct xxh64_state *state, uint64_t seed);
/** /**
* xxh64_update() - hash the data given and update the xxh64 state * xxh64_update() - hash the data given and update the xxh64 state
* @state: The xxh64 state to update. * @state: The xxh64 state to update.
* @input: The data to hash. Must not be NULL. * @input: The data to hash.
* @length: The length of the data to hash. * @length: The length of the data to hash.
* *
* After calling xxh64_reset() call xxh64_update() as many times as necessary. * After calling xxh64_reset() call xxh64_update() as many times as necessary.

View File

@ -1,6 +1,6 @@
diff --git a/include/linux/xxhash.h b/include/linux/xxhash.h diff --git a/include/linux/xxhash.h b/include/linux/xxhash.h
new file mode 100644 new file mode 100644
index 0000000..4644337 index 0000000..c77b12b
--- /dev/null --- /dev/null
+++ b/include/linux/xxhash.h +++ b/include/linux/xxhash.h
@@ -0,0 +1,230 @@ @@ -0,0 +1,230 @@
@ -84,7 +84,7 @@ index 0000000..4644337
+/** +/**
+ * xxh32() - calculate the 32-bit hash of the input with a given seed. + * xxh32() - calculate the 32-bit hash of the input with a given seed.
+ * + *
+ * @input: The data to hash. Must not be NULL. + * @input: The data to hash.
+ * @length: The length of the data to hash. + * @length: The length of the data to hash.
+ * @seed: The seed can be used to alter the result predictably. + * @seed: The seed can be used to alter the result predictably.
+ * + *
@ -95,9 +95,9 @@ index 0000000..4644337
+uint32_t xxh32(const void *input, size_t length, uint32_t seed); +uint32_t xxh32(const void *input, size_t length, uint32_t seed);
+ +
+/** +/**
+ * xxh32() - calculate the 64-bit hash of the input with a given seed. + * xxh64() - calculate the 64-bit hash of the input with a given seed.
+ * + *
+ * @input: The data to hash. Must not be NULL. + * @input: The data to hash.
+ * @length: The length of the data to hash. + * @length: The length of the data to hash.
+ * @seed: The seed can be used to alter the result predictably. + * @seed: The seed can be used to alter the result predictably.
+ * + *
@ -158,7 +158,7 @@ index 0000000..4644337
+ * xxh32_update() - hash the data given and update the xxh32 state + * xxh32_update() - hash the data given and update the xxh32 state
+ * + *
+ * @state: The xxh32 state to update. + * @state: The xxh32 state to update.
+ * @input: The data to hash. Must not be NULL. + * @input: The data to hash.
+ * @length: The length of the data to hash. + * @length: The length of the data to hash.
+ * + *
+ * After calling xxh32_reset() call xxh32_update() as many times as necessary. + * After calling xxh32_reset() call xxh32_update() as many times as necessary.
@ -183,7 +183,7 @@ index 0000000..4644337
+/** +/**
+ * xxh64_reset() - reset the xxh64 state to start a new hashing operation + * xxh64_reset() - reset the xxh64 state to start a new hashing operation
+ * + *
+ * @state: The xxh32 state to reset. + * @state: The xxh64 state to reset.
+ * @seed: Initialize the hash state with this seed. + * @seed: Initialize the hash state with this seed.
+ */ + */
+void xxh64_reset(struct xxh64_state *state, uint64_t seed); +void xxh64_reset(struct xxh64_state *state, uint64_t seed);
@ -191,7 +191,7 @@ index 0000000..4644337
+/** +/**
+ * xxh64_update() - hash the data given and update the xxh64 state + * xxh64_update() - hash the data given and update the xxh64 state
+ * @state: The xxh64 state to update. + * @state: The xxh64 state to update.
+ * @input: The data to hash. Must not be NULL. + * @input: The data to hash.
+ * @length: The length of the data to hash. + * @length: The length of the data to hash.
+ * + *
+ * After calling xxh64_reset() call xxh64_update() as many times as necessary. + * After calling xxh64_reset() call xxh64_update() as many times as necessary.