Merge pull request #661 from easyaspi314/doxygen_xxh3

Documentation update
Cyan4973 · Dec 13, 2021 · c0d7495 · c0d7495
2 parents f3eaf95 + 2d11523
commit c0d7495
Show file tree

Hide file tree

Showing 3 changed files with 488 additions and 281 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -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
@@ -42,6 +42,9 @@ PREDEFINED             = "XXH_DOXYGEN=" \
                          "XSUM_API=" \
                          "XXH_STATIC_LINKING_ONLY" \
                          "XXH_IMPLEMENTATION" \
+                         "XXH_PUREF=[[gnu::pure]]" \
+                         "XXH_CONSTF=[[gnu::const]]" \
+                         "XXH_MALLOCF=[[gnu::malloc]]" \
                          "XXH_ALIGN(N)=alignas(N)" \
                          "XXH_ALIGN_MEMBER(align,type)=alignas(align) type"
 

diff --git a/xxh_x86dispatch.c b/xxh_x86dispatch.c
@@ -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)