Doxyfile.in 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. PROJECT_NAME = @PACKAGE_NAME@
  2. PROJECT_NUMBER = @PACKAGE_VERSION@
  3. PROJECT_BRIEF = Library implementing the XKB specification for parsing \
  4. keyboard descriptions and handling keyboard state
  5. OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@
  6. SITEMAP_URL = https://xkbcommon.org/doc/@PACKAGE_VERSION@/
  7. BRIEF_MEMBER_DESC = NO
  8. JAVADOC_AUTOBRIEF = YES
  9. OPTIMIZE_OUTPUT_FOR_C = YES
  10. EXTENSION_MAPPING = no_extension=md \
  11. txt=md
  12. SORT_MEMBER_DOCS = NO
  13. QUIET = $(DOXYGEN_QUIET)
  14. WARN_IF_UNDOCUMENTED = NO
  15. WARN_AS_ERROR = $(DOXYGEN_WARN_AS_ERROR)
  16. INPUT = @INPUT@
  17. FILE_PATTERNS = *.c \
  18. *.h
  19. FILTER_PATTERNS = *include/xkbcommon/xkbcommon-keysyms.h=scripts/update-keysyms-docstring.py
  20. # These are included in other file but we do not want them as standalone
  21. EXCLUDE = LICENSE NEWS.md meson.options
  22. RECURSIVE = YES
  23. EXTRACT_PRIVATE = YES
  24. EXAMPLE_PATH = test
  25. USE_MDFILE_AS_MAINPAGE = README.md
  26. VERBATIM_HEADERS = NO
  27. MARKDOWN_ID_STYLE = GITHUB
  28. ALPHABETICAL_INDEX = NO
  29. IGNORE_PREFIX = xkb_ \
  30. XKB_ \
  31. rxkb_ \
  32. RXKB_
  33. DISABLE_INDEX = NO
  34. GENERATE_TREEVIEW = NO
  35. FULL_SIDEBAR = NO
  36. HTML_EXTRA_STYLESHEET = doc/doxygen-extra.css
  37. HTML_COLORSTYLE = TOGGLE
  38. TIMESTAMP = NO
  39. ENUM_VALUES_PER_LINE = 1
  40. SEARCHENGINE = YES
  41. GENERATE_LATEX = NO
  42. HAVE_DOT = YES
  43. DOTFILE_DIRS = doc/diagrams
  44. DOT_IMAGE_FORMAT = svg
  45. IMAGE_PATH = doc/img
  46. # Workaround HTML tags not supported by Doxygen
  47. ALIASES += figure="@htmlonly[block]<figure>@endhtmlonly"
  48. ALIASES += endfigure="@htmlonly[block]</figure>@endhtmlonly"
  49. ALIASES += figcaption="@htmlonly[block]<figcaption>@endhtmlonly"
  50. ALIASES += endfigcaption="@htmlonly[block]</figcaption>@endhtmlonly"
  51. ALIASES += rawHtml="@htmlonly<!--"
  52. ALIASES += endRawHtml="-->@endhtmlonly"