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