chore: Improve document

Apply format for all doxygen documents.
Every document has the following structure.
Signature of the function

@brief description
@params parameters
@pre    preconditions
@returns possible return values
@note	notes
@see-also
This commit is contained in:
Takayuki Matsuoka
2023-08-25 07:38:05 +09:00
parent e31acd5786
commit 4104e9e222
3 changed files with 465 additions and 192 deletions

View File

@@ -38,6 +38,7 @@ EXPAND_ONLY_PREDEF = YES
# Predefine some macros to clean up the output.
PREDEFINED = "XXH_DOXYGEN=" \
"XXH_PUBLIC_API=" \
"XXH_NOESCAPE=" \
"XXH_FORCE_INLINE=static inline" \
"XXH_NO_INLINE=static" \
"XXH_RESTRICT=restrict" \

View File

@@ -38,6 +38,7 @@ EXPAND_ONLY_PREDEF = YES
# Predefine some macros to clean up the output.
PREDEFINED = "XXH_DOXYGEN=" \
"XXH_PUBLIC_API=" \
"XXH_NOESCAPE=" \
"XXH_FORCE_INLINE=static inline" \
"XXH_NO_INLINE=static" \
"XXH_RESTRICT=restrict" \

655
xxhash.h

File diff suppressed because it is too large Load Diff