Doxyfile 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. # Doxygen config for xxHash
  2. DOXYFILE_ENCODING = UTF-8
  3. PROJECT_NAME = "xxHash"
  4. PROJECT_NUMBER = "0.8.0"
  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 = YES
  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. # So we can document the internals
  27. EXTRACT_STATIC = YES
  28. # Document the macros
  29. MACRO_EXPANSION = YES
  30. EXPAND_ONLY_PREDEF = YES
  31. # Predefine some macros to clean up the output.
  32. PREDEFINED = "XXH_DOXYGEN=" \
  33. "XXH_PUBLIC_API=" \
  34. "XXH_FORCE_INLINE=static inline" \
  35. "XXH_NO_INLINE=static" \
  36. "XXH_RESTRICT=restrict" \
  37. "XSUM_API=" \
  38. "XXH_STATIC_LINKING_ONLY" \
  39. "XXH_IMPLEMENTATION" \
  40. "XXH_ALIGN(N)=alignas(N)" \
  41. "XXH_ALIGN_MEMBER(align,type)=alignas(align) type"
  42. # We want HTML docs
  43. GENERATE_HTML = YES
  44. HTML_OUTPUT = html
  45. HTML_FILE_EXTENSION = .html
  46. # Tweak the colors a bit
  47. HTML_COLORSTYLE_HUE = 220
  48. HTML_COLORSTYLE_GAMMA = 100
  49. HTML_COLORSTYLE_SAT = 100
  50. # We don't want LaTeX.
  51. GENERATE_LATEX = NO