comparison Xcode/XcodeDocSet/Doxyfile @ 3331:d44a0a913aa2

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