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 a project.
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# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See
24# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING      = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
35PROJECT_NAME           = "nrfx"
36
37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
41### EDIT THIS ###
42
43PROJECT_NUMBER         = "2.3"
44
45# Using the PROJECT_BRIEF tag one can provide an optional one line description
46# for a project that appears at the top of each page and should give viewer a
47# quick idea about the purpose of the project. Keep the description short.
48
49### EDIT THIS ###
50
51PROJECT_BRIEF          =
52
53# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
54# in the documentation. The maximum height of the logo should not exceed 55
55# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
56# the logo to the output directory.
57
58PROJECT_LOGO           = buildfiles/nordic_small.png
59
60# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
61# into which the generated documentation will be written. If a relative path is
62# entered, it will be relative to the location where doxygen was started. If
63# left blank the current directory will be used.
64
65OUTPUT_DIRECTORY       =
66
67# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
68# directories (in 2 levels) under the output directory of each output format and
69# will distribute the generated files over these directories. Enabling this
70# option can be useful when feeding doxygen a huge amount of source files, where
71# putting all generated files in the same directory would otherwise causes
72# performance problems for the file system.
73# The default value is: NO.
74
75### EDIT THIS ###
76
77CREATE_SUBDIRS         = NO
78
79# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
80# characters to appear in the names of generated files. If set to NO, non-ASCII
81# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
82# U+3044.
83# The default value is: NO.
84
85#ALLOW_UNICODE_NAMES    = NO
86
87# The OUTPUT_LANGUAGE tag is used to specify the language in which all
88# documentation generated by doxygen is written. Doxygen will use this
89# information to generate all constant output in the proper language.
90# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
91# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
92# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
93# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
94# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
95# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
96# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
97# Ukrainian and Vietnamese.
98# The default value is: English.
99
100OUTPUT_LANGUAGE        = English
101
102# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
103# descriptions after the members that are listed in the file and class
104# documentation (similar to Javadoc). Set to NO to disable this.
105# The default value is: YES.
106
107BRIEF_MEMBER_DESC      = YES
108
109# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
110# description of a member or function before the detailed description
111#
112# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
113# brief descriptions will be completely suppressed.
114# The default value is: YES.
115
116REPEAT_BRIEF           = YES
117
118# This tag implements a quasi-intelligent brief description abbreviator that is
119# used to form the text in various listings. Each string in this list, if found
120# as the leading text of the brief description, will be stripped from the text
121# and the result, after processing the whole list, is used as the annotated
122# text. Otherwise, the brief description is used as-is. If left blank, the
123# following values are used ($name is automatically replaced with the name of
124# the entity):The $name class, The $name widget, The $name file, is, provides,
125# specifies, contains, represents, a, an and the.
126
127ABBREVIATE_BRIEF       =
128
129# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
130# doxygen will generate a detailed section even if there is only a brief
131# description.
132# The default value is: NO.
133
134ALWAYS_DETAILED_SEC    = NO
135
136# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
137# inherited members of a class in the documentation of that class as if those
138# members were ordinary class members. Constructors, destructors and assignment
139# operators of the base classes will not be shown.
140# The default value is: NO.
141
142INLINE_INHERITED_MEMB  = NO
143
144# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
145# before files name in the file list and in the header files. If set to NO the
146# shortest path that makes the file name unique will be used
147# The default value is: YES.
148
149FULL_PATH_NAMES        = YES
150
151# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
152# Stripping is only done if one of the specified strings matches the left-hand
153# part of the path. The tag can be used to show relative paths in the file list.
154# If left blank the directory from which doxygen is run is used as the path to
155# strip.
156#
157# Note that you can specify absolute paths here, but also relative paths, which
158# will be relative from the directory where doxygen is started.
159# This tag requires that the tag FULL_PATH_NAMES is set to YES.
160
161STRIP_FROM_PATH        = ..
162
163# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
164# path mentioned in the documentation of a class, which tells the reader which
165# header file to include in order to use a class. If left blank only the name of
166# the header file containing the class definition is used. Otherwise one should
167# specify the list of include paths that are normally passed to the compiler
168# using the -I flag.
169
170STRIP_FROM_INC_PATH    =
171
172# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
173# less readable) file names. This can be useful is your file systems doesn't
174# support long names like on DOS, Mac, or CD-ROM.
175# The default value is: NO.
176
177SHORT_NAMES            = NO
178
179# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
180# first line (until the first dot) of a Javadoc-style comment as the brief
181# description. If set to NO, the Javadoc-style will behave just like regular Qt-
182# style comments (thus requiring an explicit @brief command for a brief
183# description.)
184# The default value is: NO.
185
186JAVADOC_AUTOBRIEF      = NO
187
188# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
189# line (until the first dot) of a Qt-style comment as the brief description. If
190# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
191# requiring an explicit \brief command for a brief description.)
192# The default value is: NO.
193
194QT_AUTOBRIEF           = NO
195
196# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
197# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
198# a brief description. This used to be the default behavior. The new default is
199# to treat a multi-line C++ comment block as a detailed description. Set this
200# tag to YES if you prefer the old behavior instead.
201#
202# Note that setting this tag to YES also means that rational rose comments are
203# not recognized any more.
204# The default value is: NO.
205
206MULTILINE_CPP_IS_BRIEF = NO
207
208# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
209# documentation from any documented member that it re-implements.
210# The default value is: YES.
211
212INHERIT_DOCS           = YES
213
214# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
215# page for each member. If set to NO, the documentation of a member will be part
216# of the file/class/namespace that contains it.
217# The default value is: NO.
218
219SEPARATE_MEMBER_PAGES  = NO
220
221# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
222# uses this value to replace tabs by spaces in code fragments.
223# Minimum value: 1, maximum value: 16, default value: 4.
224
225TAB_SIZE               = 4
226
227# This tag can be used to specify a number of aliases that act as commands in
228# the documentation. An alias has the form:
229# name=value
230# For example adding
231# "sideeffect=@par Side Effects:\n"
232# will allow you to put the command \sideeffect (or @sideeffect) in the
233# documentation, which will result in a user-defined paragraph with heading
234# "Side Effects:". You can put \n's in the value part of an alias to insert
235# newlines (in the resulting output). You can put ^^ in the value part of an
236# alias to insert a newline as if a physical newline was in the original file.
237
238ALIASES                = tagGreenTick="@htmlonly<CENTER><font color=\"green\">✔</font></CENTER>@endhtmlonly" \
239                         tagRedCross="@htmlonly<CENTER><font color=\"red\">✖</font></CENTER>@endhtmlonly"
240
241# This tag can be used to specify a number of word-keyword mappings (TCL only).
242# A mapping has the form "name=value". For example adding "class=itcl::class"
243# will allow you to use the command class in the itcl::class meaning.
244
245TCL_SUBST              =
246
247# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
248# only. Doxygen will then generate output that is more tailored for C. For
249# instance, some of the names that are used will be different. The list of all
250# members will be omitted, etc.
251# The default value is: NO.
252
253OPTIMIZE_OUTPUT_FOR_C  = YES
254
255# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
256# Python sources only. Doxygen will then generate output that is more tailored
257# for that language. For instance, namespaces will be presented as packages,
258# qualified scopes will look different, etc.
259# The default value is: NO.
260
261OPTIMIZE_OUTPUT_JAVA   = NO
262
263# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
264# sources. Doxygen will then generate output that is tailored for Fortran.
265# The default value is: NO.
266
267OPTIMIZE_FOR_FORTRAN   = NO
268
269# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
270# sources. Doxygen will then generate output that is tailored for VHDL.
271# The default value is: NO.
272
273OPTIMIZE_OUTPUT_VHDL   = NO
274
275# Doxygen selects the parser to use depending on the extension of the files it
276# parses. With this tag you can assign which parser to use for a given
277# extension. Doxygen has a built-in mapping, but you can override or extend it
278# using this tag. The format is ext=language, where ext is a file extension, and
279# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
280# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
281# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
282# Fortran. In the later case the parser tries to guess whether the code is fixed
283# or free formatted code, this is the default for Fortran type files), VHDL. For
284# instance to make doxygen treat .inc files as Fortran files (default is PHP),
285# and .f files as C (default is Fortran), use: inc=Fortran f=C.
286#
287# Note: For files without extension you can use no_extension as a placeholder.
288#
289# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
290# the files are not read by doxygen.
291
292EXTENSION_MAPPING      =
293
294# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
295# according to the Markdown format, which allows for more readable
296# documentation. See http://daringfireball.net/projects/markdown/ for details.
297# The output of markdown processing is further processed by doxygen, so you can
298# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
299# case of backward compatibilities issues.
300# The default value is: YES.
301
302MARKDOWN_SUPPORT       = YES
303
304# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
305# to that level are automatically included in the table of contents, even if
306# they do not have an id attribute.
307# Note: This feature currently applies only to Markdown headings.
308# Minimum value: 0, maximum value: 99, default value: 0.
309# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
310
311#TOC_INCLUDE_HEADINGS   = 0
312
313# When enabled doxygen tries to link words that correspond to documented
314# classes, or namespaces to their corresponding documentation. Such a link can
315# be prevented in individual cases by putting a % sign in front of the word or
316# globally by setting AUTOLINK_SUPPORT to NO.
317# The default value is: YES.
318
319AUTOLINK_SUPPORT       = YES
320
321# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
322# to include (a tag file for) the STL sources as input, then you should set this
323# tag to YES in order to let doxygen match functions declarations and
324# definitions whose arguments contain STL classes (e.g. func(std::string);
325# versus func(std::string) {}). This also make the inheritance and collaboration
326# diagrams that involve STL classes more complete and accurate.
327# The default value is: NO.
328
329BUILTIN_STL_SUPPORT    = NO
330
331# If you use Microsoft's C++/CLI language, you should set this option to YES to
332# enable parsing support.
333# The default value is: NO.
334
335CPP_CLI_SUPPORT        = NO
336
337# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
338# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
339# will parse them like normal C++ but will assume all classes use public instead
340# of private inheritance when no explicit protection keyword is present.
341# The default value is: NO.
342
343SIP_SUPPORT            = NO
344
345# For Microsoft's IDL there are propget and propput attributes to indicate
346# getter and setter methods for a property. Setting this option to YES will make
347# doxygen to replace the get and set methods by a property in the documentation.
348# This will only work if the methods are indeed getting or setting a simple
349# type. If this is not the case, or you want to show the methods anyway, you
350# should set this option to NO.
351# The default value is: YES.
352
353IDL_PROPERTY_SUPPORT   = YES
354
355# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
356# tag is set to YES then doxygen will reuse the documentation of the first
357# member in the group (if any) for the other members of the group. By default
358# all members of a group must be documented explicitly.
359# The default value is: NO.
360
361DISTRIBUTE_GROUP_DOC   = NO
362
363# If one adds a struct or class to a group and this option is enabled, then also
364# any nested class or struct is added to the same group. By default this option
365# is disabled and one has to add nested compounds explicitly via \ingroup.
366# The default value is: NO.
367
368#GROUP_NESTED_COMPOUNDS = NO
369
370# Set the SUBGROUPING tag to YES to allow class member groups of the same type
371# (for instance a group of public functions) to be put as a subgroup of that
372# type (e.g. under the Public Functions section). Set it to NO to prevent
373# subgrouping. Alternatively, this can be done per class using the
374# \nosubgrouping command.
375# The default value is: YES.
376
377SUBGROUPING            = YES
378
379# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
380# are shown inside the group in which they are included (e.g. using \ingroup)
381# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
382# and RTF).
383#
384# Note that this feature does not work in combination with
385# SEPARATE_MEMBER_PAGES.
386# The default value is: NO.
387
388INLINE_GROUPED_CLASSES = NO
389
390# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
391# with only public data fields or simple typedef fields will be shown inline in
392# the documentation of the scope in which they are defined (i.e. file,
393# namespace, or group documentation), provided this scope is documented. If set
394# to NO, structs, classes, and unions are shown on a separate page (for HTML and
395# Man pages) or section (for LaTeX and RTF).
396# The default value is: NO.
397
398INLINE_SIMPLE_STRUCTS  = NO
399
400# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
401# enum is documented as struct, union, or enum with the name of the typedef. So
402# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
403# with name TypeT. When disabled the typedef will appear as a member of a file,
404# namespace, or class. And the struct will be named TypeS. This can typically be
405# useful for C code in case the coding convention dictates that all compound
406# types are typedef'ed and only the typedef is referenced, never the tag name.
407# The default value is: NO.
408
409TYPEDEF_HIDES_STRUCT   = NO
410
411# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
412# cache is used to resolve symbols given their name and scope. Since this can be
413# an expensive process and often the same symbol appears multiple times in the
414# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
415# doxygen will become slower. If the cache is too large, memory is wasted. The
416# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
417# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
418# symbols. At the end of a run doxygen will report the cache usage and suggest
419# the optimal cache size from a speed point of view.
420# Minimum value: 0, maximum value: 9, default value: 0.
421
422LOOKUP_CACHE_SIZE      = 0
423
424#---------------------------------------------------------------------------
425# Build related configuration options
426#---------------------------------------------------------------------------
427
428# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
429# documentation are documented, even if no documentation was available. Private
430# class members and static file members will be hidden unless the
431# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
432# Note: This will also disable the warnings about undocumented members that are
433# normally produced when WARNINGS is set to YES.
434# The default value is: NO.
435
436EXTRACT_ALL            = NO
437
438# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
439# be included in the documentation.
440# The default value is: NO.
441
442EXTRACT_PRIVATE        = NO
443
444# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
445# scope will be included in the documentation.
446# The default value is: NO.
447
448EXTRACT_PACKAGE        = NO
449
450# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
451# included in the documentation.
452# The default value is: NO.
453
454EXTRACT_STATIC         = YES
455
456# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
457# locally in source files will be included in the documentation. If set to NO,
458# only classes defined in header files are included. Does not have any effect
459# for Java sources.
460# The default value is: YES.
461
462EXTRACT_LOCAL_CLASSES  = YES
463
464# This flag is only useful for Objective-C code. If set to YES, local methods,
465# which are defined in the implementation section but not in the interface are
466# included in the documentation. If set to NO, only methods in the interface are
467# included.
468# The default value is: NO.
469
470EXTRACT_LOCAL_METHODS  = NO
471
472# If this flag is set to YES, the members of anonymous namespaces will be
473# extracted and appear in the documentation as a namespace called
474# 'anonymous_namespace{file}', where file will be replaced with the base name of
475# the file that contains the anonymous namespace. By default anonymous namespace
476# are hidden.
477# The default value is: NO.
478
479EXTRACT_ANON_NSPACES   = NO
480
481# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
482# undocumented members inside documented classes or files. If set to NO these
483# members will be included in the various overviews, but no documentation
484# section is generated. This option has no effect if EXTRACT_ALL is enabled.
485# The default value is: NO.
486
487HIDE_UNDOC_MEMBERS     = NO
488
489# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
490# undocumented classes that are normally visible in the class hierarchy. If set
491# to NO, these classes will be included in the various overviews. This option
492# has no effect if EXTRACT_ALL is enabled.
493# The default value is: NO.
494
495HIDE_UNDOC_CLASSES     = NO
496
497# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
498# (class|struct|union) declarations. If set to NO, these declarations will be
499# included in the documentation.
500# The default value is: NO.
501
502HIDE_FRIEND_COMPOUNDS  = NO
503
504# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
505# documentation blocks found inside the body of a function. If set to NO, these
506# blocks will be appended to the function's detailed documentation block.
507# The default value is: NO.
508
509HIDE_IN_BODY_DOCS      = NO
510
511# The INTERNAL_DOCS tag determines if documentation that is typed after a
512# \internal command is included. If the tag is set to NO then the documentation
513# will be excluded. Set it to YES to include the internal documentation.
514# The default value is: NO.
515
516INTERNAL_DOCS          = NO
517
518# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
519# names in lower-case letters. If set to YES, upper-case letters are also
520# allowed. This is useful if you have classes or files whose names only differ
521# in case and if your file system supports case sensitive file names. Windows
522# and Mac users are advised to set this option to NO.
523# The default value is: system dependent.
524
525CASE_SENSE_NAMES       = NO
526
527# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
528# their full class and namespace scopes in the documentation. If set to YES, the
529# scope will be hidden.
530# The default value is: NO.
531
532HIDE_SCOPE_NAMES       = NO
533
534# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
535# append additional text to a page's title, such as Class Reference. If set to
536# YES the compound reference will be hidden.
537# The default value is: NO.
538
539#HIDE_COMPOUND_REFERENCE= NO
540
541# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
542# the files that are included by a file in the documentation of that file.
543# The default value is: YES.
544
545SHOW_INCLUDE_FILES     = YES
546
547# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
548# grouped member an include statement to the documentation, telling the reader
549# which file to include in order to use the member.
550# The default value is: NO.
551
552#SHOW_GROUPED_MEMB_INC  = NO
553
554# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
555# files with double quotes in the documentation rather than with sharp brackets.
556# The default value is: NO.
557
558FORCE_LOCAL_INCLUDES   = NO
559
560# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
561# documentation for inline members.
562# The default value is: YES.
563
564INLINE_INFO            = YES
565
566# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
567# (detailed) documentation of file and class members alphabetically by member
568# name. If set to NO, the members will appear in declaration order.
569# The default value is: YES.
570
571SORT_MEMBER_DOCS       = YES
572
573# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
574# descriptions of file, namespace and class members alphabetically by member
575# name. If set to NO, the members will appear in declaration order. Note that
576# this will also influence the order of the classes in the class list.
577# The default value is: NO.
578
579SORT_BRIEF_DOCS        = NO
580
581# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
582# (brief and detailed) documentation of class members so that constructors and
583# destructors are listed first. If set to NO the constructors will appear in the
584# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
585# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
586# member documentation.
587# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
588# detailed member documentation.
589# The default value is: NO.
590
591SORT_MEMBERS_CTORS_1ST = NO
592
593# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
594# of group names into alphabetical order. If set to NO the group names will
595# appear in their defined order.
596# The default value is: NO.
597
598SORT_GROUP_NAMES       = NO
599
600# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
601# fully-qualified names, including namespaces. If set to NO, the class list will
602# be sorted only by class name, not including the namespace part.
603# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
604# Note: This option applies only to the class list, not to the alphabetical
605# list.
606# The default value is: NO.
607
608SORT_BY_SCOPE_NAME     = NO
609
610# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
611# type resolution of all parameters of a function it will reject a match between
612# the prototype and the implementation of a member function even if there is
613# only one candidate or it is obvious which candidate to choose by doing a
614# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
615# accept a match between prototype and implementation in such cases.
616# The default value is: NO.
617
618STRICT_PROTO_MATCHING  = NO
619
620# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
621# list. This list is created by putting \todo commands in the documentation.
622# The default value is: YES.
623
624GENERATE_TODOLIST      = YES
625
626# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
627# list. This list is created by putting \test commands in the documentation.
628# The default value is: YES.
629
630GENERATE_TESTLIST      = YES
631
632# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
633# list. This list is created by putting \bug commands in the documentation.
634# The default value is: YES.
635
636GENERATE_BUGLIST       = YES
637
638# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
639# the deprecated list. This list is created by putting \deprecated commands in
640# the documentation.
641# The default value is: YES.
642
643GENERATE_DEPRECATEDLIST= YES
644
645# The ENABLED_SECTIONS tag can be used to enable conditional documentation
646# sections, marked by \if <section_label> ... \endif and \cond <section_label>
647# ... \endcond blocks.
648
649ENABLED_SECTIONS       =
650
651# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
652# initial value of a variable or macro / define can have for it to appear in the
653# documentation. If the initializer consists of more lines than specified here
654# it will be hidden. Use a value of 0 to hide initializers completely. The
655# appearance of the value of individual variables and macros / defines can be
656# controlled using \showinitializer or \hideinitializer command in the
657# documentation regardless of this setting.
658# Minimum value: 0, maximum value: 10000, default value: 30.
659
660MAX_INITIALIZER_LINES  = 30
661
662# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
663# the bottom of the documentation of classes and structs. If set to YES, the
664# list will mention the files that were used to generate the documentation.
665# The default value is: YES.
666
667SHOW_USED_FILES        = YES
668
669# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
670# will remove the Files entry from the Quick Index and from the Folder Tree View
671# (if specified).
672# The default value is: YES.
673
674SHOW_FILES             = NO
675
676# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
677# page. This will remove the Namespaces entry from the Quick Index and from the
678# Folder Tree View (if specified).
679# The default value is: YES.
680
681SHOW_NAMESPACES        = YES
682
683# The FILE_VERSION_FILTER tag can be used to specify a program or script that
684# doxygen should invoke to get the current version for each file (typically from
685# the version control system). Doxygen will invoke the program by executing (via
686# popen()) the command command input-file, where command is the value of the
687# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
688# by doxygen. Whatever the program writes to standard output is used as the file
689# version. For an example see the documentation.
690
691FILE_VERSION_FILTER    =
692
693# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
694# by doxygen. The layout file controls the global structure of the generated
695# output files in an output format independent way. To create the layout file
696# that represents doxygen's defaults, run doxygen with the -l option. You can
697# optionally specify a file name after the option, if omitted DoxygenLayout.xml
698# will be used as the name of the layout file.
699#
700# Note that if you run doxygen from a directory containing a file called
701# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
702# tag is left empty.
703
704LAYOUT_FILE            = buildfiles/layout.xml
705
706# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
707# the reference definitions. This must be a list of .bib files. The .bib
708# extension is automatically appended if omitted. This requires the bibtex tool
709# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
710# For LaTeX the style of the bibliography can be controlled using
711# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
712# search path. See also \cite for info how to create references.
713
714CITE_BIB_FILES         =
715
716#---------------------------------------------------------------------------
717# Configuration options related to warning and progress messages
718#---------------------------------------------------------------------------
719
720# The QUIET tag can be used to turn on/off the messages that are generated to
721# standard output by doxygen. If QUIET is set to YES this implies that the
722# messages are off.
723# The default value is: NO.
724
725QUIET                  = YES
726
727# The WARNINGS tag can be used to turn on/off the warning messages that are
728# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
729# this implies that the warnings are on.
730#
731# Tip: Turn warnings on while writing the documentation.
732# The default value is: YES.
733
734WARNINGS               = YES
735
736# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
737# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
738# will automatically be disabled.
739# The default value is: YES.
740
741WARN_IF_UNDOCUMENTED   = YES
742
743# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
744# potential errors in the documentation, such as not documenting some parameters
745# in a documented function, or documenting parameters that don't exist or using
746# markup commands wrongly.
747# The default value is: YES.
748
749WARN_IF_DOC_ERROR      = YES
750
751# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
752# are documented, but have no documentation for their parameters or return
753# value. If set to NO, doxygen will only warn about wrong or incomplete
754# parameter documentation, but not about the absence of documentation.
755# The default value is: NO.
756
757WARN_NO_PARAMDOC       = YES
758
759# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
760# a warning is encountered.
761# The default value is: NO.
762
763#WARN_AS_ERROR          = NO
764
765# The WARN_FORMAT tag determines the format of the warning messages that doxygen
766# can produce. The string should contain the $file, $line, and $text tags, which
767# will be replaced by the file and line number from which the warning originated
768# and the warning text. Optionally the format may contain $version, which will
769# be replaced by the version of the file (if it could be obtained via
770# FILE_VERSION_FILTER)
771# The default value is: $file:$line: $text.
772
773WARN_FORMAT            = "$file:$line: $text"
774
775# The WARN_LOGFILE tag can be used to specify a file to which warning and error
776# messages should be written. If left blank the output is written to standard
777# error (stderr).
778
779WARN_LOGFILE           = warnings_nrfx.txt
780
781#---------------------------------------------------------------------------
782# Configuration options related to the input files
783#---------------------------------------------------------------------------
784
785# The INPUT tag is used to specify the files and/or directories that contain
786# documented source files. You may enter file names like myfile.cpp or
787# directories like /usr/src/myproject. Separate the files or directories with
788# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
789# Note: If this tag is empty the current directory is searched.
790
791### EDIT THIS ###
792
793INPUT                  = ../helpers \
794                         ../drivers \
795                         ../hal \
796                         ../soc \
797                         ../templates \
798                         ../CHANGELOG.md \
799                         config_dox \
800                         .
801
802# This tag can be used to specify the character encoding of the source files
803# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
804# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
805# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
806# possible encodings.
807# The default value is: UTF-8.
808
809INPUT_ENCODING         = UTF-8
810
811# If the value of the INPUT tag contains directories, you can use the
812# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
813# *.h) to filter out the source-files in the directories.
814#
815# Note that for custom extensions or not directly supported extensions you also
816# need to set EXTENSION_MAPPING for the extension otherwise the files are not
817# read by doxygen.
818#
819# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
820# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
821# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
822# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
823# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
824
825FILE_PATTERNS          = *.h \
826                         *.dox
827
828# The RECURSIVE tag can be used to specify whether or not subdirectories should
829# be searched for input files as well.
830# The default value is: NO.
831
832RECURSIVE              = YES
833
834# The EXCLUDE tag can be used to specify files and/or directories that should be
835# excluded from the INPUT source files. This way you can easily exclude a
836# subdirectory from a directory tree whose root is specified with the INPUT tag.
837#
838# Note that relative paths are relative to the directory from which doxygen is
839# run.
840
841EXCLUDE                =
842
843# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
844# directories that are symbolic links (a Unix file system feature) are excluded
845# from the input.
846# The default value is: NO.
847
848EXCLUDE_SYMLINKS       = NO
849
850# If the value of the INPUT tag contains directories, you can use the
851# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
852# certain files from those directories.
853#
854# Note that the wildcards are matched against the file with absolute path, so to
855# exclude all test directories for example use the pattern */test/*
856
857EXCLUDE_PATTERNS       =
858
859# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
860# (namespaces, classes, functions, etc.) that should be excluded from the
861# output. The symbol name can be a fully qualified name, a word, or if the
862# wildcard * is used, a substring. Examples: ANamespace, AClass,
863# AClass::ANamespace, ANamespace::*Test
864#
865# Note that the wildcards are matched against the file with absolute path, so to
866# exclude all test directories use the pattern */test/*
867
868EXCLUDE_SYMBOLS        =
869
870# The EXAMPLE_PATH tag can be used to specify one or more files or directories
871# that contain example code fragments that are included (see the \include
872# command).
873
874EXAMPLE_PATH           =
875
876# If the value of the EXAMPLE_PATH tag contains directories, you can use the
877# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
878# *.h) to filter out the source-files in the directories. If left blank all
879# files are included.
880
881EXAMPLE_PATTERNS       =
882
883# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
884# searched for input files to be used with the \include or \dontinclude commands
885# irrespective of the value of the RECURSIVE tag.
886# The default value is: NO.
887
888EXAMPLE_RECURSIVE      = NO
889
890# The IMAGE_PATH tag can be used to specify one or more files or directories
891# that contain images that are to be included in the documentation (see the
892# \image command).
893
894IMAGE_PATH             =
895
896# The INPUT_FILTER tag can be used to specify a program that doxygen should
897# invoke to filter for each input file. Doxygen will invoke the filter program
898# by executing (via popen()) the command:
899#
900# <filter> <input-file>
901#
902# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
903# name of an input file. Doxygen will then use the output that the filter
904# program writes to standard output. If FILTER_PATTERNS is specified, this tag
905# will be ignored.
906#
907# Note that the filter must not add or remove lines; it is applied before the
908# code is scanned, but not when the output code is generated. If lines are added
909# or removed, the anchors will not be placed correctly.
910#
911# Note that for custom extensions or not directly supported extensions you also
912# need to set EXTENSION_MAPPING for the extension otherwise the files are not
913# properly processed by doxygen.
914
915INPUT_FILTER           =
916
917# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
918# basis. Doxygen will compare the file name with each pattern and apply the
919# filter if there is a match. The filters are a list of the form: pattern=filter
920# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
921# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
922# patterns match the file name, INPUT_FILTER is applied.
923#
924# Note that for custom extensions or not directly supported extensions you also
925# need to set EXTENSION_MAPPING for the extension otherwise the files are not
926# properly processed by doxygen.
927
928FILTER_PATTERNS        =
929
930# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
931# INPUT_FILTER) will also be used to filter the input files that are used for
932# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
933# The default value is: NO.
934
935FILTER_SOURCE_FILES    = NO
936
937# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
938# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
939# it is also possible to disable source filtering for a specific pattern using
940# *.ext= (so without naming a filter).
941# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
942
943FILTER_SOURCE_PATTERNS =
944
945# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
946# is part of the input, its contents will be placed on the main page
947# (index.html). This can be useful if you have a project on for instance GitHub
948# and want to reuse the introduction page also for the doxygen output.
949
950USE_MDFILE_AS_MAINPAGE =
951
952#---------------------------------------------------------------------------
953# Configuration options related to source browsing
954#---------------------------------------------------------------------------
955
956# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
957# generated. Documented entities will be cross-referenced with these sources.
958#
959# Note: To get rid of all source code in the generated output, make sure that
960# also VERBATIM_HEADERS is set to NO.
961# The default value is: NO.
962
963SOURCE_BROWSER         = NO
964
965# Setting the INLINE_SOURCES tag to YES will include the body of functions,
966# classes and enums directly into the documentation.
967# The default value is: NO.
968
969INLINE_SOURCES         = NO
970
971# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
972# special comment blocks from generated source code fragments. Normal C, C++ and
973# Fortran comments will always remain visible.
974# The default value is: YES.
975
976STRIP_CODE_COMMENTS    = NO
977
978# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
979# function all documented functions referencing it will be listed.
980# The default value is: NO.
981
982REFERENCED_BY_RELATION = NO
983
984# If the REFERENCES_RELATION tag is set to YES then for each documented function
985# all documented entities called/used by that function will be listed.
986# The default value is: NO.
987
988REFERENCES_RELATION    = NO
989
990# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
991# to YES then the hyperlinks from functions in REFERENCES_RELATION and
992# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
993# link to the documentation.
994# The default value is: YES.
995
996REFERENCES_LINK_SOURCE = YES
997
998# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
999# source code will show a tooltip with additional information such as prototype,
1000# brief description and links to the definition and documentation. Since this
1001# will make the HTML file larger and loading of large files a bit slower, you
1002# can opt to disable this feature.
1003# The default value is: YES.
1004# This tag requires that the tag SOURCE_BROWSER is set to YES.
1005
1006#SOURCE_TOOLTIPS        = YES
1007
1008# If the USE_HTAGS tag is set to YES then the references to source code will
1009# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1010# source browser. The htags tool is part of GNU's global source tagging system
1011# (see https://www.gnu.org/software/global/global.html). You will need version
1012# 4.8.6 or higher.
1013#
1014# To use it do the following:
1015# - Install the latest version of global
1016# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1017# - Make sure the INPUT points to the root of the source tree
1018# - Run doxygen as normal
1019#
1020# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1021# tools must be available from the command line (i.e. in the search path).
1022#
1023# The result: instead of the source browser generated by doxygen, the links to
1024# source code will now point to the output of htags.
1025# The default value is: NO.
1026# This tag requires that the tag SOURCE_BROWSER is set to YES.
1027
1028USE_HTAGS              = NO
1029
1030# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1031# verbatim copy of the header file for each class for which an include is
1032# specified. Set to NO to disable this.
1033# See also: Section \class.
1034# The default value is: YES.
1035
1036VERBATIM_HEADERS       = NO
1037
1038# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1039# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1040# cost of reduced performance. This can be particularly helpful with template
1041# rich C++ code for which doxygen's built-in parser lacks the necessary type
1042# information.
1043# Note: The availability of this option depends on whether or not doxygen was
1044# generated with the -Duse-libclang=ON option for CMake.
1045# The default value is: NO.
1046
1047#CLANG_ASSISTED_PARSING = NO
1048
1049# If clang assisted parsing is enabled you can provide the compiler with command
1050# line options that you would normally use when invoking the compiler. Note that
1051# the include paths will already be set by doxygen for the files and directories
1052# specified with INPUT and INCLUDE_PATH.
1053# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1054
1055#CLANG_OPTIONS          =
1056
1057# If clang assisted parsing is enabled you can provide the clang parser with the
1058# path to the compilation database (see:
1059# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1060# were built. This is equivalent to specifying the "-p" option to a clang tool,
1061# such as clang-check. These options will then be passed to the parser.
1062# Note: The availability of this option depends on whether or not doxygen was
1063# generated with the -Duse-libclang=ON option for CMake.
1064# The default value is: 0.
1065
1066#CLANG_COMPILATION_DATABASE_PATH                                        = 0
1067
1068#---------------------------------------------------------------------------
1069# Configuration options related to the alphabetical class index
1070#---------------------------------------------------------------------------
1071
1072# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1073# compounds will be generated. Enable this if the project contains a lot of
1074# classes, structs, unions or interfaces.
1075# The default value is: YES.
1076
1077ALPHABETICAL_INDEX     = NO
1078
1079# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1080# which the alphabetical index list will be split.
1081# Minimum value: 1, maximum value: 20, default value: 5.
1082# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1083
1084COLS_IN_ALPHA_INDEX    = 5
1085
1086# In case all classes in a project start with a common prefix, all classes will
1087# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1088# can be used to specify a prefix (or a list of prefixes) that should be ignored
1089# while generating the index headers.
1090# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1091
1092IGNORE_PREFIX          =
1093
1094#---------------------------------------------------------------------------
1095# Configuration options related to the HTML output
1096#---------------------------------------------------------------------------
1097
1098# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1099# The default value is: YES.
1100
1101GENERATE_HTML          = YES
1102
1103# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1104# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1105# it.
1106# The default directory is: html.
1107# This tag requires that the tag GENERATE_HTML is set to YES.
1108
1109HTML_OUTPUT            = html
1110
1111# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1112# generated HTML page (for example: .htm, .php, .asp).
1113# The default value is: .html.
1114# This tag requires that the tag GENERATE_HTML is set to YES.
1115
1116HTML_FILE_EXTENSION    = .html
1117
1118# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1119# each generated HTML page. If the tag is left blank doxygen will generate a
1120# standard header.
1121#
1122# To get valid HTML the header file that includes any scripts and style sheets
1123# that doxygen needs, which is dependent on the configuration options used (e.g.
1124# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1125# default header using
1126# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1127# YourConfigFile
1128# and then modify the file new_header.html. See also section "Doxygen usage"
1129# for information on how to generate the default header that doxygen normally
1130# uses.
1131# Note: The header is subject to change so you typically have to regenerate the
1132# default header when upgrading to a newer version of doxygen. For a description
1133# of the possible markers and block names see the documentation.
1134# This tag requires that the tag GENERATE_HTML is set to YES.
1135
1136HTML_HEADER            = buildfiles/header.html
1137
1138# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1139# generated HTML page. If the tag is left blank doxygen will generate a standard
1140# footer. See HTML_HEADER for more information on how to generate a default
1141# footer and what special commands can be used inside the footer. See also
1142# section "Doxygen usage" for information on how to generate the default footer
1143# that doxygen normally uses.
1144# This tag requires that the tag GENERATE_HTML is set to YES.
1145
1146HTML_FOOTER            = buildfiles/footer.html
1147
1148# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1149# sheet that is used by each HTML page. It can be used to fine-tune the look of
1150# the HTML output. If left blank doxygen will generate a default style sheet.
1151# See also section "Doxygen usage" for information on how to generate the style
1152# sheet that doxygen normally uses.
1153# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1154# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1155# obsolete.
1156# This tag requires that the tag GENERATE_HTML is set to YES.
1157
1158HTML_STYLESHEET        =
1159
1160# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1161# cascading style sheets that are included after the standard style sheets
1162# created by doxygen. Using this option one can overrule certain style aspects.
1163# This is preferred over using HTML_STYLESHEET since it does not replace the
1164# standard style sheet and is therefore more robust against future updates.
1165# Doxygen will copy the style sheet files to the output directory.
1166# Note: The order of the extra style sheet files is of importance (e.g. the last
1167# style sheet in the list overrules the setting of the previous ones in the
1168# list). For an example see the documentation.
1169# This tag requires that the tag GENERATE_HTML is set to YES.
1170
1171HTML_EXTRA_STYLESHEET  = buildfiles/extra_stylesheet.css
1172
1173# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1174# other source files which should be copied to the HTML output directory. Note
1175# that these files will be copied to the base HTML output directory. Use the
1176# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1177# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1178# files will be copied as-is; there are no commands or markers available.
1179# This tag requires that the tag GENERATE_HTML is set to YES.
1180
1181HTML_EXTRA_FILES       = buildfiles/favicon.ico
1182
1183# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1184# will adjust the colors in the style sheet and background images according to
1185# this color. Hue is specified as an angle on a colorwheel, see
1186# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1187# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1188# purple, and 360 is red again.
1189# Minimum value: 0, maximum value: 359, default value: 220.
1190# This tag requires that the tag GENERATE_HTML is set to YES.
1191
1192HTML_COLORSTYLE_HUE    = 196
1193
1194# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1195# in the HTML output. For a value of 0 the output will use grayscales only. A
1196# value of 255 will produce the most vivid colors.
1197# Minimum value: 0, maximum value: 255, default value: 100.
1198# This tag requires that the tag GENERATE_HTML is set to YES.
1199
1200HTML_COLORSTYLE_SAT    = 46
1201
1202# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1203# luminance component of the colors in the HTML output. Values below 100
1204# gradually make the output lighter, whereas values above 100 make the output
1205# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1206# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1207# change the gamma.
1208# Minimum value: 40, maximum value: 240, default value: 80.
1209# This tag requires that the tag GENERATE_HTML is set to YES.
1210
1211HTML_COLORSTYLE_GAMMA  = 92
1212
1213# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1214# page will contain the date and time when the page was generated. Setting this
1215# to YES can help to show when doxygen was last run and thus if the
1216# documentation is up to date.
1217# The default value is: NO.
1218# This tag requires that the tag GENERATE_HTML is set to YES.
1219
1220HTML_TIMESTAMP         = YES
1221
1222# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1223# documentation will contain a main index with vertical navigation menus that
1224# are dynamically created via Javascript. If disabled, the navigation index will
1225# consists of multiple levels of tabs that are statically embedded in every HTML
1226# page. Disable this option to support browsers that do not have Javascript,
1227# like the Qt help browser.
1228# The default value is: YES.
1229# This tag requires that the tag GENERATE_HTML is set to YES.
1230
1231#HTML_DYNAMIC_MENUS     = YES
1232
1233# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1234# documentation will contain sections that can be hidden and shown after the
1235# page has loaded.
1236# The default value is: NO.
1237# This tag requires that the tag GENERATE_HTML is set to YES.
1238
1239HTML_DYNAMIC_SECTIONS  = NO
1240
1241# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1242# shown in the various tree structured indices initially; the user can expand
1243# and collapse entries dynamically later on. Doxygen will expand the tree to
1244# such a level that at most the specified number of entries are visible (unless
1245# a fully collapsed tree already exceeds this amount). So setting the number of
1246# entries 1 will produce a full collapsed tree by default. 0 is a special value
1247# representing an infinite number of entries and will result in a full expanded
1248# tree by default.
1249# Minimum value: 0, maximum value: 9999, default value: 100.
1250# This tag requires that the tag GENERATE_HTML is set to YES.
1251
1252HTML_INDEX_NUM_ENTRIES = 100
1253
1254# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1255# generated that can be used as input for Apple's Xcode 3 integrated development
1256# environment (see: https://developer.apple.com/tools/xcode/), introduced with
1257# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1258# Makefile in the HTML output directory. Running make will produce the docset in
1259# that directory and running make install will install the docset in
1260# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1261# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1262# for more information.
1263# The default value is: NO.
1264# This tag requires that the tag GENERATE_HTML is set to YES.
1265
1266GENERATE_DOCSET        = NO
1267
1268# This tag determines the name of the docset feed. A documentation feed provides
1269# an umbrella under which multiple documentation sets from a single provider
1270# (such as a company or product suite) can be grouped.
1271# The default value is: Doxygen generated docs.
1272# This tag requires that the tag GENERATE_DOCSET is set to YES.
1273
1274DOCSET_FEEDNAME        = "Doxygen generated docs"
1275
1276# This tag specifies a string that should uniquely identify the documentation
1277# set bundle. This should be a reverse domain-name style string, e.g.
1278# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1279# The default value is: org.doxygen.Project.
1280# This tag requires that the tag GENERATE_DOCSET is set to YES.
1281
1282DOCSET_BUNDLE_ID       = org.doxygen.Project
1283
1284# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1285# the documentation publisher. This should be a reverse domain-name style
1286# string, e.g. com.mycompany.MyDocSet.documentation.
1287# The default value is: org.doxygen.Publisher.
1288# This tag requires that the tag GENERATE_DOCSET is set to YES.
1289
1290DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
1291
1292# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1293# The default value is: Publisher.
1294# This tag requires that the tag GENERATE_DOCSET is set to YES.
1295
1296DOCSET_PUBLISHER_NAME  = Publisher
1297
1298# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1299# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1300# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1301# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1302# Windows.
1303#
1304# The HTML Help Workshop contains a compiler that can convert all HTML output
1305# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1306# files are now used as the Windows 98 help format, and will replace the old
1307# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1308# HTML files also contain an index, a table of contents, and you can search for
1309# words in the documentation. The HTML workshop also contains a viewer for
1310# compressed HTML files.
1311# The default value is: NO.
1312# This tag requires that the tag GENERATE_HTML is set to YES.
1313
1314GENERATE_HTMLHELP      = NO
1315
1316# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1317# file. You can add a path in front of the file if the result should not be
1318# written to the html output directory.
1319# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1320
1321CHM_FILE               =
1322
1323# The HHC_LOCATION tag can be used to specify the location (absolute path
1324# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1325# doxygen will try to run the HTML help compiler on the generated index.hhp.
1326# The file has to be specified with full path.
1327# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1328
1329HHC_LOCATION           =
1330
1331# The GENERATE_CHI flag controls if a separate .chi index file is generated
1332# (YES) or that it should be included in the master .chm file (NO).
1333# The default value is: NO.
1334# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1335
1336GENERATE_CHI           = NO
1337
1338# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1339# and project file content.
1340# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1341
1342CHM_INDEX_ENCODING     =
1343
1344# The BINARY_TOC flag controls whether a binary table of contents is generated
1345# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1346# enables the Previous and Next buttons.
1347# The default value is: NO.
1348# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1349
1350BINARY_TOC             = NO
1351
1352# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1353# the table of contents of the HTML help documentation and to the tree view.
1354# The default value is: NO.
1355# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1356
1357TOC_EXPAND             = NO
1358
1359# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1360# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1361# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1362# (.qch) of the generated HTML documentation.
1363# The default value is: NO.
1364# This tag requires that the tag GENERATE_HTML is set to YES.
1365
1366GENERATE_QHP           = NO
1367
1368# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1369# the file name of the resulting .qch file. The path specified is relative to
1370# the HTML output folder.
1371# This tag requires that the tag GENERATE_QHP is set to YES.
1372
1373QCH_FILE               =
1374
1375# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1376# Project output. For more information please see Qt Help Project / Namespace
1377# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace).
1378# The default value is: org.doxygen.Project.
1379# This tag requires that the tag GENERATE_QHP is set to YES.
1380
1381QHP_NAMESPACE          = org.doxygen.Project
1382
1383# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1384# Help Project output. For more information please see Qt Help Project / Virtual
1385# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders).
1386# The default value is: doc.
1387# This tag requires that the tag GENERATE_QHP is set to YES.
1388
1389QHP_VIRTUAL_FOLDER     = doc
1390
1391# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1392# filter to add. For more information please see Qt Help Project / Custom
1393# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
1394# This tag requires that the tag GENERATE_QHP is set to YES.
1395
1396QHP_CUST_FILTER_NAME   =
1397
1398# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1399# custom filter to add. For more information please see Qt Help Project / Custom
1400# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters).
1401# This tag requires that the tag GENERATE_QHP is set to YES.
1402
1403QHP_CUST_FILTER_ATTRS  =
1404
1405# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1406# project's filter section matches. Qt Help Project / Filter Attributes (see:
1407# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes).
1408# This tag requires that the tag GENERATE_QHP is set to YES.
1409
1410QHP_SECT_FILTER_ATTRS  =
1411
1412# The QHG_LOCATION tag can be used to specify the location of Qt's
1413# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1414# generated .qhp file.
1415# This tag requires that the tag GENERATE_QHP is set to YES.
1416
1417QHG_LOCATION           =
1418
1419# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1420# generated, together with the HTML files, they form an Eclipse help plugin. To
1421# install this plugin and make it available under the help contents menu in
1422# Eclipse, the contents of the directory containing the HTML and XML files needs
1423# to be copied into the plugins directory of eclipse. The name of the directory
1424# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1425# After copying Eclipse needs to be restarted before the help appears.
1426# The default value is: NO.
1427# This tag requires that the tag GENERATE_HTML is set to YES.
1428
1429GENERATE_ECLIPSEHELP   = YES
1430
1431# A unique identifier for the Eclipse help plugin. When installing the plugin
1432# the directory name containing the HTML and XML files should also have this
1433# name. Each documentation set should have its own identifier.
1434# The default value is: org.doxygen.Project.
1435# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1436
1437ECLIPSE_DOC_ID         = com.nordic.infocenter.nrfx
1438
1439# If you want full control over the layout of the generated HTML pages it might
1440# be necessary to disable the index and replace it with your own. The
1441# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1442# of each HTML page. A value of NO enables the index and the value YES disables
1443# it. Since the tabs in the index contain the same information as the navigation
1444# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1445# The default value is: NO.
1446# This tag requires that the tag GENERATE_HTML is set to YES.
1447
1448### EDIT THIS ###
1449
1450DISABLE_INDEX          = YES
1451
1452# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1453# structure should be generated to display hierarchical information. If the tag
1454# value is set to YES, a side panel will be generated containing a tree-like
1455# index structure (just like the one that is generated for HTML Help). For this
1456# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1457# (i.e. any modern browser). Windows users are probably better off using the
1458# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1459# further fine-tune the look of the index. As an example, the default style
1460# sheet generated by doxygen has an example that shows how to put an image at
1461# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1462# the same information as the tab index, you could consider setting
1463# DISABLE_INDEX to YES when enabling this option.
1464# The default value is: NO.
1465# This tag requires that the tag GENERATE_HTML is set to YES.
1466
1467GENERATE_TREEVIEW      = YES
1468
1469# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1470# doxygen will group on one line in the generated HTML documentation.
1471#
1472# Note that a value of 0 will completely suppress the enum values from appearing
1473# in the overview section.
1474# Minimum value: 0, maximum value: 20, default value: 4.
1475# This tag requires that the tag GENERATE_HTML is set to YES.
1476
1477ENUM_VALUES_PER_LINE   = 1
1478
1479# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1480# to set the initial width (in pixels) of the frame in which the tree is shown.
1481# Minimum value: 0, maximum value: 1500, default value: 250.
1482# This tag requires that the tag GENERATE_HTML is set to YES.
1483
1484TREEVIEW_WIDTH         = 250
1485
1486# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1487# external symbols imported via tag files in a separate window.
1488# The default value is: NO.
1489# This tag requires that the tag GENERATE_HTML is set to YES.
1490
1491EXT_LINKS_IN_WINDOW    = NO
1492
1493# Use this tag to change the font size of LaTeX formulas included as images in
1494# the HTML documentation. When you change the font size after a successful
1495# doxygen run you need to manually remove any form_*.png images from the HTML
1496# output directory to force them to be regenerated.
1497# Minimum value: 8, maximum value: 50, default value: 10.
1498# This tag requires that the tag GENERATE_HTML is set to YES.
1499
1500FORMULA_FONTSIZE       = 10
1501
1502# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1503# generated for formulas are transparent PNGs. Transparent PNGs are not
1504# supported properly for IE 6.0, but are supported on all modern browsers.
1505#
1506# Note that when changing this option you need to delete any form_*.png files in
1507# the HTML output directory before the changes have effect.
1508# The default value is: YES.
1509# This tag requires that the tag GENERATE_HTML is set to YES.
1510
1511FORMULA_TRANSPARENT    = YES
1512
1513# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1514# https://www.mathjax.org) which uses client side Javascript for the rendering
1515# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1516# installed or if you want to formulas look prettier in the HTML output. When
1517# enabled you may also need to install MathJax separately and configure the path
1518# to it using the MATHJAX_RELPATH option.
1519# The default value is: NO.
1520# This tag requires that the tag GENERATE_HTML is set to YES.
1521
1522USE_MATHJAX            = NO
1523
1524# When MathJax is enabled you can set the default output format to be used for
1525# the MathJax output. See the MathJax site (see:
1526# http://docs.mathjax.org/en/latest/output.html) for more details.
1527# Possible values are: HTML-CSS (which is slower, but has the best
1528# compatibility), NativeMML (i.e. MathML) and SVG.
1529# The default value is: HTML-CSS.
1530# This tag requires that the tag USE_MATHJAX is set to YES.
1531
1532MATHJAX_FORMAT         = HTML-CSS
1533
1534# When MathJax is enabled you need to specify the location relative to the HTML
1535# output directory using the MATHJAX_RELPATH option. The destination directory
1536# should contain the MathJax.js script. For instance, if the mathjax directory
1537# is located at the same level as the HTML output directory, then
1538# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1539# Content Delivery Network so you can quickly see the result without installing
1540# MathJax. However, it is strongly recommended to install a local copy of
1541# MathJax from https://www.mathjax.org before deployment.
1542# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/.
1543# This tag requires that the tag USE_MATHJAX is set to YES.
1544
1545MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
1546
1547# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1548# extension names that should be enabled during MathJax rendering. For example
1549# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1550# This tag requires that the tag USE_MATHJAX is set to YES.
1551
1552MATHJAX_EXTENSIONS     =
1553
1554# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1555# of code that will be used on startup of the MathJax code. See the MathJax site
1556# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1557# example see the documentation.
1558# This tag requires that the tag USE_MATHJAX is set to YES.
1559
1560#MATHJAX_CODEFILE       =
1561
1562# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1563# the HTML output. The underlying search engine uses javascript and DHTML and
1564# should work on any modern browser. Note that when using HTML help
1565# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1566# there is already a search function so this one should typically be disabled.
1567# For large projects the javascript based search engine can be slow, then
1568# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1569# search using the keyboard; to jump to the search box use <access key> + S
1570# (what the <access key> is depends on the OS and browser, but it is typically
1571# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1572# key> to jump into the search results window, the results can be navigated
1573# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1574# the search. The filter options can be selected when the cursor is inside the
1575# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1576# to select a filter and <Enter> or <escape> to activate or cancel the filter
1577# option.
1578# The default value is: YES.
1579# This tag requires that the tag GENERATE_HTML is set to YES.
1580
1581SEARCHENGINE           = YES
1582
1583# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1584# implemented using a web server instead of a web client using Javascript. There
1585# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1586# setting. When disabled, doxygen will generate a PHP script for searching and
1587# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1588# and searching needs to be provided by external tools. See the section
1589# "External Indexing and Searching" for details.
1590# The default value is: NO.
1591# This tag requires that the tag SEARCHENGINE is set to YES.
1592
1593SERVER_BASED_SEARCH    = NO
1594
1595# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1596# script for searching. Instead the search results are written to an XML file
1597# which needs to be processed by an external indexer. Doxygen will invoke an
1598# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1599# search results.
1600#
1601# Doxygen ships with an example indexer (doxyindexer) and search engine
1602# (doxysearch.cgi) which are based on the open source search engine library
1603# Xapian (see: https://xapian.org/).
1604#
1605# See the section "External Indexing and Searching" for details.
1606# The default value is: NO.
1607# This tag requires that the tag SEARCHENGINE is set to YES.
1608
1609EXTERNAL_SEARCH        = NO
1610
1611# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1612# which will return the search results when EXTERNAL_SEARCH is enabled.
1613#
1614# Doxygen ships with an example indexer (doxyindexer) and search engine
1615# (doxysearch.cgi) which are based on the open source search engine library
1616# Xapian (see: https://xapian.org/). See the section "External Indexing and
1617# Searching" for details.
1618# This tag requires that the tag SEARCHENGINE is set to YES.
1619
1620SEARCHENGINE_URL       =
1621
1622# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1623# search data is written to a file for indexing by an external tool. With the
1624# SEARCHDATA_FILE tag the name of this file can be specified.
1625# The default file is: searchdata.xml.
1626# This tag requires that the tag SEARCHENGINE is set to YES.
1627
1628SEARCHDATA_FILE        = searchdata.xml
1629
1630# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1631# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1632# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1633# projects and redirect the results back to the right project.
1634# This tag requires that the tag SEARCHENGINE is set to YES.
1635
1636EXTERNAL_SEARCH_ID     =
1637
1638# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1639# projects other than the one defined by this configuration file, but that are
1640# all added to the same external search index. Each project needs to have a
1641# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1642# to a relative location where the documentation can be found. The format is:
1643# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1644# This tag requires that the tag SEARCHENGINE is set to YES.
1645
1646EXTRA_SEARCH_MAPPINGS  =
1647
1648#---------------------------------------------------------------------------
1649# Configuration options related to the LaTeX output
1650#---------------------------------------------------------------------------
1651
1652# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1653# The default value is: YES.
1654
1655GENERATE_LATEX         = NO
1656
1657# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1658# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1659# it.
1660# The default directory is: latex.
1661# This tag requires that the tag GENERATE_LATEX is set to YES.
1662
1663LATEX_OUTPUT           = latex
1664
1665# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1666# invoked.
1667#
1668# Note that when enabling USE_PDFLATEX this option is only used for generating
1669# bitmaps for formulas in the HTML output, but not in the Makefile that is
1670# written to the output directory.
1671# The default file is: latex.
1672# This tag requires that the tag GENERATE_LATEX is set to YES.
1673
1674LATEX_CMD_NAME         = latex
1675
1676# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1677# index for LaTeX.
1678# The default file is: makeindex.
1679# This tag requires that the tag GENERATE_LATEX is set to YES.
1680
1681MAKEINDEX_CMD_NAME     = makeindex
1682
1683# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1684# documents. This may be useful for small projects and may help to save some
1685# trees in general.
1686# The default value is: NO.
1687# This tag requires that the tag GENERATE_LATEX is set to YES.
1688
1689COMPACT_LATEX          = NO
1690
1691# The PAPER_TYPE tag can be used to set the paper type that is used by the
1692# printer.
1693# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1694# 14 inches) and executive (7.25 x 10.5 inches).
1695# The default value is: a4.
1696# This tag requires that the tag GENERATE_LATEX is set to YES.
1697
1698PAPER_TYPE             = a4
1699
1700# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1701# that should be included in the LaTeX output. The package can be specified just
1702# by its name or with the correct syntax as to be used with the LaTeX
1703# \usepackage command. To get the times font for instance you can specify :
1704# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1705# To use the option intlimits with the amsmath package you can specify:
1706# EXTRA_PACKAGES=[intlimits]{amsmath}
1707# If left blank no extra packages will be included.
1708# This tag requires that the tag GENERATE_LATEX is set to YES.
1709
1710EXTRA_PACKAGES         =
1711
1712# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1713# generated LaTeX document. The header should contain everything until the first
1714# chapter. If it is left blank doxygen will generate a standard header. See
1715# section "Doxygen usage" for information on how to let doxygen write the
1716# default header to a separate file.
1717#
1718# Note: Only use a user-defined header if you know what you are doing! The
1719# following commands have a special meaning inside the header: $title,
1720# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1721# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1722# string, for the replacement values of the other commands the user is referred
1723# to HTML_HEADER.
1724# This tag requires that the tag GENERATE_LATEX is set to YES.
1725
1726LATEX_HEADER           =
1727
1728# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1729# generated LaTeX document. The footer should contain everything after the last
1730# chapter. If it is left blank doxygen will generate a standard footer. See
1731# LATEX_HEADER for more information on how to generate a default footer and what
1732# special commands can be used inside the footer.
1733#
1734# Note: Only use a user-defined footer if you know what you are doing!
1735# This tag requires that the tag GENERATE_LATEX is set to YES.
1736
1737LATEX_FOOTER           =
1738
1739# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1740# LaTeX style sheets that are included after the standard style sheets created
1741# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1742# will copy the style sheet files to the output directory.
1743# Note: The order of the extra style sheet files is of importance (e.g. the last
1744# style sheet in the list overrules the setting of the previous ones in the
1745# list).
1746# This tag requires that the tag GENERATE_LATEX is set to YES.
1747
1748#LATEX_EXTRA_STYLESHEET =
1749
1750# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1751# other source files which should be copied to the LATEX_OUTPUT output
1752# directory. Note that the files will be copied as-is; there are no commands or
1753# markers available.
1754# This tag requires that the tag GENERATE_LATEX is set to YES.
1755
1756#LATEX_EXTRA_FILES      =
1757
1758# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1759# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1760# contain links (just like the HTML output) instead of page references. This
1761# makes the output suitable for online browsing using a PDF viewer.
1762# The default value is: YES.
1763# This tag requires that the tag GENERATE_LATEX is set to YES.
1764
1765PDF_HYPERLINKS         = YES
1766
1767# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1768# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1769# higher quality PDF documentation.
1770# The default value is: YES.
1771# This tag requires that the tag GENERATE_LATEX is set to YES.
1772
1773USE_PDFLATEX           = YES
1774
1775# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1776# command to the generated LaTeX files. This will instruct LaTeX to keep running
1777# if errors occur, instead of asking the user for help. This option is also used
1778# when generating formulas in HTML.
1779# The default value is: NO.
1780# This tag requires that the tag GENERATE_LATEX is set to YES.
1781
1782LATEX_BATCHMODE        = NO
1783
1784# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1785# index chapters (such as File Index, Compound Index, etc.) in the output.
1786# The default value is: NO.
1787# This tag requires that the tag GENERATE_LATEX is set to YES.
1788
1789LATEX_HIDE_INDICES     = NO
1790
1791# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1792# code with syntax highlighting in the LaTeX output.
1793#
1794# Note that which sources are shown also depends on other settings such as
1795# SOURCE_BROWSER.
1796# The default value is: NO.
1797# This tag requires that the tag GENERATE_LATEX is set to YES.
1798
1799LATEX_SOURCE_CODE      = NO
1800
1801# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1802# bibliography, e.g. plainnat, or ieeetr. See
1803# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1804# The default value is: plain.
1805# This tag requires that the tag GENERATE_LATEX is set to YES.
1806
1807LATEX_BIB_STYLE        = plain
1808
1809# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1810# page will contain the date and time when the page was generated. Setting this
1811# to NO can help when comparing the output of multiple runs.
1812# The default value is: NO.
1813# This tag requires that the tag GENERATE_LATEX is set to YES.
1814
1815#LATEX_TIMESTAMP        = NO
1816
1817#---------------------------------------------------------------------------
1818# Configuration options related to the RTF output
1819#---------------------------------------------------------------------------
1820
1821# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1822# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1823# readers/editors.
1824# The default value is: NO.
1825
1826GENERATE_RTF           = NO
1827
1828# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1829# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1830# it.
1831# The default directory is: rtf.
1832# This tag requires that the tag GENERATE_RTF is set to YES.
1833
1834RTF_OUTPUT             = rtf
1835
1836# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1837# documents. This may be useful for small projects and may help to save some
1838# trees in general.
1839# The default value is: NO.
1840# This tag requires that the tag GENERATE_RTF is set to YES.
1841
1842COMPACT_RTF            = NO
1843
1844# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1845# contain hyperlink fields. The RTF file will contain links (just like the HTML
1846# output) instead of page references. This makes the output suitable for online
1847# browsing using Word or some other Word compatible readers that support those
1848# fields.
1849#
1850# Note: WordPad (write) and others do not support links.
1851# The default value is: NO.
1852# This tag requires that the tag GENERATE_RTF is set to YES.
1853
1854RTF_HYPERLINKS         = NO
1855
1856# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1857# file, i.e. a series of assignments. You only have to provide replacements,
1858# missing definitions are set to their default value.
1859#
1860# See also section "Doxygen usage" for information on how to generate the
1861# default style sheet that doxygen normally uses.
1862# This tag requires that the tag GENERATE_RTF is set to YES.
1863
1864RTF_STYLESHEET_FILE    =
1865
1866# Set optional variables used in the generation of an RTF document. Syntax is
1867# similar to doxygen's config file. A template extensions file can be generated
1868# using doxygen -e rtf extensionFile.
1869# This tag requires that the tag GENERATE_RTF is set to YES.
1870
1871RTF_EXTENSIONS_FILE    =
1872
1873# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1874# with syntax highlighting in the RTF output.
1875#
1876# Note that which sources are shown also depends on other settings such as
1877# SOURCE_BROWSER.
1878# The default value is: NO.
1879# This tag requires that the tag GENERATE_RTF is set to YES.
1880
1881#RTF_SOURCE_CODE        = NO
1882
1883#---------------------------------------------------------------------------
1884# Configuration options related to the man page output
1885#---------------------------------------------------------------------------
1886
1887# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1888# classes and files.
1889# The default value is: NO.
1890
1891GENERATE_MAN           = NO
1892
1893# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1894# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1895# it. A directory man3 will be created inside the directory specified by
1896# MAN_OUTPUT.
1897# The default directory is: man.
1898# This tag requires that the tag GENERATE_MAN is set to YES.
1899
1900MAN_OUTPUT             = man
1901
1902# The MAN_EXTENSION tag determines the extension that is added to the generated
1903# man pages. In case the manual section does not start with a number, the number
1904# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1905# optional.
1906# The default value is: .3.
1907# This tag requires that the tag GENERATE_MAN is set to YES.
1908
1909MAN_EXTENSION          = .3
1910
1911# The MAN_SUBDIR tag determines the name of the directory created within
1912# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1913# MAN_EXTENSION with the initial . removed.
1914# This tag requires that the tag GENERATE_MAN is set to YES.
1915
1916#MAN_SUBDIR             =
1917
1918# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1919# will generate one additional man file for each entity documented in the real
1920# man page(s). These additional files only source the real man page, but without
1921# them the man command would be unable to find the correct page.
1922# The default value is: NO.
1923# This tag requires that the tag GENERATE_MAN is set to YES.
1924
1925MAN_LINKS              = NO
1926
1927#---------------------------------------------------------------------------
1928# Configuration options related to the XML output
1929#---------------------------------------------------------------------------
1930
1931# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1932# captures the structure of the code including all documentation.
1933# The default value is: NO.
1934
1935GENERATE_XML           = NO
1936
1937# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1938# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1939# it.
1940# The default directory is: xml.
1941# This tag requires that the tag GENERATE_XML is set to YES.
1942
1943XML_OUTPUT             = xml
1944
1945# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1946# listings (including syntax highlighting and cross-referencing information) to
1947# the XML output. Note that enabling this will significantly increase the size
1948# of the XML output.
1949# The default value is: YES.
1950# This tag requires that the tag GENERATE_XML is set to YES.
1951
1952XML_PROGRAMLISTING     = YES
1953
1954#---------------------------------------------------------------------------
1955# Configuration options related to the DOCBOOK output
1956#---------------------------------------------------------------------------
1957
1958# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1959# that can be used to generate PDF.
1960# The default value is: NO.
1961
1962#GENERATE_DOCBOOK       = NO
1963
1964# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1965# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1966# front of it.
1967# The default directory is: docbook.
1968# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1969
1970#DOCBOOK_OUTPUT         = docbook
1971
1972# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1973# program listings (including syntax highlighting and cross-referencing
1974# information) to the DOCBOOK output. Note that enabling this will significantly
1975# increase the size of the DOCBOOK output.
1976# The default value is: NO.
1977# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1978
1979#DOCBOOK_PROGRAMLISTING = NO
1980
1981#---------------------------------------------------------------------------
1982# Configuration options for the AutoGen Definitions output
1983#---------------------------------------------------------------------------
1984
1985# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
1986# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
1987# the structure of the code including all documentation. Note that this feature
1988# is still experimental and incomplete at the moment.
1989# The default value is: NO.
1990
1991GENERATE_AUTOGEN_DEF   = NO
1992
1993#---------------------------------------------------------------------------
1994# Configuration options related to the Perl module output
1995#---------------------------------------------------------------------------
1996
1997# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
1998# file that captures the structure of the code including all documentation.
1999#
2000# Note that this feature is still experimental and incomplete at the moment.
2001# The default value is: NO.
2002
2003GENERATE_PERLMOD       = NO
2004
2005# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2006# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2007# output from the Perl module output.
2008# The default value is: NO.
2009# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2010
2011PERLMOD_LATEX          = NO
2012
2013# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2014# formatted so it can be parsed by a human reader. This is useful if you want to
2015# understand what is going on. On the other hand, if this tag is set to NO, the
2016# size of the Perl module output will be much smaller and Perl will parse it
2017# just the same.
2018# The default value is: YES.
2019# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2020
2021PERLMOD_PRETTY         = YES
2022
2023# The names of the make variables in the generated doxyrules.make file are
2024# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2025# so different doxyrules.make files included by the same Makefile don't
2026# overwrite each other's variables.
2027# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2028
2029PERLMOD_MAKEVAR_PREFIX =
2030
2031#---------------------------------------------------------------------------
2032# Configuration options related to the preprocessor
2033#---------------------------------------------------------------------------
2034
2035# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2036# C-preprocessor directives found in the sources and include files.
2037# The default value is: YES.
2038
2039ENABLE_PREPROCESSING   = YES
2040
2041# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2042# in the source code. If set to NO, only conditional compilation will be
2043# performed. Macro expansion can be done in a controlled way by setting
2044# EXPAND_ONLY_PREDEF to YES.
2045# The default value is: NO.
2046# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2047
2048MACRO_EXPANSION        = YES
2049
2050# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2051# the macro expansion is limited to the macros specified with the PREDEFINED and
2052# EXPAND_AS_DEFINED tags.
2053# The default value is: NO.
2054# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2055
2056EXPAND_ONLY_PREDEF     = NO
2057
2058# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2059# INCLUDE_PATH will be searched if a #include is found.
2060# The default value is: YES.
2061# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2062
2063SEARCH_INCLUDES        = YES
2064
2065# The INCLUDE_PATH tag can be used to specify one or more directories that
2066# contain include files that are not input files but should be processed by the
2067# preprocessor.
2068# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2069
2070INCLUDE_PATH           =
2071
2072# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2073# patterns (like *.h and *.hpp) to filter out the header-files in the
2074# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2075# used.
2076# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2077
2078INCLUDE_FILE_PATTERNS  =
2079
2080# The PREDEFINED tag can be used to specify one or more macro names that are
2081# defined before the preprocessor is started (similar to the -D option of e.g.
2082# gcc). The argument of the tag is a list of macros of the form: name or
2083# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2084# is assumed. To prevent a macro definition from being undefined via #undef or
2085# recursively expanded use the := operator instead of the = operator.
2086# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2087
2088PREDEFINED             = SUPPRESS_INLINE_IMPLEMENTATION \
2089                         __NRFX_DOXYGEN__ \
2090                         CONFIG_PURGE_ENABLED \
2091                         == \
2092                         1 \
2093                         CONFIG_DISASSOCIATE_ENABLED \
2094                         == \
2095                         1 \
2096                         CONFIG_GTS_ENABLED \
2097                         == \
2098                         1 \
2099                         CONFIG_ORPHAN_ENABLED \
2100                         == \
2101                         1 \
2102                         CONFIG_RXE_ENABLED \
2103                         == \
2104                         1 \
2105                         CONFIG_START_ENABLED \
2106                         == \
2107                         1 \
2108                         CONFIG_SYNC_ENABLED \
2109                         == \
2110                         1 \
2111                         CONFIG_PANID_CONFLICT_ENABLED \
2112                         == \
2113                         1
2114
2115# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2116# tag can be used to specify a list of macro names that should be expanded. The
2117# macro definition that is found in the sources will be used. Use the PREDEFINED
2118# tag if you want to use a different macro definition that overrules the
2119# definition found in the source code.
2120# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2121
2122EXPAND_AS_DEFINED      =
2123
2124# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2125# remove all references to function-like macros that are alone on a line, have
2126# an all uppercase name, and do not end with a semicolon. Such function macros
2127# are typically used for boiler-plate code, and will confuse the parser if not
2128# removed.
2129# The default value is: YES.
2130# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2131
2132SKIP_FUNCTION_MACROS   = YES
2133
2134#---------------------------------------------------------------------------
2135# Configuration options related to external references
2136#---------------------------------------------------------------------------
2137
2138# The TAGFILES tag can be used to specify one or more tag files. For each tag
2139# file the location of the external documentation should be added. The format of
2140# a tag file without this location is as follows:
2141# TAGFILES = file1 file2 ...
2142# Adding location for the tag files is done as follows:
2143# TAGFILES = file1=loc1 "file2 = loc2" ...
2144# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2145# section "Linking to external documentation" for more information about the use
2146# of tag files.
2147# Note: Each tag file must have a unique name (where the name does NOT include
2148# the path). If a tag file is not located in the directory in which doxygen is
2149# run, you must also specify the path to the tagfile here.
2150
2151TAGFILES               =
2152
2153# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2154# tag file that is based on the input files it reads. See section "Linking to
2155# external documentation" for more information about the usage of tag files.
2156
2157### EDIT THIS ###
2158
2159GENERATE_TAGFILE       =
2160
2161# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2162# the class index. If set to NO, only the inherited external classes will be
2163# listed.
2164# The default value is: NO.
2165
2166ALLEXTERNALS           = NO
2167
2168# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2169# in the modules index. If set to NO, only the current project's groups will be
2170# listed.
2171# The default value is: YES.
2172
2173EXTERNAL_GROUPS        = NO
2174
2175# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2176# the related pages index. If set to NO, only the current project's pages will
2177# be listed.
2178# The default value is: YES.
2179
2180#EXTERNAL_PAGES         = YES
2181
2182# The PERL_PATH should be the absolute path and name of the perl script
2183# interpreter (i.e. the result of 'which perl').
2184# The default file (with absolute path) is: /usr/bin/perl.
2185
2186PERL_PATH              = /usr/bin/perl
2187
2188#---------------------------------------------------------------------------
2189# Configuration options related to the dot tool
2190#---------------------------------------------------------------------------
2191
2192# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2193# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2194# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2195# disabled, but it is recommended to install and use dot, since it yields more
2196# powerful graphs.
2197# The default value is: YES.
2198
2199CLASS_DIAGRAMS         = YES
2200
2201# You can define message sequence charts within doxygen comments using the \msc
2202# command. Doxygen will then run the mscgen tool (see:
2203# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2204# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2205# the mscgen tool resides. If left empty the tool is assumed to be found in the
2206# default search path.
2207
2208MSCGEN_PATH            =
2209
2210# You can include diagrams made with dia in doxygen documentation. Doxygen will
2211# then run dia to produce the diagram and insert it in the documentation. The
2212# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2213# If left empty dia is assumed to be found in the default search path.
2214
2215#DIA_PATH               =
2216
2217# If set to YES the inheritance and collaboration graphs will hide inheritance
2218# and usage relations if the target is undocumented or is not a class.
2219# The default value is: YES.
2220
2221HIDE_UNDOC_RELATIONS   = YES
2222
2223# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2224# available from the path. This tool is part of Graphviz (see:
2225# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2226# Bell Labs. The other options in this section have no effect if this option is
2227# set to NO
2228# The default value is: NO.
2229
2230HAVE_DOT               = NO
2231
2232# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2233# to run in parallel. When set to 0 doxygen will base this on the number of
2234# processors available in the system. You can set it explicitly to a value
2235# larger than 0 to get control over the balance between CPU load and processing
2236# speed.
2237# Minimum value: 0, maximum value: 32, default value: 0.
2238# This tag requires that the tag HAVE_DOT is set to YES.
2239
2240DOT_NUM_THREADS        = 0
2241
2242# When you want a differently looking font in the dot files that doxygen
2243# generates you can specify the font name using DOT_FONTNAME. You need to make
2244# sure dot is able to find the font, which can be done by putting it in a
2245# standard location or by setting the DOTFONTPATH environment variable or by
2246# setting DOT_FONTPATH to the directory containing the font.
2247# The default value is: Helvetica.
2248# This tag requires that the tag HAVE_DOT is set to YES.
2249
2250DOT_FONTNAME           = Helvetica
2251
2252# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2253# dot graphs.
2254# Minimum value: 4, maximum value: 24, default value: 10.
2255# This tag requires that the tag HAVE_DOT is set to YES.
2256
2257DOT_FONTSIZE           = 10
2258
2259# By default doxygen will tell dot to use the default font as specified with
2260# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2261# the path where dot can find it using this tag.
2262# This tag requires that the tag HAVE_DOT is set to YES.
2263
2264DOT_FONTPATH           =
2265
2266# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2267# each documented class showing the direct and indirect inheritance relations.
2268# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2269# The default value is: YES.
2270# This tag requires that the tag HAVE_DOT is set to YES.
2271
2272CLASS_GRAPH            = YES
2273
2274# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2275# graph for each documented class showing the direct and indirect implementation
2276# dependencies (inheritance, containment, and class references variables) of the
2277# class with other documented classes.
2278# The default value is: YES.
2279# This tag requires that the tag HAVE_DOT is set to YES.
2280
2281COLLABORATION_GRAPH    = YES
2282
2283# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2284# groups, showing the direct groups dependencies.
2285# The default value is: YES.
2286# This tag requires that the tag HAVE_DOT is set to YES.
2287
2288GROUP_GRAPHS           = YES
2289
2290# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2291# collaboration diagrams in a style similar to the OMG's Unified Modeling
2292# Language.
2293# The default value is: NO.
2294# This tag requires that the tag HAVE_DOT is set to YES.
2295
2296UML_LOOK               = NO
2297
2298# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2299# class node. If there are many fields or methods and many nodes the graph may
2300# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2301# number of items for each type to make the size more manageable. Set this to 0
2302# for no limit. Note that the threshold may be exceeded by 50% before the limit
2303# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2304# but if the number exceeds 15, the total amount of fields shown is limited to
2305# 10.
2306# Minimum value: 0, maximum value: 100, default value: 10.
2307# This tag requires that the tag HAVE_DOT is set to YES.
2308
2309UML_LIMIT_NUM_FIELDS   = 10
2310
2311# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2312# collaboration graphs will show the relations between templates and their
2313# instances.
2314# The default value is: NO.
2315# This tag requires that the tag HAVE_DOT is set to YES.
2316
2317TEMPLATE_RELATIONS     = NO
2318
2319# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2320# YES then doxygen will generate a graph for each documented file showing the
2321# direct and indirect include dependencies of the file with other documented
2322# files.
2323# The default value is: YES.
2324# This tag requires that the tag HAVE_DOT is set to YES.
2325
2326INCLUDE_GRAPH          = YES
2327
2328# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2329# set to YES then doxygen will generate a graph for each documented file showing
2330# the direct and indirect include dependencies of the file with other documented
2331# files.
2332# The default value is: YES.
2333# This tag requires that the tag HAVE_DOT is set to YES.
2334
2335INCLUDED_BY_GRAPH      = YES
2336
2337# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2338# dependency graph for every global function or class method.
2339#
2340# Note that enabling this option will significantly increase the time of a run.
2341# So in most cases it will be better to enable call graphs for selected
2342# functions only using the \callgraph command. Disabling a call graph can be
2343# accomplished by means of the command \hidecallgraph.
2344# The default value is: NO.
2345# This tag requires that the tag HAVE_DOT is set to YES.
2346
2347CALL_GRAPH             = NO
2348
2349# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2350# dependency graph for every global function or class method.
2351#
2352# Note that enabling this option will significantly increase the time of a run.
2353# So in most cases it will be better to enable caller graphs for selected
2354# functions only using the \callergraph command. Disabling a caller graph can be
2355# accomplished by means of the command \hidecallergraph.
2356# The default value is: NO.
2357# This tag requires that the tag HAVE_DOT is set to YES.
2358
2359CALLER_GRAPH           = NO
2360
2361# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2362# hierarchy of all classes instead of a textual one.
2363# The default value is: YES.
2364# This tag requires that the tag HAVE_DOT is set to YES.
2365
2366GRAPHICAL_HIERARCHY    = YES
2367
2368# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2369# dependencies a directory has on other directories in a graphical way. The
2370# dependency relations are determined by the #include relations between the
2371# files in the directories.
2372# The default value is: YES.
2373# This tag requires that the tag HAVE_DOT is set to YES.
2374
2375DIRECTORY_GRAPH        = YES
2376
2377# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2378# generated by dot. For an explanation of the image formats see the section
2379# output formats in the documentation of the dot tool (Graphviz (see:
2380# http://www.graphviz.org/)).
2381# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2382# to make the SVG files visible in IE 9+ (other browsers do not have this
2383# requirement).
2384# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2385# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2386# png:gdiplus:gdiplus.
2387# The default value is: png.
2388# This tag requires that the tag HAVE_DOT is set to YES.
2389
2390DOT_IMAGE_FORMAT       = svg
2391
2392# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2393# enable generation of interactive SVG images that allow zooming and panning.
2394#
2395# Note that this requires a modern browser other than Internet Explorer. Tested
2396# and working are Firefox, Chrome, Safari, and Opera.
2397# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2398# the SVG files visible. Older versions of IE do not have SVG support.
2399# The default value is: NO.
2400# This tag requires that the tag HAVE_DOT is set to YES.
2401
2402INTERACTIVE_SVG        = NO
2403
2404# The DOT_PATH tag can be used to specify the path where the dot tool can be
2405# found. If left blank, it is assumed the dot tool can be found in the path.
2406# This tag requires that the tag HAVE_DOT is set to YES.
2407
2408DOT_PATH               =
2409
2410# The DOTFILE_DIRS tag can be used to specify one or more directories that
2411# contain dot files that are included in the documentation (see the \dotfile
2412# command).
2413# This tag requires that the tag HAVE_DOT is set to YES.
2414
2415DOTFILE_DIRS           =
2416
2417# The MSCFILE_DIRS tag can be used to specify one or more directories that
2418# contain msc files that are included in the documentation (see the \mscfile
2419# command).
2420
2421MSCFILE_DIRS           =
2422
2423# The DIAFILE_DIRS tag can be used to specify one or more directories that
2424# contain dia files that are included in the documentation (see the \diafile
2425# command).
2426
2427#DIAFILE_DIRS           =
2428
2429# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2430# path where java can find the plantuml.jar file. If left blank, it is assumed
2431# PlantUML is not used or called during a preprocessing step. Doxygen will
2432# generate a warning when it encounters a \startuml command in this case and
2433# will not generate output for the diagram.
2434
2435#PLANTUML_JAR_PATH      =
2436
2437# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2438# configuration file for plantuml.
2439
2440#PLANTUML_CFG_FILE      =
2441
2442# When using plantuml, the specified paths are searched for files specified by
2443# the !include statement in a plantuml block.
2444
2445#PLANTUML_INCLUDE_PATH  =
2446
2447# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2448# that will be shown in the graph. If the number of nodes in a graph becomes
2449# larger than this value, doxygen will truncate the graph, which is visualized
2450# by representing a node as a red box. Note that doxygen if the number of direct
2451# children of the root node in a graph is already larger than
2452# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2453# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2454# Minimum value: 0, maximum value: 10000, default value: 50.
2455# This tag requires that the tag HAVE_DOT is set to YES.
2456
2457DOT_GRAPH_MAX_NODES    = 50
2458
2459# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2460# generated by dot. A depth value of 3 means that only nodes reachable from the
2461# root by following a path via at most 3 edges will be shown. Nodes that lay
2462# further from the root node will be omitted. Note that setting this option to 1
2463# or 2 may greatly reduce the computation time needed for large code bases. Also
2464# note that the size of a graph can be further restricted by
2465# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2466# Minimum value: 0, maximum value: 1000, default value: 0.
2467# This tag requires that the tag HAVE_DOT is set to YES.
2468
2469MAX_DOT_GRAPH_DEPTH    = 0
2470
2471# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2472# background. This is disabled by default, because dot on Windows does not seem
2473# to support this out of the box.
2474#
2475# Warning: Depending on the platform used, enabling this option may lead to
2476# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2477# read).
2478# The default value is: NO.
2479# This tag requires that the tag HAVE_DOT is set to YES.
2480
2481DOT_TRANSPARENT        = NO
2482
2483# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2484# files in one run (i.e. multiple -o and -T options on the command line). This
2485# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2486# this, this feature is disabled by default.
2487# The default value is: NO.
2488# This tag requires that the tag HAVE_DOT is set to YES.
2489
2490DOT_MULTI_TARGETS      = NO
2491
2492# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2493# explaining the meaning of the various boxes and arrows in the dot generated
2494# graphs.
2495# The default value is: YES.
2496# This tag requires that the tag HAVE_DOT is set to YES.
2497
2498GENERATE_LEGEND        = YES
2499
2500# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2501# files that are used to generate the various graphs.
2502# The default value is: YES.
2503# This tag requires that the tag HAVE_DOT is set to YES.
2504
2505DOT_CLEANUP            = YES
2506