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.
266 lines
8.4 KiB
266 lines
8.4 KiB
# Doxyfile 1.8.14 |
|
|
|
# This file describes the settings to be used by the documentation system |
|
# doxygen (www.doxygen.org) for qmk_firmware (github.com/qmk/qmk_firmware) |
|
# |
|
# All text after a double hash (##) is considered a comment and is placed in |
|
# front of the TAG it is preceding. |
|
# |
|
# All text after a single hash (#) is considered a comment and will be ignored. |
|
# The format is: |
|
# TAG = value [value, ...] |
|
# For lists, items can also be appended using: |
|
# TAG += value [value, ...] |
|
# Values that contain spaces should be placed between quotes (\" \"). |
|
|
|
#--------------------------------------------------------------------------- |
|
# Project related configuration options |
|
#--------------------------------------------------------------------------- |
|
|
|
DOXYFILE_ENCODING = UTF-8 |
|
PROJECT_NAME = "QMK Firmware" |
|
PROJECT_NUMBER = https://github.com/qmk/qmk_firmware |
|
PROJECT_BRIEF = "Keyboard controller firmware for Atmel AVR and ARM USB families" |
|
OUTPUT_DIRECTORY = doxygen |
|
ALLOW_UNICODE_NAMES = NO |
|
OUTPUT_LANGUAGE = English |
|
BRIEF_MEMBER_DESC = YES |
|
REPEAT_BRIEF = YES |
|
ABBREVIATE_BRIEF = "The $name class" \ |
|
"The $name widget" \ |
|
"The $name file" \ |
|
is \ |
|
provides \ |
|
specifies \ |
|
contains \ |
|
represents \ |
|
a \ |
|
an \ |
|
the |
|
ALWAYS_DETAILED_SEC = NO |
|
INLINE_INHERITED_MEMB = NO |
|
FULL_PATH_NAMES = YES |
|
STRIP_FROM_PATH = |
|
STRIP_FROM_INC_PATH = |
|
SHORT_NAMES = NO |
|
JAVADOC_AUTOBRIEF = NO |
|
QT_AUTOBRIEF = NO |
|
MULTILINE_CPP_IS_BRIEF = NO |
|
INHERIT_DOCS = YES |
|
SEPARATE_MEMBER_PAGES = NO |
|
TAB_SIZE = 4 |
|
ALIASES = |
|
TCL_SUBST = |
|
OPTIMIZE_OUTPUT_FOR_C = YES |
|
OPTIMIZE_OUTPUT_JAVA = NO |
|
OPTIMIZE_FOR_FORTRAN = NO |
|
OPTIMIZE_OUTPUT_VHDL = NO |
|
EXTENSION_MAPPING = |
|
MARKDOWN_SUPPORT = YES |
|
TOC_INCLUDE_HEADINGS = 2 |
|
AUTOLINK_SUPPORT = YES |
|
BUILTIN_STL_SUPPORT = NO |
|
CPP_CLI_SUPPORT = NO |
|
SIP_SUPPORT = NO |
|
IDL_PROPERTY_SUPPORT = YES |
|
DISTRIBUTE_GROUP_DOC = NO |
|
GROUP_NESTED_COMPOUNDS = NO |
|
SUBGROUPING = YES |
|
INLINE_GROUPED_CLASSES = NO |
|
INLINE_SIMPLE_STRUCTS = NO |
|
TYPEDEF_HIDES_STRUCT = NO |
|
LOOKUP_CACHE_SIZE = 0 |
|
|
|
#--------------------------------------------------------------------------- |
|
# Build related configuration options |
|
#--------------------------------------------------------------------------- |
|
|
|
EXTRACT_ALL = NO |
|
EXTRACT_PRIVATE = NO |
|
EXTRACT_PACKAGE = NO |
|
EXTRACT_STATIC = NO |
|
EXTRACT_LOCAL_CLASSES = YES |
|
EXTRACT_LOCAL_METHODS = NO |
|
EXTRACT_ANON_NSPACES = NO |
|
HIDE_UNDOC_MEMBERS = NO |
|
HIDE_UNDOC_CLASSES = NO |
|
HIDE_FRIEND_COMPOUNDS = NO |
|
HIDE_IN_BODY_DOCS = NO |
|
INTERNAL_DOCS = NO |
|
CASE_SENSE_NAMES = NO |
|
HIDE_SCOPE_NAMES = YES |
|
HIDE_COMPOUND_REFERENCE= NO |
|
SHOW_INCLUDE_FILES = YES |
|
SHOW_GROUPED_MEMB_INC = NO |
|
FORCE_LOCAL_INCLUDES = NO |
|
INLINE_INFO = YES |
|
SORT_MEMBER_DOCS = YES |
|
SORT_BRIEF_DOCS = NO |
|
SORT_MEMBERS_CTORS_1ST = NO |
|
SORT_GROUP_NAMES = NO |
|
SORT_BY_SCOPE_NAME = NO |
|
STRICT_PROTO_MATCHING = NO |
|
GENERATE_TODOLIST = YES |
|
GENERATE_TESTLIST = YES |
|
GENERATE_BUGLIST = YES |
|
GENERATE_DEPRECATEDLIST= YES |
|
ENABLED_SECTIONS = |
|
MAX_INITIALIZER_LINES = 30 |
|
SHOW_USED_FILES = YES |
|
SHOW_FILES = YES |
|
SHOW_NAMESPACES = YES |
|
FILE_VERSION_FILTER = |
|
LAYOUT_FILE = |
|
CITE_BIB_FILES = |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to warning and progress messages |
|
#--------------------------------------------------------------------------- |
|
|
|
QUIET = NO |
|
WARNINGS = YES |
|
WARN_IF_UNDOCUMENTED = YES |
|
WARN_IF_DOC_ERROR = YES |
|
WARN_NO_PARAMDOC = NO |
|
WARN_AS_ERROR = NO |
|
WARN_FORMAT = "$file:$line: $text" |
|
WARN_LOGFILE = |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to the input files |
|
#--------------------------------------------------------------------------- |
|
|
|
INPUT = tmk_core quantum drivers |
|
INPUT_ENCODING = UTF-8 |
|
FILE_PATTERNS = *.c \ |
|
*.cc \ |
|
*.cxx \ |
|
*.cpp \ |
|
*.c++ \ |
|
*.h \ |
|
*.hh \ |
|
*.hxx \ |
|
*.hpp \ |
|
*.h++ |
|
RECURSIVE = YES |
|
EXCLUDE = |
|
EXCLUDE_SYMLINKS = NO |
|
EXCLUDE_PATTERNS = |
|
EXCLUDE_SYMBOLS = |
|
EXAMPLE_PATH = |
|
EXAMPLE_PATTERNS = * |
|
EXAMPLE_RECURSIVE = NO |
|
IMAGE_PATH = |
|
INPUT_FILTER = |
|
FILTER_PATTERNS = |
|
FILTER_SOURCE_FILES = NO |
|
FILTER_SOURCE_PATTERNS = |
|
USE_MDFILE_AS_MAINPAGE = |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to source browsing |
|
#--------------------------------------------------------------------------- |
|
|
|
SOURCE_BROWSER = YES |
|
INLINE_SOURCES = NO |
|
STRIP_CODE_COMMENTS = YES |
|
REFERENCED_BY_RELATION = NO |
|
REFERENCES_RELATION = NO |
|
REFERENCES_LINK_SOURCE = YES |
|
SOURCE_TOOLTIPS = YES |
|
USE_HTAGS = NO |
|
VERBATIM_HEADERS = YES |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to the alphabetical class index |
|
#--------------------------------------------------------------------------- |
|
|
|
ALPHABETICAL_INDEX = YES |
|
COLS_IN_ALPHA_INDEX = 5 |
|
IGNORE_PREFIX = |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to disabled outputs |
|
#--------------------------------------------------------------------------- |
|
|
|
GENERATE_HTML = NO |
|
GENERATE_LATEX = NO |
|
GENERATE_RTF = NO |
|
GENERATE_MAN = NO |
|
GENERATE_DOCBOOK = NO |
|
GENERATE_AUTOGEN_DEF = NO |
|
GENERATE_PERLMOD = NO |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to the XML output |
|
#--------------------------------------------------------------------------- |
|
|
|
GENERATE_XML = YES |
|
XML_OUTPUT = xml |
|
XML_PROGRAMLISTING = YES |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to the preprocessor |
|
#--------------------------------------------------------------------------- |
|
|
|
ENABLE_PREPROCESSING = YES |
|
MACRO_EXPANSION = NO |
|
EXPAND_ONLY_PREDEF = NO |
|
SEARCH_INCLUDES = YES |
|
INCLUDE_PATH = |
|
INCLUDE_FILE_PATTERNS = |
|
PREDEFINED = |
|
EXPAND_AS_DEFINED = |
|
SKIP_FUNCTION_MACROS = YES |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to external references |
|
#--------------------------------------------------------------------------- |
|
|
|
TAGFILES = |
|
GENERATE_TAGFILE = |
|
ALLEXTERNALS = NO |
|
EXTERNAL_GROUPS = YES |
|
EXTERNAL_PAGES = YES |
|
PERL_PATH = /usr/bin/perl |
|
|
|
#--------------------------------------------------------------------------- |
|
# Configuration options related to the dot tool |
|
#--------------------------------------------------------------------------- |
|
|
|
CLASS_DIAGRAMS = YES |
|
MSCGEN_PATH = |
|
DIA_PATH = |
|
HIDE_UNDOC_RELATIONS = YES |
|
HAVE_DOT = NO |
|
DOT_NUM_THREADS = 0 |
|
DOT_FONTNAME = Helvetica |
|
DOT_FONTSIZE = 10 |
|
DOT_FONTPATH = |
|
CLASS_GRAPH = YES |
|
COLLABORATION_GRAPH = YES |
|
GROUP_GRAPHS = YES |
|
UML_LOOK = NO |
|
UML_LIMIT_NUM_FIELDS = 10 |
|
TEMPLATE_RELATIONS = NO |
|
INCLUDE_GRAPH = YES |
|
INCLUDED_BY_GRAPH = YES |
|
CALL_GRAPH = NO |
|
CALLER_GRAPH = NO |
|
GRAPHICAL_HIERARCHY = YES |
|
DIRECTORY_GRAPH = YES |
|
DOT_IMAGE_FORMAT = png |
|
INTERACTIVE_SVG = NO |
|
DOT_PATH = |
|
DOTFILE_DIRS = |
|
MSCFILE_DIRS = |
|
DIAFILE_DIRS = |
|
PLANTUML_JAR_PATH = |
|
PLANTUML_CFG_FILE = |
|
PLANTUML_INCLUDE_PATH = |
|
DOT_GRAPH_MAX_NODES = 50 |
|
MAX_DOT_GRAPH_DEPTH = 0 |
|
DOT_TRANSPARENT = NO |
|
DOT_MULTI_TARGETS = NO |
|
GENERATE_LEGEND = YES |
|
DOT_CLEANUP = YES
|
|
|