~townsend/unity/fix-lp1301394-trusty

1188.1.2 by Gord Allott
forgot to add Doxyfile.in
1
# Doxyfile 1.4.7-4
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 hash (#) is considered a comment and will be ignored
7
# The format is:
8
#       TAG = value [value, ...]
9
# For lists items can also be appended using:
10
#       TAG += value [value, ...]
11
# Values that contain spaces should be placed between quotes (" ")
12
13
#---------------------------------------------------------------------------
14
# Project related configuration options
15
#---------------------------------------------------------------------------
16
17
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
18
# by quotes) that should identify the project.
19
20
PROJECT_NAME           = @PROJECT_NAME@ - @UNITY_API_VERSION@
21
22
# The PROJECT_NUMBER tag can be used to enter a project or revision number. 
23
# This could be handy for archiving the generated documentation or 
24
# if some version control system is used.
25
26
PROJECT_NUMBER         = @VERSION@
27
28
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
29
# base path where the generated documentation will be put. 
30
# If a relative path is entered, it will be relative to the location 
31
# where doxygen was started. If left blank the current directory will be used.
32
33
OUTPUT_DIRECTORY       = api-doc
34
35
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
36
# 4096 sub-directories (in 2 levels) under the output directory of each output 
37
# format and will distribute the generated files over these directories. 
38
# Enabling this option can be useful when feeding doxygen a huge amount of 
39
# source files, where putting all generated files in the same directory would 
40
# otherwise cause performance problems for the file system.
41
42
CREATE_SUBDIRS         = NO
43
44
# The OUTPUT_LANGUAGE tag is used to specify the language in which all 
45
# documentation generated by doxygen is written. Doxygen will use this 
46
# information to generate all constant output in the proper language. 
47
# The default language is English, other supported languages are: 
48
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
49
# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, 
50
# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, 
51
# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
52
# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
53
54
OUTPUT_LANGUAGE        = English
55
56
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
57
# include brief member descriptions after the members that are listed in 
58
# the file and class documentation (similar to JavaDoc). 
59
# Set to NO to disable this.
60
61
BRIEF_MEMBER_DESC      = YES
62
63
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
64
# the brief description of a member or function before the detailed description. 
65
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
66
# brief descriptions will be completely suppressed.
67
68
REPEAT_BRIEF           = YES
69
70
# This tag implements a quasi-intelligent brief description abbreviator 
71
# that is used to form the text in various listings. Each string 
72
# in this list, if found as the leading text of the brief description, will be 
73
# stripped from the text and the result after processing the whole list, is 
74
# used as the annotated text. Otherwise, the brief description is used as-is. 
75
# If left blank, the following values are used ("$name" is automatically 
76
# replaced with the name of the entity): "The $name class" "The $name widget" 
77
# "The $name file" "is" "provides" "specifies" "contains" 
78
# "represents" "a" "an" "the"
79
80
ABBREVIATE_BRIEF       = 
81
82
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
83
# Doxygen will generate a detailed section even if there is only a brief 
84
# description.
85
86
ALWAYS_DETAILED_SEC    = NO
87
88
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
89
# inherited members of a class in the documentation of that class as if those 
90
# members were ordinary class members. Constructors, destructors and assignment 
91
# operators of the base classes will not be shown.
92
93
INLINE_INHERITED_MEMB  = NO
94
95
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
96
# path before files name in the file list and in the header files. If set 
97
# to NO the shortest path that makes the file name unique will be used.
98
99
FULL_PATH_NAMES        = NO
100
101
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
102
# can be used to strip a user-defined part of the path. Stripping is 
103
# only done if one of the specified strings matches the left-hand part of 
104
# the path. The tag can be used to show relative paths in the file list. 
105
# If left blank the directory from which doxygen is run is used as the 
106
# path to strip.
107
108
STRIP_FROM_PATH        = 
109
110
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
111
# the path mentioned in the documentation of a class, which tells 
112
# the reader which header file to include in order to use a class. 
113
# If left blank only the name of the header file containing the class 
114
# definition is used. Otherwise one should specify the include paths that 
115
# are normally passed to the compiler using the -I flag.
116
117
STRIP_FROM_INC_PATH    = 
118
119
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
120
# (but less readable) file names. This can be useful is your file systems 
121
# doesn't support long names like on DOS, Mac, or CD-ROM.
122
123
SHORT_NAMES            = NO
124
125
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
126
# will interpret the first line (until the first dot) of a JavaDoc-style 
127
# comment as the brief description. If set to NO, the JavaDoc 
128
# comments will behave just like the Qt-style comments (thus requiring an 
129
# explicit @brief command for a brief description.
130
131
JAVADOC_AUTOBRIEF      = NO
132
133
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
134
# treat a multi-line C++ special comment block (i.e. a block of //! or /// 
135
# comments) as a brief description. This used to be the default behaviour. 
136
# The new default is to treat a multi-line C++ comment block as a detailed 
137
# description. Set this tag to YES if you prefer the old behaviour instead.
138
139
MULTILINE_CPP_IS_BRIEF = NO
140
141
142
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
143
# member inherits the documentation from any documented member that it 
144
# re-implements.
145
146
INHERIT_DOCS           = YES
147
148
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
149
# a new page for each member. If set to NO, the documentation of a member will 
150
# be part of the file/class/namespace that contains it.
151
152
SEPARATE_MEMBER_PAGES  = NO
153
154
# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
155
# Doxygen uses this value to replace tabs by spaces in code fragments.
156
157
TAB_SIZE               = 2
158
159
# This tag can be used to specify a number of aliases that acts 
160
# as commands in the documentation. An alias has the form "name=value". 
161
# For example adding "sideeffect=\par Side Effects:\n" will allow you to 
162
# put the command \sideeffect (or @sideeffect) in the documentation, which 
163
# will result in a user-defined paragraph with heading "Side Effects:". 
164
# You can put \n's in the value part of an alias to insert newlines.
165
166
ALIASES                = 
167
168
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
169
# sources only. Doxygen will then generate output that is more tailored for C. 
170
# For instance, some of the names that are used will be different. The list 
171
# of all members will be omitted, etc.
172
173
OPTIMIZE_OUTPUT_FOR_C  = NO
174
175
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
176
# sources only. Doxygen will then generate output that is more tailored for Java. 
177
# For instance, namespaces will be presented as packages, qualified scopes 
178
# will look different, etc.
179
180
OPTIMIZE_OUTPUT_JAVA   = NO
181
182
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
183
# include (a tag file for) the STL sources as input, then you should 
184
# set this tag to YES in order to let doxygen match functions declarations and 
185
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
186
# func(std::string) {}). This also make the inheritance and collaboration 
187
# diagrams that involve STL classes more complete and accurate.
188
189
BUILTIN_STL_SUPPORT    = YES
190
191
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
192
# tag is set to YES, then doxygen will reuse the documentation of the first 
193
# member in the group (if any) for the other members of the group. By default 
194
# all members of a group must be documented explicitly.
195
196
DISTRIBUTE_GROUP_DOC   = NO
197
198
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
199
# the same type (for instance a group of public functions) to be put as a 
200
# subgroup of that type (e.g. under the Public Functions section). Set it to 
201
# NO to prevent subgrouping. Alternatively, this can be done per class using 
202
# the \nosubgrouping command.
203
204
SUBGROUPING            = YES
205
206
#---------------------------------------------------------------------------
207
# Build related configuration options
208
#---------------------------------------------------------------------------
209
210
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
211
# documentation are documented, even if no documentation was available. 
212
# Private class members and static file members will be hidden unless 
213
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
214
215
EXTRACT_ALL            = YES
216
217
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
218
# will be included in the documentation.
219
220
EXTRACT_PRIVATE        = YES
221
222
# If the EXTRACT_STATIC tag is set to YES all static members of a file 
223
# will be included in the documentation.
224
225
EXTRACT_STATIC         = YES
226
227
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
228
# defined locally in source files will be included in the documentation. 
229
# If set to NO only classes defined in header files are included.
230
231
EXTRACT_LOCAL_CLASSES  = YES
232
233
# This flag is only useful for Objective-C code. When set to YES local 
234
# methods, which are defined in the implementation section but not in 
235
# the interface are included in the documentation. 
236
# If set to NO (the default) only methods in the interface are included.
237
238
EXTRACT_LOCAL_METHODS  = NO
239
240
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
241
# undocumented members of documented classes, files or namespaces. 
242
# If set to NO (the default) these members will be included in the 
243
# various overviews, but no documentation section is generated. 
244
# This option has no effect if EXTRACT_ALL is enabled.
245
246
HIDE_UNDOC_MEMBERS     = NO
247
248
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
249
# undocumented classes that are normally visible in the class hierarchy. 
250
# If set to NO (the default) these classes will be included in the various 
251
# overviews. This option has no effect if EXTRACT_ALL is enabled.
252
253
HIDE_UNDOC_CLASSES     = NO
254
255
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
256
# friend (class|struct|union) declarations. 
257
# If set to NO (the default) these declarations will be included in the 
258
# documentation.
259
260
HIDE_FRIEND_COMPOUNDS  = NO
261
262
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
263
# documentation blocks found inside the body of a function. 
264
# If set to NO (the default) these blocks will be appended to the 
265
# function's detailed documentation block.
266
267
HIDE_IN_BODY_DOCS      = NO
268
269
# The INTERNAL_DOCS tag determines if documentation 
270
# that is typed after a \internal command is included. If the tag is set 
271
# to NO (the default) then the documentation will be excluded. 
272
# Set it to YES to include the internal documentation.
273
274
INTERNAL_DOCS          = YES
275
276
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
277
# file names in lower-case letters. If set to YES upper-case letters are also 
278
# allowed. This is useful if you have classes or files whose names only differ 
279
# in case and if your file system supports case sensitive file names. Windows 
280
# and Mac users are advised to set this option to NO.
281
282
CASE_SENSE_NAMES       = YES
283
284
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
285
# will show members with their full class and namespace scopes in the 
286
# documentation. If set to YES the scope will be hidden.
287
288
HIDE_SCOPE_NAMES       = NO
289
290
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
291
# will put a list of the files that are included by a file in the documentation 
292
# of that file.
293
294
SHOW_INCLUDE_FILES     = YES
295
296
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
297
# is inserted in the documentation for inline members.
298
299
INLINE_INFO            = YES
300
301
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
302
# will sort the (detailed) documentation of file and class members 
303
# alphabetically by member name. If set to NO the members will appear in 
304
# declaration order.
305
306
SORT_MEMBER_DOCS       = NO
307
308
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
309
# brief documentation of file, namespace and class members alphabetically 
310
# by member name. If set to NO (the default) the members will appear in 
311
# declaration order.
312
313
SORT_BRIEF_DOCS        = NO
314
315
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
316
# sorted by fully-qualified names, including namespaces. If set to 
317
# NO (the default), the class list will be sorted only by class name, 
318
# not including the namespace part. 
319
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
320
# Note: This option applies only to the class list, not to the 
321
# alphabetical list.
322
323
SORT_BY_SCOPE_NAME     = NO
324
325
# The GENERATE_TODOLIST tag can be used to enable (YES) or 
326
# disable (NO) the todo list. This list is created by putting \todo 
327
# commands in the documentation.
328
329
GENERATE_TODOLIST      = YES
330
331
# The GENERATE_TESTLIST tag can be used to enable (YES) or 
332
# disable (NO) the test list. This list is created by putting \test 
333
# commands in the documentation.
334
335
GENERATE_TESTLIST      = YES
336
337
# The GENERATE_BUGLIST tag can be used to enable (YES) or 
338
# disable (NO) the bug list. This list is created by putting \bug 
339
# commands in the documentation.
340
341
GENERATE_BUGLIST       = YES
342
343
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
344
# disable (NO) the deprecated list. This list is created by putting 
345
# \deprecated commands in the documentation.
346
347
GENERATE_DEPRECATEDLIST= YES
348
349
# The ENABLED_SECTIONS tag can be used to enable conditional 
350
# documentation sections, marked by \if sectionname ... \endif.
351
352
ENABLED_SECTIONS       = 
353
354
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
355
# the initial value of a variable or define consists of for it to appear in 
356
# the documentation. If the initializer consists of more lines than specified 
357
# here it will be hidden. Use a value of 0 to hide initializers completely. 
358
# The appearance of the initializer of individual variables and defines in the 
359
# documentation can be controlled using \showinitializer or \hideinitializer 
360
# command in the documentation regardless of this setting.
361
362
MAX_INITIALIZER_LINES  = 30
363
364
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
365
# at the bottom of the documentation of classes and structs. If set to YES the 
366
# list will mention the files that were used to generate the documentation.
367
368
SHOW_USED_FILES        = YES
369
370
# If the sources in your project are distributed over multiple directories 
371
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
372
# in the documentation. The default is NO.
373
374
SHOW_DIRECTORIES       = YES
375
376
# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
377
# doxygen should invoke to get the current version for each file (typically from the 
378
# version control system). Doxygen will invoke the program by executing (via 
379
# popen()) the command <command> <input-file>, where <command> is the value of 
380
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
381
# provided by doxygen. Whatever the program writes to standard output 
382
# is used as the file version. See the manual for examples.
383
384
FILE_VERSION_FILTER    = 
385
386
#---------------------------------------------------------------------------
387
# configuration options related to warning and progress messages
388
#---------------------------------------------------------------------------
389
390
# The QUIET tag can be used to turn on/off the messages that are generated 
391
# by doxygen. Possible values are YES and NO. If left blank NO is used.
392
393
QUIET                  = YES
394
395
# The WARNINGS tag can be used to turn on/off the warning messages that are 
396
# generated by doxygen. Possible values are YES and NO. If left blank 
397
# NO is used.
398
399
WARNINGS               = YES
400
401
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
402
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
403
# automatically be disabled.
404
405
WARN_IF_UNDOCUMENTED   = YES
406
407
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
408
# potential errors in the documentation, such as not documenting some 
409
# parameters in a documented function, or documenting parameters that 
410
# don't exist or using markup commands wrongly.
411
412
WARN_IF_DOC_ERROR      = YES
413
414
# This WARN_NO_PARAMDOC option can be abled to get warnings for 
415
# functions that are documented, but have no documentation for their parameters 
416
# or return value. If set to NO (the default) doxygen will only warn about 
417
# wrong or incomplete parameter documentation, but not about the absence of 
418
# documentation.
419
420
WARN_NO_PARAMDOC       = NO
421
422
# The WARN_FORMAT tag determines the format of the warning messages that 
423
# doxygen can produce. The string should contain the $file, $line, and $text 
424
# tags, which will be replaced by the file and line number from which the 
425
# warning originated and the warning text. Optionally the format may contain 
426
# $version, which will be replaced by the version of the file (if it could 
427
# be obtained via FILE_VERSION_FILTER)
428
429
WARN_FORMAT            = "$file:$line: $text"
430
431
# The WARN_LOGFILE tag can be used to specify a file to which warning 
432
# and error messages should be written. If left blank the output is written 
433
# to stderr.
434
435
WARN_LOGFILE           = doxygen-warnings.log
436
437
#---------------------------------------------------------------------------
438
# configuration options related to the input files
439
#---------------------------------------------------------------------------
440
441
# The INPUT tag can be used to specify the files and/or directories that contain 
442
# documented source files. You may enter file names like "myfile.cpp" or 
443
# directories like "/usr/src/myproject". Separate the files or directories 
444
# with spaces.
445
1242.2.14 by Neil Jagdish Patel
fix documentation generation for the nation
446
INPUT                  = @TOP_SRCDIR@/plugins/unityshell/src @TOP_SRCDIR@/tests @TOP_SRCDIR@/services @TOP_SRCDIR@/UnityCore
1188.1.2 by Gord Allott
forgot to add Doxyfile.in
447
448
# If the value of the INPUT tag contains directories, you can use the 
449
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
450
# and *.h) to filter out the source-files in the directories. If left 
451
# blank the following patterns are tested: 
452
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
453
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
454
455
FILE_PATTERNS          = 
456
457
# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
458
# should be searched for input files as well. Possible values are YES and NO. 
459
# If left blank NO is used.
460
461
RECURSIVE              = YES
462
463
# The EXCLUDE tag can be used to specify files and/or directories that should 
464
# excluded from the INPUT source files. This way you can easily exclude a 
465
# subdirectory from a directory tree whose root is specified with the INPUT tag.
466
467
EXCLUDE                = 
468
469
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
470
# directories that are symbolic links (a Unix filesystem feature) are excluded 
471
# from the input.
472
473
EXCLUDE_SYMLINKS       = NO
474
475
# If the value of the INPUT tag contains directories, you can use the 
476
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
477
# certain files from those directories. Note that the wildcards are matched 
478
# against the file with absolute path, so to exclude all test directories 
479
# for example use the pattern */test/*
480
481
EXCLUDE_PATTERNS       = 
482
483
# The EXAMPLE_PATH tag can be used to specify one or more files or 
484
# directories that contain example code fragments that are included (see 
485
# the \include command).
486
487
EXAMPLE_PATH           = @top_srcdir@/examples
488
489
# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
490
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
491
# and *.h) to filter out the source-files in the directories. If left 
492
# blank all files are included.
493
494
EXAMPLE_PATTERNS       = 
495
496
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
497
# searched for input files to be used with the \include or \dontinclude 
498
# commands irrespective of the value of the RECURSIVE tag. 
499
# Possible values are YES and NO. If left blank NO is used.
500
501
EXAMPLE_RECURSIVE      = NO
502
503
# The IMAGE_PATH tag can be used to specify one or more files or 
504
# directories that contain image that are included in the documentation (see 
505
# the \image command).
506
507
IMAGE_PATH             = 
508
509
# The INPUT_FILTER tag can be used to specify a program that doxygen should 
510
# invoke to filter for each input file. Doxygen will invoke the filter program 
511
# by executing (via popen()) the command <filter> <input-file>, where <filter> 
512
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
513
# input file. Doxygen will then use the output that the filter program writes 
514
# to standard output.  If FILTER_PATTERNS is specified, this tag will be 
515
# ignored.
516
517
INPUT_FILTER           = 
518
519
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
520
# basis.  Doxygen will compare the file name with each pattern and apply the 
521
# filter if there is a match.  The filters are a list of the form: 
522
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
523
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
524
# is applied to all files.
525
526
FILTER_PATTERNS        = 
527
528
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
529
# INPUT_FILTER) will be used to filter the input files when producing source 
530
# files to browse (i.e. when SOURCE_BROWSER is set to YES).
531
532
FILTER_SOURCE_FILES    = NO
533
534
#---------------------------------------------------------------------------
535
# configuration options related to source browsing
536
#---------------------------------------------------------------------------
537
538
# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
539
# be generated. Documented entities will be cross-referenced with these sources. 
540
# Note: To get rid of all source code in the generated output, make sure also 
541
# VERBATIM_HEADERS is set to NO.
542
543
SOURCE_BROWSER         = YES
544
545
# Setting the INLINE_SOURCES tag to YES will include the body 
546
# of functions and classes directly in the documentation.
547
548
INLINE_SOURCES         = YES
549
550
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
551
# doxygen to hide any special comment blocks from generated source code 
552
# fragments. Normal C and C++ comments will always remain visible.
553
554
STRIP_CODE_COMMENTS    = YES
555
556
# If the REFERENCED_BY_RELATION tag is set to YES (the default) 
557
# then for each documented function all documented 
558
# functions referencing it will be listed.
559
560
REFERENCED_BY_RELATION = YES
561
562
# If the REFERENCES_RELATION tag is set to YES (the default) 
563
# then for each documented function all documented entities 
564
# called/used by that function will be listed.
565
566
REFERENCES_RELATION    = YES
567
568
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
569
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
570
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
571
# link to the source code.  Otherwise they will link to the documentstion.
572
573
REFERENCES_LINK_SOURCE = YES
574
575
# If the USE_HTAGS tag is set to YES then the references to source code 
576
# will point to the HTML generated by the htags(1) tool instead of doxygen 
577
# built-in source browser. The htags tool is part of GNU's global source 
578
# tagging system (see http://www.gnu.org/software/global/global.html). You 
579
# will need version 4.8.6 or higher.
580
581
USE_HTAGS              = NO
582
583
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
584
# will generate a verbatim copy of the header file for each class for 
585
# which an include is specified. Set to NO to disable this.
586
587
VERBATIM_HEADERS       = YES
588
589
#---------------------------------------------------------------------------
590
# configuration options related to the alphabetical class index
591
#---------------------------------------------------------------------------
592
593
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
594
# of all compounds will be generated. Enable this if the project 
595
# contains a lot of classes, structs, unions or interfaces.
596
597
ALPHABETICAL_INDEX     = NO
598
599
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
600
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
601
# in which this list will be split (can be a number in the range [1..20])
602
603
COLS_IN_ALPHA_INDEX    = 5
604
605
# In case all classes in a project start with a common prefix, all 
606
# classes will be put under the same header in the alphabetical index. 
607
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
608
# should be ignored while generating the index headers.
609
610
IGNORE_PREFIX          = 
611
612
#---------------------------------------------------------------------------
613
# configuration options related to the HTML output
614
#---------------------------------------------------------------------------
615
616
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
617
# generate HTML output.
618
619
GENERATE_HTML          = YES
620
621
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
622
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
623
# put in front of it. If left blank `html' will be used as the default path.
624
625
HTML_OUTPUT            = html
626
627
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
628
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
629
# doxygen will generate files with .html extension.
630
631
HTML_FILE_EXTENSION    = .html
632
633
# The HTML_HEADER tag can be used to specify a personal HTML header for 
634
# each generated HTML page. If it is left blank doxygen will generate a 
635
# standard header.
636
637
HTML_HEADER            = 
638
639
# The HTML_FOOTER tag can be used to specify a personal HTML footer for 
640
# each generated HTML page. If it is left blank doxygen will generate a 
641
# standard footer.
642
643
HTML_FOOTER            = 
644
645
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
646
# style sheet that is used by each HTML page. It can be used to 
647
# fine-tune the look of the HTML output. If the tag is left blank doxygen 
648
# will generate a default style sheet. Note that doxygen will try to copy 
649
# the style sheet file to the HTML output directory, so don't put your own 
650
# stylesheet in the HTML output directory as well, or it will be erased!
651
652
HTML_STYLESHEET        = 
653
654
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
655
# files or namespaces will be aligned in HTML using tables. If set to 
656
# NO a bullet list will be used.
657
658
HTML_ALIGN_MEMBERS     = YES
659
660
# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
661
# will be generated that can be used as input for tools like the 
662
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
663
# of the generated HTML documentation.
664
665
GENERATE_HTMLHELP      = NO
666
667
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
668
# be used to specify the file name of the resulting .chm file. You 
669
# can add a path in front of the file if the result should not be 
670
# written to the html output directory.
671
672
CHM_FILE               = 
673
674
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
675
# be used to specify the location (absolute path including file name) of 
676
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
677
# the HTML help compiler on the generated index.hhp.
678
679
HHC_LOCATION           = 
680
681
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
682
# controls if a separate .chi index file is generated (YES) or that 
683
# it should be included in the master .chm file (NO).
684
685
GENERATE_CHI           = NO
686
687
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
688
# controls whether a binary table of contents is generated (YES) or a 
689
# normal table of contents (NO) in the .chm file.
690
691
BINARY_TOC             = NO
692
693
# The TOC_EXPAND flag can be set to YES to add extra items for group members 
694
# to the contents of the HTML help documentation and to the tree view.
695
696
TOC_EXPAND             = NO
697
698
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
699
# top of each HTML page. The value NO (the default) enables the index and 
700
# the value YES disables it.
701
702
DISABLE_INDEX          = NO
703
704
# This tag can be used to set the number of enum values (range [1..20]) 
705
# that doxygen will group on one line in the generated HTML documentation.
706
707
ENUM_VALUES_PER_LINE   = 4
708
709
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
710
# generated containing a tree-like index structure (just like the one that 
711
# is generated for HTML Help). For this to work a browser that supports 
712
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 
713
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 
714
# probably better off using the HTML help feature.
715
716
GENERATE_TREEVIEW      = YES
717
718
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
719
# used to set the initial width (in pixels) of the frame in which the tree 
720
# is shown.
721
722
TREEVIEW_WIDTH         = 320
723
724
#---------------------------------------------------------------------------
725
# configuration options related to the LaTeX output
726
#---------------------------------------------------------------------------
727
728
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
729
# generate Latex output.
730
731
GENERATE_LATEX         = NO
732
733
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
734
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
735
# put in front of it. If left blank `latex' will be used as the default path.
736
737
LATEX_OUTPUT           = latex
738
739
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
740
# invoked. If left blank `latex' will be used as the default command name.
741
742
LATEX_CMD_NAME         = latex
743
744
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
745
# generate index for LaTeX. If left blank `makeindex' will be used as the 
746
# default command name.
747
748
MAKEINDEX_CMD_NAME     = makeindex
749
750
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
751
# LaTeX documents. This may be useful for small projects and may help to 
752
# save some trees in general.
753
754
COMPACT_LATEX          = NO
755
756
# The PAPER_TYPE tag can be used to set the paper type that is used 
757
# by the printer. Possible values are: a4, a4wide, letter, legal and 
758
# executive. If left blank a4wide will be used.
759
760
PAPER_TYPE             = a4wide
761
762
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
763
# packages that should be included in the LaTeX output.
764
765
EXTRA_PACKAGES         = 
766
767
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
768
# the generated latex document. The header should contain everything until 
769
# the first chapter. If it is left blank doxygen will generate a 
770
# standard header. Notice: only use this tag if you know what you are doing!
771
772
LATEX_HEADER           = 
773
774
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
775
# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
776
# contain links (just like the HTML output) instead of page references 
777
# This makes the output suitable for online browsing using a pdf viewer.
778
779
PDF_HYPERLINKS         = NO
780
781
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
782
# plain latex in the generated Makefile. Set this option to YES to get a 
783
# higher quality PDF documentation.
784
785
USE_PDFLATEX           = NO
786
787
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
788
# command to the generated LaTeX files. This will instruct LaTeX to keep 
789
# running if errors occur, instead of asking the user for help. 
790
# This option is also used when generating formulas in HTML.
791
792
LATEX_BATCHMODE        = NO
793
794
# If LATEX_HIDE_INDICES is set to YES then doxygen will not 
795
# include the index chapters (such as File Index, Compound Index, etc.) 
796
# in the output.
797
798
LATEX_HIDE_INDICES     = NO
799
800
#---------------------------------------------------------------------------
801
# configuration options related to the RTF output
802
#---------------------------------------------------------------------------
803
804
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
805
# The RTF output is optimized for Word 97 and may not look very pretty with 
806
# other RTF readers or editors.
807
808
GENERATE_RTF           = NO
809
810
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
811
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
812
# put in front of it. If left blank `rtf' will be used as the default path.
813
814
RTF_OUTPUT             = rtf
815
816
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
817
# RTF documents. This may be useful for small projects and may help to 
818
# save some trees in general.
819
820
COMPACT_RTF            = NO
821
822
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
823
# will contain hyperlink fields. The RTF file will 
824
# contain links (just like the HTML output) instead of page references. 
825
# This makes the output suitable for online browsing using WORD or other 
826
# programs which support those fields. 
827
# Note: wordpad (write) and others do not support links.
828
829
RTF_HYPERLINKS         = NO
830
831
# Load stylesheet definitions from file. Syntax is similar to doxygen's 
832
# config file, i.e. a series of assignments. You only have to provide 
833
# replacements, missing definitions are set to their default value.
834
835
RTF_STYLESHEET_FILE    = 
836
837
# Set optional variables used in the generation of an rtf document. 
838
# Syntax is similar to doxygen's config file.
839
840
RTF_EXTENSIONS_FILE    = 
841
842
#---------------------------------------------------------------------------
843
# configuration options related to the man page output
844
#---------------------------------------------------------------------------
845
846
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
847
# generate man pages
848
849
GENERATE_MAN           = NO
850
851
# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
852
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
853
# put in front of it. If left blank `man' will be used as the default path.
854
855
MAN_OUTPUT             = man
856
857
# The MAN_EXTENSION tag determines the extension that is added to 
858
# the generated man pages (default is the subroutine's section .3)
859
860
MAN_EXTENSION          = .3
861
862
# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
863
# then it will generate one additional man file for each entity 
864
# documented in the real man page(s). These additional files 
865
# only source the real man page, but without them the man command 
866
# would be unable to find the correct page. The default is NO.
867
868
MAN_LINKS              = NO
869
870
#---------------------------------------------------------------------------
871
# configuration options related to the XML output
872
#---------------------------------------------------------------------------
873
874
# If the GENERATE_XML tag is set to YES Doxygen will 
875
# generate an XML file that captures the structure of 
876
# the code including all documentation.
877
878
GENERATE_XML           = NO
879
880
# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
881
# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
882
# put in front of it. If left blank `xml' will be used as the default path.
883
884
XML_OUTPUT             = xml
885
886
# The XML_SCHEMA tag can be used to specify an XML schema, 
887
# which can be used by a validating XML parser to check the 
888
# syntax of the XML files.
889
890
XML_SCHEMA             = 
891
892
# The XML_DTD tag can be used to specify an XML DTD, 
893
# which can be used by a validating XML parser to check the 
894
# syntax of the XML files.
895
896
XML_DTD                = 
897
898
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
899
# dump the program listings (including syntax highlighting 
900
# and cross-referencing information) to the XML output. Note that 
901
# enabling this will significantly increase the size of the XML output.
902
903
XML_PROGRAMLISTING     = YES
904
905
#---------------------------------------------------------------------------
906
# configuration options for the AutoGen Definitions output
907
#---------------------------------------------------------------------------
908
909
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
910
# generate an AutoGen Definitions (see autogen.sf.net) file 
911
# that captures the structure of the code including all 
912
# documentation. Note that this feature is still experimental 
913
# and incomplete at the moment.
914
915
GENERATE_AUTOGEN_DEF   = NO
916
917
#---------------------------------------------------------------------------
918
# configuration options related to the Perl module output
919
#---------------------------------------------------------------------------
920
921
# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
922
# generate a Perl module file that captures the structure of 
923
# the code including all documentation. Note that this 
924
# feature is still experimental and incomplete at the 
925
# moment.
926
927
GENERATE_PERLMOD       = NO
928
929
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
930
# the necessary Makefile rules, Perl scripts and LaTeX code to be able 
931
# to generate PDF and DVI output from the Perl module output.
932
933
PERLMOD_LATEX          = NO
934
935
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
936
# nicely formatted so it can be parsed by a human reader.  This is useful 
937
# if you want to understand what is going on.  On the other hand, if this 
938
# tag is set to NO the size of the Perl module output will be much smaller 
939
# and Perl will parse it just the same.
940
941
PERLMOD_PRETTY         = YES
942
943
# The names of the make variables in the generated doxyrules.make file 
944
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
945
# This is useful so different doxyrules.make files included by the same 
946
# Makefile don't overwrite each other's variables.
947
948
PERLMOD_MAKEVAR_PREFIX = 
949
950
#---------------------------------------------------------------------------
951
# Configuration options related to the preprocessor   
952
#---------------------------------------------------------------------------
953
954
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
955
# evaluate all C-preprocessor directives found in the sources and include 
956
# files.
957
958
ENABLE_PREPROCESSING   = YES
959
960
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
961
# names in the source code. If set to NO (the default) only conditional 
962
# compilation will be performed. Macro expansion can be done in a controlled 
963
# way by setting EXPAND_ONLY_PREDEF to YES.
964
965
MACRO_EXPANSION        = NO
966
967
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
968
# then the macro expansion is limited to the macros specified with the 
969
# PREDEFINED and EXPAND_AS_DEFINED tags.
970
971
EXPAND_ONLY_PREDEF     = NO
972
973
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
974
# in the INCLUDE_PATH (see below) will be search if a #include is found.
975
976
SEARCH_INCLUDES        = YES
977
978
# The INCLUDE_PATH tag can be used to specify one or more directories that 
979
# contain include files that are not input files but should be processed by 
980
# the preprocessor.
981
982
INCLUDE_PATH           = 
983
984
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
985
# patterns (like *.h and *.hpp) to filter out the header-files in the 
986
# directories. If left blank, the patterns specified with FILE_PATTERNS will 
987
# be used.
988
989
INCLUDE_FILE_PATTERNS  = 
990
991
# The PREDEFINED tag can be used to specify one or more macro names that 
992
# are defined before the preprocessor is started (similar to the -D option of 
993
# gcc). The argument of the tag is a list of macros of the form: name 
994
# or name=definition (no spaces). If the definition and the = are 
995
# omitted =1 is assumed. To prevent a macro definition from being 
996
# undefined via #undef or recursively expanded use the := operator 
997
# instead of the = operator.
998
999
PREDEFINED             = LIBFTDI_LINUX_ASYNC_MODE
1000
1001
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1002
# this tag can be used to specify a list of macro names that should be expanded. 
1003
# The macro definition that is found in the sources will be used. 
1004
# Use the PREDEFINED tag if you want to use a different macro definition.
1005
1006
EXPAND_AS_DEFINED      = 
1007
1008
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1009
# doxygen's preprocessor will remove all function-like macros that are alone 
1010
# on a line, have an all uppercase name, and do not end with a semicolon. Such 
1011
# function macros are typically used for boiler-plate code, and will confuse 
1012
# the parser if not removed.
1013
1014
SKIP_FUNCTION_MACROS   = YES
1015
1016
#---------------------------------------------------------------------------
1017
# Configuration::additions related to external references   
1018
#---------------------------------------------------------------------------
1019
1020
# The TAGFILES option can be used to specify one or more tagfiles. 
1021
# Optionally an initial location of the external documentation 
1022
# can be added for each tagfile. The format of a tag file without 
1023
# this location is as follows: 
1024
#   TAGFILES = file1 file2 ... 
1025
# Adding location for the tag files is done as follows: 
1026
#   TAGFILES = file1=loc1 "file2 = loc2" ... 
1027
# where "loc1" and "loc2" can be relative or absolute paths or 
1028
# URLs. If a location is present for each tag, the installdox tool 
1029
# does not have to be run to correct the links.
1030
# Note that each tag file must have a unique name
1031
# (where the name does NOT include the path)
1032
# If a tag file is not located in the directory in which doxygen 
1033
# is run, you must also specify the path to the tagfile here.
1034
1035
TAGFILES               = 
1036
1037
# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1038
# a tag file that is based on the input files it reads.
1039
1040
GENERATE_TAGFILE       = 
1041
1042
# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1043
# in the class index. If set to NO only the inherited external classes 
1044
# will be listed.
1045
1046
ALLEXTERNALS           = NO
1047
1048
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1049
# in the modules index. If set to NO, only the current project's groups will 
1050
# be listed.
1051
1052
EXTERNAL_GROUPS        = YES
1053
1054
# The PERL_PATH should be the absolute path and name of the perl script 
1055
# interpreter (i.e. the result of `which perl').
1056
1057
PERL_PATH              = /usr/bin/perl
1058
1059
#---------------------------------------------------------------------------
1060
# Configuration options related to the dot tool   
1061
#---------------------------------------------------------------------------
1062
1063
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1064
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1065
# or super classes. Setting the tag to NO turns the diagrams off. Note that 
1066
# this option is superseded by the HAVE_DOT option below. This is only a 
1067
# fallback. It is recommended to install and use dot, since it yields more 
1068
# powerful graphs.
1069
1070
CLASS_DIAGRAMS         = YES
1071
1072
# If set to YES, the inheritance and collaboration graphs will hide 
1073
# inheritance and usage relations if the target is undocumented 
1074
# or is not a class.
1075
1076
HIDE_UNDOC_RELATIONS   = YES
1077
1078
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1079
# available from the path. This tool is part of Graphviz, a graph visualization 
1080
# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1081
# have no effect if this option is set to NO (the default)
1082
1083
HAVE_DOT               = NO
1084
1085
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1086
# will generate a graph for each documented class showing the direct and 
1087
# indirect inheritance relations. Setting this tag to YES will force the 
1088
# the CLASS_DIAGRAMS tag to NO.
1089
1090
CLASS_GRAPH            = YES
1091
1092
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1093
# will generate a graph for each documented class showing the direct and 
1094
# indirect implementation dependencies (inheritance, containment, and 
1095
# class references variables) of the class with other documented classes.
1096
1097
COLLABORATION_GRAPH    = YES
1098
1099
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1100
# will generate a graph for groups, showing the direct groups dependencies
1101
1102
GROUP_GRAPHS           = YES
1103
1104
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1105
# collaboration diagrams in a style similar to the OMG's Unified Modeling 
1106
# Language.
1107
1108
UML_LOOK               = NO
1109
1110
# If set to YES, the inheritance and collaboration graphs will show the 
1111
# relations between templates and their instances.
1112
1113
TEMPLATE_RELATIONS     = NO
1114
1115
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1116
# tags are set to YES then doxygen will generate a graph for each documented 
1117
# file showing the direct and indirect include dependencies of the file with 
1118
# other documented files.
1119
1120
INCLUDE_GRAPH          = YES
1121
1122
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1123
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1124
# documented header file showing the documented files that directly or 
1125
# indirectly include this file.
1126
1127
INCLUDED_BY_GRAPH      = YES
1128
1129
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1130
# generate a call dependency graph for every global function or class method. 
1131
# Note that enabling this option will significantly increase the time of a run. 
1132
# So in most cases it will be better to enable call graphs for selected 
1133
# functions only using the \callgraph command.
1134
1135
CALL_GRAPH             = NO
1136
1137
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will 
1138
# generate a caller dependency graph for every global function or class method. 
1139
# Note that enabling this option will significantly increase the time of a run. 
1140
# So in most cases it will be better to enable caller graphs for selected 
1141
# functions only using the \callergraph command.
1142
1143
CALLER_GRAPH           = NO
1144
1145
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1146
# will graphical hierarchy of all classes instead of a textual one.
1147
1148
GRAPHICAL_HIERARCHY    = YES
1149
1150
# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1151
# then doxygen will show the dependencies a directory has on other directories 
1152
# in a graphical way. The dependency relations are determined by the #include
1153
# relations between the files in the directories.
1154
1155
DIRECTORY_GRAPH        = YES
1156
1157
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1158
# generated by dot. Possible values are png, jpg, or gif
1159
# If left blank png will be used.
1160
1161
DOT_IMAGE_FORMAT       = png
1162
1163
# The tag DOT_PATH can be used to specify the path where the dot tool can be 
1164
# found. If left blank, it is assumed the dot tool can be found in the path.
1165
1166
DOT_PATH               = 
1167
1168
# The DOTFILE_DIRS tag can be used to specify one or more directories that 
1169
# contain dot files that are included in the documentation (see the 
1170
# \dotfile command).
1171
1172
DOTFILE_DIRS           = 
1173
1174
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1175
# graphs generated by dot. A depth value of 3 means that only nodes reachable 
1176
# from the root by following a path via at most 3 edges will be shown. Nodes 
1177
# that lay further from the root node will be omitted. Note that setting this 
1178
# option to 1 or 2 may greatly reduce the computation time needed for large 
1179
# code bases. Also note that a graph may be further truncated if the graph's 
1180
# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
1181
# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
1182
# the graph is not depth-constrained.
1183
1184
MAX_DOT_GRAPH_DEPTH    = 0
1185
1186
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1187
# background. This is disabled by default, which results in a white background. 
1188
# Warning: Depending on the platform used, enabling this option may lead to 
1189
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to 
1190
# read).
1191
1192
DOT_TRANSPARENT        = NO
1193
1194
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1195
# files in one run (i.e. multiple -o and -T options on the command line). This 
1196
# makes dot run faster, but since only newer versions of dot (>1.8.10) 
1197
# support this, this feature is disabled by default.
1198
1199
DOT_MULTI_TARGETS      = NO
1200
1201
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1202
# generate a legend page explaining the meaning of the various boxes and 
1203
# arrows in the dot generated graphs.
1204
1205
GENERATE_LEGEND        = YES
1206
1207
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1208
# remove the intermediate dot files that are used to generate 
1209
# the various graphs.
1210
1211
DOT_CLEANUP            = YES
1212
1213
#---------------------------------------------------------------------------
1214
# Configuration::additions related to the search engine   
1215
#---------------------------------------------------------------------------
1216
1217
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1218
# for the HTML output. The underlying search engine uses javascript
1219
# and DHTML and should work on any modern browser. Note that when using
1220
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
1221
# (GENERATE_DOCSET) there is already a search function so this one should
1222
# typically be disabled. For large projects the javascript based search engine
1223
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1224
1225
SEARCHENGINE           = YES
1226
1227
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1228
# implemented using a PHP enabled web server instead of at the web client
1229
# using Javascript. Doxygen will generate the search PHP script and index
1230
# file to put on the web server. The advantage of the server
1231
# based approach is that it scales better to large projects and allows
1232
# full text search. The disadvances is that it is more difficult to setup
1233
# and does not have live searching capabilities.
1234
1235
SERVER_BASED_SEARCH    = NO
1236