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