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