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