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