comparison include/doxyfile @ 5067:61d53410eb41

Fixed bug #859 CREATE_SUBDIRS helps a lot if browsing HTML documentation in a file browser. ALWAYS_DETAILED_SEC makes sure everything has at least the automatic documentation like function prototype and source references. STRIP_FROM_PATH allows you to include only the relevant portions of the files' paths, cleaning up both the file list and directory tree, though you need to change the path listed here to match wherever you put SDL. ALIASES avoids some warnings generated by C:\source\svn.libsdl.org\trunk\SDL\src\joystick\darwin\10.3.9-FIX\IOHIDLib.h. It seems Apple uses a few commands which are not normally supported by Doxygen. BUILTIN_STL_SUPPORT adds support for parsing code which makes use of the standard template library. There isn't a lot of C++ in SDL (some in bwindow at least), but this still seems like a good idea. TYPEDEF_HIDES_STRUCT means that for code like this: typedef struct A {int B;} C; C is documented as a structure containing B instead of a typedef mapped to A. EXTRACT_ALL, EXTRACT_PRIVATE, EXTRACT_STATIC, EXTRACT_LOCAL_METHODS, EXTRACT_ANON_NSPACES and INTERNAL_DOCS make sure that _everything_ is documented. CASE_SENSE_NAMES = NO avoids potential conflicts when building documentation on case insensitive file systems like NTFS and FAT32. WARN_NO_PARAMDOC lets you know when you have documented some, but not all, of the parameters of a function. This is useful when you're working on adding such documentation since it makes partially documented functions easier to spot. WARN_LOGFILE writes warnings to a seperate file instead of mixing them in with stdout. When not running in quiet mode, these warnings can be hard to spot without this flag. I added *.h.in and *.h.default to FILE_PATTERNS to generate documentation for config.h.in and config.h.default. RECURSIVE tells doxygen to look not only in the input directory, but also in subfolders. EXCLUDE avoids documenting things like test programs, examples and templates which need to be documented separately. I've used EXCLUDE_PATTERNS to exclude non-source subdirectories that often find their way into source folders (such as obj or .svn). EXAMPLE_PATH lists directories doxygen will search to find included example code. So far, SDL doesn't really use this feature, but I've listed some likely locations. SOURCE_BROWSER adds syntax highlighted source code to the HTML output. USE_HTAGS is nice, but not available on Windows. INLINE_SOURCES adds the body of a function to it's documentation so you can quickly see exactly what it does. ALPHABETICAL_INDEX generates an alphabetical list of all structures, functions, etc., which makes it much easier to find what you're looking for. IGNORE_PREFIX skips the SDL_ prefix when deciding which index page to place an item on so you don't have everything show up under "S". HTML_DYNAMIC_SECTIONS hides the includes/included by diagrams by default and adds JavaScript to allow the user to show and hide them by clicking a link. ENUM_VALUES_PER_LINE = 1 makes enums easier to read by placing each value on it's own line. GENERATE_TREEVIEW produces a two frame index page with a navigation tree on the left. I have LaTeX and man pages turned off to speed up doxygen, you may want to turn them back on yourself. I added _WIN32=1 to PREDEFINED to cause SDL to output documentation related to Win32 builds of SDL. Normally, doxygen gets confused since there are multiple definitions for various structures and formats that vary by platform. Without this doxygen can produce broken documentation or, if you're lucky, output documentation only for the dummy drivers, which isn't very useful. You need to pick a platform. GENERATE_TAGFILE produces a file which can be used to link other doxygen documentation to the SDL documentation. CLASS_DIAGRAMS turns on class diagrams even when dot is not available. HAVE_DOT tells doxygen to try to use dot to generate diagrams. TEMPLATE_RELATIONS and INCLUDE_GRAPH add additional diagrams to the documentation. DOT_MULTI_TARGETS speeds up dot. OUTPUT_DIRECTORY, INPUT and other paths reflect the fact that this Doxyfile is intended to process src as well as include and is being run from a separate subdirectory. Doxygen produces several temporary files while it's running and if interrupted, can leave those files behind. It's easier to clean up if there aren't a hundred or so files in the same folder. I typically run doxygen in SDL/doxy and set the output directory to '.'. Since doxygen puts it's output in subfolders by type, this keeps things pretty well organised. You could use '../doc' instead and get the same results.
author Sam Lantinga <slouken@libsdl.org>
date Fri, 21 Jan 2011 12:57:01 -0800
parents c121d94672cb
children 30da7089dcb4
comparison
equal deleted inserted replaced
5066:3afb71c202b2 5067:61d53410eb41
1 # Doxyfile 1.4.4 1 # Doxyfile 1.5.9
2 2
3 # This file describes the settings to be used by the documentation system 3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for a project 4 # doxygen (www.doxygen.org) for a project
5 # 5 #
6 # All text after a hash (#) is considered a comment and will be ignored 6 # All text after a hash (#) is considered a comment and will be ignored
12 12
13 #--------------------------------------------------------------------------- 13 #---------------------------------------------------------------------------
14 # Project related configuration options 14 # Project related configuration options
15 #--------------------------------------------------------------------------- 15 #---------------------------------------------------------------------------
16 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
17 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
18 # by quotes) that should identify the project. 26 # by quotes) that should identify the project.
19 27
20 PROJECT_NAME = SDL 28 PROJECT_NAME = SDL
21 29
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 36 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
29 # base path where the generated documentation will be put. 37 # base path where the generated documentation will be put.
30 # If a relative path is entered, it will be relative to the location 38 # If a relative path is entered, it will be relative to the location
31 # where doxygen was started. If left blank the current directory will be used. 39 # where doxygen was started. If left blank the current directory will be used.
32 40
33 OUTPUT_DIRECTORY = docs 41 OUTPUT_DIRECTORY = .
34 42
35 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 43 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
36 # 4096 sub-directories (in 2 levels) under the output directory of each output 44 # 4096 sub-directories (in 2 levels) under the output directory of each output
37 # format and will distribute the generated files over these directories. 45 # format and will distribute the generated files over these directories.
38 # Enabling this option can be useful when feeding doxygen a huge amount of 46 # Enabling this option can be useful when feeding doxygen a huge amount of
39 # source files, where putting all generated files in the same directory would 47 # source files, where putting all generated files in the same directory would
40 # otherwise cause performance problems for the file system. 48 # otherwise cause performance problems for the file system.
41 49
42 CREATE_SUBDIRS = NO 50 CREATE_SUBDIRS = YES
43 51
44 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 52 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
45 # documentation generated by doxygen is written. Doxygen will use this 53 # documentation generated by doxygen is written. Doxygen will use this
46 # information to generate all constant output in the proper language. 54 # information to generate all constant output in the proper language.
47 # The default language is English, other supported languages are: 55 # The default language is English, other supported languages are:
48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, 56 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, 57 # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, 58 # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 59 # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
52 # Swedish, and Ukrainian. 60 # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
61 # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
53 62
54 OUTPUT_LANGUAGE = English 63 OUTPUT_LANGUAGE = English
55
56 # This tag can be used to specify the encoding used in the generated output.
57 # The encoding is not always determined by the language that is chosen,
58 # but also whether or not the output is meant for Windows or non-Windows users.
59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
60 # forces the Windows encoding (this is the default for the Windows binary),
61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
62 # all platforms other than Windows).
63
64 USE_WINDOWS_ENCODING = NO
65 64
66 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 65 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
67 # include brief member descriptions after the members that are listed in 66 # include brief member descriptions after the members that are listed in
68 # the file and class documentation (similar to JavaDoc). 67 # the file and class documentation (similar to JavaDoc).
69 # Set to NO to disable this. 68 # Set to NO to disable this.
85 # If left blank, the following values are used ("$name" is automatically 84 # If left blank, the following values are used ("$name" is automatically
86 # replaced with the name of the entity): "The $name class" "The $name widget" 85 # replaced with the name of the entity): "The $name class" "The $name widget"
87 # "The $name file" "is" "provides" "specifies" "contains" 86 # "The $name file" "is" "provides" "specifies" "contains"
88 # "represents" "a" "an" "the" 87 # "represents" "a" "an" "the"
89 88
90 ABBREVIATE_BRIEF = 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
91 100
92 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 101 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
93 # Doxygen will generate a detailed section even if there is only a brief 102 # Doxygen will generate a detailed section even if there is only a brief
94 # description. 103 # description.
95 104
96 ALWAYS_DETAILED_SEC = NO 105 ALWAYS_DETAILED_SEC = YES
97 106
98 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 107 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
99 # inherited members of a class in the documentation of that class as if those 108 # inherited members of a class in the documentation of that class as if those
100 # members were ordinary class members. Constructors, destructors and assignment 109 # members were ordinary class members. Constructors, destructors and assignment
101 # operators of the base classes will not be shown. 110 # operators of the base classes will not be shown.
113 # only done if one of the specified strings matches the left-hand part of 122 # only done if one of the specified strings matches the left-hand part of
114 # the path. The tag can be used to show relative paths in the file list. 123 # the path. The tag can be used to show relative paths in the file list.
115 # If left blank the directory from which doxygen is run is used as the 124 # If left blank the directory from which doxygen is run is used as the
116 # path to strip. 125 # path to strip.
117 126
118 STRIP_FROM_PATH = 127 STRIP_FROM_PATH = ../ \
128 C:/source/svn.libsdl.org/trunk/ \
129 C:\source\svn.libsdl.org\trunk\ \
130 ..\
119 131
120 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 132 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
121 # the path mentioned in the documentation of a class, which tells 133 # the path mentioned in the documentation of a class, which tells
122 # the reader which header file to include in order to use a class. 134 # the reader which header file to include in order to use a class.
123 # If left blank only the name of the header file containing the class 135 # If left blank only the name of the header file containing the class
133 SHORT_NAMES = NO 145 SHORT_NAMES = NO
134 146
135 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 147 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
136 # will interpret the first line (until the first dot) of a JavaDoc-style 148 # will interpret the first line (until the first dot) of a JavaDoc-style
137 # comment as the brief description. If set to NO, the JavaDoc 149 # comment as the brief description. If set to NO, the JavaDoc
138 # comments will behave just like the Qt-style comments (thus requiring an 150 # comments will behave just like regular Qt-style comments
139 # explicit @brief command for a brief description. 151 # (thus requiring an explicit @brief command for a brief description.)
140 152
141 JAVADOC_AUTOBRIEF = NO 153 JAVADOC_AUTOBRIEF = NO
154
155 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
156 # interpret the first line (until the first dot) of a Qt-style
157 # comment as the brief description. If set to NO, the comments
158 # will behave just like regular Qt-style comments (thus requiring
159 # an explicit \brief command for a brief description.)
160
161 QT_AUTOBRIEF = NO
142 162
143 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 163 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
144 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 164 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
145 # comments) as a brief description. This used to be the default behaviour. 165 # comments) as a brief description. This used to be the default behaviour.
146 # The new default is to treat a multi-line C++ comment block as a detailed 166 # The new default is to treat a multi-line C++ comment block as a detailed
147 # description. Set this tag to YES if you prefer the old behaviour instead. 167 # description. Set this tag to YES if you prefer the old behaviour instead.
148 168
149 MULTILINE_CPP_IS_BRIEF = NO 169 MULTILINE_CPP_IS_BRIEF = NO
150 170
151 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
152 # will output the detailed description near the top, like JavaDoc.
153 # If set to NO, the detailed description appears after the member
154 # documentation.
155
156 DETAILS_AT_TOP = NO
157
158 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 171 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
159 # member inherits the documentation from any documented member that it 172 # member inherits the documentation from any documented member that it
160 # re-implements. 173 # re-implements.
161 174
162 INHERIT_DOCS = YES 175 INHERIT_DOCS = YES
163
164 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
165 # tag is set to YES, then doxygen will reuse the documentation of the first
166 # member in the group (if any) for the other members of the group. By default
167 # all members of a group must be documented explicitly.
168
169 DISTRIBUTE_GROUP_DOC = NO
170 176
171 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 177 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
172 # a new page for each member. If set to NO, the documentation of a member will 178 # a new page for each member. If set to NO, the documentation of a member will
173 # be part of the file/class/namespace that contains it. 179 # be part of the file/class/namespace that contains it.
174 180
184 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 190 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
185 # put the command \sideeffect (or @sideeffect) in the documentation, which 191 # put the command \sideeffect (or @sideeffect) in the documentation, which
186 # will result in a user-defined paragraph with heading "Side Effects:". 192 # will result in a user-defined paragraph with heading "Side Effects:".
187 # You can put \n's in the value part of an alias to insert newlines. 193 # You can put \n's in the value part of an alias to insert newlines.
188 194
189 ALIASES = 195 ALIASES = "defined=\"\def\"" \
196 "discussion=\"\par Discussion:\n\""
190 197
191 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 198 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
192 # sources only. Doxygen will then generate output that is more tailored for C. 199 # sources only. Doxygen will then generate output that is more tailored for C.
193 # For instance, some of the names that are used will be different. The list 200 # For instance, some of the names that are used will be different. The list
194 # of all members will be omitted, etc. 201 # of all members will be omitted, etc.
195 202
196 OPTIMIZE_OUTPUT_FOR_C = YES 203 OPTIMIZE_OUTPUT_FOR_C = YES
197 204
198 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 205 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
199 # only. Doxygen will then generate output that is more tailored for Java. 206 # sources only. Doxygen will then generate output that is more tailored for
200 # For instance, namespaces will be presented as packages, qualified scopes 207 # Java. For instance, namespaces will be presented as packages, qualified
201 # will look different, etc. 208 # scopes will look different, etc.
202 209
203 OPTIMIZE_OUTPUT_JAVA = NO 210 OPTIMIZE_OUTPUT_JAVA = NO
211
212 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
213 # sources only. Doxygen will then generate output that is more tailored for
214 # Fortran.
215
216 OPTIMIZE_FOR_FORTRAN = NO
217
218 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
219 # sources. Doxygen will then generate output that is tailored for
220 # VHDL.
221
222 OPTIMIZE_OUTPUT_VHDL = NO
223
224 # Doxygen selects the parser to use depending on the extension of the files it parses.
225 # With this tag you can assign which parser to use for a given extension.
226 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
227 # The format is ext=language, where ext is a file extension, and language is one of
228 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
229 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
230 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
231 # use: inc=Fortran f=C. Note that for custom extensions you also need to set
232 # FILE_PATTERNS otherwise the files are not read by doxygen.
233
234 EXTENSION_MAPPING =
235
236 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
237 # to include (a tag file for) the STL sources as input, then you should
238 # set this tag to YES in order to let doxygen match functions declarations and
239 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
240 # func(std::string) {}). This also make the inheritance and collaboration
241 # diagrams that involve STL classes more complete and accurate.
242
243 BUILTIN_STL_SUPPORT = YES
244
245 # If you use Microsoft's C++/CLI language, you should set this option to YES to
246 # enable parsing support.
247
248 CPP_CLI_SUPPORT = NO
249
250 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
251 # Doxygen will parse them like normal C++ but will assume all classes use public
252 # instead of private inheritance when no explicit protection keyword is present.
253
254 SIP_SUPPORT = NO
255
256 # For Microsoft's IDL there are propget and propput attributes to indicate getter
257 # and setter methods for a property. Setting this option to YES (the default)
258 # will make doxygen to replace the get and set methods by a property in the
259 # documentation. This will only work if the methods are indeed getting or
260 # setting a simple type. If this is not the case, or you want to show the
261 # methods anyway, you should set this option to NO.
262
263 IDL_PROPERTY_SUPPORT = YES
264
265 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
266 # tag is set to YES, then doxygen will reuse the documentation of the first
267 # member in the group (if any) for the other members of the group. By default
268 # all members of a group must be documented explicitly.
269
270 DISTRIBUTE_GROUP_DOC = NO
204 271
205 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 272 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
206 # the same type (for instance a group of public functions) to be put as a 273 # the same type (for instance a group of public functions) to be put as a
207 # subgroup of that type (e.g. under the Public Functions section). Set it to 274 # subgroup of that type (e.g. under the Public Functions section). Set it to
208 # NO to prevent subgrouping. Alternatively, this can be done per class using 275 # NO to prevent subgrouping. Alternatively, this can be done per class using
209 # the \nosubgrouping command. 276 # the \nosubgrouping command.
210 277
211 SUBGROUPING = YES 278 SUBGROUPING = YES
212 279
280 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
281 # is documented as struct, union, or enum with the name of the typedef. So
282 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
283 # with name TypeT. When disabled the typedef will appear as a member of a file,
284 # namespace, or class. And the struct will be named TypeS. This can typically
285 # be useful for C code in case the coding convention dictates that all compound
286 # types are typedef'ed and only the typedef is referenced, never the tag name.
287
288 TYPEDEF_HIDES_STRUCT = YES
289
290 # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
291 # determine which symbols to keep in memory and which to flush to disk.
292 # When the cache is full, less often used symbols will be written to disk.
293 # For small to medium size projects (<1000 input files) the default value is
294 # probably good enough. For larger projects a too small cache size can cause
295 # doxygen to be busy swapping symbols to and from disk most of the time
296 # causing a significant performance penality.
297 # If the system has enough physical memory increasing the cache will improve the
298 # performance by keeping more symbols in memory. Note that the value works on
299 # a logarithmic scale so increasing the size by one will rougly double the
300 # memory usage. The cache size is given by this formula:
301 # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
302 # corresponding to a cache size of 2^16 = 65536 symbols
303
304 SYMBOL_CACHE_SIZE = 0
305
213 #--------------------------------------------------------------------------- 306 #---------------------------------------------------------------------------
214 # Build related configuration options 307 # Build related configuration options
215 #--------------------------------------------------------------------------- 308 #---------------------------------------------------------------------------
216 309
217 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 310 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
218 # documentation are documented, even if no documentation was available. 311 # documentation are documented, even if no documentation was available.
219 # Private class members and static file members will be hidden unless 312 # Private class members and static file members will be hidden unless
220 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES 313 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
221 314
222 EXTRACT_ALL = NO 315 EXTRACT_ALL = YES
223 316
224 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 317 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
225 # will be included in the documentation. 318 # will be included in the documentation.
226 319
227 EXTRACT_PRIVATE = NO 320 EXTRACT_PRIVATE = YES
228 321
229 # If the EXTRACT_STATIC tag is set to YES all static members of a file 322 # If the EXTRACT_STATIC tag is set to YES all static members of a file
230 # will be included in the documentation. 323 # will be included in the documentation.
231 324
232 EXTRACT_STATIC = NO 325 EXTRACT_STATIC = YES
233 326
234 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 327 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
235 # defined locally in source files will be included in the documentation. 328 # defined locally in source files will be included in the documentation.
236 # If set to NO only classes defined in header files are included. 329 # If set to NO only classes defined in header files are included.
237 330
240 # This flag is only useful for Objective-C code. When set to YES local 333 # This flag is only useful for Objective-C code. When set to YES local
241 # methods, which are defined in the implementation section but not in 334 # methods, which are defined in the implementation section but not in
242 # the interface are included in the documentation. 335 # the interface are included in the documentation.
243 # If set to NO (the default) only methods in the interface are included. 336 # If set to NO (the default) only methods in the interface are included.
244 337
245 EXTRACT_LOCAL_METHODS = NO 338 EXTRACT_LOCAL_METHODS = YES
339
340 # If this flag is set to YES, the members of anonymous namespaces will be
341 # extracted and appear in the documentation as a namespace called
342 # 'anonymous_namespace{file}', where file will be replaced with the base
343 # name of the file that contains the anonymous namespace. By default
344 # anonymous namespace are hidden.
345
346 EXTRACT_ANON_NSPACES = YES
246 347
247 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 348 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
248 # undocumented members of documented classes, files or namespaces. 349 # undocumented members of documented classes, files or namespaces.
249 # If set to NO (the default) these members will be included in the 350 # If set to NO (the default) these members will be included in the
250 # various overviews, but no documentation section is generated. 351 # various overviews, but no documentation section is generated.
276 # The INTERNAL_DOCS tag determines if documentation 377 # The INTERNAL_DOCS tag determines if documentation
277 # that is typed after a \internal command is included. If the tag is set 378 # that is typed after a \internal command is included. If the tag is set
278 # to NO (the default) then the documentation will be excluded. 379 # to NO (the default) then the documentation will be excluded.
279 # Set it to YES to include the internal documentation. 380 # Set it to YES to include the internal documentation.
280 381
281 INTERNAL_DOCS = NO 382 INTERNAL_DOCS = YES
282 383
283 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 384 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
284 # file names in lower-case letters. If set to YES upper-case letters are also 385 # file names in lower-case letters. If set to YES upper-case letters are also
285 # allowed. This is useful if you have classes or files whose names only differ 386 # allowed. This is useful if you have classes or files whose names only differ
286 # in case and if your file system supports case sensitive file names. Windows 387 # in case and if your file system supports case sensitive file names. Windows
287 # and Mac users are advised to set this option to NO. 388 # and Mac users are advised to set this option to NO.
288 389
289 CASE_SENSE_NAMES = YES 390 CASE_SENSE_NAMES = NO
290 391
291 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 392 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
292 # will show members with their full class and namespace scopes in the 393 # will show members with their full class and namespace scopes in the
293 # documentation. If set to YES the scope will be hidden. 394 # documentation. If set to YES the scope will be hidden.
294 395
317 # by member name. If set to NO (the default) the members will appear in 418 # by member name. If set to NO (the default) the members will appear in
318 # declaration order. 419 # declaration order.
319 420
320 SORT_BRIEF_DOCS = NO 421 SORT_BRIEF_DOCS = NO
321 422
423 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
424 # hierarchy of group names into alphabetical order. If set to NO (the default)
425 # the group names will appear in their defined order.
426
427 SORT_GROUP_NAMES = NO
428
322 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 429 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
323 # sorted by fully-qualified names, including namespaces. If set to 430 # sorted by fully-qualified names, including namespaces. If set to
324 # NO (the default), the class list will be sorted only by class name, 431 # NO (the default), the class list will be sorted only by class name,
325 # not including the namespace part. 432 # not including the namespace part.
326 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 433 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
327 # Note: This option applies only to the class list, not to the 434 # Note: This option applies only to the class list, not to the
328 # alphabetical list. 435 # alphabetical list.
329 436
330 SORT_BY_SCOPE_NAME = NO 437 SORT_BY_SCOPE_NAME = NO
331 438
366 # documentation can be controlled using \showinitializer or \hideinitializer 473 # documentation can be controlled using \showinitializer or \hideinitializer
367 # command in the documentation regardless of this setting. 474 # command in the documentation regardless of this setting.
368 475
369 MAX_INITIALIZER_LINES = 30 476 MAX_INITIALIZER_LINES = 30
370 477
371 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
372 # at the bottom of the documentation of classes and structs. If set to YES the
373 # list will mention the files that were used to generate the documentation.
374
375 SHOW_USED_FILES = YES
376
377 # If the sources in your project are distributed over multiple directories 478 # If the sources in your project are distributed over multiple directories
378 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 479 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
379 # in the documentation. The default is YES. 480 # in the documentation. The default is NO.
380 481
381 SHOW_DIRECTORIES = YES 482 SHOW_DIRECTORIES = YES
382 483
484 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
485 # This will remove the Files entry from the Quick Index and from the
486 # Folder Tree View (if specified). The default is YES.
487
488 SHOW_FILES = YES
489
490 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
491 # Namespaces page. This will remove the Namespaces entry from the Quick Index
492 # and from the Folder Tree View (if specified). The default is YES.
493
494 SHOW_NAMESPACES = YES
495
383 # The FILE_VERSION_FILTER tag can be used to specify a program or script that 496 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
384 # doxygen should invoke to get the current version for each file (typically from the 497 # doxygen should invoke to get the current version for each file (typically from
385 # version control system). Doxygen will invoke the program by executing (via 498 # the version control system). Doxygen will invoke the program by executing (via
386 # popen()) the command <command> <input-file>, where <command> is the value of 499 # popen()) the command <command> <input-file>, where <command> is the value of
387 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 500 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
388 # provided by doxygen. Whatever the progam writes to standard output 501 # provided by doxygen. Whatever the program writes to standard output
389 # is used as the file version. See the manual for examples. 502 # is used as the file version. See the manual for examples.
390 503
391 FILE_VERSION_FILTER = 504 FILE_VERSION_FILTER =
505
506 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
507 # doxygen. The layout file controls the global structure of the generated output files
508 # in an output format independent way. The create the layout file that represents
509 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
510 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
511 # of the layout file.
512
513 LAYOUT_FILE =
392 514
393 #--------------------------------------------------------------------------- 515 #---------------------------------------------------------------------------
394 # configuration options related to warning and progress messages 516 # configuration options related to warning and progress messages
395 #--------------------------------------------------------------------------- 517 #---------------------------------------------------------------------------
396 518
422 # functions that are documented, but have no documentation for their parameters 544 # functions that are documented, but have no documentation for their parameters
423 # or return value. If set to NO (the default) doxygen will only warn about 545 # or return value. If set to NO (the default) doxygen will only warn about
424 # wrong or incomplete parameter documentation, but not about the absence of 546 # wrong or incomplete parameter documentation, but not about the absence of
425 # documentation. 547 # documentation.
426 548
427 WARN_NO_PARAMDOC = NO 549 WARN_NO_PARAMDOC = YES
428 550
429 # The WARN_FORMAT tag determines the format of the warning messages that 551 # The WARN_FORMAT tag determines the format of the warning messages that
430 # doxygen can produce. The string should contain the $file, $line, and $text 552 # doxygen can produce. The string should contain the $file, $line, and $text
431 # tags, which will be replaced by the file and line number from which the 553 # tags, which will be replaced by the file and line number from which the
432 # warning originated and the warning text. Optionally the format may contain 554 # warning originated and the warning text. Optionally the format may contain
437 559
438 # The WARN_LOGFILE tag can be used to specify a file to which warning 560 # The WARN_LOGFILE tag can be used to specify a file to which warning
439 # and error messages should be written. If left blank the output is written 561 # and error messages should be written. If left blank the output is written
440 # to stderr. 562 # to stderr.
441 563
442 WARN_LOGFILE = 564 WARN_LOGFILE = ./doxygen_warn.txt
443 565
444 #--------------------------------------------------------------------------- 566 #---------------------------------------------------------------------------
445 # configuration options related to the input files 567 # configuration options related to the input files
446 #--------------------------------------------------------------------------- 568 #---------------------------------------------------------------------------
447 569
448 # The INPUT tag can be used to specify the files and/or directories that contain 570 # The INPUT tag can be used to specify the files and/or directories that contain
449 # documented source files. You may enter file names like "myfile.cpp" or 571 # documented source files. You may enter file names like "myfile.cpp" or
450 # directories like "/usr/src/myproject". Separate the files or directories 572 # directories like "/usr/src/myproject". Separate the files or directories
451 # with spaces. 573 # with spaces.
452 574
453 INPUT = 575 INPUT = ..
576
577 # This tag can be used to specify the character encoding of the source files
578 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
579 # also the default input encoding. Doxygen uses libiconv (or the iconv built
580 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
581 # the list of possible encodings.
582
583 INPUT_ENCODING = UTF-8
454 584
455 # If the value of the INPUT tag contains directories, you can use the 585 # If the value of the INPUT tag contains directories, you can use the
456 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 586 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
457 # and *.h) to filter out the source-files in the directories. If left 587 # and *.h) to filter out the source-files in the directories. If left
458 # blank the following patterns are tested: 588 # blank the following patterns are tested:
459 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 589 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
460 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm 590 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
461 591
462 FILE_PATTERNS = 592 FILE_PATTERNS = *.c \
593 *.cc \
594 *.cxx \
595 *.cpp \
596 *.c++ \
597 *.d \
598 *.java \
599 *.ii \
600 *.ixx \
601 *.ipp \
602 *.i++ \
603 *.inl \
604 *.h \
605 *.hh \
606 *.hxx \
607 *.hpp \
608 *.h++ \
609 *.idl \
610 *.odl \
611 *.cs \
612 *.php \
613 *.php3 \
614 *.inc \
615 *.m \
616 *.mm \
617 *.dox \
618 *.py \
619 *.f90 \
620 *.f \
621 *.vhd \
622 *.vhdl \
623 *.h.in \
624 *.h.default
463 625
464 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 626 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
465 # should be searched for input files as well. Possible values are YES and NO. 627 # should be searched for input files as well. Possible values are YES and NO.
466 # If left blank NO is used. 628 # If left blank NO is used.
467 629
468 RECURSIVE = NO 630 RECURSIVE = YES
469 631
470 # The EXCLUDE tag can be used to specify files and/or directories that should 632 # The EXCLUDE tag can be used to specify files and/or directories that should
471 # excluded from the INPUT source files. This way you can easily exclude a 633 # excluded from the INPUT source files. This way you can easily exclude a
472 # subdirectory from a directory tree whose root is specified with the INPUT tag. 634 # subdirectory from a directory tree whose root is specified with the INPUT tag.
473 635
474 EXCLUDE = 636 EXCLUDE = ../doxy \
637 ../test \
638 ../Xcode \
639 ../VisualC \
640 ../VisualCE \
641 ../Xcode-iPhoneOS
475 642
476 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 643 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
477 # directories that are symbolic links (a Unix filesystem feature) are excluded 644 # directories that are symbolic links (a Unix filesystem feature) are excluded
478 # from the input. 645 # from the input.
479 646
483 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 650 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
484 # certain files from those directories. Note that the wildcards are matched 651 # certain files from those directories. Note that the wildcards are matched
485 # against the file with absolute path, so to exclude all test directories 652 # against the file with absolute path, so to exclude all test directories
486 # for example use the pattern */test/* 653 # for example use the pattern */test/*
487 654
488 EXCLUDE_PATTERNS = 655 EXCLUDE_PATTERNS = */.svn/* \
656 */bin/* \
657 */lib/* \
658 */obj/*
659
660 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
661 # (namespaces, classes, functions, etc.) that should be excluded from the
662 # output. The symbol name can be a fully qualified name, a word, or if the
663 # wildcard * is used, a substring. Examples: ANamespace, AClass,
664 # AClass::ANamespace, ANamespace::*Test
665
666 EXCLUDE_SYMBOLS =
489 667
490 # The EXAMPLE_PATH tag can be used to specify one or more files or 668 # The EXAMPLE_PATH tag can be used to specify one or more files or
491 # directories that contain example code fragments that are included (see 669 # directories that contain example code fragments that are included (see
492 # the \include command). 670 # the \include command).
493 671
494 EXAMPLE_PATH = 672 EXAMPLE_PATH = ../test \
673 ../Xcode \
674 ../Xcode-iPhoneOS
495 675
496 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 676 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
497 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 677 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
498 # and *.h) to filter out the source-files in the directories. If left 678 # and *.h) to filter out the source-files in the directories. If left
499 # blank all files are included. 679 # blank all files are included.
500 680
501 EXAMPLE_PATTERNS = 681 EXAMPLE_PATTERNS = *
502 682
503 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 683 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
504 # searched for input files to be used with the \include or \dontinclude 684 # searched for input files to be used with the \include or \dontinclude
505 # commands irrespective of the value of the RECURSIVE tag. 685 # commands irrespective of the value of the RECURSIVE tag.
506 # Possible values are YES and NO. If left blank NO is used. 686 # Possible values are YES and NO. If left blank NO is used.
507 687
508 EXAMPLE_RECURSIVE = NO 688 EXAMPLE_RECURSIVE = YES
509 689
510 # The IMAGE_PATH tag can be used to specify one or more files or 690 # The IMAGE_PATH tag can be used to specify one or more files or
511 # directories that contain image that are included in the documentation (see 691 # directories that contain image that are included in the documentation (see
512 # the \image command). 692 # the \image command).
513 693
545 # If the SOURCE_BROWSER tag is set to YES then a list of source files will 725 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
546 # be generated. Documented entities will be cross-referenced with these sources. 726 # be generated. Documented entities will be cross-referenced with these sources.
547 # Note: To get rid of all source code in the generated output, make sure also 727 # Note: To get rid of all source code in the generated output, make sure also
548 # VERBATIM_HEADERS is set to NO. 728 # VERBATIM_HEADERS is set to NO.
549 729
550 SOURCE_BROWSER = NO 730 SOURCE_BROWSER = YES
551 731
552 # Setting the INLINE_SOURCES tag to YES will include the body 732 # Setting the INLINE_SOURCES tag to YES will include the body
553 # of functions and classes directly in the documentation. 733 # of functions and classes directly in the documentation.
554 734
555 INLINE_SOURCES = NO 735 INLINE_SOURCES = YES
556 736
557 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 737 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
558 # doxygen to hide any special comment blocks from generated source code 738 # doxygen to hide any special comment blocks from generated source code
559 # fragments. Normal C and C++ comments will always remain visible. 739 # fragments. Normal C and C++ comments will always remain visible.
560 740
561 STRIP_CODE_COMMENTS = YES 741 STRIP_CODE_COMMENTS = NO
562 742
563 # If the REFERENCED_BY_RELATION tag is set to YES (the default) 743 # If the REFERENCED_BY_RELATION tag is set to YES
564 # then for each documented function all documented 744 # then for each documented function all documented
565 # functions referencing it will be listed. 745 # functions referencing it will be listed.
566 746
567 REFERENCED_BY_RELATION = YES 747 REFERENCED_BY_RELATION = YES
568 748
569 # If the REFERENCES_RELATION tag is set to YES (the default) 749 # If the REFERENCES_RELATION tag is set to YES
570 # then for each documented function all documented entities 750 # then for each documented function all documented entities
571 # called/used by that function will be listed. 751 # called/used by that function will be listed.
572 752
573 REFERENCES_RELATION = YES 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
574 761
575 # If the USE_HTAGS tag is set to YES then the references to source code 762 # If the USE_HTAGS tag is set to YES then the references to source code
576 # will point to the HTML generated by the htags(1) tool instead of doxygen 763 # will point to the HTML generated by the htags(1) tool instead of doxygen
577 # built-in source browser. The htags tool is part of GNU's global source 764 # built-in source browser. The htags tool is part of GNU's global source
578 # tagging system (see http://www.gnu.org/software/global/global.html). You 765 # tagging system (see http://www.gnu.org/software/global/global.html). You
592 779
593 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 780 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
594 # of all compounds will be generated. Enable this if the project 781 # of all compounds will be generated. Enable this if the project
595 # contains a lot of classes, structs, unions or interfaces. 782 # contains a lot of classes, structs, unions or interfaces.
596 783
597 ALPHABETICAL_INDEX = NO 784 ALPHABETICAL_INDEX = YES
598 785
599 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 786 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
600 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 787 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
601 # in which this list will be split (can be a number in the range [1..20]) 788 # in which this list will be split (can be a number in the range [1..20])
602 789
605 # In case all classes in a project start with a common prefix, all 792 # In case all classes in a project start with a common prefix, all
606 # classes will be put under the same header in the alphabetical index. 793 # classes will be put under the same header in the alphabetical index.
607 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 794 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
608 # should be ignored while generating the index headers. 795 # should be ignored while generating the index headers.
609 796
610 IGNORE_PREFIX = 797 IGNORE_PREFIX = SDL_ \
798 SDL
611 799
612 #--------------------------------------------------------------------------- 800 #---------------------------------------------------------------------------
613 # configuration options related to the HTML output 801 # configuration options related to the HTML output
614 #--------------------------------------------------------------------------- 802 #---------------------------------------------------------------------------
615 803
655 # files or namespaces will be aligned in HTML using tables. If set to 843 # files or namespaces will be aligned in HTML using tables. If set to
656 # NO a bullet list will be used. 844 # NO a bullet list will be used.
657 845
658 HTML_ALIGN_MEMBERS = YES 846 HTML_ALIGN_MEMBERS = YES
659 847
848 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
849 # documentation will contain sections that can be hidden and shown after the
850 # page has loaded. For this to work a browser that supports
851 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
852 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
853
854 HTML_DYNAMIC_SECTIONS = YES
855
856 # If the GENERATE_DOCSET tag is set to YES, additional index files
857 # will be generated that can be used as input for Apple's Xcode 3
858 # integrated development environment, introduced with OSX 10.5 (Leopard).
859 # To create a documentation set, doxygen will generate a Makefile in the
860 # HTML output directory. Running make will produce the docset in that
861 # directory and running "make install" will install the docset in
862 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
863 # it at startup.
864 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
865
866 GENERATE_DOCSET = NO
867
868 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
869 # feed. A documentation feed provides an umbrella under which multiple
870 # documentation sets from a single provider (such as a company or product suite)
871 # can be grouped.
872
873 DOCSET_FEEDNAME = "SDL 1.2 Doxygen"
874
875 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
876 # should uniquely identify the documentation set bundle. This should be a
877 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
878 # will append .docset to the name.
879
880 DOCSET_BUNDLE_ID = org.libsdl.sdl12
881
660 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 882 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
661 # will be generated that can be used as input for tools like the 883 # will be generated that can be used as input for tools like the
662 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 884 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
663 # of the generated HTML documentation. 885 # of the generated HTML documentation.
664 886
665 GENERATE_HTMLHELP = NO 887 GENERATE_HTMLHELP = NO
666 888
667 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 889 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
668 # be used to specify the file name of the resulting .chm file. You 890 # be used to specify the file name of the resulting .chm file. You
669 # can add a path in front of the file if the result should not be 891 # can add a path in front of the file if the result should not be
670 # written to the html output directory. 892 # written to the html output directory.
671 893
672 CHM_FILE = 894 CHM_FILE = ./sdl12.chm
673 895
674 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 896 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
675 # be used to specify the location (absolute path including file name) of 897 # be used to specify the location (absolute path including file name) of
676 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 898 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
677 # the HTML help compiler on the generated index.hhp. 899 # the HTML help compiler on the generated index.hhp.
682 # controls if a separate .chi index file is generated (YES) or that 904 # controls if a separate .chi index file is generated (YES) or that
683 # it should be included in the master .chm file (NO). 905 # it should be included in the master .chm file (NO).
684 906
685 GENERATE_CHI = NO 907 GENERATE_CHI = NO
686 908
909 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
910 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
911 # content.
912
913 CHM_INDEX_ENCODING =
914
687 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 915 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
688 # controls whether a binary table of contents is generated (YES) or a 916 # controls whether a binary table of contents is generated (YES) or a
689 # normal table of contents (NO) in the .chm file. 917 # normal table of contents (NO) in the .chm file.
690 918
691 BINARY_TOC = NO 919 BINARY_TOC = NO
692 920
693 # The TOC_EXPAND flag can be set to YES to add extra items for group members 921 # The TOC_EXPAND flag can be set to YES to add extra items for group members
694 # to the contents of the HTML help documentation and to the tree view. 922 # to the contents of the HTML help documentation and to the tree view.
695 923
696 TOC_EXPAND = NO 924 TOC_EXPAND = YES
925
926 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
927 # are set, an additional index file will be generated that can be used as input for
928 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
929 # HTML documentation.
930
931 GENERATE_QHP = NO
932
933 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can
934 # be used to specify the file name of the resulting .qch file.
935 # The path specified is relative to the HTML output folder.
936
937 QCH_FILE =
938
939 # The QHP_NAMESPACE tag specifies the namespace to use when generating
940 # Qt Help Project output. For more information please see
941 # http://doc.trolltech.com/qthelpproject.html#namespace
942
943 QHP_NAMESPACE =
944
945 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
946 # Qt Help Project output. For more information please see
947 # http://doc.trolltech.com/qthelpproject.html#virtual-folders
948
949 QHP_VIRTUAL_FOLDER = doc
950
951 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
952 # For more information please see
953 # http://doc.trolltech.com/qthelpproject.html#custom-filters
954
955 QHP_CUST_FILTER_NAME =
956
957 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
958 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
959
960 QHP_CUST_FILTER_ATTRS =
961
962 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
963 # filter section matches.
964 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
965
966 QHP_SECT_FILTER_ATTRS =
967
968 # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
969 # be used to specify the location of Qt's qhelpgenerator.
970 # If non-empty doxygen will try to run qhelpgenerator on the generated
971 # .qhp file.
972
973 QHG_LOCATION =
697 974
698 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 975 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
699 # top of each HTML page. The value NO (the default) enables the index and 976 # top of each HTML page. The value NO (the default) enables the index and
700 # the value YES disables it. 977 # the value YES disables it.
701 978
702 DISABLE_INDEX = NO 979 DISABLE_INDEX = NO
703 980
704 # This tag can be used to set the number of enum values (range [1..20]) 981 # This tag can be used to set the number of enum values (range [1..20])
705 # that doxygen will group on one line in the generated HTML documentation. 982 # that doxygen will group on one line in the generated HTML documentation.
706 983
707 ENUM_VALUES_PER_LINE = 4 984 ENUM_VALUES_PER_LINE = 1
708 985
709 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be 986 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
710 # generated containing a tree-like index structure (just like the one that 987 # structure should be generated to display hierarchical information.
988 # If the tag value is set to FRAME, a side panel will be generated
989 # containing a tree-like index structure (just like the one that
711 # is generated for HTML Help). For this to work a browser that supports 990 # is generated for HTML Help). For this to work a browser that supports
712 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, 991 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
713 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are 992 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
714 # probably better off using the HTML help feature. 993 # probably better off using the HTML help feature. Other possible values
715 994 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
716 GENERATE_TREEVIEW = NO 995 # and Class Hierarchy pages using a tree view instead of an ordered list;
996 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
997 # disables this behavior completely. For backwards compatibility with previous
998 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
999 # respectively.
1000
1001 GENERATE_TREEVIEW = ALL
717 1002
718 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 1003 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
719 # used to set the initial width (in pixels) of the frame in which the tree 1004 # used to set the initial width (in pixels) of the frame in which the tree
720 # is shown. 1005 # is shown.
721 1006
722 TREEVIEW_WIDTH = 250 1007 TREEVIEW_WIDTH = 250
723 1008
1009 # Use this tag to change the font size of Latex formulas included
1010 # as images in the HTML documentation. The default is 10. Note that
1011 # when you change the font size after a successful doxygen run you need
1012 # to manually remove any form_*.png images from the HTML output directory
1013 # to force them to be regenerated.
1014
1015 FORMULA_FONTSIZE = 10
1016
724 #--------------------------------------------------------------------------- 1017 #---------------------------------------------------------------------------
725 # configuration options related to the LaTeX output 1018 # configuration options related to the LaTeX output
726 #--------------------------------------------------------------------------- 1019 #---------------------------------------------------------------------------
727 1020
728 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 1021 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
729 # generate Latex output. 1022 # generate Latex output.
730 1023
731 GENERATE_LATEX = YES 1024 GENERATE_LATEX = NO
732 1025
733 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 1026 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
734 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1027 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
735 # put in front of it. If left blank `latex' will be used as the default path. 1028 # put in front of it. If left blank `latex' will be used as the default path.
736 1029
774 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 1067 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
775 # is prepared for conversion to pdf (using ps2pdf). The pdf file will 1068 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
776 # contain links (just like the HTML output) instead of page references 1069 # contain links (just like the HTML output) instead of page references
777 # This makes the output suitable for online browsing using a pdf viewer. 1070 # This makes the output suitable for online browsing using a pdf viewer.
778 1071
779 PDF_HYPERLINKS = NO 1072 PDF_HYPERLINKS = YES
780 1073
781 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 1074 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
782 # plain latex in the generated Makefile. Set this option to YES to get a 1075 # plain latex in the generated Makefile. Set this option to YES to get a
783 # higher quality PDF documentation. 1076 # higher quality PDF documentation.
784 1077
785 USE_PDFLATEX = NO 1078 USE_PDFLATEX = YES
786 1079
787 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 1080 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
788 # command to the generated LaTeX files. This will instruct LaTeX to keep 1081 # command to the generated LaTeX files. This will instruct LaTeX to keep
789 # running if errors occur, instead of asking the user for help. 1082 # running if errors occur, instead of asking the user for help.
790 # This option is also used when generating formulas in HTML. 1083 # This option is also used when generating formulas in HTML.
794 # If LATEX_HIDE_INDICES is set to YES then doxygen will not 1087 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
795 # include the index chapters (such as File Index, Compound Index, etc.) 1088 # include the index chapters (such as File Index, Compound Index, etc.)
796 # in the output. 1089 # in the output.
797 1090
798 LATEX_HIDE_INDICES = NO 1091 LATEX_HIDE_INDICES = NO
1092
1093 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
1094 # source code with syntax highlighting in the LaTeX output.
1095 # Note that which sources are shown also depends on other settings
1096 # such as SOURCE_BROWSER.
1097
1098 LATEX_SOURCE_CODE = NO
799 1099
800 #--------------------------------------------------------------------------- 1100 #---------------------------------------------------------------------------
801 # configuration options related to the RTF output 1101 # configuration options related to the RTF output
802 #--------------------------------------------------------------------------- 1102 #---------------------------------------------------------------------------
803 1103
844 #--------------------------------------------------------------------------- 1144 #---------------------------------------------------------------------------
845 1145
846 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 1146 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
847 # generate man pages 1147 # generate man pages
848 1148
849 GENERATE_MAN = YES 1149 GENERATE_MAN = NO
850 1150
851 # The MAN_OUTPUT tag is used to specify where the man pages will be put. 1151 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
852 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 1152 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
853 # put in front of it. If left blank `man' will be used as the default path. 1153 # put in front of it. If left blank `man' will be used as the default path.
854 1154
964 1264
965 MACRO_EXPANSION = YES 1265 MACRO_EXPANSION = YES
966 1266
967 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 1267 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
968 # then the macro expansion is limited to the macros specified with the 1268 # then the macro expansion is limited to the macros specified with the
969 # PREDEFINED and EXPAND_AS_PREDEFINED tags. 1269 # PREDEFINED and EXPAND_AS_DEFINED tags.
970 1270
971 EXPAND_ONLY_PREDEF = YES 1271 EXPAND_ONLY_PREDEF = YES
972 1272
973 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 1273 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
974 # in the INCLUDE_PATH (see below) will be search if a #include is found. 1274 # in the INCLUDE_PATH (see below) will be search if a #include is found.
995 # omitted =1 is assumed. To prevent a macro definition from being 1295 # omitted =1 is assumed. To prevent a macro definition from being
996 # undefined via #undef or recursively expanded use the := operator 1296 # undefined via #undef or recursively expanded use the := operator
997 # instead of the = operator. 1297 # instead of the = operator.
998 1298
999 PREDEFINED = DOXYGEN_SHOULD_IGNORE_THIS=1 \ 1299 PREDEFINED = DOXYGEN_SHOULD_IGNORE_THIS=1 \
1000 DECLSPEC= SDLCALL= 1300 DECLSPEC= \
1301 SDLCALL= \
1302 _WIN32=1
1001 1303
1002 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 1304 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1003 # this tag can be used to specify a list of macro names that should be expanded. 1305 # this tag can be used to specify a list of macro names that should be expanded.
1004 # The macro definition that is found in the sources will be used. 1306 # The macro definition that is found in the sources will be used.
1005 # Use the PREDEFINED tag if you want to use a different macro definition. 1307 # Use the PREDEFINED tag if you want to use a different macro definition.
1025 # TAGFILES = file1 file2 ... 1327 # TAGFILES = file1 file2 ...
1026 # Adding location for the tag files is done as follows: 1328 # Adding location for the tag files is done as follows:
1027 # TAGFILES = file1=loc1 "file2 = loc2" ... 1329 # TAGFILES = file1=loc1 "file2 = loc2" ...
1028 # where "loc1" and "loc2" can be relative or absolute paths or 1330 # where "loc1" and "loc2" can be relative or absolute paths or
1029 # URLs. If a location is present for each tag, the installdox tool 1331 # URLs. If a location is present for each tag, the installdox tool
1030 # does not have to be run to correct the links. 1332 # does not have to be run to correct the links.
1031 # Note that each tag file must have a unique name 1333 # Note that each tag file must have a unique name
1032 # (where the name does NOT include the path) 1334 # (where the name does NOT include the path)
1033 # If a tag file is not located in the directory in which doxygen 1335 # If a tag file is not located in the directory in which doxygen
1034 # is run, you must also specify the path to the tagfile here. 1336 # is run, you must also specify the path to the tagfile here.
1035 1337
1036 TAGFILES = 1338 TAGFILES =
1037 1339
1038 # When a file name is specified after GENERATE_TAGFILE, doxygen will create 1340 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1039 # a tag file that is based on the input files it reads. 1341 # a tag file that is based on the input files it reads.
1040 1342
1041 GENERATE_TAGFILE = 1343 GENERATE_TAGFILE = ./SDL.tag
1042 1344
1043 # If the ALLEXTERNALS tag is set to YES all external classes will be listed 1345 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1044 # in the class index. If set to NO only the inherited external classes 1346 # in the class index. If set to NO only the inherited external classes
1045 # will be listed. 1347 # will be listed.
1046 1348
1053 EXTERNAL_GROUPS = YES 1355 EXTERNAL_GROUPS = YES
1054 1356
1055 # The PERL_PATH should be the absolute path and name of the perl script 1357 # The PERL_PATH should be the absolute path and name of the perl script
1056 # interpreter (i.e. the result of `which perl'). 1358 # interpreter (i.e. the result of `which perl').
1057 1359
1058 PERL_PATH = /usr/bin/perl 1360 PERL_PATH = c:\Perl\bin\perl.exe
1059 1361
1060 #--------------------------------------------------------------------------- 1362 #---------------------------------------------------------------------------
1061 # Configuration options related to the dot tool 1363 # Configuration options related to the dot tool
1062 #--------------------------------------------------------------------------- 1364 #---------------------------------------------------------------------------
1063 1365
1066 # or super classes. Setting the tag to NO turns the diagrams off. Note that 1368 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1067 # this option is superseded by the HAVE_DOT option below. This is only a 1369 # this option is superseded by the HAVE_DOT option below. This is only a
1068 # fallback. It is recommended to install and use dot, since it yields more 1370 # fallback. It is recommended to install and use dot, since it yields more
1069 # powerful graphs. 1371 # powerful graphs.
1070 1372
1071 CLASS_DIAGRAMS = NO 1373 CLASS_DIAGRAMS = YES
1374
1375 # You can define message sequence charts within doxygen comments using the \msc
1376 # command. Doxygen will then run the mscgen tool (see
1377 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1378 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1379 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1380 # default search path.
1381
1382 MSCGEN_PATH =
1072 1383
1073 # If set to YES, the inheritance and collaboration graphs will hide 1384 # If set to YES, the inheritance and collaboration graphs will hide
1074 # inheritance and usage relations if the target is undocumented 1385 # inheritance and usage relations if the target is undocumented
1075 # or is not a class. 1386 # or is not a class.
1076 1387
1079 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 1390 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1080 # available from the path. This tool is part of Graphviz, a graph visualization 1391 # available from the path. This tool is part of Graphviz, a graph visualization
1081 # toolkit from AT&T and Lucent Bell Labs. The other options in this section 1392 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1082 # have no effect if this option is set to NO (the default) 1393 # have no effect if this option is set to NO (the default)
1083 1394
1084 HAVE_DOT = NO 1395 HAVE_DOT = YES
1396
1397 # By default doxygen will write a font called FreeSans.ttf to the output
1398 # directory and reference it in all dot files that doxygen generates. This
1399 # font does not include all possible unicode characters however, so when you need
1400 # these (or just want a differently looking font) you can specify the font name
1401 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1402 # which can be done by putting it in a standard location or by setting the
1403 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1404 # containing the font.
1405
1406 DOT_FONTNAME = FreeSans
1407
1408 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1409 # The default size is 10pt.
1410
1411 DOT_FONTSIZE = 10
1412
1413 # By default doxygen will tell dot to use the output directory to look for the
1414 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1415 # different font using DOT_FONTNAME you can set the path where dot
1416 # can find it using this tag.
1417
1418 DOT_FONTPATH =
1085 1419
1086 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 1420 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1087 # will generate a graph for each documented class showing the direct and 1421 # will generate a graph for each documented class showing the direct and
1088 # indirect inheritance relations. Setting this tag to YES will force the 1422 # indirect inheritance relations. Setting this tag to YES will force the
1089 # the CLASS_DIAGRAMS tag to NO. 1423 # the CLASS_DIAGRAMS tag to NO.
1109 UML_LOOK = NO 1443 UML_LOOK = NO
1110 1444
1111 # If set to YES, the inheritance and collaboration graphs will show the 1445 # If set to YES, the inheritance and collaboration graphs will show the
1112 # relations between templates and their instances. 1446 # relations between templates and their instances.
1113 1447
1114 TEMPLATE_RELATIONS = NO 1448 TEMPLATE_RELATIONS = YES
1115 1449
1116 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 1450 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1117 # tags are set to YES then doxygen will generate a graph for each documented 1451 # tags are set to YES then doxygen will generate a graph for each documented
1118 # file showing the direct and indirect include dependencies of the file with 1452 # file showing the direct and indirect include dependencies of the file with
1119 # other documented files. 1453 # other documented files.
1120 1454
1121 INCLUDE_GRAPH = NO 1455 INCLUDE_GRAPH = YES
1122 1456
1123 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 1457 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1124 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 1458 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1125 # documented header file showing the documented files that directly or 1459 # documented header file showing the documented files that directly or
1126 # indirectly include this file. 1460 # indirectly include this file.
1127 1461
1128 INCLUDED_BY_GRAPH = YES 1462 INCLUDED_BY_GRAPH = YES
1129 1463
1130 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will 1464 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1131 # generate a call dependency graph for every global function or class method. 1465 # doxygen will generate a call dependency graph for every global function
1132 # Note that enabling this option will significantly increase the time of a run. 1466 # or class method. Note that enabling this option will significantly increase
1133 # So in most cases it will be better to enable call graphs for selected 1467 # the time of a run. So in most cases it will be better to enable call graphs
1134 # functions only using the \callgraph command. 1468 # for selected functions only using the \callgraph command.
1135 1469
1136 CALL_GRAPH = NO 1470 CALL_GRAPH = NO
1471
1472 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1473 # doxygen will generate a caller dependency graph for every global function
1474 # or class method. Note that enabling this option will significantly increase
1475 # the time of a run. So in most cases it will be better to enable caller
1476 # graphs for selected functions only using the \callergraph command.
1477
1478 CALLER_GRAPH = NO
1137 1479
1138 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1480 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1139 # will graphical hierarchy of all classes instead of a textual one. 1481 # will graphical hierarchy of all classes instead of a textual one.
1140 1482
1141 GRAPHICAL_HIERARCHY = YES 1483 GRAPHICAL_HIERARCHY = YES
1142 1484
1143 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 1485 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1144 # then doxygen will show the dependencies a directory has on other directories 1486 # then doxygen will show the dependencies a directory has on other directories
1145 # in a graphical way. The dependency relations are determined by the #include 1487 # in a graphical way. The dependency relations are determined by the #include
1146 # relations between the files in the directories. 1488 # relations between the files in the directories.
1147 1489
1148 DIRECTORY_GRAPH = YES 1490 DIRECTORY_GRAPH = YES
1149 1491
1150 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 1492 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1151 # generated by dot. Possible values are png, jpg, or gif 1493 # generated by dot. Possible values are png, jpg, or gif
1152 # If left blank png will be used. 1494 # If left blank png will be used.
1153 1495
1154 DOT_IMAGE_FORMAT = png 1496 DOT_IMAGE_FORMAT = png
1155 1497
1156 # The tag DOT_PATH can be used to specify the path where the dot tool can be 1498 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1162 # contain dot files that are included in the documentation (see the 1504 # contain dot files that are included in the documentation (see the
1163 # \dotfile command). 1505 # \dotfile command).
1164 1506
1165 DOTFILE_DIRS = 1507 DOTFILE_DIRS =
1166 1508
1167 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 1509 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1168 # (in pixels) of the graphs generated by dot. If a graph becomes larger than 1510 # nodes that will be shown in the graph. If the number of nodes in a graph
1169 # this value, doxygen will try to truncate the graph, so that it fits within 1511 # becomes larger than this value, doxygen will truncate the graph, which is
1170 # the specified constraint. Beware that most browsers cannot cope with very 1512 # visualized by representing a node as a red box. Note that doxygen if the
1171 # large images. 1513 # number of direct children of the root node in a graph is already larger than
1172 1514 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1173 MAX_DOT_GRAPH_WIDTH = 1024 1515 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1174 1516
1175 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 1517 DOT_GRAPH_MAX_NODES = 50
1176 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
1177 # this value, doxygen will try to truncate the graph, so that it fits within
1178 # the specified constraint. Beware that most browsers cannot cope with very
1179 # large images.
1180
1181 MAX_DOT_GRAPH_HEIGHT = 1024
1182 1518
1183 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 1519 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1184 # graphs generated by dot. A depth value of 3 means that only nodes reachable 1520 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1185 # from the root by following a path via at most 3 edges will be shown. Nodes 1521 # from the root by following a path via at most 3 edges will be shown. Nodes
1186 # that lay further from the root node will be omitted. Note that setting this 1522 # that lay further from the root node will be omitted. Note that setting this
1187 # option to 1 or 2 may greatly reduce the computation time needed for large 1523 # option to 1 or 2 may greatly reduce the computation time needed for large
1188 # code bases. Also note that a graph may be further truncated if the graph's 1524 # code bases. Also note that the size of a graph can be further restricted by
1189 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 1525 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1190 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 1526
1191 # the graph is not depth-constrained. 1527 MAX_DOT_GRAPH_DEPTH = 2
1192
1193 MAX_DOT_GRAPH_DEPTH = 0
1194 1528
1195 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 1529 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1196 # background. This is disabled by default, which results in a white background. 1530 # background. This is disabled by default, because dot on Windows does not
1197 # Warning: Depending on the platform used, enabling this option may lead to 1531 # seem to support this out of the box. Warning: Depending on the platform used,
1198 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to 1532 # enabling this option may lead to badly anti-aliased labels on the edges of
1199 # read). 1533 # a graph (i.e. they become hard to read).
1200 1534
1201 DOT_TRANSPARENT = NO 1535 DOT_TRANSPARENT = NO
1202 1536
1203 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 1537 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1204 # files in one run (i.e. multiple -o and -T options on the command line). This 1538 # files in one run (i.e. multiple -o and -T options on the command line). This
1205 # makes dot run faster, but since only newer versions of dot (>1.8.10) 1539 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1206 # support this, this feature is disabled by default. 1540 # support this, this feature is disabled by default.
1207 1541
1208 DOT_MULTI_TARGETS = NO 1542 DOT_MULTI_TARGETS = YES
1209 1543
1210 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 1544 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1211 # generate a legend page explaining the meaning of the various boxes and 1545 # generate a legend page explaining the meaning of the various boxes and
1212 # arrows in the dot generated graphs. 1546 # arrows in the dot generated graphs.
1213 1547
1218 # the various graphs. 1552 # the various graphs.
1219 1553
1220 DOT_CLEANUP = YES 1554 DOT_CLEANUP = YES
1221 1555
1222 #--------------------------------------------------------------------------- 1556 #---------------------------------------------------------------------------
1223 # Configuration::additions related to the search engine 1557 # Options related to the search engine
1224 #--------------------------------------------------------------------------- 1558 #---------------------------------------------------------------------------
1225 1559
1226 # The SEARCHENGINE tag specifies whether or not a search engine should be 1560 # The SEARCHENGINE tag specifies whether or not a search engine should be
1227 # used. If set to NO the values of all tags below this one will be ignored. 1561 # used. If set to NO the values of all tags below this one will be ignored.
1228 1562