We do a little documentation.

I also added a few code examples, but it all needs to be organized better.
This commit is contained in:
easyaspi314 (Devin) 2021-12-12 21:26:21 -05:00
parent f3eaf95f20
commit 82819102da
3 changed files with 487 additions and 283 deletions

View File

@ -2,7 +2,7 @@
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "xxHash"
PROJECT_NUMBER = "0.8.0"
PROJECT_NUMBER = "0.8.1"
PROJECT_BRIEF = "Extremely fast non-cryptographic hash function"
OUTPUT_DIRECTORY = doxygen
OUTPUT_LANGUAGE = English

View File

@ -36,7 +36,7 @@
/*!
* @file xxh_x86dispatch.c
*
* Automatic dispatcher code for the @ref xxh3_family on x86-based targets.
* Automatic dispatcher code for the @ref XXH3_family on x86-based targets.
*
* Optional add-on.
*
@ -316,7 +316,7 @@ static xxh_u64 XXH_xgetbv(void)
*
* Runs various CPUID/XGETBV tests to try and determine the best implementation.
*
* @ret The best @ref XXH_VECTOR implementation.
* @return The best @ref XXH_VECTOR implementation.
* @see XXH_VECTOR_TYPES
*/
static int XXH_featureTest(void)

764
xxhash.h

File diff suppressed because it is too large Load Diff