Peter's keyboard firmware (QMK) https://qmk.fm/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Doxyfile 8.4KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. # Doxyfile 1.8.14
  2. # This file describes the settings to be used by the documentation system
  3. # doxygen (www.doxygen.org) for qmk_firmware (github.com/qmk/qmk_firmware)
  4. #
  5. # All text after a double hash (##) is considered a comment and is placed in
  6. # front of the TAG it is preceding.
  7. #
  8. # All text after a single hash (#) is considered a comment and will be ignored.
  9. # The format is:
  10. # TAG = value [value, ...]
  11. # For lists, items can also be appended using:
  12. # TAG += value [value, ...]
  13. # Values that contain spaces should be placed between quotes (\" \").
  14. #---------------------------------------------------------------------------
  15. # Project related configuration options
  16. #---------------------------------------------------------------------------
  17. DOXYFILE_ENCODING = UTF-8
  18. PROJECT_NAME = "QMK Firmware"
  19. PROJECT_NUMBER = https://github.com/qmk/qmk_firmware
  20. PROJECT_BRIEF = "Keyboard controller firmware for Atmel AVR and ARM USB families"
  21. OUTPUT_DIRECTORY = doxygen
  22. ALLOW_UNICODE_NAMES = NO
  23. OUTPUT_LANGUAGE = English
  24. BRIEF_MEMBER_DESC = YES
  25. REPEAT_BRIEF = YES
  26. ABBREVIATE_BRIEF = "The $name class" \
  27. "The $name widget" \
  28. "The $name file" \
  29. is \
  30. provides \
  31. specifies \
  32. contains \
  33. represents \
  34. a \
  35. an \
  36. the
  37. ALWAYS_DETAILED_SEC = NO
  38. INLINE_INHERITED_MEMB = NO
  39. FULL_PATH_NAMES = YES
  40. STRIP_FROM_PATH =
  41. STRIP_FROM_INC_PATH =
  42. SHORT_NAMES = NO
  43. JAVADOC_AUTOBRIEF = NO
  44. QT_AUTOBRIEF = NO
  45. MULTILINE_CPP_IS_BRIEF = NO
  46. INHERIT_DOCS = YES
  47. SEPARATE_MEMBER_PAGES = NO
  48. TAB_SIZE = 4
  49. ALIASES =
  50. TCL_SUBST =
  51. OPTIMIZE_OUTPUT_FOR_C = YES
  52. OPTIMIZE_OUTPUT_JAVA = NO
  53. OPTIMIZE_FOR_FORTRAN = NO
  54. OPTIMIZE_OUTPUT_VHDL = NO
  55. EXTENSION_MAPPING =
  56. MARKDOWN_SUPPORT = YES
  57. TOC_INCLUDE_HEADINGS = 2
  58. AUTOLINK_SUPPORT = YES
  59. BUILTIN_STL_SUPPORT = NO
  60. CPP_CLI_SUPPORT = NO
  61. SIP_SUPPORT = NO
  62. IDL_PROPERTY_SUPPORT = YES
  63. DISTRIBUTE_GROUP_DOC = NO
  64. GROUP_NESTED_COMPOUNDS = NO
  65. SUBGROUPING = YES
  66. INLINE_GROUPED_CLASSES = NO
  67. INLINE_SIMPLE_STRUCTS = NO
  68. TYPEDEF_HIDES_STRUCT = NO
  69. LOOKUP_CACHE_SIZE = 0
  70. #---------------------------------------------------------------------------
  71. # Build related configuration options
  72. #---------------------------------------------------------------------------
  73. EXTRACT_ALL = NO
  74. EXTRACT_PRIVATE = NO
  75. EXTRACT_PACKAGE = NO
  76. EXTRACT_STATIC = NO
  77. EXTRACT_LOCAL_CLASSES = YES
  78. EXTRACT_LOCAL_METHODS = NO
  79. EXTRACT_ANON_NSPACES = NO
  80. HIDE_UNDOC_MEMBERS = NO
  81. HIDE_UNDOC_CLASSES = NO
  82. HIDE_FRIEND_COMPOUNDS = NO
  83. HIDE_IN_BODY_DOCS = NO
  84. INTERNAL_DOCS = NO
  85. CASE_SENSE_NAMES = NO
  86. HIDE_SCOPE_NAMES = YES
  87. HIDE_COMPOUND_REFERENCE= NO
  88. SHOW_INCLUDE_FILES = YES
  89. SHOW_GROUPED_MEMB_INC = NO
  90. FORCE_LOCAL_INCLUDES = NO
  91. INLINE_INFO = YES
  92. SORT_MEMBER_DOCS = YES
  93. SORT_BRIEF_DOCS = NO
  94. SORT_MEMBERS_CTORS_1ST = NO
  95. SORT_GROUP_NAMES = NO
  96. SORT_BY_SCOPE_NAME = NO
  97. STRICT_PROTO_MATCHING = NO
  98. GENERATE_TODOLIST = YES
  99. GENERATE_TESTLIST = YES
  100. GENERATE_BUGLIST = YES
  101. GENERATE_DEPRECATEDLIST= YES
  102. ENABLED_SECTIONS =
  103. MAX_INITIALIZER_LINES = 30
  104. SHOW_USED_FILES = YES
  105. SHOW_FILES = YES
  106. SHOW_NAMESPACES = YES
  107. FILE_VERSION_FILTER =
  108. LAYOUT_FILE =
  109. CITE_BIB_FILES =
  110. #---------------------------------------------------------------------------
  111. # Configuration options related to warning and progress messages
  112. #---------------------------------------------------------------------------
  113. QUIET = NO
  114. WARNINGS = YES
  115. WARN_IF_UNDOCUMENTED = YES
  116. WARN_IF_DOC_ERROR = YES
  117. WARN_NO_PARAMDOC = NO
  118. WARN_AS_ERROR = NO
  119. WARN_FORMAT = "$file:$line: $text"
  120. WARN_LOGFILE =
  121. #---------------------------------------------------------------------------
  122. # Configuration options related to the input files
  123. #---------------------------------------------------------------------------
  124. INPUT = tmk_core quantum drivers
  125. INPUT_ENCODING = UTF-8
  126. FILE_PATTERNS = *.c \
  127. *.cc \
  128. *.cxx \
  129. *.cpp \
  130. *.c++ \
  131. *.h \
  132. *.hh \
  133. *.hxx \
  134. *.hpp \
  135. *.h++
  136. RECURSIVE = YES
  137. EXCLUDE =
  138. EXCLUDE_SYMLINKS = NO
  139. EXCLUDE_PATTERNS =
  140. EXCLUDE_SYMBOLS =
  141. EXAMPLE_PATH =
  142. EXAMPLE_PATTERNS = *
  143. EXAMPLE_RECURSIVE = NO
  144. IMAGE_PATH =
  145. INPUT_FILTER =
  146. FILTER_PATTERNS =
  147. FILTER_SOURCE_FILES = NO
  148. FILTER_SOURCE_PATTERNS =
  149. USE_MDFILE_AS_MAINPAGE =
  150. #---------------------------------------------------------------------------
  151. # Configuration options related to source browsing
  152. #---------------------------------------------------------------------------
  153. SOURCE_BROWSER = YES
  154. INLINE_SOURCES = NO
  155. STRIP_CODE_COMMENTS = YES
  156. REFERENCED_BY_RELATION = NO
  157. REFERENCES_RELATION = NO
  158. REFERENCES_LINK_SOURCE = YES
  159. SOURCE_TOOLTIPS = YES
  160. USE_HTAGS = NO
  161. VERBATIM_HEADERS = YES
  162. #---------------------------------------------------------------------------
  163. # Configuration options related to the alphabetical class index
  164. #---------------------------------------------------------------------------
  165. ALPHABETICAL_INDEX = YES
  166. COLS_IN_ALPHA_INDEX = 5
  167. IGNORE_PREFIX =
  168. #---------------------------------------------------------------------------
  169. # Configuration options related to disabled outputs
  170. #---------------------------------------------------------------------------
  171. GENERATE_HTML = NO
  172. GENERATE_LATEX = NO
  173. GENERATE_RTF = NO
  174. GENERATE_MAN = NO
  175. GENERATE_DOCBOOK = NO
  176. GENERATE_AUTOGEN_DEF = NO
  177. GENERATE_PERLMOD = NO
  178. #---------------------------------------------------------------------------
  179. # Configuration options related to the XML output
  180. #---------------------------------------------------------------------------
  181. GENERATE_XML = YES
  182. XML_OUTPUT = xml
  183. XML_PROGRAMLISTING = YES
  184. #---------------------------------------------------------------------------
  185. # Configuration options related to the preprocessor
  186. #---------------------------------------------------------------------------
  187. ENABLE_PREPROCESSING = YES
  188. MACRO_EXPANSION = NO
  189. EXPAND_ONLY_PREDEF = NO
  190. SEARCH_INCLUDES = YES
  191. INCLUDE_PATH =
  192. INCLUDE_FILE_PATTERNS =
  193. PREDEFINED =
  194. EXPAND_AS_DEFINED =
  195. SKIP_FUNCTION_MACROS = YES
  196. #---------------------------------------------------------------------------
  197. # Configuration options related to external references
  198. #---------------------------------------------------------------------------
  199. TAGFILES =
  200. GENERATE_TAGFILE =
  201. ALLEXTERNALS = NO
  202. EXTERNAL_GROUPS = YES
  203. EXTERNAL_PAGES = YES
  204. PERL_PATH = /usr/bin/perl
  205. #---------------------------------------------------------------------------
  206. # Configuration options related to the dot tool
  207. #---------------------------------------------------------------------------
  208. CLASS_DIAGRAMS = YES
  209. MSCGEN_PATH =
  210. DIA_PATH =
  211. HIDE_UNDOC_RELATIONS = YES
  212. HAVE_DOT = NO
  213. DOT_NUM_THREADS = 0
  214. DOT_FONTNAME = Helvetica
  215. DOT_FONTSIZE = 10
  216. DOT_FONTPATH =
  217. CLASS_GRAPH = YES
  218. COLLABORATION_GRAPH = YES
  219. GROUP_GRAPHS = YES
  220. UML_LOOK = NO
  221. UML_LIMIT_NUM_FIELDS = 10
  222. TEMPLATE_RELATIONS = NO
  223. INCLUDE_GRAPH = YES
  224. INCLUDED_BY_GRAPH = YES
  225. CALL_GRAPH = NO
  226. CALLER_GRAPH = NO
  227. GRAPHICAL_HIERARCHY = YES
  228. DIRECTORY_GRAPH = YES
  229. DOT_IMAGE_FORMAT = png
  230. INTERACTIVE_SVG = NO
  231. DOT_PATH =
  232. DOTFILE_DIRS =
  233. MSCFILE_DIRS =
  234. DIAFILE_DIRS =
  235. PLANTUML_JAR_PATH =
  236. PLANTUML_CFG_FILE =
  237. PLANTUML_INCLUDE_PATH =
  238. DOT_GRAPH_MAX_NODES = 50
  239. MAX_DOT_GRAPH_DEPTH = 0
  240. DOT_TRANSPARENT = NO
  241. DOT_MULTI_TARGETS = NO
  242. GENERATE_LEGEND = YES
  243. DOT_CLEANUP = YES