1# Doxygen config for xxHash 2DOXYFILE_ENCODING = UTF-8 3 4PROJECT_NAME = "xxHash" 5PROJECT_NUMBER = "0.8.0" 6PROJECT_BRIEF = "Extremely fast non-cryptographic hash function" 7OUTPUT_DIRECTORY = doxygen 8OUTPUT_LANGUAGE = English 9 10# We already separate the internal docs. 11INTERNAL_DOCS = YES 12# Consistency 13SORT_MEMBER_DOCS = NO 14BRIEF_MEMBER_DESC = YES 15REPEAT_BRIEF = YES 16 17# Warnings 18QUIET = YES 19# Until we document everything 20WARN_IF_UNDOCUMENTED = NO 21 22# TODO: Add the other files. It is just xxhash.h for now. 23FILE_PATTERNS = xxhash.h xxh_x86dispatch.c 24# Note: xxHash's source files are technically ASCII only. 25INPUT_ENCODING = UTF-8 26TAB_SIZE = 4 27MARKDOWN_SUPPORT = YES 28 29# xxHash is a C library 30OPTIMIZE_OUTPUT_FOR_C = YES 31# So we can document the internals 32EXTRACT_STATIC = YES 33# Document the macros 34MACRO_EXPANSION = YES 35EXPAND_ONLY_PREDEF = YES 36# Predefine some macros to clean up the output. 37PREDEFINED = "XXH_DOXYGEN=" \ 38 "XXH_PUBLIC_API=" \ 39 "XXH_FORCE_INLINE=static inline" \ 40 "XXH_NO_INLINE=static" \ 41 "XXH_RESTRICT=restrict" \ 42 "XSUM_API=" \ 43 "XXH_STATIC_LINKING_ONLY" \ 44 "XXH_IMPLEMENTATION" \ 45 "XXH_ALIGN(N)=alignas(N)" \ 46 "XXH_ALIGN_MEMBER(align,type)=alignas(align) type" 47 48# We want HTML docs 49GENERATE_HTML = YES 50HTML_OUTPUT = html 51HTML_FILE_EXTENSION = .html 52# Tweak the colors a bit 53HTML_COLORSTYLE_HUE = 220 54HTML_COLORSTYLE_GAMMA = 100 55HTML_COLORSTYLE_SAT = 100 56 57# We don't want LaTeX. 58GENERATE_LATEX = NO 59