Google Git
Sign in
pigweed / third_party / github / zephyrproject-rtos / zephyr / 85c64466fff8ff14011fa597d1af1b2d65a88451 / . / doc / doxygen.config
blob: b3ee14cd6df8c8d91f189786d804c07d744f2f60 [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 =
11OUTPUT_DIRECTORY = doc/
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
78GENERATE_DEPRECATEDLIST= NO
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 Nashif3f123c62016-02-09 18:57:11 -0500[diff] [blame]101 include/ \
Rodrigo Caballeroa3edcaa2016-02-07 12:00:52 -0600[diff] [blame]102 include/misc/ \
Inaky Perez-Gonzalez7fbe0ba2016-06-14 18:47:33 -0700[diff] [blame]103 include/arch/x86/ \
104 include/arch/arc/ include/arch/arc/v2 \
105 include/arch/arm/ include/arch/arm/cortex_m \
106 include/arch/nios2/ \
Anas Nashif246d3f22016-04-17 03:22:02 +0800[diff] [blame]107 lib/libc/minimal/include/ \
Anas Nashif7d76e962016-05-28 14:41:55 -0400[diff] [blame]108 ext/lib/crypto/tinycrypt/include/
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]109INPUT_ENCODING = UTF-8
Anas Nashiffdce5142015-07-11 08:09:45 -0400[diff] [blame]110FILE_PATTERNS = "*.c" "*.h" "*.S"
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]111RECURSIVE = YES
112EXCLUDE =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]113EXCLUDE_SYMLINKS =
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]114EXCLUDE_PATTERNS =
115EXCLUDE_SYMBOLS =
116EXAMPLE_PATH =
117EXAMPLE_PATTERNS =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]118EXAMPLE_RECURSIVE = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]119IMAGE_PATH =
120INPUT_FILTER =
121FILTER_PATTERNS =
122FILTER_SOURCE_FILES = NO
123FILTER_SOURCE_PATTERNS =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]124USE_MDFILE_AS_MAINPAGE = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]125#---------------------------------------------------------------------------
126# Configuration options related to source browsing
127#---------------------------------------------------------------------------
128SOURCE_BROWSER = NO
129INLINE_SOURCES = NO
130STRIP_CODE_COMMENTS = YES
131REFERENCED_BY_RELATION = NO
132REFERENCES_RELATION = NO
133REFERENCES_LINK_SOURCE = YES
134SOURCE_TOOLTIPS = YES
135USE_HTAGS = NO
136VERBATIM_HEADERS = YES
137#---------------------------------------------------------------------------
138# Configuration options related to the alphabetical class index
139#---------------------------------------------------------------------------
140ALPHABETICAL_INDEX = YES
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]141COLS_IN_ALPHA_INDEX = 2
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]142IGNORE_PREFIX =
143#---------------------------------------------------------------------------
144# Configuration options related to the HTML output
145#---------------------------------------------------------------------------
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]146GENERATE_HTML = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]147HTML_OUTPUT = html
148HTML_FILE_EXTENSION = .html
149HTML_HEADER =
150HTML_FOOTER =
151HTML_STYLESHEET =
152HTML_EXTRA_STYLESHEET =
153HTML_EXTRA_FILES =
154HTML_COLORSTYLE_HUE = 220
155HTML_COLORSTYLE_SAT = 100
156HTML_COLORSTYLE_GAMMA = 80
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]157HTML_TIMESTAMP = YES
158HTML_DYNAMIC_SECTIONS = YES
Anas Nashiff1c948d2015-10-04 10:02:16 -0400[diff] [blame]159HTML_INDEX_NUM_ENTRIES = 100
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]160GENERATE_DOCSET = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]161DOCSET_FEEDNAME = "Doxygen generated docs"
162DOCSET_BUNDLE_ID = org.doxygen.Project
163DOCSET_PUBLISHER_ID = org.doxygen.Publisher
164DOCSET_PUBLISHER_NAME = Publisher
165GENERATE_HTMLHELP = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]166CHM_FILE = NO
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]167HHC_LOCATION =
168GENERATE_CHI = NO
169CHM_INDEX_ENCODING =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]170BINARY_TOC = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]171TOC_EXPAND = NO
172GENERATE_QHP = NO
173QCH_FILE =
174QHP_NAMESPACE = org.doxygen.Project
175QHP_VIRTUAL_FOLDER = doc
176QHP_CUST_FILTER_NAME =
177QHP_CUST_FILTER_ATTRS =
178QHP_SECT_FILTER_ATTRS =
179QHG_LOCATION =
180GENERATE_ECLIPSEHELP = NO
181ECLIPSE_DOC_ID = org.doxygen.Project
182DISABLE_INDEX = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]183GENERATE_TREEVIEW = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]184ENUM_VALUES_PER_LINE = 4
185TREEVIEW_WIDTH = 250
186EXT_LINKS_IN_WINDOW = NO
187FORMULA_FONTSIZE = 10
188FORMULA_TRANSPARENT = YES
189USE_MATHJAX = NO
190MATHJAX_FORMAT = HTML-CSS
191MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
192MATHJAX_EXTENSIONS =
193MATHJAX_CODEFILE =
194SEARCHENGINE = YES
195SERVER_BASED_SEARCH = NO
196EXTERNAL_SEARCH = NO
197SEARCHENGINE_URL =
198SEARCHDATA_FILE = searchdata.xml
199EXTERNAL_SEARCH_ID =
200EXTRA_SEARCH_MAPPINGS =
201#---------------------------------------------------------------------------
202# Configuration options related to the LaTeX output
203#---------------------------------------------------------------------------
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]204GENERATE_LATEX = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]205LATEX_OUTPUT = latex
206LATEX_CMD_NAME = latex
207MAKEINDEX_CMD_NAME = makeindex
208COMPACT_LATEX = NO
209PAPER_TYPE = a4
210EXTRA_PACKAGES =
211LATEX_HEADER =
212LATEX_FOOTER =
213LATEX_EXTRA_FILES =
214PDF_HYPERLINKS = YES
215USE_PDFLATEX = YES
216LATEX_BATCHMODE = NO
217LATEX_HIDE_INDICES = NO
218LATEX_SOURCE_CODE = NO
219LATEX_BIB_STYLE = plain
220#---------------------------------------------------------------------------
221# Configuration options related to the RTF output
222#---------------------------------------------------------------------------
223GENERATE_RTF = NO
224RTF_OUTPUT = rtf
225COMPACT_RTF = NO
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]226RTF_HYPERLINKS = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]227RTF_STYLESHEET_FILE =
228RTF_EXTENSIONS_FILE =
229#---------------------------------------------------------------------------
230# Configuration options related to the man page output
231#---------------------------------------------------------------------------
232GENERATE_MAN = NO
233MAN_OUTPUT = man
234MAN_EXTENSION = .3
235MAN_LINKS = NO
236#---------------------------------------------------------------------------
237# Configuration options related to the XML output
238#---------------------------------------------------------------------------
239GENERATE_XML = YES
240XML_OUTPUT = xml
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]241XML_PROGRAMLISTING = YES
242#---------------------------------------------------------------------------
243# Configuration options related to the DOCBOOK output
244#---------------------------------------------------------------------------
245GENERATE_DOCBOOK = NO
246DOCBOOK_OUTPUT = docbook
247#---------------------------------------------------------------------------
248# Configuration options for the AutoGen Definitions output
249#---------------------------------------------------------------------------
250GENERATE_AUTOGEN_DEF = NO
251#---------------------------------------------------------------------------
252# Configuration options related to the Perl module output
253#---------------------------------------------------------------------------
254GENERATE_PERLMOD = NO
255PERLMOD_LATEX = NO
256PERLMOD_PRETTY = YES
257PERLMOD_MAKEVAR_PREFIX =
258#---------------------------------------------------------------------------
259# Configuration options related to the preprocessor
260#---------------------------------------------------------------------------
261ENABLE_PREPROCESSING = YES
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]262MACRO_EXPANSION = YES
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]263EXPAND_ONLY_PREDEF = NO
264SEARCH_INCLUDES = YES
265INCLUDE_PATH =
266INCLUDE_FILE_PATTERNS =
Anas Nashif1f99be52015-09-13 11:22:37 -0400[diff] [blame]267PREDEFINED = "CONFIG_SYS_CLOCK_EXISTS=y" \
Yonattan Louise55632902015-10-16 17:09:35 -0500[diff] [blame]268 "CONFIG_KERNEL_EVENT_LOGGER=y" \
Fabrice Oliverof39b9b82016-04-15 16:45:33 +0200[diff] [blame]269 "CONFIG_KERNEL_EVENT_LOGGER_DYNAMIC=y" \
Fabrice Olivero128dcbb2016-05-17 13:46:55 +0200[diff] [blame]270 "CONFIG_KERNEL_EVENT_LOGGER_CUSTOM_TIMESTAMP=y" \
Fabrice Oliverof39b9b82016-04-15 16:45:33 +0200[diff] [blame]271 "CONFIG_TASK_MONITOR=y" \
Anas Nashifdfee3322016-02-09 07:31:57 -0500[diff] [blame]272 "CONFIG_NANO_TIMEOUTS=y" \
273 "CONFIG_UART_INTERRUPT_DRIVEN=y" \
274 "CONFIG_UART_DRV_CMD=y" \
Ramesh Thomas6d1e3cf2016-04-21 12:18:12 -0700[diff] [blame]275 "CONFIG_SYS_POWER_MANAGEMENT=y" \
276 "CONFIG_DEVICE_POWER_MANAGEMENT=y" \
Johan Hedbergd5fb23b2016-06-15 11:42:18 +0300[diff] [blame]277 "CONFIG_BLUETOOTH_SMP=y" \
278 "CONFIG_BLUETOOTH_BREDR=y" \
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]279EXPAND_AS_DEFINED =
Carol Leeec2a7462015-08-04 10:21:47 -0400[diff] [blame]280SKIP_FUNCTION_MACROS = NO
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]281#---------------------------------------------------------------------------
282# Configuration options related to external references
283#---------------------------------------------------------------------------
Inaky Perez-Gonzalez85c64462016-06-15 09:53:29 -0700[diff] [blame^]284TAGFILES =
Anas Nashif06d380c2015-05-13 14:05:30 -0400[diff] [blame]285ALLEXTERNALS = NO
286EXTERNAL_GROUPS = YES
287EXTERNAL_PAGES = YES
288PERL_PATH = /usr/bin/perl
289#---------------------------------------------------------------------------
290# Configuration options related to the dot tool
291#---------------------------------------------------------------------------
292CLASS_DIAGRAMS = NO
293MSCGEN_PATH =
294DIA_PATH =
295HIDE_UNDOC_RELATIONS = YES
296HAVE_DOT = NO
297DOT_NUM_THREADS = 0
298DOT_FONTNAME = Helvetica
299DOT_FONTSIZE = 10
300DOT_FONTPATH =
301CLASS_GRAPH = YES
302COLLABORATION_GRAPH = YES
303GROUP_GRAPHS = YES
304UML_LOOK = NO
305UML_LIMIT_NUM_FIELDS = 10
306TEMPLATE_RELATIONS = NO
307INCLUDE_GRAPH = YES
308INCLUDED_BY_GRAPH = YES
309CALL_GRAPH = NO
310CALLER_GRAPH = NO
311GRAPHICAL_HIERARCHY = YES
312DIRECTORY_GRAPH = YES
313DOT_IMAGE_FORMAT = png
314INTERACTIVE_SVG = NO
315DOT_PATH =
316DOTFILE_DIRS =
317MSCFILE_DIRS =
318DIAFILE_DIRS =
319DOT_GRAPH_MAX_NODES = 50
320MAX_DOT_GRAPH_DEPTH = 0
321DOT_TRANSPARENT = NO
322DOT_MULTI_TARGETS = NO
323GENERATE_LEGEND = YES
324DOT_CLEANUP = YES
325
326ALIASES += "rst=\verbatim embed:rst"
327ALIASES += "endrst=\endverbatim"
328ALIASES += "rststar=\verbatim embed:rst:leading-asterisk"
329ALIASES += "endrststar=\endverbatim"
330ALIASES += "r=\verbatim embed:rst:leading-asterisk"
331ALIASES += "er=\endverbatim"