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