1 # Doxyfile 1.3.2 |
1 # Doxyfile 1.3.6 |
2 |
2 |
3 #--------------------------------------------------------------------------- |
3 # This file describes the settings to be used by the documentation system |
4 # General configuration options |
4 # doxygen (www.doxygen.org) for a project |
5 #--------------------------------------------------------------------------- |
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 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
|
18 # by quotes) that should identify the project. |
|
19 |
6 PROJECT_NAME = hugo |
20 PROJECT_NAME = hugo |
|
21 |
|
22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. |
|
23 # This could be handy for archiving the generated documentation or |
|
24 # if some version control system is used. |
|
25 |
7 PROJECT_NUMBER = 0.1 |
26 PROJECT_NUMBER = 0.1 |
|
27 |
|
28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
|
29 # base path where the generated documentation will be put. |
|
30 # 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. |
|
32 |
8 OUTPUT_DIRECTORY = |
33 OUTPUT_DIRECTORY = |
|
34 |
|
35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
|
36 # documentation generated by doxygen is written. Doxygen will use this |
|
37 # information to generate all constant output in the proper language. |
|
38 # The default language is English, other supported languages are: |
|
39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, |
|
40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en |
|
41 # (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, |
|
42 # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
|
43 |
9 OUTPUT_LANGUAGE = English |
44 OUTPUT_LANGUAGE = English |
|
45 |
|
46 # This tag can be used to specify the encoding used in the generated output. |
|
47 # The encoding is not always determined by the language that is chosen, |
|
48 # but also whether or not the output is meant for Windows or non-Windows users. |
|
49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES |
|
50 # forces the Windows encoding (this is the default for the Windows binary), |
|
51 # whereas setting the tag to NO uses a Unix-style encoding (the default for |
|
52 # all platforms other than Windows). |
|
53 |
10 USE_WINDOWS_ENCODING = NO |
54 USE_WINDOWS_ENCODING = NO |
|
55 |
|
56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will |
|
57 # include brief member descriptions after the members that are listed in |
|
58 # the file and class documentation (similar to JavaDoc). |
|
59 # Set to NO to disable this. |
|
60 |
|
61 BRIEF_MEMBER_DESC = YES |
|
62 |
|
63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend |
|
64 # the brief description of a member or function before the detailed description. |
|
65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the |
|
66 # brief descriptions will be completely suppressed. |
|
67 |
|
68 REPEAT_BRIEF = NO |
|
69 |
|
70 # This tag implements a quasi-intelligent brief description abbreviator |
|
71 # that is used to form the text in various listings. Each string |
|
72 # in this list, if found as the leading text of the brief description, will be |
|
73 # stripped from the text and the result after processing the whole list, is used |
|
74 # as the annotated text. Otherwise, the brief description is used as-is. If left |
|
75 # blank, the following values are used ("$name" is automatically replaced with the |
|
76 # name of the entity): "The $name class" "The $name widget" "The $name file" |
|
77 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the" |
|
78 |
|
79 ABBREVIATE_BRIEF = |
|
80 |
|
81 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then |
|
82 # Doxygen will generate a detailed section even if there is only a brief |
|
83 # description. |
|
84 |
|
85 ALWAYS_DETAILED_SEC = NO |
|
86 |
|
87 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited |
|
88 # members of a class in the documentation of that class as if those members were |
|
89 # ordinary class members. Constructors, destructors and assignment operators of |
|
90 # the base classes will not be shown. |
|
91 |
|
92 INLINE_INHERITED_MEMB = NO |
|
93 |
|
94 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full |
|
95 # path before files name in the file list and in the header files. If set |
|
96 # to NO the shortest path that makes the file name unique will be used. |
|
97 |
|
98 FULL_PATH_NAMES = NO |
|
99 |
|
100 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag |
|
101 # can be used to strip a user-defined part of the path. Stripping is |
|
102 # only done if one of the specified strings matches the left-hand part of |
|
103 # the path. It is allowed to use relative paths in the argument list. |
|
104 # If left blank the directory from which doxygen is run is used as the |
|
105 # path to strip. |
|
106 |
|
107 STRIP_FROM_PATH = |
|
108 |
|
109 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
|
110 # (but less readable) file names. This can be useful is your file systems |
|
111 # doesn't support long names like on DOS, Mac, or CD-ROM. |
|
112 |
|
113 SHORT_NAMES = NO |
|
114 |
|
115 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
|
116 # will interpret the first line (until the first dot) of a JavaDoc-style |
|
117 # comment as the brief description. If set to NO, the JavaDoc |
|
118 # comments will behave just like the Qt-style comments (thus requiring an |
|
119 # explicit @brief command for a brief description. |
|
120 |
|
121 JAVADOC_AUTOBRIEF = NO |
|
122 |
|
123 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
|
124 # treat a multi-line C++ special comment block (i.e. a block of //! or /// |
|
125 # comments) as a brief description. This used to be the default behaviour. |
|
126 # The new default is to treat a multi-line C++ comment block as a detailed |
|
127 # description. Set this tag to YES if you prefer the old behaviour instead. |
|
128 |
|
129 MULTILINE_CPP_IS_BRIEF = NO |
|
130 |
|
131 # If the DETAILS_AT_TOP tag is set to YES then Doxygen |
|
132 # will output the detailed description near the top, like JavaDoc. |
|
133 # If set to NO, the detailed description appears after the member |
|
134 # documentation. |
|
135 |
|
136 DETAILS_AT_TOP = NO |
|
137 |
|
138 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
|
139 # member inherits the documentation from any documented member that it |
|
140 # re-implements. |
|
141 |
|
142 INHERIT_DOCS = NO |
|
143 |
|
144 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
|
145 # tag is set to YES, then doxygen will reuse the documentation of the first |
|
146 # member in the group (if any) for the other members of the group. By default |
|
147 # all members of a group must be documented explicitly. |
|
148 |
|
149 DISTRIBUTE_GROUP_DOC = NO |
|
150 |
|
151 # The TAB_SIZE tag can be used to set the number of spaces in a tab. |
|
152 # Doxygen uses this value to replace tabs by spaces in code fragments. |
|
153 |
|
154 TAB_SIZE = 8 |
|
155 |
|
156 # This tag can be used to specify a number of aliases that acts |
|
157 # as commands in the documentation. An alias has the form "name=value". |
|
158 # For example adding "sideeffect=\par Side Effects:\n" will allow you to |
|
159 # put the command \sideeffect (or @sideeffect) in the documentation, which |
|
160 # will result in a user-defined paragraph with heading "Side Effects:". |
|
161 # You can put \n's in the value part of an alias to insert newlines. |
|
162 |
|
163 ALIASES = |
|
164 |
|
165 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
|
166 # only. Doxygen will then generate output that is more tailored for C. |
|
167 # For instance, some of the names that are used will be different. The list |
|
168 # of all members will be omitted, etc. |
|
169 |
|
170 OPTIMIZE_OUTPUT_FOR_C = YES |
|
171 |
|
172 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources |
|
173 # only. Doxygen will then generate output that is more tailored for Java. |
|
174 # For instance, namespaces will be presented as packages, qualified scopes |
|
175 # will look different, etc. |
|
176 |
|
177 OPTIMIZE_OUTPUT_JAVA = NO |
|
178 |
|
179 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
|
180 # the same type (for instance a group of public functions) to be put as a |
|
181 # subgroup of that type (e.g. under the Public Functions section). Set it to |
|
182 # NO to prevent subgrouping. Alternatively, this can be done per class using |
|
183 # the \nosubgrouping command. |
|
184 |
|
185 SUBGROUPING = YES |
|
186 |
|
187 #--------------------------------------------------------------------------- |
|
188 # Build related configuration options |
|
189 #--------------------------------------------------------------------------- |
|
190 |
|
191 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
|
192 # documentation are documented, even if no documentation was available. |
|
193 # Private class members and static file members will be hidden unless |
|
194 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
|
195 |
11 EXTRACT_ALL = NO |
196 EXTRACT_ALL = NO |
|
197 |
|
198 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
|
199 # will be included in the documentation. |
|
200 |
12 EXTRACT_PRIVATE = NO |
201 EXTRACT_PRIVATE = NO |
|
202 |
|
203 # If the EXTRACT_STATIC tag is set to YES all static members of a file |
|
204 # will be included in the documentation. |
|
205 |
13 EXTRACT_STATIC = NO |
206 EXTRACT_STATIC = NO |
|
207 |
|
208 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
|
209 # defined locally in source files will be included in the documentation. |
|
210 # If set to NO only classes defined in header files are included. |
|
211 |
14 EXTRACT_LOCAL_CLASSES = YES |
212 EXTRACT_LOCAL_CLASSES = YES |
|
213 |
|
214 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
|
215 # undocumented members of documented classes, files or namespaces. |
|
216 # If set to NO (the default) these members will be included in the |
|
217 # various overviews, but no documentation section is generated. |
|
218 # This option has no effect if EXTRACT_ALL is enabled. |
|
219 |
15 HIDE_UNDOC_MEMBERS = YES |
220 HIDE_UNDOC_MEMBERS = YES |
|
221 |
|
222 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
|
223 # undocumented classes that are normally visible in the class hierarchy. |
|
224 # If set to NO (the default) these classes will be included in the various |
|
225 # overviews. This option has no effect if EXTRACT_ALL is enabled. |
|
226 |
16 HIDE_UNDOC_CLASSES = YES |
227 HIDE_UNDOC_CLASSES = YES |
|
228 |
|
229 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
|
230 # friend (class|struct|union) declarations. |
|
231 # If set to NO (the default) these declarations will be included in the |
|
232 # documentation. |
|
233 |
17 HIDE_FRIEND_COMPOUNDS = NO |
234 HIDE_FRIEND_COMPOUNDS = NO |
|
235 |
|
236 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
|
237 # documentation blocks found inside the body of a function. |
|
238 # If set to NO (the default) these blocks will be appended to the |
|
239 # function's detailed documentation block. |
|
240 |
18 HIDE_IN_BODY_DOCS = NO |
241 HIDE_IN_BODY_DOCS = NO |
19 BRIEF_MEMBER_DESC = YES |
242 |
20 REPEAT_BRIEF = NO |
243 # The INTERNAL_DOCS tag determines if documentation |
21 ALWAYS_DETAILED_SEC = NO |
244 # that is typed after a \internal command is included. If the tag is set |
22 INLINE_INHERITED_MEMB = NO |
245 # to NO (the default) then the documentation will be excluded. |
23 FULL_PATH_NAMES = NO |
246 # Set it to YES to include the internal documentation. |
24 STRIP_FROM_PATH = |
247 |
25 INTERNAL_DOCS = NO |
248 INTERNAL_DOCS = NO |
|
249 |
|
250 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
|
251 # file names in lower-case letters. If set to YES upper-case letters are also |
|
252 # allowed. This is useful if you have classes or files whose names only differ |
|
253 # in case and if your file system supports case sensitive file names. Windows |
|
254 # users are advised to set this option to NO. |
|
255 |
26 CASE_SENSE_NAMES = YES |
256 CASE_SENSE_NAMES = YES |
27 SHORT_NAMES = NO |
257 |
|
258 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
|
259 # will show members with their full class and namespace scopes in the |
|
260 # documentation. If set to YES the scope will be hidden. |
|
261 |
28 HIDE_SCOPE_NAMES = YES |
262 HIDE_SCOPE_NAMES = YES |
|
263 |
|
264 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
|
265 # will put a list of the files that are included by a file in the documentation |
|
266 # of that file. |
|
267 |
29 SHOW_INCLUDE_FILES = YES |
268 SHOW_INCLUDE_FILES = YES |
30 JAVADOC_AUTOBRIEF = NO |
269 |
31 MULTILINE_CPP_IS_BRIEF = NO |
270 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
32 DETAILS_AT_TOP = NO |
271 # is inserted in the documentation for inline members. |
33 INHERIT_DOCS = NO |
272 |
34 INLINE_INFO = YES |
273 INLINE_INFO = YES |
|
274 |
|
275 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
|
276 # will sort the (detailed) documentation of file and class members |
|
277 # alphabetically by member name. If set to NO the members will appear in |
|
278 # declaration order. |
|
279 |
35 SORT_MEMBER_DOCS = NO |
280 SORT_MEMBER_DOCS = NO |
36 DISTRIBUTE_GROUP_DOC = NO |
281 |
37 TAB_SIZE = 8 |
282 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the |
|
283 # brief documentation of file, namespace and class members alphabetically |
|
284 # by member name. If set to NO (the default) the members will appear in |
|
285 # declaration order. |
|
286 |
|
287 SORT_BRIEF_DOCS = NO |
|
288 |
|
289 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be |
|
290 # sorted by fully-qualified names, including namespaces. If set to |
|
291 # NO (the default), the class list will be sorted only by class name, |
|
292 # not including the namespace part. |
|
293 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. |
|
294 # Note: This option applies only to the class list, not to the |
|
295 # alphabetical list. |
|
296 |
|
297 SORT_BY_SCOPE_NAME = NO |
|
298 |
|
299 # The GENERATE_TODOLIST tag can be used to enable (YES) or |
|
300 # disable (NO) the todo list. This list is created by putting \todo |
|
301 # commands in the documentation. |
|
302 |
38 GENERATE_TODOLIST = YES |
303 GENERATE_TODOLIST = YES |
|
304 |
|
305 # The GENERATE_TESTLIST tag can be used to enable (YES) or |
|
306 # disable (NO) the test list. This list is created by putting \test |
|
307 # commands in the documentation. |
|
308 |
39 GENERATE_TESTLIST = YES |
309 GENERATE_TESTLIST = YES |
|
310 |
|
311 # The GENERATE_BUGLIST tag can be used to enable (YES) or |
|
312 # disable (NO) the bug list. This list is created by putting \bug |
|
313 # commands in the documentation. |
|
314 |
40 GENERATE_BUGLIST = YES |
315 GENERATE_BUGLIST = YES |
|
316 |
|
317 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
|
318 # disable (NO) the deprecated list. This list is created by putting |
|
319 # \deprecated commands in the documentation. |
|
320 |
41 GENERATE_DEPRECATEDLIST= YES |
321 GENERATE_DEPRECATEDLIST= YES |
42 ALIASES = |
322 |
|
323 # The ENABLED_SECTIONS tag can be used to enable conditional |
|
324 # documentation sections, marked by \if sectionname ... \endif. |
|
325 |
43 ENABLED_SECTIONS = |
326 ENABLED_SECTIONS = |
|
327 |
|
328 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
|
329 # the initial value of a variable or define consists of for it to appear in |
|
330 # the documentation. If the initializer consists of more lines than specified |
|
331 # here it will be hidden. Use a value of 0 to hide initializers completely. |
|
332 # The appearance of the initializer of individual variables and defines in the |
|
333 # documentation can be controlled using \showinitializer or \hideinitializer |
|
334 # command in the documentation regardless of this setting. |
|
335 |
44 MAX_INITIALIZER_LINES = 30 |
336 MAX_INITIALIZER_LINES = 30 |
45 OPTIMIZE_OUTPUT_FOR_C = YES |
337 |
46 OPTIMIZE_OUTPUT_JAVA = NO |
338 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
|
339 # at the bottom of the documentation of classes and structs. If set to YES the |
|
340 # list will mention the files that were used to generate the documentation. |
|
341 |
47 SHOW_USED_FILES = YES |
342 SHOW_USED_FILES = YES |
|
343 |
48 #--------------------------------------------------------------------------- |
344 #--------------------------------------------------------------------------- |
49 # configuration options related to warning and progress messages |
345 # configuration options related to warning and progress messages |
50 #--------------------------------------------------------------------------- |
346 #--------------------------------------------------------------------------- |
|
347 |
|
348 # The QUIET tag can be used to turn on/off the messages that are generated |
|
349 # by doxygen. Possible values are YES and NO. If left blank NO is used. |
|
350 |
51 QUIET = NO |
351 QUIET = NO |
|
352 |
|
353 # The WARNINGS tag can be used to turn on/off the warning messages that are |
|
354 # generated by doxygen. Possible values are YES and NO. If left blank |
|
355 # NO is used. |
|
356 |
52 WARNINGS = YES |
357 WARNINGS = YES |
|
358 |
|
359 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
|
360 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
|
361 # automatically be disabled. |
|
362 |
53 WARN_IF_UNDOCUMENTED = YES |
363 WARN_IF_UNDOCUMENTED = YES |
|
364 |
|
365 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
|
366 # potential errors in the documentation, such as not documenting some |
|
367 # parameters in a documented function, or documenting parameters that |
|
368 # don't exist or using markup commands wrongly. |
|
369 |
54 WARN_IF_DOC_ERROR = YES |
370 WARN_IF_DOC_ERROR = YES |
|
371 |
|
372 # The WARN_FORMAT tag determines the format of the warning messages that |
|
373 # doxygen can produce. The string should contain the $file, $line, and $text |
|
374 # tags, which will be replaced by the file and line number from which the |
|
375 # warning originated and the warning text. |
|
376 |
55 WARN_FORMAT = "$file:$line: $text" |
377 WARN_FORMAT = "$file:$line: $text" |
|
378 |
|
379 # The WARN_LOGFILE tag can be used to specify a file to which warning |
|
380 # and error messages should be written. If left blank the output is written |
|
381 # to stderr. |
|
382 |
56 WARN_LOGFILE = |
383 WARN_LOGFILE = |
|
384 |
57 #--------------------------------------------------------------------------- |
385 #--------------------------------------------------------------------------- |
58 # configuration options related to the input files |
386 # configuration options related to the input files |
59 #--------------------------------------------------------------------------- |
387 #--------------------------------------------------------------------------- |
|
388 |
|
389 # The INPUT tag can be used to specify the files and/or directories that contain |
|
390 # documented source files. You may enter file names like "myfile.cpp" or |
|
391 # directories like "/usr/src/myproject". Separate the files or directories |
|
392 # with spaces. |
|
393 |
60 INPUT = ../src/demo/alpar/emptygraph.h \ |
394 INPUT = ../src/demo/alpar/emptygraph.h \ |
61 ../src/doxy/invalid.h \ |
395 ../src/doxy/invalid.h \ |
62 ../src/demo/alpar/smart_graph.h \ |
396 ../src/demo/alpar/smart_graph.h \ |
63 ../src/demo/alpar/mapskeleton.h \ |
397 ../src/demo/alpar/mapskeleton.h \ |
64 ../src/demo/alpar/dijkstra/dijkstra.h \ |
398 ../src/demo/alpar/dijkstra/dijkstra.h \ |
65 ../src/demo/alpar/dijkstra/bin_heap.hh \ |
399 ../src/demo/alpar/dijkstra/bin_heap.hh \ |
66 ../src/demo/alpar/dijkstra/fib_heap.h \ |
400 ../src/demo/alpar/dijkstra/fib_heap.h \ |
|
401 ../src/demo/athos/xy/xy.h \ |
|
402 ../src/demo/athos/xy/boundingbox.h \ |
67 maps.dox |
403 maps.dox |
|
404 |
|
405 # If the value of the INPUT tag contains directories, you can use the |
|
406 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
|
407 # and *.h) to filter out the source-files in the directories. If left |
|
408 # blank the following patterns are tested: |
|
409 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp |
|
410 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc |
|
411 |
68 FILE_PATTERNS = |
412 FILE_PATTERNS = |
|
413 |
|
414 # The RECURSIVE tag can be used to turn specify whether or not subdirectories |
|
415 # should be searched for input files as well. Possible values are YES and NO. |
|
416 # If left blank NO is used. |
|
417 |
69 RECURSIVE = NO |
418 RECURSIVE = NO |
|
419 |
|
420 # The EXCLUDE tag can be used to specify files and/or directories that should |
|
421 # excluded from the INPUT source files. This way you can easily exclude a |
|
422 # subdirectory from a directory tree whose root is specified with the INPUT tag. |
|
423 |
70 EXCLUDE = |
424 EXCLUDE = |
|
425 |
|
426 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories |
|
427 # that are symbolic links (a Unix filesystem feature) are excluded from the input. |
|
428 |
71 EXCLUDE_SYMLINKS = NO |
429 EXCLUDE_SYMLINKS = NO |
|
430 |
|
431 # If the value of the INPUT tag contains directories, you can use the |
|
432 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
|
433 # certain files from those directories. |
|
434 |
72 EXCLUDE_PATTERNS = |
435 EXCLUDE_PATTERNS = |
|
436 |
|
437 # The EXAMPLE_PATH tag can be used to specify one or more files or |
|
438 # directories that contain example code fragments that are included (see |
|
439 # the \include command). |
|
440 |
73 EXAMPLE_PATH = examples |
441 EXAMPLE_PATH = examples |
|
442 |
|
443 # If the value of the EXAMPLE_PATH tag contains directories, you can use the |
|
444 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
|
445 # and *.h) to filter out the source-files in the directories. If left |
|
446 # blank all files are included. |
|
447 |
74 EXAMPLE_PATTERNS = |
448 EXAMPLE_PATTERNS = |
|
449 |
|
450 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
|
451 # searched for input files to be used with the \include or \dontinclude |
|
452 # commands irrespective of the value of the RECURSIVE tag. |
|
453 # Possible values are YES and NO. If left blank NO is used. |
|
454 |
75 EXAMPLE_RECURSIVE = NO |
455 EXAMPLE_RECURSIVE = NO |
|
456 |
|
457 # The IMAGE_PATH tag can be used to specify one or more files or |
|
458 # directories that contain image that are included in the documentation (see |
|
459 # the \image command). |
|
460 |
76 IMAGE_PATH = |
461 IMAGE_PATH = |
|
462 |
|
463 # The INPUT_FILTER tag can be used to specify a program that doxygen should |
|
464 # invoke to filter for each input file. Doxygen will invoke the filter program |
|
465 # by executing (via popen()) the command <filter> <input-file>, where <filter> |
|
466 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
|
467 # input file. Doxygen will then use the output that the filter program writes |
|
468 # to standard output. |
|
469 |
77 INPUT_FILTER = |
470 INPUT_FILTER = |
|
471 |
|
472 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
|
473 # INPUT_FILTER) will be used to filter the input files when producing source |
|
474 # files to browse (i.e. when SOURCE_BROWSER is set to YES). |
|
475 |
78 FILTER_SOURCE_FILES = NO |
476 FILTER_SOURCE_FILES = NO |
|
477 |
79 #--------------------------------------------------------------------------- |
478 #--------------------------------------------------------------------------- |
80 # configuration options related to source browsing |
479 # configuration options related to source browsing |
81 #--------------------------------------------------------------------------- |
480 #--------------------------------------------------------------------------- |
|
481 |
|
482 # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
|
483 # be generated. Documented entities will be cross-referenced with these sources. |
|
484 # Note: To get rid of all source code in the generated output, make sure also |
|
485 # VERBATIM_HEADERS is set to NO. |
|
486 |
82 SOURCE_BROWSER = YES |
487 SOURCE_BROWSER = YES |
|
488 |
|
489 # Setting the INLINE_SOURCES tag to YES will include the body |
|
490 # of functions and classes directly in the documentation. |
|
491 |
83 INLINE_SOURCES = NO |
492 INLINE_SOURCES = NO |
|
493 |
|
494 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
|
495 # doxygen to hide any special comment blocks from generated source code |
|
496 # fragments. Normal C and C++ comments will always remain visible. |
|
497 |
84 STRIP_CODE_COMMENTS = YES |
498 STRIP_CODE_COMMENTS = YES |
|
499 |
|
500 # If the REFERENCED_BY_RELATION tag is set to YES (the default) |
|
501 # then for each documented function all documented |
|
502 # functions referencing it will be listed. |
|
503 |
85 REFERENCED_BY_RELATION = YES |
504 REFERENCED_BY_RELATION = YES |
|
505 |
|
506 # If the REFERENCES_RELATION tag is set to YES (the default) |
|
507 # then for each documented function all documented entities |
|
508 # called/used by that function will be listed. |
|
509 |
86 REFERENCES_RELATION = YES |
510 REFERENCES_RELATION = YES |
|
511 |
|
512 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
|
513 # will generate a verbatim copy of the header file for each class for |
|
514 # which an include is specified. Set to NO to disable this. |
|
515 |
87 VERBATIM_HEADERS = YES |
516 VERBATIM_HEADERS = YES |
|
517 |
88 #--------------------------------------------------------------------------- |
518 #--------------------------------------------------------------------------- |
89 # configuration options related to the alphabetical class index |
519 # configuration options related to the alphabetical class index |
90 #--------------------------------------------------------------------------- |
520 #--------------------------------------------------------------------------- |
|
521 |
|
522 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
|
523 # of all compounds will be generated. Enable this if the project |
|
524 # contains a lot of classes, structs, unions or interfaces. |
|
525 |
91 ALPHABETICAL_INDEX = YES |
526 ALPHABETICAL_INDEX = YES |
|
527 |
|
528 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
|
529 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
|
530 # in which this list will be split (can be a number in the range [1..20]) |
|
531 |
92 COLS_IN_ALPHA_INDEX = 2 |
532 COLS_IN_ALPHA_INDEX = 2 |
|
533 |
|
534 # In case all classes in a project start with a common prefix, all |
|
535 # classes will be put under the same header in the alphabetical index. |
|
536 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
|
537 # should be ignored while generating the index headers. |
|
538 |
93 IGNORE_PREFIX = |
539 IGNORE_PREFIX = |
|
540 |
94 #--------------------------------------------------------------------------- |
541 #--------------------------------------------------------------------------- |
95 # configuration options related to the HTML output |
542 # configuration options related to the HTML output |
96 #--------------------------------------------------------------------------- |
543 #--------------------------------------------------------------------------- |
|
544 |
|
545 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
|
546 # generate HTML output. |
|
547 |
97 GENERATE_HTML = YES |
548 GENERATE_HTML = YES |
|
549 |
|
550 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
|
551 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
552 # put in front of it. If left blank `html' will be used as the default path. |
|
553 |
98 HTML_OUTPUT = html |
554 HTML_OUTPUT = html |
|
555 |
|
556 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
|
557 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
|
558 # doxygen will generate files with .html extension. |
|
559 |
99 HTML_FILE_EXTENSION = .html |
560 HTML_FILE_EXTENSION = .html |
|
561 |
|
562 # The HTML_HEADER tag can be used to specify a personal HTML header for |
|
563 # each generated HTML page. If it is left blank doxygen will generate a |
|
564 # standard header. |
|
565 |
100 HTML_HEADER = |
566 HTML_HEADER = |
|
567 |
|
568 # The HTML_FOOTER tag can be used to specify a personal HTML footer for |
|
569 # each generated HTML page. If it is left blank doxygen will generate a |
|
570 # standard footer. |
|
571 |
101 HTML_FOOTER = |
572 HTML_FOOTER = |
|
573 |
|
574 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
|
575 # style sheet that is used by each HTML page. It can be used to |
|
576 # fine-tune the look of the HTML output. If the tag is left blank doxygen |
|
577 # will generate a default style sheet. Note that doxygen will try to copy |
|
578 # the style sheet file to the HTML output directory, so don't put your own |
|
579 # stylesheet in the HTML output directory as well, or it will be erased! |
|
580 |
102 HTML_STYLESHEET = |
581 HTML_STYLESHEET = |
|
582 |
|
583 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
|
584 # files or namespaces will be aligned in HTML using tables. If set to |
|
585 # NO a bullet list will be used. |
|
586 |
103 HTML_ALIGN_MEMBERS = YES |
587 HTML_ALIGN_MEMBERS = YES |
|
588 |
|
589 # If the GENERATE_HTMLHELP tag is set to YES, additional index files |
|
590 # will be generated that can be used as input for tools like the |
|
591 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
|
592 # of the generated HTML documentation. |
|
593 |
104 GENERATE_HTMLHELP = NO |
594 GENERATE_HTMLHELP = NO |
|
595 |
|
596 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
|
597 # be used to specify the file name of the resulting .chm file. You |
|
598 # can add a path in front of the file if the result should not be |
|
599 # written to the html output directory. |
|
600 |
105 CHM_FILE = |
601 CHM_FILE = |
|
602 |
|
603 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
|
604 # be used to specify the location (absolute path including file name) of |
|
605 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
|
606 # the HTML help compiler on the generated index.hhp. |
|
607 |
106 HHC_LOCATION = |
608 HHC_LOCATION = |
|
609 |
|
610 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
|
611 # controls if a separate .chi index file is generated (YES) or that |
|
612 # it should be included in the master .chm file (NO). |
|
613 |
107 GENERATE_CHI = NO |
614 GENERATE_CHI = NO |
|
615 |
|
616 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
|
617 # controls whether a binary table of contents is generated (YES) or a |
|
618 # normal table of contents (NO) in the .chm file. |
|
619 |
108 BINARY_TOC = NO |
620 BINARY_TOC = NO |
|
621 |
|
622 # The TOC_EXPAND flag can be set to YES to add extra items for group members |
|
623 # to the contents of the HTML help documentation and to the tree view. |
|
624 |
109 TOC_EXPAND = NO |
625 TOC_EXPAND = NO |
|
626 |
|
627 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
|
628 # top of each HTML page. The value NO (the default) enables the index and |
|
629 # the value YES disables it. |
|
630 |
110 DISABLE_INDEX = NO |
631 DISABLE_INDEX = NO |
|
632 |
|
633 # This tag can be used to set the number of enum values (range [1..20]) |
|
634 # that doxygen will group on one line in the generated HTML documentation. |
|
635 |
111 ENUM_VALUES_PER_LINE = 4 |
636 ENUM_VALUES_PER_LINE = 4 |
|
637 |
|
638 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
|
639 # generated containing a tree-like index structure (just like the one that |
|
640 # is generated for HTML Help). For this to work a browser that supports |
|
641 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
|
642 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
|
643 # probably better off using the HTML help feature. |
|
644 |
112 GENERATE_TREEVIEW = YES |
645 GENERATE_TREEVIEW = YES |
|
646 |
|
647 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
|
648 # used to set the initial width (in pixels) of the frame in which the tree |
|
649 # is shown. |
|
650 |
113 TREEVIEW_WIDTH = 250 |
651 TREEVIEW_WIDTH = 250 |
|
652 |
114 #--------------------------------------------------------------------------- |
653 #--------------------------------------------------------------------------- |
115 # configuration options related to the LaTeX output |
654 # configuration options related to the LaTeX output |
116 #--------------------------------------------------------------------------- |
655 #--------------------------------------------------------------------------- |
|
656 |
|
657 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will |
|
658 # generate Latex output. |
|
659 |
117 GENERATE_LATEX = YES |
660 GENERATE_LATEX = YES |
|
661 |
|
662 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. |
|
663 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
664 # put in front of it. If left blank `latex' will be used as the default path. |
|
665 |
118 LATEX_OUTPUT = latex |
666 LATEX_OUTPUT = latex |
|
667 |
|
668 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
|
669 # invoked. If left blank `latex' will be used as the default command name. |
|
670 |
119 LATEX_CMD_NAME = latex |
671 LATEX_CMD_NAME = latex |
|
672 |
|
673 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to |
|
674 # generate index for LaTeX. If left blank `makeindex' will be used as the |
|
675 # default command name. |
|
676 |
120 MAKEINDEX_CMD_NAME = makeindex |
677 MAKEINDEX_CMD_NAME = makeindex |
|
678 |
|
679 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact |
|
680 # LaTeX documents. This may be useful for small projects and may help to |
|
681 # save some trees in general. |
|
682 |
121 COMPACT_LATEX = YES |
683 COMPACT_LATEX = YES |
|
684 |
|
685 # The PAPER_TYPE tag can be used to set the paper type that is used |
|
686 # by the printer. Possible values are: a4, a4wide, letter, legal and |
|
687 # executive. If left blank a4wide will be used. |
|
688 |
122 PAPER_TYPE = a4wide |
689 PAPER_TYPE = a4wide |
|
690 |
|
691 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX |
|
692 # packages that should be included in the LaTeX output. |
|
693 |
123 EXTRA_PACKAGES = |
694 EXTRA_PACKAGES = |
|
695 |
|
696 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for |
|
697 # the generated latex document. The header should contain everything until |
|
698 # the first chapter. If it is left blank doxygen will generate a |
|
699 # standard header. Notice: only use this tag if you know what you are doing! |
|
700 |
124 LATEX_HEADER = |
701 LATEX_HEADER = |
|
702 |
|
703 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated |
|
704 # is prepared for conversion to pdf (using ps2pdf). The pdf file will |
|
705 # contain links (just like the HTML output) instead of page references |
|
706 # This makes the output suitable for online browsing using a pdf viewer. |
|
707 |
125 PDF_HYPERLINKS = YES |
708 PDF_HYPERLINKS = YES |
|
709 |
|
710 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of |
|
711 # plain latex in the generated Makefile. Set this option to YES to get a |
|
712 # higher quality PDF documentation. |
|
713 |
126 USE_PDFLATEX = YES |
714 USE_PDFLATEX = YES |
|
715 |
|
716 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. |
|
717 # command to the generated LaTeX files. This will instruct LaTeX to keep |
|
718 # running if errors occur, instead of asking the user for help. |
|
719 # This option is also used when generating formulas in HTML. |
|
720 |
127 LATEX_BATCHMODE = NO |
721 LATEX_BATCHMODE = NO |
|
722 |
|
723 # If LATEX_HIDE_INDICES is set to YES then doxygen will not |
|
724 # include the index chapters (such as File Index, Compound Index, etc.) |
|
725 # in the output. |
|
726 |
128 LATEX_HIDE_INDICES = NO |
727 LATEX_HIDE_INDICES = NO |
|
728 |
129 #--------------------------------------------------------------------------- |
729 #--------------------------------------------------------------------------- |
130 # configuration options related to the RTF output |
730 # configuration options related to the RTF output |
131 #--------------------------------------------------------------------------- |
731 #--------------------------------------------------------------------------- |
|
732 |
|
733 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output |
|
734 # The RTF output is optimized for Word 97 and may not look very pretty with |
|
735 # other RTF readers or editors. |
|
736 |
132 GENERATE_RTF = NO |
737 GENERATE_RTF = NO |
|
738 |
|
739 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. |
|
740 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
741 # put in front of it. If left blank `rtf' will be used as the default path. |
|
742 |
133 RTF_OUTPUT = rtf |
743 RTF_OUTPUT = rtf |
|
744 |
|
745 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact |
|
746 # RTF documents. This may be useful for small projects and may help to |
|
747 # save some trees in general. |
|
748 |
134 COMPACT_RTF = NO |
749 COMPACT_RTF = NO |
|
750 |
|
751 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated |
|
752 # will contain hyperlink fields. The RTF file will |
|
753 # contain links (just like the HTML output) instead of page references. |
|
754 # This makes the output suitable for online browsing using WORD or other |
|
755 # programs which support those fields. |
|
756 # Note: wordpad (write) and others do not support links. |
|
757 |
135 RTF_HYPERLINKS = NO |
758 RTF_HYPERLINKS = NO |
|
759 |
|
760 # Load stylesheet definitions from file. Syntax is similar to doxygen's |
|
761 # config file, i.e. a series of assignments. You only have to provide |
|
762 # replacements, missing definitions are set to their default value. |
|
763 |
136 RTF_STYLESHEET_FILE = |
764 RTF_STYLESHEET_FILE = |
|
765 |
|
766 # Set optional variables used in the generation of an rtf document. |
|
767 # Syntax is similar to doxygen's config file. |
|
768 |
137 RTF_EXTENSIONS_FILE = |
769 RTF_EXTENSIONS_FILE = |
|
770 |
138 #--------------------------------------------------------------------------- |
771 #--------------------------------------------------------------------------- |
139 # configuration options related to the man page output |
772 # configuration options related to the man page output |
140 #--------------------------------------------------------------------------- |
773 #--------------------------------------------------------------------------- |
|
774 |
|
775 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will |
|
776 # generate man pages |
|
777 |
141 GENERATE_MAN = NO |
778 GENERATE_MAN = NO |
|
779 |
|
780 # The MAN_OUTPUT tag is used to specify where the man pages will be put. |
|
781 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
782 # put in front of it. If left blank `man' will be used as the default path. |
|
783 |
142 MAN_OUTPUT = man |
784 MAN_OUTPUT = man |
|
785 |
|
786 # The MAN_EXTENSION tag determines the extension that is added to |
|
787 # the generated man pages (default is the subroutine's section .3) |
|
788 |
143 MAN_EXTENSION = .3 |
789 MAN_EXTENSION = .3 |
|
790 |
|
791 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, |
|
792 # then it will generate one additional man file for each entity |
|
793 # documented in the real man page(s). These additional files |
|
794 # only source the real man page, but without them the man command |
|
795 # would be unable to find the correct page. The default is NO. |
|
796 |
144 MAN_LINKS = NO |
797 MAN_LINKS = NO |
|
798 |
145 #--------------------------------------------------------------------------- |
799 #--------------------------------------------------------------------------- |
146 # configuration options related to the XML output |
800 # configuration options related to the XML output |
147 #--------------------------------------------------------------------------- |
801 #--------------------------------------------------------------------------- |
|
802 |
|
803 # If the GENERATE_XML tag is set to YES Doxygen will |
|
804 # generate an XML file that captures the structure of |
|
805 # the code including all documentation. |
|
806 |
148 GENERATE_XML = NO |
807 GENERATE_XML = NO |
|
808 |
|
809 # The XML_OUTPUT tag is used to specify where the XML pages will be put. |
|
810 # If a relative path is entered the value of OUTPUT_DIRECTORY will be |
|
811 # put in front of it. If left blank `xml' will be used as the default path. |
|
812 |
149 XML_OUTPUT = xml |
813 XML_OUTPUT = xml |
|
814 |
|
815 # The XML_SCHEMA tag can be used to specify an XML schema, |
|
816 # which can be used by a validating XML parser to check the |
|
817 # syntax of the XML files. |
|
818 |
150 XML_SCHEMA = |
819 XML_SCHEMA = |
|
820 |
|
821 # The XML_DTD tag can be used to specify an XML DTD, |
|
822 # which can be used by a validating XML parser to check the |
|
823 # syntax of the XML files. |
|
824 |
151 XML_DTD = |
825 XML_DTD = |
|
826 |
|
827 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will |
|
828 # dump the program listings (including syntax highlighting |
|
829 # and cross-referencing information) to the XML output. Note that |
|
830 # enabling this will significantly increase the size of the XML output. |
|
831 |
|
832 XML_PROGRAMLISTING = YES |
|
833 |
152 #--------------------------------------------------------------------------- |
834 #--------------------------------------------------------------------------- |
153 # configuration options for the AutoGen Definitions output |
835 # configuration options for the AutoGen Definitions output |
154 #--------------------------------------------------------------------------- |
836 #--------------------------------------------------------------------------- |
|
837 |
|
838 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will |
|
839 # generate an AutoGen Definitions (see autogen.sf.net) file |
|
840 # that captures the structure of the code including all |
|
841 # documentation. Note that this feature is still experimental |
|
842 # and incomplete at the moment. |
|
843 |
155 GENERATE_AUTOGEN_DEF = NO |
844 GENERATE_AUTOGEN_DEF = NO |
|
845 |
156 #--------------------------------------------------------------------------- |
846 #--------------------------------------------------------------------------- |
157 # configuration options related to the Perl module output |
847 # configuration options related to the Perl module output |
158 #--------------------------------------------------------------------------- |
848 #--------------------------------------------------------------------------- |
|
849 |
|
850 # If the GENERATE_PERLMOD tag is set to YES Doxygen will |
|
851 # generate a Perl module file that captures the structure of |
|
852 # the code including all documentation. Note that this |
|
853 # feature is still experimental and incomplete at the |
|
854 # moment. |
|
855 |
159 GENERATE_PERLMOD = NO |
856 GENERATE_PERLMOD = NO |
|
857 |
|
858 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate |
|
859 # the necessary Makefile rules, Perl scripts and LaTeX code to be able |
|
860 # to generate PDF and DVI output from the Perl module output. |
|
861 |
160 PERLMOD_LATEX = NO |
862 PERLMOD_LATEX = NO |
|
863 |
|
864 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be |
|
865 # nicely formatted so it can be parsed by a human reader. This is useful |
|
866 # if you want to understand what is going on. On the other hand, if this |
|
867 # tag is set to NO the size of the Perl module output will be much smaller |
|
868 # and Perl will parse it just the same. |
|
869 |
161 PERLMOD_PRETTY = YES |
870 PERLMOD_PRETTY = YES |
|
871 |
|
872 # The names of the make variables in the generated doxyrules.make file |
|
873 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. |
|
874 # This is useful so different doxyrules.make files included by the same |
|
875 # Makefile don't overwrite each other's variables. |
|
876 |
162 PERLMOD_MAKEVAR_PREFIX = |
877 PERLMOD_MAKEVAR_PREFIX = |
|
878 |
163 #--------------------------------------------------------------------------- |
879 #--------------------------------------------------------------------------- |
164 # Configuration options related to the preprocessor |
880 # Configuration options related to the preprocessor |
165 #--------------------------------------------------------------------------- |
881 #--------------------------------------------------------------------------- |
|
882 |
|
883 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
|
884 # evaluate all C-preprocessor directives found in the sources and include |
|
885 # files. |
|
886 |
166 ENABLE_PREPROCESSING = YES |
887 ENABLE_PREPROCESSING = YES |
|
888 |
|
889 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
|
890 # names in the source code. If set to NO (the default) only conditional |
|
891 # compilation will be performed. Macro expansion can be done in a controlled |
|
892 # way by setting EXPAND_ONLY_PREDEF to YES. |
|
893 |
167 MACRO_EXPANSION = NO |
894 MACRO_EXPANSION = NO |
|
895 |
|
896 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
|
897 # then the macro expansion is limited to the macros specified with the |
|
898 # PREDEFINED and EXPAND_AS_PREDEFINED tags. |
|
899 |
168 EXPAND_ONLY_PREDEF = NO |
900 EXPAND_ONLY_PREDEF = NO |
|
901 |
|
902 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
|
903 # in the INCLUDE_PATH (see below) will be search if a #include is found. |
|
904 |
169 SEARCH_INCLUDES = YES |
905 SEARCH_INCLUDES = YES |
|
906 |
|
907 # The INCLUDE_PATH tag can be used to specify one or more directories that |
|
908 # contain include files that are not input files but should be processed by |
|
909 # the preprocessor. |
|
910 |
170 INCLUDE_PATH = |
911 INCLUDE_PATH = |
|
912 |
|
913 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
|
914 # patterns (like *.h and *.hpp) to filter out the header-files in the |
|
915 # directories. If left blank, the patterns specified with FILE_PATTERNS will |
|
916 # be used. |
|
917 |
171 INCLUDE_FILE_PATTERNS = |
918 INCLUDE_FILE_PATTERNS = |
|
919 |
|
920 # The PREDEFINED tag can be used to specify one or more macro names that |
|
921 # are defined before the preprocessor is started (similar to the -D option of |
|
922 # gcc). The argument of the tag is a list of macros of the form: name |
|
923 # or name=definition (no spaces). If the definition and the = are |
|
924 # omitted =1 is assumed. |
|
925 |
172 PREDEFINED = DOXYGEN |
926 PREDEFINED = DOXYGEN |
|
927 |
|
928 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
|
929 # this tag can be used to specify a list of macro names that should be expanded. |
|
930 # The macro definition that is found in the sources will be used. |
|
931 # Use the PREDEFINED tag if you want to use a different macro definition. |
|
932 |
173 EXPAND_AS_DEFINED = |
933 EXPAND_AS_DEFINED = |
|
934 |
|
935 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
|
936 # doxygen's preprocessor will remove all function-like macros that are alone |
|
937 # on a line, have an all uppercase name, and do not end with a semicolon. Such |
|
938 # function macros are typically used for boiler-plate code, and will confuse the |
|
939 # parser if not removed. |
|
940 |
174 SKIP_FUNCTION_MACROS = YES |
941 SKIP_FUNCTION_MACROS = YES |
175 #--------------------------------------------------------------------------- |
942 |
176 # Configuration::addtions related to external references |
943 #--------------------------------------------------------------------------- |
177 #--------------------------------------------------------------------------- |
944 # Configuration::additions related to external references |
|
945 #--------------------------------------------------------------------------- |
|
946 |
|
947 # The TAGFILES option can be used to specify one or more tagfiles. |
|
948 # Optionally an initial location of the external documentation |
|
949 # can be added for each tagfile. The format of a tag file without |
|
950 # this location is as follows: |
|
951 # TAGFILES = file1 file2 ... |
|
952 # Adding location for the tag files is done as follows: |
|
953 # TAGFILES = file1=loc1 "file2 = loc2" ... |
|
954 # where "loc1" and "loc2" can be relative or absolute paths or |
|
955 # URLs. If a location is present for each tag, the installdox tool |
|
956 # does not have to be run to correct the links. |
|
957 # Note that each tag file must have a unique name |
|
958 # (where the name does NOT include the path) |
|
959 # If a tag file is not located in the directory in which doxygen |
|
960 # is run, you must also specify the path to the tagfile here. |
|
961 |
178 TAGFILES = |
962 TAGFILES = |
|
963 |
|
964 # When a file name is specified after GENERATE_TAGFILE, doxygen will create |
|
965 # a tag file that is based on the input files it reads. |
|
966 |
179 GENERATE_TAGFILE = |
967 GENERATE_TAGFILE = |
|
968 |
|
969 # If the ALLEXTERNALS tag is set to YES all external classes will be listed |
|
970 # in the class index. If set to NO only the inherited external classes |
|
971 # will be listed. |
|
972 |
180 ALLEXTERNALS = NO |
973 ALLEXTERNALS = NO |
|
974 |
|
975 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
|
976 # in the modules index. If set to NO, only the current project's groups will |
|
977 # be listed. |
|
978 |
181 EXTERNAL_GROUPS = YES |
979 EXTERNAL_GROUPS = YES |
|
980 |
|
981 # The PERL_PATH should be the absolute path and name of the perl script |
|
982 # interpreter (i.e. the result of `which perl'). |
|
983 |
182 PERL_PATH = /usr/bin/perl |
984 PERL_PATH = /usr/bin/perl |
|
985 |
183 #--------------------------------------------------------------------------- |
986 #--------------------------------------------------------------------------- |
184 # Configuration options related to the dot tool |
987 # Configuration options related to the dot tool |
185 #--------------------------------------------------------------------------- |
988 #--------------------------------------------------------------------------- |
|
989 |
|
990 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
|
991 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or |
|
992 # super classes. Setting the tag to NO turns the diagrams off. Note that this |
|
993 # option is superseded by the HAVE_DOT option below. This is only a fallback. It is |
|
994 # recommended to install and use dot, since it yields more powerful graphs. |
|
995 |
186 CLASS_DIAGRAMS = YES |
996 CLASS_DIAGRAMS = YES |
|
997 |
|
998 # If set to YES, the inheritance and collaboration graphs will hide |
|
999 # inheritance and usage relations if the target is undocumented |
|
1000 # or is not a class. |
|
1001 |
187 HIDE_UNDOC_RELATIONS = NO |
1002 HIDE_UNDOC_RELATIONS = NO |
|
1003 |
|
1004 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
|
1005 # available from the path. This tool is part of Graphviz, a graph visualization |
|
1006 # toolkit from AT&T and Lucent Bell Labs. The other options in this section |
|
1007 # have no effect if this option is set to NO (the default) |
|
1008 |
188 HAVE_DOT = YES |
1009 HAVE_DOT = YES |
|
1010 |
|
1011 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
|
1012 # will generate a graph for each documented class showing the direct and |
|
1013 # indirect inheritance relations. Setting this tag to YES will force the |
|
1014 # the CLASS_DIAGRAMS tag to NO. |
|
1015 |
189 CLASS_GRAPH = YES |
1016 CLASS_GRAPH = YES |
|
1017 |
|
1018 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
|
1019 # will generate a graph for each documented class showing the direct and |
|
1020 # indirect implementation dependencies (inheritance, containment, and |
|
1021 # class references variables) of the class with other documented classes. |
|
1022 |
190 COLLABORATION_GRAPH = YES |
1023 COLLABORATION_GRAPH = YES |
|
1024 |
|
1025 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
|
1026 # collaboration diagrams in a style similar to the OMG's Unified Modeling |
|
1027 # Language. |
|
1028 |
191 UML_LOOK = NO |
1029 UML_LOOK = NO |
|
1030 |
|
1031 # If set to YES, the inheritance and collaboration graphs will show the |
|
1032 # relations between templates and their instances. |
|
1033 |
192 TEMPLATE_RELATIONS = YES |
1034 TEMPLATE_RELATIONS = YES |
|
1035 |
|
1036 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
|
1037 # tags are set to YES then doxygen will generate a graph for each documented |
|
1038 # file showing the direct and indirect include dependencies of the file with |
|
1039 # other documented files. |
|
1040 |
193 INCLUDE_GRAPH = YES |
1041 INCLUDE_GRAPH = YES |
|
1042 |
|
1043 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
|
1044 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
|
1045 # documented header file showing the documented files that directly or |
|
1046 # indirectly include this file. |
|
1047 |
194 INCLUDED_BY_GRAPH = YES |
1048 INCLUDED_BY_GRAPH = YES |
|
1049 |
|
1050 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will |
|
1051 # generate a call dependency graph for every global function or class method. |
|
1052 # Note that enabling this option will significantly increase the time of a run. |
|
1053 # So in most cases it will be better to enable call graphs for selected |
|
1054 # functions only using the \callgraph command. |
|
1055 |
195 CALL_GRAPH = YES |
1056 CALL_GRAPH = YES |
|
1057 |
|
1058 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
|
1059 # will graphical hierarchy of all classes instead of a textual one. |
|
1060 |
196 GRAPHICAL_HIERARCHY = YES |
1061 GRAPHICAL_HIERARCHY = YES |
|
1062 |
|
1063 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
|
1064 # generated by dot. Possible values are png, jpg, or gif |
|
1065 # If left blank png will be used. |
|
1066 |
197 DOT_IMAGE_FORMAT = png |
1067 DOT_IMAGE_FORMAT = png |
|
1068 |
|
1069 # The tag DOT_PATH can be used to specify the path where the dot tool can be |
|
1070 # found. If left blank, it is assumed the dot tool can be found on the path. |
|
1071 |
198 DOT_PATH = |
1072 DOT_PATH = |
|
1073 |
|
1074 # The DOTFILE_DIRS tag can be used to specify one or more directories that |
|
1075 # contain dot files that are included in the documentation (see the |
|
1076 # \dotfile command). |
|
1077 |
199 DOTFILE_DIRS = |
1078 DOTFILE_DIRS = |
|
1079 |
|
1080 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width |
|
1081 # (in pixels) of the graphs generated by dot. If a graph becomes larger than |
|
1082 # this value, doxygen will try to truncate the graph, so that it fits within |
|
1083 # the specified constraint. Beware that most browsers cannot cope with very |
|
1084 # large images. |
|
1085 |
200 MAX_DOT_GRAPH_WIDTH = 1024 |
1086 MAX_DOT_GRAPH_WIDTH = 1024 |
|
1087 |
|
1088 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height |
|
1089 # (in pixels) of the graphs generated by dot. If a graph becomes larger than |
|
1090 # this value, doxygen will try to truncate the graph, so that it fits within |
|
1091 # the specified constraint. Beware that most browsers cannot cope with very |
|
1092 # large images. |
|
1093 |
201 MAX_DOT_GRAPH_HEIGHT = 1024 |
1094 MAX_DOT_GRAPH_HEIGHT = 1024 |
|
1095 |
|
1096 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
|
1097 # graphs generated by dot. A depth value of 3 means that only nodes reachable |
|
1098 # from the root by following a path via at most 3 edges will be shown. Nodes that |
|
1099 # lay further from the root node will be omitted. Note that setting this option to |
|
1100 # 1 or 2 may greatly reduce the computation time needed for large code bases. Also |
|
1101 # note that a graph may be further truncated if the graph's image dimensions are |
|
1102 # not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). |
|
1103 # If 0 is used for the depth value (the default), the graph is not depth-constrained. |
|
1104 |
202 MAX_DOT_GRAPH_DEPTH = 0 |
1105 MAX_DOT_GRAPH_DEPTH = 0 |
|
1106 |
|
1107 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
|
1108 # generate a legend page explaining the meaning of the various boxes and |
|
1109 # arrows in the dot generated graphs. |
|
1110 |
203 GENERATE_LEGEND = YES |
1111 GENERATE_LEGEND = YES |
|
1112 |
|
1113 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
|
1114 # remove the intermediate dot files that are used to generate |
|
1115 # the various graphs. |
|
1116 |
204 DOT_CLEANUP = YES |
1117 DOT_CLEANUP = YES |
205 #--------------------------------------------------------------------------- |
1118 |
206 # Configuration::addtions related to the search engine |
1119 #--------------------------------------------------------------------------- |
207 #--------------------------------------------------------------------------- |
1120 # Configuration::additions related to the search engine |
|
1121 #--------------------------------------------------------------------------- |
|
1122 |
|
1123 # The SEARCHENGINE tag specifies whether or not a search engine should be |
|
1124 # used. If set to NO the values of all tags below this one will be ignored. |
|
1125 |
208 SEARCHENGINE = YES |
1126 SEARCHENGINE = YES |
209 CGI_NAME = search.cgi |
|
210 CGI_URL = |
|
211 DOC_URL = |
|
212 DOC_ABSPATH = |
|
213 BIN_ABSPATH = /usr/local/bin/ |
|
214 EXT_DOC_PATHS = |
|