annotate Doxyfile @ 1265:ca301f6abef7

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