Debian Codegraph @

ext/xxHash/Doxyfile-internal

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