xref: /utopia/UTPA2-700.0.x/projects/build/bspOneUtopia.dxyfile (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1# Doxyfile 1.5.7.1
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#---------------------------------------------------------------------------
16PROJECT_LOGO           = ./doxy_folder/mstar_logo.png
17
18# This tag specifies the encoding used for all characters in the config file
19# that follow. The default is UTF-8 which is also the encoding used for all
20# text before the first occurrence of this tag. Doxygen uses libiconv (or the
21# iconv built into libc) for the transcoding. See
22# http://www.gnu.org/software/libiconv for the list of possible encodings.
23
24DOXYFILE_ENCODING      = UTF-8
25
26# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
27# by quotes) that should identify the project.
28
29PROJECT_NAME           = "Utopia2_500 API Specification"
30
31# The PROJECT_NUMBER tag can be used to enter a project or revision number.
32# This could be handy for archiving the generated documentation or
33# if some version control system is used.
34
35PROJECT_NUMBER         = "V1.0"
36
37# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
38# base path where the generated documentation will be put.
39# If a relative path is entered, it will be relative to the location
40# where doxygen was started. If left blank the current directory will be used.
41
42OUTPUT_DIRECTORY       = ./dxyOneUtopia_files
43
44# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
45# 4096 sub-directories (in 2 levels) under the output directory of each output
46# format and will distribute the generated files over these directories.
47# Enabling this option can be useful when feeding doxygen a huge amount of
48# source files, where putting all generated files in the same directory would
49# otherwise cause performance problems for the file system.
50
51CREATE_SUBDIRS         = NO
52
53# The OUTPUT_LANGUAGE tag is used to specify the language in which all
54# documentation generated by doxygen is written. Doxygen will use this
55# information to generate all constant output in the proper language.
56# The default language is English, other supported languages are:
57# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
58# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
59# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
60# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
61# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene,
62# Spanish, Swedish, and Ukrainian.
63
64OUTPUT_LANGUAGE        = English
65
66# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67# include brief member descriptions after the members that are listed in
68# the file and class documentation (similar to JavaDoc).
69# Set to NO to disable this.
70
71BRIEF_MEMBER_DESC      = YES
72
73# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
74# the brief description of a member or function before the detailed description.
75# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
76# brief descriptions will be completely suppressed.
77
78REPEAT_BRIEF           = YES
79
80# This tag implements a quasi-intelligent brief description abbreviator
81# that is used to form the text in various listings. Each string
82# in this list, if found as the leading text of the brief description, will be
83# stripped from the text and the result after processing the whole list, is
84# used as the annotated text. Otherwise, the brief description is used as-is.
85# If left blank, the following values are used ("$name" is automatically
86# replaced with the name of the entity): "The $name class" "The $name widget"
87# "The $name file" "is" "provides" "specifies" "contains"
88# "represents" "a" "an" "the"
89
90ABBREVIATE_BRIEF       = "The $name class        " \
91                         "The $name widget        " \
92                         "The $name file        " \
93                         is \
94                         provides \
95                         specifies \
96                         contains \
97                         represents \
98                         a \
99                         an \
100                         the
101
102# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
103# Doxygen will generate a detailed section even if there is only a brief
104# description.
105
106ALWAYS_DETAILED_SEC    = NO
107
108# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
109# inherited members of a class in the documentation of that class as if those
110# members were ordinary class members. Constructors, destructors and assignment
111# operators of the base classes will not be shown.
112
113INLINE_INHERITED_MEMB  = NO
114
115# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
116# path before files name in the file list and in the header files. If set
117# to NO the shortest path that makes the file name unique will be used.
118
119FULL_PATH_NAMES        = NO
120
121# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
122# can be used to strip a user-defined part of the path. Stripping is
123# only done if one of the specified strings matches the left-hand part of
124# the path. The tag can be used to show relative paths in the file list.
125# If left blank the directory from which doxygen is run is used as the
126# path to strip.
127
128STRIP_FROM_PATH        =
129
130# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
131# the path mentioned in the documentation of a class, which tells
132# the reader which header file to include in order to use a class.
133# If left blank only the name of the header file containing the class
134# definition is used. Otherwise one should specify the include paths that
135# are normally passed to the compiler using the -I flag.
136
137STRIP_FROM_INC_PATH    =
138
139# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
140# (but less readable) file names. This can be useful is your file systems
141# doesn't support long names like on DOS, Mac, or CD-ROM.
142
143SHORT_NAMES            = NO
144
145# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
146# will interpret the first line (until the first dot) of a JavaDoc-style
147# comment as the brief description. If set to NO, the JavaDoc
148# comments will behave just like regular Qt-style comments
149# (thus requiring an explicit @brief command for a brief description.)
150
151JAVADOC_AUTOBRIEF      = NO
152
153# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
154# interpret the first line (until the first dot) of a Qt-style
155# comment as the brief description. If set to NO, the comments
156# will behave just like regular Qt-style comments (thus requiring
157# an explicit \brief command for a brief description.)
158
159QT_AUTOBRIEF           = NO
160
161# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
162# treat a multi-line C++ special comment block (i.e. a block of //! or ///
163# comments) as a brief description. This used to be the default behaviour.
164# The new default is to treat a multi-line C++ comment block as a detailed
165# description. Set this tag to YES if you prefer the old behaviour instead.
166
167MULTILINE_CPP_IS_BRIEF = NO
168
169# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
170# member inherits the documentation from any documented member that it
171# re-implements.
172
173INHERIT_DOCS           = YES
174
175# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
176# a new page for each member. If set to NO, the documentation of a member will
177# be part of the file/class/namespace that contains it.
178
179SEPARATE_MEMBER_PAGES  = NO
180
181# The TAB_SIZE tag can be used to set the number of spaces in a tab.
182# Doxygen uses this value to replace tabs by spaces in code fragments.
183
184TAB_SIZE               = 8
185
186# This tag can be used to specify a number of aliases that acts
187# as commands in the documentation. An alias has the form "name=value".
188# For example adding "sideeffect=\par Side Effects:\n" will allow you to
189# put the command \sideeffect (or @sideeffect) in the documentation, which
190# will result in a user-defined paragraph with heading "Side Effects:".
191# You can put \n's in the value part of an alias to insert newlines.
192
193ALIASES                =
194
195# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
196# sources only. Doxygen will then generate output that is more tailored for C.
197# For instance, some of the names that are used will be different. The list
198# of all members will be omitted, etc.
199
200OPTIMIZE_OUTPUT_FOR_C  = YES
201
202# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
203# sources only. Doxygen will then generate output that is more tailored for
204# Java. For instance, namespaces will be presented as packages, qualified
205# scopes will look different, etc.
206
207OPTIMIZE_OUTPUT_JAVA   = NO
208
209# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
210# sources only. Doxygen will then generate output that is more tailored for
211# Fortran.
212
213OPTIMIZE_FOR_FORTRAN   = NO
214
215# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
216# sources. Doxygen will then generate output that is tailored for
217# VHDL.
218
219OPTIMIZE_OUTPUT_VHDL   = NO
220
221# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
222# to include (a tag file for) the STL sources as input, then you should
223# set this tag to YES in order to let doxygen match functions declarations and
224# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
225# func(std::string) {}). This also make the inheritance and collaboration
226# diagrams that involve STL classes more complete and accurate.
227
228BUILTIN_STL_SUPPORT    = NO
229
230# If you use Microsoft's C++/CLI language, you should set this option to YES to
231# enable parsing support.
232
233CPP_CLI_SUPPORT        = NO
234
235# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
236# Doxygen will parse them like normal C++ but will assume all classes use public
237# instead of private inheritance when no explicit protection keyword is present.
238
239SIP_SUPPORT            = NO
240
241# For Microsoft's IDL there are propget and propput attributes to indicate getter
242# and setter methods for a property. Setting this option to YES (the default)
243# will make doxygen to replace the get and set methods by a property in the
244# documentation. This will only work if the methods are indeed getting or
245# setting a simple type. If this is not the case, or you want to show the
246# methods anyway, you should set this option to NO.
247
248IDL_PROPERTY_SUPPORT   = YES
249
250# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
251# tag is set to YES, then doxygen will reuse the documentation of the first
252# member in the group (if any) for the other members of the group. By default
253# all members of a group must be documented explicitly.
254
255DISTRIBUTE_GROUP_DOC   = NO
256
257# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
258# the same type (for instance a group of public functions) to be put as a
259# subgroup of that type (e.g. under the Public Functions section). Set it to
260# NO to prevent subgrouping. Alternatively, this can be done per class using
261# the \nosubgrouping command.
262
263SUBGROUPING            = YES
264
265# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
266# is documented as struct, union, or enum with the name of the typedef. So
267# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
268# with name TypeT. When disabled the typedef will appear as a member of a file,
269# namespace, or class. And the struct will be named TypeS. This can typically
270# be useful for C code in case the coding convention dictates that all compound
271# types are typedef'ed and only the typedef is referenced, never the tag name.
272
273TYPEDEF_HIDES_STRUCT   = YES
274
275# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
276# determine which symbols to keep in memory and which to flush to disk.
277# When the cache is full, less often used symbols will be written to disk.
278# For small to medium size projects (<1000 input files) the default value is
279# probably good enough. For larger projects a too small cache size can cause
280# doxygen to be busy swapping symbols to and from disk most of the time
281# causing a significant performance penality.
282# If the system has enough physical memory increasing the cache will improve the
283# performance by keeping more symbols in memory. Note that the value works on
284# a logarithmic scale so increasing the size by one will rougly double the
285# memory usage. The cache size is given by this formula:
286# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
287# corresponding to a cache size of 2^16 = 65536 symbols
288
289#SYMBOL_CACHE_SIZE      = 0
290
291#---------------------------------------------------------------------------
292# Build related configuration options
293#---------------------------------------------------------------------------
294
295# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
296# documentation are documented, even if no documentation was available.
297# Private class members and static file members will be hidden unless
298# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
299
300EXTRACT_ALL            = NO
301
302# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
303# will be included in the documentation.
304
305EXTRACT_PRIVATE        = NO
306
307# If the EXTRACT_STATIC tag is set to YES all static members of a file
308# will be included in the documentation.
309
310EXTRACT_STATIC         = NO
311
312# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
313# defined locally in source files will be included in the documentation.
314# If set to NO only classes defined in header files are included.
315
316EXTRACT_LOCAL_CLASSES  = YES
317
318# This flag is only useful for Objective-C code. When set to YES local
319# methods, which are defined in the implementation section but not in
320# the interface are included in the documentation.
321# If set to NO (the default) only methods in the interface are included.
322
323EXTRACT_LOCAL_METHODS  = NO
324
325# If this flag is set to YES, the members of anonymous namespaces will be
326# extracted and appear in the documentation as a namespace called
327# 'anonymous_namespace{file}', where file will be replaced with the base
328# name of the file that contains the anonymous namespace. By default
329# anonymous namespace are hidden.
330
331EXTRACT_ANON_NSPACES   = NO
332
333# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
334# undocumented members of documented classes, files or namespaces.
335# If set to NO (the default) these members will be included in the
336# various overviews, but no documentation section is generated.
337# This option has no effect if EXTRACT_ALL is enabled.
338
339HIDE_UNDOC_MEMBERS     = YES
340
341# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
342# undocumented classes that are normally visible in the class hierarchy.
343# If set to NO (the default) these classes will be included in the various
344# overviews. This option has no effect if EXTRACT_ALL is enabled.
345
346HIDE_UNDOC_CLASSES     = YES
347
348# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
349# friend (class|struct|union) declarations.
350# If set to NO (the default) these declarations will be included in the
351# documentation.
352
353HIDE_FRIEND_COMPOUNDS  = NO
354
355# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
356# documentation blocks found inside the body of a function.
357# If set to NO (the default) these blocks will be appended to the
358# function's detailed documentation block.
359
360HIDE_IN_BODY_DOCS      = NO
361
362# The INTERNAL_DOCS tag determines if documentation
363# that is typed after a \internal command is included. If the tag is set
364# to NO (the default) then the documentation will be excluded.
365# Set it to YES to include the internal documentation.
366
367INTERNAL_DOCS          = NO
368
369# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
370# file names in lower-case letters. If set to YES upper-case letters are also
371# allowed. This is useful if you have classes or files whose names only differ
372# in case and if your file system supports case sensitive file names. Windows
373# and Mac users are advised to set this option to NO.
374
375CASE_SENSE_NAMES       = NO
376
377# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
378# will show members with their full class and namespace scopes in the
379# documentation. If set to YES the scope will be hidden.
380
381HIDE_SCOPE_NAMES       = NO
382
383# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
384# will put a list of the files that are included by a file in the documentation
385# of that file.
386
387SHOW_INCLUDE_FILES     = YES
388
389# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
390# is inserted in the documentation for inline members.
391
392INLINE_INFO            = YES
393
394# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
395# will sort the (detailed) documentation of file and class members
396# alphabetically by member name. If set to NO the members will appear in
397# declaration order.
398
399SORT_MEMBER_DOCS       = YES
400
401# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
402# brief documentation of file, namespace and class members alphabetically
403# by member name. If set to NO (the default) the members will appear in
404# declaration order.
405
406SORT_BRIEF_DOCS        = NO
407
408# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
409# hierarchy of group names into alphabetical order. If set to NO (the default)
410# the group names will appear in their defined order.
411
412SORT_GROUP_NAMES       = NO
413
414# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
415# sorted by fully-qualified names, including namespaces. If set to
416# NO (the default), the class list will be sorted only by class name,
417# not including the namespace part.
418# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
419# Note: This option applies only to the class list, not to the
420# alphabetical list.
421
422SORT_BY_SCOPE_NAME     = NO
423
424# The GENERATE_TODOLIST tag can be used to enable (YES) or
425# disable (NO) the todo list. This list is created by putting \todo
426# commands in the documentation.
427
428GENERATE_TODOLIST      = NO
429
430# The GENERATE_TESTLIST tag can be used to enable (YES) or
431# disable (NO) the test list. This list is created by putting \test
432# commands in the documentation.
433
434GENERATE_TESTLIST      = YES
435
436# The GENERATE_BUGLIST tag can be used to enable (YES) or
437# disable (NO) the bug list. This list is created by putting \bug
438# commands in the documentation.
439
440GENERATE_BUGLIST       = YES
441
442# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
443# disable (NO) the deprecated list. This list is created by putting
444# \deprecated commands in the documentation.
445
446GENERATE_DEPRECATEDLIST= YES
447
448# The ENABLED_SECTIONS tag can be used to enable conditional
449# documentation sections, marked by \if sectionname ... \endif.
450
451ENABLED_SECTIONS       =
452
453# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
454# the initial value of a variable or define consists of for it to appear in
455# the documentation. If the initializer consists of more lines than specified
456# here it will be hidden. Use a value of 0 to hide initializers completely.
457# The appearance of the initializer of individual variables and defines in the
458# documentation can be controlled using \showinitializer or \hideinitializer
459# command in the documentation regardless of this setting.
460
461MAX_INITIALIZER_LINES  = 30
462
463# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
464# at the bottom of the documentation of classes and structs. If set to YES the
465# list will mention the files that were used to generate the documentation.
466
467SHOW_USED_FILES        = YES
468
469# If the sources in your project are distributed over multiple directories
470# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
471# in the documentation. The default is NO.
472
473SHOW_DIRECTORIES       = NO
474
475# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
476# This will remove the Files entry from the Quick Index and from the
477# Folder Tree View (if specified). The default is YES.
478
479SHOW_FILES             = YES
480
481# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
482# Namespaces page.  This will remove the Namespaces entry from the Quick Index
483# and from the Folder Tree View (if specified). The default is YES.
484
485SHOW_NAMESPACES        = YES
486
487# The FILE_VERSION_FILTER tag can be used to specify a program or script that
488# doxygen should invoke to get the current version for each file (typically from
489# the version control system). Doxygen will invoke the program by executing (via
490# popen()) the command <command> <input-file>, where <command> is the value of
491# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
492# provided by doxygen. Whatever the program writes to standard output
493# is used as the file version. See the manual for examples.
494
495FILE_VERSION_FILTER    =
496
497# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
498# doxygen. The layout file controls the global structure of the generated output files
499# in an output format independent way. The create the layout file that represents
500# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
501# file name after the option, if omitted DoxygenLayout.xml will be used as the name
502# of the layout file.
503
504#LAYOUT_FILE            =
505
506#---------------------------------------------------------------------------
507# configuration options related to warning and progress messages
508#---------------------------------------------------------------------------
509
510# The QUIET tag can be used to turn on/off the messages that are generated
511# by doxygen. Possible values are YES and NO. If left blank NO is used.
512
513QUIET                  = YES
514
515# The WARNINGS tag can be used to turn on/off the warning messages that are
516# generated by doxygen. Possible values are YES and NO. If left blank
517# NO is used.
518
519WARNINGS               = YES
520
521# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
522# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
523# automatically be disabled.
524
525WARN_IF_UNDOCUMENTED   = YES
526
527# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
528# potential errors in the documentation, such as not documenting some
529# parameters in a documented function, or documenting parameters that
530# don't exist or using markup commands wrongly.
531
532WARN_IF_DOC_ERROR      = YES
533
534# This WARN_NO_PARAMDOC option can be abled to get warnings for
535# functions that are documented, but have no documentation for their parameters
536# or return value. If set to NO (the default) doxygen will only warn about
537# wrong or incomplete parameter documentation, but not about the absence of
538# documentation.
539
540WARN_NO_PARAMDOC       = NO
541
542# The WARN_FORMAT tag determines the format of the warning messages that
543# doxygen can produce. The string should contain the $file, $line, and $text
544# tags, which will be replaced by the file and line number from which the
545# warning originated and the warning text. Optionally the format may contain
546# $version, which will be replaced by the version of the file (if it could
547# be obtained via FILE_VERSION_FILTER)
548
549WARN_FORMAT            = "$file:$line: $text  "
550
551# The WARN_LOGFILE tag can be used to specify a file to which warning
552# and error messages should be written. If left blank the output is written
553# to stderr.
554
555WARN_LOGFILE           = dxy.logfile
556
557#---------------------------------------------------------------------------
558# configuration options related to the input files
559#---------------------------------------------------------------------------
560
561# The INPUT tag can be used to specify the files and/or directories that contain
562# documented source files. You may enter file names like "myfile.cpp" or
563# directories like "/usr/src/myproject". Separate the files or directories
564# with spaces.
565
566INPUT                  = \
567
568@INCLUDE               = dxyOneUtopia.infile
569
570
571# This tag can be used to specify the character encoding of the source files
572# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
573# also the default input encoding. Doxygen uses libiconv (or the iconv built
574# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
575# the list of possible encodings.
576
577INPUT_ENCODING         = UTF-8
578
579# If the value of the INPUT tag contains directories, you can use the
580# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
581# and *.h) to filter out the source-files in the directories. If left
582# blank the following patterns are tested:
583# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
584# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
585
586FILE_PATTERNS          = *.c \
587                         *.cc \
588                         *.cxx \
589                         *.cpp \
590                         *.c++ \
591                         *.d \
592                         *.java \
593                         *.ii \
594                         *.ixx \
595                         *.ipp \
596                         *.i++ \
597                         *.inl \
598                         *.h \
599                         *.hh \
600                         *.hxx \
601                         *.hpp \
602                         *.h++ \
603                         *.idl \
604                         *.odl \
605                         *.cs \
606                         *.php \
607                         *.php3 \
608                         *.inc \
609                         *.m \
610                         *.mm \
611                         *.dox \
612                         *.py \
613                         *.f90 \
614                         *.f \
615                         *.vhd \
616                         *.vhdl
617
618# The RECURSIVE tag can be used to turn specify whether or not subdirectories
619# should be searched for input files as well. Possible values are YES and NO.
620# If left blank NO is used.
621
622RECURSIVE              = NO
623
624# The EXCLUDE tag can be used to specify files and/or directories that should
625# excluded from the INPUT source files. This way you can easily exclude a
626# subdirectory from a directory tree whose root is specified with the INPUT tag.
627
628EXCLUDE                =
629
630# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
631# directories that are symbolic links (a Unix filesystem feature) are excluded
632# from the input.
633
634EXCLUDE_SYMLINKS       = NO
635
636# If the value of the INPUT tag contains directories, you can use the
637# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
638# certain files from those directories. Note that the wildcards are matched
639# against the file with absolute path, so to exclude all test directories
640# for example use the pattern */test/*
641
642EXCLUDE_PATTERNS       =
643
644# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
645# (namespaces, classes, functions, etc.) that should be excluded from the
646# output. The symbol name can be a fully qualified name, a word, or if the
647# wildcard * is used, a substring. Examples: ANamespace, AClass,
648# AClass::ANamespace, ANamespace::*Test
649
650EXCLUDE_SYMBOLS        =
651
652# The EXAMPLE_PATH tag can be used to specify one or more files or
653# directories that contain example code fragments that are included (see
654# the \include command).
655
656EXAMPLE_PATH           =
657
658# If the value of the EXAMPLE_PATH tag contains directories, you can use the
659# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
660# and *.h) to filter out the source-files in the directories. If left
661# blank all files are included.
662
663EXAMPLE_PATTERNS       = *
664
665# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
666# searched for input files to be used with the \include or \dontinclude
667# commands irrespective of the value of the RECURSIVE tag.
668# Possible values are YES and NO. If left blank NO is used.
669
670EXAMPLE_RECURSIVE      = NO
671
672# The IMAGE_PATH tag can be used to specify one or more files or
673# directories that contain image that are included in the documentation (see
674# the \image command).
675
676IMAGE_PATH             = ./doxy_folder
677
678# The INPUT_FILTER tag can be used to specify a program that doxygen should
679# invoke to filter for each input file. Doxygen will invoke the filter program
680# by executing (via popen()) the command <filter> <input-file>, where <filter>
681# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
682# input file. Doxygen will then use the output that the filter program writes
683# to standard output.  If FILTER_PATTERNS is specified, this tag will be
684# ignored.
685
686INPUT_FILTER           =
687
688# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
689# basis.  Doxygen will compare the file name with each pattern and apply the
690# filter if there is a match.  The filters are a list of the form:
691# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
692# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
693# is applied to all files.
694
695FILTER_PATTERNS        =
696
697# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
698# INPUT_FILTER) will be used to filter the input files when producing source
699# files to browse (i.e. when SOURCE_BROWSER is set to YES).
700
701FILTER_SOURCE_FILES    = NO
702
703#---------------------------------------------------------------------------
704# configuration options related to source browsing
705#---------------------------------------------------------------------------
706
707# If the SOURCE_BROWSER tag is set to YES then a list of source files will
708# be generated. Documented entities will be cross-referenced with these sources.
709# Note: To get rid of all source code in the generated output, make sure also
710# VERBATIM_HEADERS is set to NO.
711
712SOURCE_BROWSER         = NO
713
714# Setting the INLINE_SOURCES tag to YES will include the body
715# of functions and classes directly in the documentation.
716
717INLINE_SOURCES         = NO
718
719# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
720# doxygen to hide any special comment blocks from generated source code
721# fragments. Normal C and C++ comments will always remain visible.
722
723STRIP_CODE_COMMENTS    = YES
724
725# If the REFERENCED_BY_RELATION tag is set to YES
726# then for each documented function all documented
727# functions referencing it will be listed.
728
729REFERENCED_BY_RELATION = NO
730
731# If the REFERENCES_RELATION tag is set to YES
732# then for each documented function all documented entities
733# called/used by that function will be listed.
734
735REFERENCES_RELATION    = NO
736
737# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
738# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
739# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
740# link to the source code.  Otherwise they will link to the documentstion.
741
742REFERENCES_LINK_SOURCE = NO
743
744# If the USE_HTAGS tag is set to YES then the references to source code
745# will point to the HTML generated by the htags(1) tool instead of doxygen
746# built-in source browser. The htags tool is part of GNU's global source
747# tagging system (see http://www.gnu.org/software/global/global.html). You
748# will need version 4.8.6 or higher.
749
750USE_HTAGS              = NO
751
752# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
753# will generate a verbatim copy of the header file for each class for
754# which an include is specified. Set to NO to disable this.
755
756VERBATIM_HEADERS       = NO
757
758#---------------------------------------------------------------------------
759# configuration options related to the alphabetical class index
760#---------------------------------------------------------------------------
761
762# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
763# of all compounds will be generated. Enable this if the project
764# contains a lot of classes, structs, unions or interfaces.
765
766ALPHABETICAL_INDEX     = NO
767
768# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
769# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
770# in which this list will be split (can be a number in the range [1..20])
771
772COLS_IN_ALPHA_INDEX    = 5
773
774# In case all classes in a project start with a common prefix, all
775# classes will be put under the same header in the alphabetical index.
776# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
777# should be ignored while generating the index headers.
778
779IGNORE_PREFIX          =
780
781#---------------------------------------------------------------------------
782# configuration options related to the HTML output
783#---------------------------------------------------------------------------
784
785# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
786# generate HTML output.
787
788GENERATE_HTML          = YES
789
790# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
791# If a relative path is entered the value of OUTPUT_DIRECTORY will be
792# put in front of it. If left blank `html' will be used as the default path.
793
794HTML_OUTPUT            = html
795
796# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
797# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
798# doxygen will generate files with .html extension.
799
800HTML_FILE_EXTENSION    = .html
801
802# The HTML_HEADER tag can be used to specify a personal HTML header for
803# each generated HTML page. If it is left blank doxygen will generate a
804# standard header.
805
806HTML_HEADER            =
807
808# The HTML_FOOTER tag can be used to specify a personal HTML footer for
809# each generated HTML page. If it is left blank doxygen will generate a
810# standard footer.
811
812HTML_FOOTER            =
813
814# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
815# style sheet that is used by each HTML page. It can be used to
816# fine-tune the look of the HTML output. If the tag is left blank doxygen
817# will generate a default style sheet. Note that doxygen will try to copy
818# the style sheet file to the HTML output directory, so don't put your own
819# stylesheet in the HTML output directory as well, or it will be erased!
820
821HTML_STYLESHEET        =
822
823# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
824# files or namespaces will be aligned in HTML using tables. If set to
825# NO a bullet list will be used.
826
827HTML_ALIGN_MEMBERS     = YES
828
829# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
830# documentation will contain sections that can be hidden and shown after the
831# page has loaded. For this to work a browser that supports
832# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
833# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
834
835HTML_DYNAMIC_SECTIONS  = NO
836
837# If the GENERATE_DOCSET tag is set to YES, additional index files
838# will be generated that can be used as input for Apple's Xcode 3
839# integrated development environment, introduced with OSX 10.5 (Leopard).
840# To create a documentation set, doxygen will generate a Makefile in the
841# HTML output directory. Running make will produce the docset in that
842# directory and running "make install" will install the docset in
843# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
844# it at startup.
845# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
846
847GENERATE_DOCSET        = NO
848
849# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
850# feed. A documentation feed provides an umbrella under which multiple
851# documentation sets from a single provider (such as a company or product suite)
852# can be grouped.
853
854DOCSET_FEEDNAME        = "Doxygen generated docs"
855
856# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
857# should uniquely identify the documentation set bundle. This should be a
858# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
859# will append .docset to the name.
860
861DOCSET_BUNDLE_ID       = org.doxygen.Project
862
863# If the GENERATE_HTMLHELP tag is set to YES, additional index files
864# will be generated that can be used as input for tools like the
865# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
866# of the generated HTML documentation.
867
868GENERATE_HTMLHELP      = NO
869
870# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
871# be used to specify the file name of the resulting .chm file. You
872# can add a path in front of the file if the result should not be
873# written to the html output directory.
874
875CHM_FILE               = a5_nos.CHM
876
877# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
878# be used to specify the location (absolute path including file name) of
879# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
880# the HTML help compiler on the generated index.hhp.
881
882HHC_LOCATION           = "C:\Program Files\HTML Help Workshop\hhc.exe"
883
884# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
885# controls if a separate .chi index file is generated (YES) or that
886# it should be included in the master .chm file (NO).
887
888GENERATE_CHI           = NO
889
890# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
891# is used to encode HtmlHelp index (hhk), content (hhc) and project file
892# content.
893
894CHM_INDEX_ENCODING     =
895
896# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
897# controls whether a binary table of contents is generated (YES) or a
898# normal table of contents (NO) in the .chm file.
899
900BINARY_TOC             = NO
901
902# The TOC_EXPAND flag can be set to YES to add extra items for group members
903# to the contents of the HTML help documentation and to the tree view.
904
905TOC_EXPAND             = NO
906
907# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
908# are set, an additional index file will be generated that can be used as input for
909# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
910# HTML documentation.
911
912#GENERATE_QHP           = NO
913
914# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
915# be used to specify the file name of the resulting .qch file.
916# The path specified is relative to the HTML output folder.
917
918#QCH_FILE               =
919
920# The QHP_NAMESPACE tag specifies the namespace to use when generating
921# Qt Help Project output. For more information please see
922# <a href="http://doc.trolltech.com/qthelpproject.html#namespace">Qt Help Project / Namespace</a>.
923
924#QHP_NAMESPACE          = org.doxygen.Project
925
926# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
927# Qt Help Project output. For more information please see
928# <a href="http://doc.trolltech.com/qthelpproject.html#virtual-folders">Qt Help Project / Virtual Folders</a>.
929
930#QHP_VIRTUAL_FOLDER     = doc
931
932# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
933# be used to specify the location of Qt's qhelpgenerator.
934# If non-empty doxygen will try to run qhelpgenerator on the generated
935# .qhp file .
936
937#QHG_LOCATION           =
938
939# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
940# top of each HTML page. The value NO (the default) enables the index and
941# the value YES disables it.
942
943DISABLE_INDEX          = NO
944
945# This tag can be used to set the number of enum values (range [1..20])
946# that doxygen will group on one line in the generated HTML documentation.
947
948ENUM_VALUES_PER_LINE   = 4
949
950# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
951# structure should be generated to display hierarchical information.
952# If the tag value is set to FRAME, a side panel will be generated
953# containing a tree-like index structure (just like the one that
954# is generated for HTML Help). For this to work a browser that supports
955# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
956# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
957# probably better off using the HTML help feature. Other possible values
958# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
959# and Class Hierarchy pages using a tree view instead of an ordered list;
960# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
961# disables this behavior completely. For backwards compatibility with previous
962# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
963# respectively.
964
965GENERATE_TREEVIEW      = YES
966
967# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
968# used to set the initial width (in pixels) of the frame in which the tree
969# is shown.
970
971TREEVIEW_WIDTH         = 250
972
973# Use this tag to change the font size of Latex formulas included
974# as images in the HTML documentation. The default is 10. Note that
975# when you change the font size after a successful doxygen run you need
976# to manually remove any form_*.png images from the HTML output directory
977# to force them to be regenerated.
978
979FORMULA_FONTSIZE       = 10
980
981#---------------------------------------------------------------------------
982# configuration options related to the LaTeX output
983#---------------------------------------------------------------------------
984
985# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
986# generate Latex output.
987
988GENERATE_LATEX         = YES
989
990# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
991# If a relative path is entered the value of OUTPUT_DIRECTORY will be
992# put in front of it. If left blank `latex' will be used as the default path.
993
994LATEX_OUTPUT           = latex
995
996# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
997# invoked. If left blank `latex' will be used as the default command name.
998
999LATEX_CMD_NAME         = latex
1000
1001# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
1002# generate index for LaTeX. If left blank `makeindex' will be used as the
1003# default command name.
1004
1005MAKEINDEX_CMD_NAME     = makeindex
1006
1007# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
1008# LaTeX documents. This may be useful for small projects and may help to
1009# save some trees in general.
1010
1011COMPACT_LATEX          = YES
1012
1013# The PAPER_TYPE tag can be used to set the paper type that is used
1014# by the printer. Possible values are: a4, a4wide, letter, legal and
1015# executive. If left blank a4wide will be used.
1016
1017PAPER_TYPE             = a4
1018
1019# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1020# packages that should be included in the LaTeX output.
1021
1022EXTRA_PACKAGES         =
1023
1024# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
1025# the generated latex document. The header should contain everything until
1026# the first chapter. If it is left blank doxygen will generate a
1027# standard header. Notice: only use this tag if you know what you are doing!
1028
1029LATEX_HEADER           =
1030
1031# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1032# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1033# contain links (just like the HTML output) instead of page references
1034# This makes the output suitable for online browsing using a pdf viewer.
1035
1036PDF_HYPERLINKS         = YES
1037
1038# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
1039# plain latex in the generated Makefile. Set this option to YES to get a
1040# higher quality PDF documentation.
1041
1042USE_PDFLATEX           = YES
1043
1044# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
1045# command to the generated LaTeX files. This will instruct LaTeX to keep
1046# running if errors occur, instead of asking the user for help.
1047# This option is also used when generating formulas in HTML.
1048
1049LATEX_BATCHMODE        = NO
1050
1051# If LATEX_HIDE_INDICES is set to YES then doxygen will not
1052# include the index chapters (such as File Index, Compound Index, etc.)
1053# in the output.
1054
1055LATEX_HIDE_INDICES     = NO
1056
1057#---------------------------------------------------------------------------
1058# configuration options related to the RTF output
1059#---------------------------------------------------------------------------
1060
1061# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
1062# The RTF output is optimized for Word 97 and may not look very pretty with
1063# other RTF readers or editors.
1064
1065GENERATE_RTF           = YES
1066
1067# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
1068# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1069# put in front of it. If left blank `rtf' will be used as the default path.
1070
1071RTF_OUTPUT             = rtf
1072
1073# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
1074# RTF documents. This may be useful for small projects and may help to
1075# save some trees in general.
1076
1077COMPACT_RTF            = YES
1078
1079# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
1080# will contain hyperlink fields. The RTF file will
1081# contain links (just like the HTML output) instead of page references.
1082# This makes the output suitable for online browsing using WORD or other
1083# programs which support those fields.
1084# Note: wordpad (write) and others do not support links.
1085
1086RTF_HYPERLINKS         = YES
1087
1088# Load stylesheet definitions from file. Syntax is similar to doxygen's
1089# config file, i.e. a series of assignments. You only have to provide
1090# replacements, missing definitions are set to their default value.
1091
1092RTF_STYLESHEET_FILE    =
1093
1094# Set optional variables used in the generation of an rtf document.
1095# Syntax is similar to doxygen's config file.
1096
1097RTF_EXTENSIONS_FILE    =
1098
1099#---------------------------------------------------------------------------
1100# configuration options related to the man page output
1101#---------------------------------------------------------------------------
1102
1103# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1104# generate man pages
1105
1106GENERATE_MAN           = NO
1107
1108# The MAN_OUTPUT tag is used to specify where the man pages will be put.
1109# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1110# put in front of it. If left blank `man' will be used as the default path.
1111
1112MAN_OUTPUT             = man
1113
1114# The MAN_EXTENSION tag determines the extension that is added to
1115# the generated man pages (default is the subroutine's section .3)
1116
1117MAN_EXTENSION          = .3
1118
1119# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1120# then it will generate one additional man file for each entity
1121# documented in the real man page(s). These additional files
1122# only source the real man page, but without them the man command
1123# would be unable to find the correct page. The default is NO.
1124
1125MAN_LINKS              = NO
1126
1127#---------------------------------------------------------------------------
1128# configuration options related to the XML output
1129#---------------------------------------------------------------------------
1130
1131# If the GENERATE_XML tag is set to YES Doxygen will
1132# generate an XML file that captures the structure of
1133# the code including all documentation.
1134
1135GENERATE_XML           = NO
1136
1137# The XML_OUTPUT tag is used to specify where the XML pages will be put.
1138# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1139# put in front of it. If left blank `xml' will be used as the default path.
1140
1141XML_OUTPUT             = xml
1142
1143# The XML_SCHEMA tag can be used to specify an XML schema,
1144# which can be used by a validating XML parser to check the
1145# syntax of the XML files.
1146
1147XML_SCHEMA             =
1148
1149# The XML_DTD tag can be used to specify an XML DTD,
1150# which can be used by a validating XML parser to check the
1151# syntax of the XML files.
1152
1153XML_DTD                =
1154
1155# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1156# dump the program listings (including syntax highlighting
1157# and cross-referencing information) to the XML output. Note that
1158# enabling this will significantly increase the size of the XML output.
1159
1160XML_PROGRAMLISTING     = YES
1161
1162#---------------------------------------------------------------------------
1163# configuration options for the AutoGen Definitions output
1164#---------------------------------------------------------------------------
1165
1166# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1167# generate an AutoGen Definitions (see autogen.sf.net) file
1168# that captures the structure of the code including all
1169# documentation. Note that this feature is still experimental
1170# and incomplete at the moment.
1171
1172GENERATE_AUTOGEN_DEF   = NO
1173
1174#---------------------------------------------------------------------------
1175# configuration options related to the Perl module output
1176#---------------------------------------------------------------------------
1177
1178# If the GENERATE_PERLMOD tag is set to YES Doxygen will
1179# generate a Perl module file that captures the structure of
1180# the code including all documentation. Note that this
1181# feature is still experimental and incomplete at the
1182# moment.
1183
1184GENERATE_PERLMOD       = NO
1185
1186# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1187# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1188# to generate PDF and DVI output from the Perl module output.
1189
1190PERLMOD_LATEX          = YES
1191
1192# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1193# nicely formatted so it can be parsed by a human reader.  This is useful
1194# if you want to understand what is going on.  On the other hand, if this
1195# tag is set to NO the size of the Perl module output will be much smaller
1196# and Perl will parse it just the same.
1197
1198PERLMOD_PRETTY         = YES
1199
1200# The names of the make variables in the generated doxyrules.make file
1201# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1202# This is useful so different doxyrules.make files included by the same
1203# Makefile don't overwrite each other's variables.
1204
1205PERLMOD_MAKEVAR_PREFIX =
1206
1207#---------------------------------------------------------------------------
1208# Configuration options related to the preprocessor
1209#---------------------------------------------------------------------------
1210
1211# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1212# evaluate all C-preprocessor directives found in the sources and include
1213# files.
1214
1215ENABLE_PREPROCESSING   = YES
1216
1217# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1218# names in the source code. If set to NO (the default) only conditional
1219# compilation will be performed. Macro expansion can be done in a controlled
1220# way by setting EXPAND_ONLY_PREDEF to YES.
1221
1222MACRO_EXPANSION        = YES
1223
1224# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1225# then the macro expansion is limited to the macros specified with the
1226# PREDEFINED and EXPAND_AS_DEFINED tags.
1227
1228EXPAND_ONLY_PREDEF     = YES
1229
1230# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1231# in the INCLUDE_PATH (see below) will be search if a #include is found.
1232
1233SEARCH_INCLUDES        = NO
1234
1235# The INCLUDE_PATH tag can be used to specify one or more directories that
1236# contain include files that are not input files but should be processed by
1237# the preprocessor.
1238
1239INCLUDE_PATH           =
1240
1241# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1242# patterns (like *.h and *.hpp) to filter out the header-files in the
1243# directories. If left blank, the patterns specified with FILE_PATTERNS will
1244# be used.
1245
1246INCLUDE_FILE_PATTERNS  =
1247
1248# The PREDEFINED tag can be used to specify one or more macro names that
1249# are defined before the preprocessor is started (similar to the -D option of
1250# gcc). The argument of the tag is a list of macros of the form: name
1251# or name=definition (no spaces). If the definition and the = are
1252# omitted =1 is assumed. To prevent a macro definition from being
1253# undefined via #undef or recursively expanded use the := operator
1254# instead of the = operator.
1255
1256PREDEFINED             = IIC_UNIT_NUM=2 \
1257                         MSOS_TYPE_LINUX \
1258                         __attribute__(x)=
1259
1260# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1261# this tag can be used to specify a list of macro names that should be expanded.
1262# The macro definition that is found in the sources will be used.
1263# Use the PREDEFINED tag if you want to use a different macro definition.
1264
1265EXPAND_AS_DEFINED      =
1266
1267# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1268# doxygen's preprocessor will remove all function-like macros that are alone
1269# on a line, have an all uppercase name, and do not end with a semicolon. Such
1270# function macros are typically used for boiler-plate code, and will confuse
1271# the parser if not removed.
1272
1273SKIP_FUNCTION_MACROS   = YES
1274
1275#---------------------------------------------------------------------------
1276# Configuration::additions related to external references
1277#---------------------------------------------------------------------------
1278
1279# The TAGFILES option can be used to specify one or more tagfiles.
1280# Optionally an initial location of the external documentation
1281# can be added for each tagfile. The format of a tag file without
1282# this location is as follows:
1283#   TAGFILES = file1 file2 ...
1284# Adding location for the tag files is done as follows:
1285#   TAGFILES = file1=loc1 "file2 = loc2" ...
1286# where "loc1" and "loc2" can be relative or absolute paths or
1287# URLs. If a location is present for each tag, the installdox tool
1288# does not have to be run to correct the links.
1289# Note that each tag file must have a unique name
1290# (where the name does NOT include the path)
1291# If a tag file is not located in the directory in which doxygen
1292# is run, you must also specify the path to the tagfile here.
1293
1294TAGFILES               =
1295
1296# When a file name is specified after GENERATE_TAGFILE, doxygen will create
1297# a tag file that is based on the input files it reads.
1298
1299GENERATE_TAGFILE       =
1300
1301# If the ALLEXTERNALS tag is set to YES all external classes will be listed
1302# in the class index. If set to NO only the inherited external classes
1303# will be listed.
1304
1305ALLEXTERNALS           = NO
1306
1307# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1308# in the modules index. If set to NO, only the current project's groups will
1309# be listed.
1310
1311EXTERNAL_GROUPS        = YES
1312
1313# The PERL_PATH should be the absolute path and name of the perl script
1314# interpreter (i.e. the result of `which perl').
1315
1316PERL_PATH              = /usr/bin/perl
1317
1318#---------------------------------------------------------------------------
1319# Configuration options related to the dot tool
1320#---------------------------------------------------------------------------
1321
1322# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1323# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1324# or super classes. Setting the tag to NO turns the diagrams off. Note that
1325# this option is superseded by the HAVE_DOT option below. This is only a
1326# fallback. It is recommended to install and use dot, since it yields more
1327# powerful graphs.
1328
1329CLASS_DIAGRAMS         = YES
1330
1331# You can define message sequence charts within doxygen comments using the \msc
1332# command. Doxygen will then run the mscgen tool (see
1333# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1334# documentation. The MSCGEN_PATH tag allows you to specify the directory where
1335# the mscgen tool resides. If left empty the tool is assumed to be found in the
1336# default search path.
1337
1338MSCGEN_PATH            =
1339
1340# If set to YES, the inheritance and collaboration graphs will hide
1341# inheritance and usage relations if the target is undocumented
1342# or is not a class.
1343
1344HIDE_UNDOC_RELATIONS   = YES
1345
1346# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1347# available from the path. This tool is part of Graphviz, a graph visualization
1348# toolkit from AT&T and Lucent Bell Labs. The other options in this section
1349# have no effect if this option is set to NO (the default)
1350
1351HAVE_DOT               = NO
1352
1353# By default doxygen will write a font called FreeSans.ttf to the output
1354# directory and reference it in all dot files that doxygen generates. This
1355# font does not include all possible unicode characters however, so when you need
1356# these (or just want a differently looking font) you can specify the font name
1357# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1358# which can be done by putting it in a standard location or by setting the
1359# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1360# containing the font.
1361
1362DOT_FONTNAME           = FreeSans
1363
1364# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1365# The default size is 10pt.
1366
1367#DOT_FONTSIZE           = 10
1368
1369# By default doxygen will tell dot to use the output directory to look for the
1370# FreeSans.ttf font (which doxygen will put there itself). If you specify a
1371# different font using DOT_FONTNAME you can set the path where dot
1372# can find it using this tag.
1373
1374DOT_FONTPATH           =
1375
1376# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1377# will generate a graph for each documented class showing the direct and
1378# indirect inheritance relations. Setting this tag to YES will force the
1379# the CLASS_DIAGRAMS tag to NO.
1380
1381CLASS_GRAPH            = YES
1382
1383# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1384# will generate a graph for each documented class showing the direct and
1385# indirect implementation dependencies (inheritance, containment, and
1386# class references variables) of the class with other documented classes.
1387
1388COLLABORATION_GRAPH    = YES
1389
1390# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1391# will generate a graph for groups, showing the direct groups dependencies
1392
1393GROUP_GRAPHS           = YES
1394
1395# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1396# collaboration diagrams in a style similar to the OMG's Unified Modeling
1397# Language.
1398
1399UML_LOOK               = NO
1400
1401# If set to YES, the inheritance and collaboration graphs will show the
1402# relations between templates and their instances.
1403
1404TEMPLATE_RELATIONS     = NO
1405
1406# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1407# tags are set to YES then doxygen will generate a graph for each documented
1408# file showing the direct and indirect include dependencies of the file with
1409# other documented files.
1410
1411INCLUDE_GRAPH          = YES
1412
1413# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1414# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1415# documented header file showing the documented files that directly or
1416# indirectly include this file.
1417
1418INCLUDED_BY_GRAPH      = YES
1419
1420# If the CALL_GRAPH and HAVE_DOT options are set to YES then
1421# doxygen will generate a call dependency graph for every global function
1422# or class method. Note that enabling this option will significantly increase
1423# the time of a run. So in most cases it will be better to enable call graphs
1424# for selected functions only using the \callgraph command.
1425
1426CALL_GRAPH             = NO
1427
1428# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1429# doxygen will generate a caller dependency graph for every global function
1430# or class method. Note that enabling this option will significantly increase
1431# the time of a run. So in most cases it will be better to enable caller
1432# graphs for selected functions only using the \callergraph command.
1433
1434CALLER_GRAPH           = NO
1435
1436# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1437# will graphical hierarchy of all classes instead of a textual one.
1438
1439GRAPHICAL_HIERARCHY    = YES
1440
1441# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1442# then doxygen will show the dependencies a directory has on other directories
1443# in a graphical way. The dependency relations are determined by the #include
1444# relations between the files in the directories.
1445
1446DIRECTORY_GRAPH        = YES
1447
1448# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1449# generated by dot. Possible values are png, jpg, or gif
1450# If left blank png will be used.
1451
1452DOT_IMAGE_FORMAT       = png
1453
1454# The tag DOT_PATH can be used to specify the path where the dot tool can be
1455# found. If left blank, it is assumed the dot tool can be found in the path.
1456
1457DOT_PATH               =
1458
1459# The DOTFILE_DIRS tag can be used to specify one or more directories that
1460# contain dot files that are included in the documentation (see the
1461# \dotfile command).
1462
1463DOTFILE_DIRS           =
1464
1465# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1466# nodes that will be shown in the graph. If the number of nodes in a graph
1467# becomes larger than this value, doxygen will truncate the graph, which is
1468# visualized by representing a node as a red box. Note that doxygen if the
1469# number of direct children of the root node in a graph is already larger than
1470# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1471# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1472
1473DOT_GRAPH_MAX_NODES    = 50
1474
1475# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1476# graphs generated by dot. A depth value of 3 means that only nodes reachable
1477# from the root by following a path via at most 3 edges will be shown. Nodes
1478# that lay further from the root node will be omitted. Note that setting this
1479# option to 1 or 2 may greatly reduce the computation time needed for large
1480# code bases. Also note that the size of a graph can be further restricted by
1481# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1482
1483MAX_DOT_GRAPH_DEPTH    = 1000
1484
1485# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1486# background. This is disabled by default, because dot on Windows does not
1487# seem to support this out of the box. Warning: Depending on the platform used,
1488# enabling this option may lead to badly anti-aliased labels on the edges of
1489# a graph (i.e. they become hard to read).
1490
1491DOT_TRANSPARENT        = NO
1492
1493# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1494# files in one run (i.e. multiple -o and -T options on the command line). This
1495# makes dot run faster, but since only newer versions of dot (>1.8.10)
1496# support this, this feature is disabled by default.
1497
1498DOT_MULTI_TARGETS      = NO
1499
1500# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1501# generate a legend page explaining the meaning of the various boxes and
1502# arrows in the dot generated graphs.
1503
1504GENERATE_LEGEND        = YES
1505
1506# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1507# remove the intermediate dot files that are used to generate
1508# the various graphs.
1509
1510DOT_CLEANUP            = YES
1511
1512#---------------------------------------------------------------------------
1513# Configuration::additions related to the search engine
1514#---------------------------------------------------------------------------
1515
1516# The SEARCHENGINE tag specifies whether or not a search engine should be
1517# used. If set to NO the values of all tags below this one will be ignored.
1518
1519SEARCHENGINE           = NO
1520