Doxyfile 2.0 KB

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