Google Git
Sign in
pigweed / third_party / github / zephyrproject-rtos / zephyr / 289c0f0304322fcddefcb2874b3b5e8f51041944 / . / doc / zephyr.doxyfile
blob: 03a5597bdbae06aeb9f863a2988c1b0fb1105274 [file] [log] [blame]
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]1# Doxyfile 1.8.6
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8
Anas Nashif089a10b2015-06-12 10:51:09 -0700[diff] [blame]7PROJECT_NAME = "Zephyr Project"
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]8PROJECT_NUMBER =
9PROJECT_BRIEF =
10PROJECT_LOGO =
Anas Nashif1fdfc5d2017-02-05 09:24:50 -0500[diff] [blame]11OUTPUT_DIRECTORY = doxygen/
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]12CREATE_SUBDIRS = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]13OUTPUT_LANGUAGE = English
14BRIEF_MEMBER_DESC = YES
15REPEAT_BRIEF = YES
Carol Lee1aa77332015-08-07 13:22:27 -0400[diff] [blame]16ABBREVIATE_BRIEF = YES
17ALWAYS_DETAILED_SEC = YES
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]18INLINE_INHERITED_MEMB = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]19FULL_PATH_NAMES = YES
20STRIP_FROM_PATH =
21STRIP_FROM_INC_PATH =
22SHORT_NAMES = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]23JAVADOC_AUTOBRIEF = NO
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]24QT_AUTOBRIEF = NO
25MULTILINE_CPP_IS_BRIEF = NO
26INHERIT_DOCS = YES
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]27SEPARATE_MEMBER_PAGES = YES
28TAB_SIZE = 8
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]29ALIASES =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]30TCL_SUBST = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]31OPTIMIZE_OUTPUT_FOR_C = YES
32OPTIMIZE_OUTPUT_JAVA = NO
33OPTIMIZE_FOR_FORTRAN = NO
34OPTIMIZE_OUTPUT_VHDL = NO
35EXTENSION_MAPPING =
36MARKDOWN_SUPPORT = YES
37AUTOLINK_SUPPORT = YES
38BUILTIN_STL_SUPPORT = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]39CPP_CLI_SUPPORT = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]40SIP_SUPPORT = NO
41IDL_PROPERTY_SUPPORT = YES
42DISTRIBUTE_GROUP_DOC = NO
43SUBGROUPING = YES
44INLINE_GROUPED_CLASSES = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]45INLINE_SIMPLE_STRUCTS = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]46TYPEDEF_HIDES_STRUCT = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]47LOOKUP_CACHE_SIZE = 9
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]48#---------------------------------------------------------------------------
49# Build related configuration options
50#---------------------------------------------------------------------------
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]51EXTRACT_ALL = YES
52EXTRACT_PRIVATE = NO
53EXTRACT_PACKAGE = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]54EXTRACT_STATIC = YES
55EXTRACT_LOCAL_CLASSES = YES
56EXTRACT_LOCAL_METHODS = YES
57EXTRACT_ANON_NSPACES = NO
58HIDE_UNDOC_MEMBERS = NO
59HIDE_UNDOC_CLASSES = NO
60HIDE_FRIEND_COMPOUNDS = NO
61HIDE_IN_BODY_DOCS = NO
Anas Nashife7ace3f2015-08-13 12:05:24 -0400[diff] [blame]62INTERNAL_DOCS = NO
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]63CASE_SENSE_NAMES = YES
64HIDE_SCOPE_NAMES = NO
65SHOW_INCLUDE_FILES = YES
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]66SHOW_GROUPED_MEMB_INC = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]67FORCE_LOCAL_INCLUDES = NO
68INLINE_INFO = YES
69SORT_MEMBER_DOCS = YES
70SORT_BRIEF_DOCS = NO
71SORT_MEMBERS_CTORS_1ST = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]72SORT_GROUP_NAMES = YES
73SORT_BY_SCOPE_NAME = YES
74STRICT_PROTO_MATCHING = YES
75GENERATE_TODOLIST = NO
76GENERATE_TESTLIST = NO
77GENERATE_BUGLIST = NO
Anas Nashif97109a62017-01-15 09:30:53 -0500[diff] [blame]78GENERATE_DEPRECATEDLIST= YES
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]79ENABLED_SECTIONS = YES
80MAX_INITIALIZER_LINES = 300
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]81SHOW_USED_FILES = YES
82SHOW_FILES = YES
83SHOW_NAMESPACES = YES
84FILE_VERSION_FILTER =
85LAYOUT_FILE =
86CITE_BIB_FILES =
87#---------------------------------------------------------------------------
88# Configuration options related to warning and progress messages
89#---------------------------------------------------------------------------
Inaky Perez-Gonzalezef61a712016-06-14 18:48:07 -0700[diff] [blame]90QUIET = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]91WARNINGS = YES
92WARN_IF_UNDOCUMENTED = YES
93WARN_IF_DOC_ERROR = YES
94WARN_NO_PARAMDOC = NO
95WARN_FORMAT = "$file:$line: $text"
96WARN_LOGFILE =
97#---------------------------------------------------------------------------
98# Configuration options related to the input files
99#---------------------------------------------------------------------------
100INPUT = \
Anas Nashif1fdfc5d2017-02-05 09:24:50 -0500[diff] [blame]101 ../include/ \
102 ../include/misc/ \
103 ../include/arch/x86/ \
104 ../include/arch/arc/ \
105 ../include/arch/arc/v2 \
106 ../include/arch/arm/ \
107 ../include/arch/arm/cortex_m \
108 ../include/arch/nios2/ \
109 ../lib/libc/minimal/include/ \
Ravi kumar Veeramally42a91f42017-08-28 12:19:32 +0300[diff] [blame]110 ../include/net/coap.h \
Jukka Rissanen611ccaa2017-04-09 19:34:57 +0300[diff] [blame]111 ../include/net/dns_resolve.h \
Anas Nashif1fdfc5d2017-02-05 09:24:50 -0500[diff] [blame]112 ../tests/ztest/include/
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]113INPUT_ENCODING = UTF-8
Anas Nashiffdce5142015-07-11 08:09:45 -0400[diff] [blame]114FILE_PATTERNS = "*.c" "*.h" "*.S"
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]115RECURSIVE = YES
David B. Kinder91f25ee2017-09-09 08:19:15 -0700[diff] [blame]116EXCLUDE = ../include/spi_legacy.h
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]117EXCLUDE_SYMLINKS =
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]118EXCLUDE_PATTERNS =
119EXCLUDE_SYMBOLS =
120EXAMPLE_PATH =
121EXAMPLE_PATTERNS =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]122EXAMPLE_RECURSIVE = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]123IMAGE_PATH =
124INPUT_FILTER =
125FILTER_PATTERNS =
126FILTER_SOURCE_FILES = NO
127FILTER_SOURCE_PATTERNS =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]128USE_MDFILE_AS_MAINPAGE = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]129#---------------------------------------------------------------------------
130# Configuration options related to source browsing
131#---------------------------------------------------------------------------
132SOURCE_BROWSER = NO
133INLINE_SOURCES = NO
134STRIP_CODE_COMMENTS = YES
135REFERENCED_BY_RELATION = NO
136REFERENCES_RELATION = NO
137REFERENCES_LINK_SOURCE = YES
138SOURCE_TOOLTIPS = YES
139USE_HTAGS = NO
140VERBATIM_HEADERS = YES
141#---------------------------------------------------------------------------
142# Configuration options related to the alphabetical class index
143#---------------------------------------------------------------------------
144ALPHABETICAL_INDEX = YES
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]145COLS_IN_ALPHA_INDEX = 2
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]146IGNORE_PREFIX =
147#---------------------------------------------------------------------------
148# Configuration options related to the HTML output
149#---------------------------------------------------------------------------
Anas Nashiff4668cc2017-08-05 10:32:03 -0400[diff] [blame]150GENERATE_HTML = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]151HTML_OUTPUT = html
152HTML_FILE_EXTENSION = .html
153HTML_HEADER =
154HTML_FOOTER =
155HTML_STYLESHEET =
156HTML_EXTRA_STYLESHEET =
157HTML_EXTRA_FILES =
158HTML_COLORSTYLE_HUE = 220
159HTML_COLORSTYLE_SAT = 100
160HTML_COLORSTYLE_GAMMA = 80
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]161HTML_TIMESTAMP = YES
162HTML_DYNAMIC_SECTIONS = YES
Anas Nashiff1c948d2015-10-04 10:02:16 -0400[diff] [blame]163HTML_INDEX_NUM_ENTRIES = 100
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]164GENERATE_DOCSET = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]165DOCSET_FEEDNAME = "Doxygen generated docs"
166DOCSET_BUNDLE_ID = org.doxygen.Project
167DOCSET_PUBLISHER_ID = org.doxygen.Publisher
168DOCSET_PUBLISHER_NAME = Publisher
169GENERATE_HTMLHELP = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]170CHM_FILE = NO
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]171HHC_LOCATION =
172GENERATE_CHI = NO
173CHM_INDEX_ENCODING =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]174BINARY_TOC = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]175TOC_EXPAND = NO
176GENERATE_QHP = NO
177QCH_FILE =
178QHP_NAMESPACE = org.doxygen.Project
179QHP_VIRTUAL_FOLDER = doc
180QHP_CUST_FILTER_NAME =
181QHP_CUST_FILTER_ATTRS =
182QHP_SECT_FILTER_ATTRS =
183QHG_LOCATION =
184GENERATE_ECLIPSEHELP = NO
185ECLIPSE_DOC_ID = org.doxygen.Project
186DISABLE_INDEX = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]187GENERATE_TREEVIEW = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]188ENUM_VALUES_PER_LINE = 4
189TREEVIEW_WIDTH = 250
190EXT_LINKS_IN_WINDOW = NO
191FORMULA_FONTSIZE = 10
192FORMULA_TRANSPARENT = YES
193USE_MATHJAX = NO
194MATHJAX_FORMAT = HTML-CSS
195MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
196MATHJAX_EXTENSIONS =
197MATHJAX_CODEFILE =
198SEARCHENGINE = YES
199SERVER_BASED_SEARCH = NO
200EXTERNAL_SEARCH = NO
201SEARCHENGINE_URL =
202SEARCHDATA_FILE = searchdata.xml
203EXTERNAL_SEARCH_ID =
204EXTRA_SEARCH_MAPPINGS =
205#---------------------------------------------------------------------------
206# Configuration options related to the LaTeX output
207#---------------------------------------------------------------------------
Inaky Perez-Gonzalezf6d29b22016-07-01 11:58:28 -0700[diff] [blame]208GENERATE_LATEX = NO
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]209LATEX_OUTPUT = latex
210LATEX_CMD_NAME = latex
211MAKEINDEX_CMD_NAME = makeindex
212COMPACT_LATEX = NO
213PAPER_TYPE = a4
214EXTRA_PACKAGES =
215LATEX_HEADER =
216LATEX_FOOTER =
217LATEX_EXTRA_FILES =
218PDF_HYPERLINKS = YES
219USE_PDFLATEX = YES
220LATEX_BATCHMODE = NO
221LATEX_HIDE_INDICES = NO
222LATEX_SOURCE_CODE = NO
223LATEX_BIB_STYLE = plain
224#---------------------------------------------------------------------------
225# Configuration options related to the RTF output
226#---------------------------------------------------------------------------
227GENERATE_RTF = NO
228RTF_OUTPUT = rtf
229COMPACT_RTF = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]230RTF_HYPERLINKS = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]231RTF_STYLESHEET_FILE =
232RTF_EXTENSIONS_FILE =
233#---------------------------------------------------------------------------
234# Configuration options related to the man page output
235#---------------------------------------------------------------------------
236GENERATE_MAN = NO
237MAN_OUTPUT = man
238MAN_EXTENSION = .3
239MAN_LINKS = NO
240#---------------------------------------------------------------------------
241# Configuration options related to the XML output
242#---------------------------------------------------------------------------
243GENERATE_XML = YES
244XML_OUTPUT = xml
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]245XML_PROGRAMLISTING = YES
246#---------------------------------------------------------------------------
247# Configuration options related to the DOCBOOK output
248#---------------------------------------------------------------------------
249GENERATE_DOCBOOK = NO
250DOCBOOK_OUTPUT = docbook
251#---------------------------------------------------------------------------
252# Configuration options for the AutoGen Definitions output
253#---------------------------------------------------------------------------
254GENERATE_AUTOGEN_DEF = NO
255#---------------------------------------------------------------------------
256# Configuration options related to the Perl module output
257#---------------------------------------------------------------------------
258GENERATE_PERLMOD = NO
259PERLMOD_LATEX = NO
260PERLMOD_PRETTY = YES
261PERLMOD_MAKEVAR_PREFIX =
262#---------------------------------------------------------------------------
263# Configuration options related to the preprocessor
264#---------------------------------------------------------------------------
265ENABLE_PREPROCESSING = YES
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]266MACRO_EXPANSION = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]267EXPAND_ONLY_PREDEF = NO
268SEARCH_INCLUDES = YES
269INCLUDE_PATH =
270INCLUDE_FILE_PATTERNS =
Anas Nashif1f99be52015-09-13 11:22:37 -0400[diff] [blame]271PREDEFINED = "CONFIG_SYS_CLOCK_EXISTS=y" \
Yonattan Louise55632902015-10-16 17:09:35 -0500[diff] [blame]272 "CONFIG_KERNEL_EVENT_LOGGER=y" \
Fabrice Oliverof39b9b82016-04-15 16:45:33 +0200[diff] [blame]273 "CONFIG_KERNEL_EVENT_LOGGER_DYNAMIC=y" \
Fabrice Olivero128dcbb2016-05-17 13:46:55 +0200[diff] [blame]274 "CONFIG_KERNEL_EVENT_LOGGER_CUSTOM_TIMESTAMP=y" \
Fabrice Oliverof39b9b82016-04-15 16:45:33 +0200[diff] [blame]275 "CONFIG_TASK_MONITOR=y" \
Anas Nashifdfee3322016-02-09 07:31:57 -0500[diff] [blame]276 "CONFIG_UART_INTERRUPT_DRIVEN=y" \
277 "CONFIG_UART_DRV_CMD=y" \
Ramesh Thomas6d1e3cf2016-04-21 12:18:12 -0700[diff] [blame]278 "CONFIG_SYS_POWER_MANAGEMENT=y" \
279 "CONFIG_DEVICE_POWER_MANAGEMENT=y" \
Johan Hedberg2975ca02017-08-09 09:21:11 +0300[diff] [blame]280 "CONFIG_BT_SMP=y" \
281 "CONFIG_BT_BREDR=y" \
David B. Kinder7bc92b32016-09-12 10:16:13 -0700[diff] [blame]282 "__deprecated=" \
Andrew Boiea3d36592016-08-29 11:21:42 -0700[diff] [blame]283 "__printf_like(x, y)=" \
Andrew Boiefa94ee72017-09-28 16:54:35 -0700[diff] [blame]284 "__attribute(x)__=" \
285 "__syscall=" \
286 "__syscall_inline="
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]287EXPAND_AS_DEFINED =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]288SKIP_FUNCTION_MACROS = NO
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]289#---------------------------------------------------------------------------
290# Configuration options related to external references
291#---------------------------------------------------------------------------
Inaky Perez-Gonzalez85c64462016-06-15 09:53:29 -0700[diff] [blame]292TAGFILES =
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]293ALLEXTERNALS = NO
294EXTERNAL_GROUPS = YES
295EXTERNAL_PAGES = YES
296PERL_PATH = /usr/bin/perl
297#---------------------------------------------------------------------------
298# Configuration options related to the dot tool
299#---------------------------------------------------------------------------
300CLASS_DIAGRAMS = NO
301MSCGEN_PATH =
302DIA_PATH =
303HIDE_UNDOC_RELATIONS = YES
304HAVE_DOT = NO
305DOT_NUM_THREADS = 0
306DOT_FONTNAME = Helvetica
307DOT_FONTSIZE = 10
308DOT_FONTPATH =
309CLASS_GRAPH = YES
310COLLABORATION_GRAPH = YES
311GROUP_GRAPHS = YES
312UML_LOOK = NO
313UML_LIMIT_NUM_FIELDS = 10
314TEMPLATE_RELATIONS = NO
315INCLUDE_GRAPH = YES
316INCLUDED_BY_GRAPH = YES
317CALL_GRAPH = NO
318CALLER_GRAPH = NO
319GRAPHICAL_HIERARCHY = YES
320DIRECTORY_GRAPH = YES
321DOT_IMAGE_FORMAT = png
322INTERACTIVE_SVG = NO
323DOT_PATH =
324DOTFILE_DIRS =
325MSCFILE_DIRS =
326DIAFILE_DIRS =
327DOT_GRAPH_MAX_NODES = 50
328MAX_DOT_GRAPH_DEPTH = 0
329DOT_TRANSPARENT = NO
330DOT_MULTI_TARGETS = NO
331GENERATE_LEGEND = YES
332DOT_CLEANUP = YES
333
334ALIASES += "rst=\verbatim embed:rst"
335ALIASES += "endrst=\endverbatim"
336ALIASES += "rststar=\verbatim embed:rst:leading-asterisk"
337ALIASES += "endrststar=\endverbatim"
338ALIASES += "r=\verbatim embed:rst:leading-asterisk"
339ALIASES += "er=\endverbatim"