mirror of
https://github.com/Cyan4973/xxHash.git
synced 2026-01-19 04:52:10 +00:00
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:
1
Doxyfile
1
Doxyfile
@@ -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" \
|
||||
|
||||
@@ -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" \
|
||||
|
||||
Reference in New Issue
Block a user