1 |
# Doxyfile 1.3.5 |
2 |
|
3 |
# This file describes the settings to be used by the documentation system |
4 |
# doxygen (www.doxygen.org) for a project |
5 |
# |
6 |
# All text after a hash (#) is considered a comment and will be ignored |
7 |
# The format is: |
8 |
# TAG = value [value, ...] |
9 |
# For lists items can also be appended using: |
10 |
# TAG += value [value, ...] |
11 |
# Values that contain spaces should be placed between quotes (" ") |
12 |
|
13 |
#--------------------------------------------------------------------------- |
14 |
# Project related configuration options |
15 |
#--------------------------------------------------------------------------- |
16 |
|
17 |
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded |
18 |
# by quotes) that should identify the project. |
19 |
|
20 |
PROJECT_NAME = "eggdrop1.9" |
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 |
|
26 |
PROJECT_NUMBER = |
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 |
|
33 |
OUTPUT_DIRECTORY = doc/developer |
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, Norwegian, Polish, Portuguese, |
42 |
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. |
43 |
|
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 |
|
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 = YES |
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 = YES |
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 = YES |
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 = YES |
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 |
|
105 |
STRIP_FROM_PATH = |
106 |
|
107 |
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter |
108 |
# (but less readable) file names. This can be useful is your file systems |
109 |
# doesn't support long names like on DOS, Mac, or CD-ROM. |
110 |
|
111 |
SHORT_NAMES = NO |
112 |
|
113 |
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen |
114 |
# will interpret the first line (until the first dot) of a JavaDoc-style |
115 |
# comment as the brief description. If set to NO, the JavaDoc |
116 |
# comments will behave just like the Qt-style comments (thus requiring an |
117 |
# explicit @brief command for a brief description. |
118 |
|
119 |
JAVADOC_AUTOBRIEF = NO |
120 |
|
121 |
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen |
122 |
# treat a multi-line C++ special comment block (i.e. a block of //! or /// |
123 |
# comments) as a brief description. This used to be the default behaviour. |
124 |
# The new default is to treat a multi-line C++ comment block as a detailed |
125 |
# description. Set this tag to YES if you prefer the old behaviour instead. |
126 |
|
127 |
MULTILINE_CPP_IS_BRIEF = NO |
128 |
|
129 |
# If the DETAILS_AT_TOP tag is set to YES then Doxygen |
130 |
# will output the detailed description near the top, like JavaDoc. |
131 |
# If set to NO, the detailed description appears after the member |
132 |
# documentation. |
133 |
|
134 |
DETAILS_AT_TOP = YES |
135 |
|
136 |
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented |
137 |
# member inherits the documentation from any documented member that it |
138 |
# re-implements. |
139 |
|
140 |
INHERIT_DOCS = YES |
141 |
|
142 |
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC |
143 |
# tag is set to YES, then doxygen will reuse the documentation of the first |
144 |
# member in the group (if any) for the other members of the group. By default |
145 |
# all members of a group must be documented explicitly. |
146 |
|
147 |
DISTRIBUTE_GROUP_DOC = NO |
148 |
|
149 |
# The TAB_SIZE tag can be used to set the number of spaces in a tab. |
150 |
# Doxygen uses this value to replace tabs by spaces in code fragments. |
151 |
|
152 |
TAB_SIZE = 2 |
153 |
|
154 |
# This tag can be used to specify a number of aliases that acts |
155 |
# as commands in the documentation. An alias has the form "name=value". |
156 |
# For example adding "sideeffect=\par Side Effects:\n" will allow you to |
157 |
# put the command \sideeffect (or @sideeffect) in the documentation, which |
158 |
# will result in a user-defined paragraph with heading "Side Effects:". |
159 |
# You can put \n's in the value part of an alias to insert newlines. |
160 |
|
161 |
ALIASES = "bind=\xrefitem bind \"Bind\" \"Bind List\"" |
162 |
ALIASES += "name=\par \"Name:\" " |
163 |
ALIASES += "flags=\par \"Flags:\" " |
164 |
ALIASES += "match=\par \"Match:\" " |
165 |
ALIASES += "stackable=\par \"Note:\" This bind is stackable." |
166 |
ALIASES += "breakable=\par \"Note:\" This bind is stackable and breakable." |
167 |
ALIASES += "noparam=\par \"Parameters:\" None." |
168 |
ALIASES += "noreturn=\return Any return value will be ignored." |
169 |
ALIASES += "format=\par \"Format:\" " |
170 |
|
171 |
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
172 |
# only. Doxygen will then generate output that is more tailored for C. |
173 |
# For instance, some of the names that are used will be different. The list |
174 |
# of all members will be omitted, etc. |
175 |
|
176 |
OPTIMIZE_OUTPUT_FOR_C = YES |
177 |
|
178 |
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources |
179 |
# only. Doxygen will then generate output that is more tailored for Java. |
180 |
# For instance, namespaces will be presented as packages, qualified scopes |
181 |
# will look different, etc. |
182 |
|
183 |
OPTIMIZE_OUTPUT_JAVA = NO |
184 |
|
185 |
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of |
186 |
# the same type (for instance a group of public functions) to be put as a |
187 |
# subgroup of that type (e.g. under the Public Functions section). Set it to |
188 |
# NO to prevent subgrouping. Alternatively, this can be done per class using |
189 |
# the \nosubgrouping command. |
190 |
|
191 |
SUBGROUPING = YES |
192 |
|
193 |
#--------------------------------------------------------------------------- |
194 |
# Build related configuration options |
195 |
#--------------------------------------------------------------------------- |
196 |
|
197 |
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in |
198 |
# documentation are documented, even if no documentation was available. |
199 |
# Private class members and static file members will be hidden unless |
200 |
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES |
201 |
|
202 |
EXTRACT_ALL = YES |
203 |
|
204 |
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
205 |
# will be included in the documentation. |
206 |
|
207 |
EXTRACT_PRIVATE = YES |
208 |
|
209 |
# If the EXTRACT_STATIC tag is set to YES all static members of a file |
210 |
# will be included in the documentation. |
211 |
|
212 |
EXTRACT_STATIC = YES |
213 |
|
214 |
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) |
215 |
# defined locally in source files will be included in the documentation. |
216 |
# If set to NO only classes defined in header files are included. |
217 |
|
218 |
EXTRACT_LOCAL_CLASSES = YES |
219 |
|
220 |
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all |
221 |
# undocumented members of documented classes, files or namespaces. |
222 |
# If set to NO (the default) these members will be included in the |
223 |
# various overviews, but no documentation section is generated. |
224 |
# This option has no effect if EXTRACT_ALL is enabled. |
225 |
|
226 |
HIDE_UNDOC_MEMBERS = NO |
227 |
|
228 |
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all |
229 |
# undocumented classes that are normally visible in the class hierarchy. |
230 |
# If set to NO (the default) these classes will be included in the various |
231 |
# overviews. This option has no effect if EXTRACT_ALL is enabled. |
232 |
|
233 |
HIDE_UNDOC_CLASSES = NO |
234 |
|
235 |
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all |
236 |
# friend (class|struct|union) declarations. |
237 |
# If set to NO (the default) these declarations will be included in the |
238 |
# documentation. |
239 |
|
240 |
HIDE_FRIEND_COMPOUNDS = NO |
241 |
|
242 |
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any |
243 |
# documentation blocks found inside the body of a function. |
244 |
# If set to NO (the default) these blocks will be appended to the |
245 |
# function's detailed documentation block. |
246 |
|
247 |
HIDE_IN_BODY_DOCS = NO |
248 |
|
249 |
# The INTERNAL_DOCS tag determines if documentation |
250 |
# that is typed after a \internal command is included. If the tag is set |
251 |
# to NO (the default) then the documentation will be excluded. |
252 |
# Set it to YES to include the internal documentation. |
253 |
|
254 |
INTERNAL_DOCS = NO |
255 |
|
256 |
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate |
257 |
# file names in lower-case letters. If set to YES upper-case letters are also |
258 |
# allowed. This is useful if you have classes or files whose names only differ |
259 |
# in case and if your file system supports case sensitive file names. Windows |
260 |
# users are advised to set this option to NO. |
261 |
|
262 |
CASE_SENSE_NAMES = YES |
263 |
|
264 |
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen |
265 |
# will show members with their full class and namespace scopes in the |
266 |
# documentation. If set to YES the scope will be hidden. |
267 |
|
268 |
HIDE_SCOPE_NAMES = NO |
269 |
|
270 |
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen |
271 |
# will put a list of the files that are included by a file in the documentation |
272 |
# of that file. |
273 |
|
274 |
SHOW_INCLUDE_FILES = YES |
275 |
|
276 |
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] |
277 |
# is inserted in the documentation for inline members. |
278 |
|
279 |
INLINE_INFO = YES |
280 |
|
281 |
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen |
282 |
# will sort the (detailed) documentation of file and class members |
283 |
# alphabetically by member name. If set to NO the members will appear in |
284 |
# declaration order. |
285 |
|
286 |
SORT_MEMBER_DOCS = YES |
287 |
|
288 |
# The GENERATE_TODOLIST tag can be used to enable (YES) or |
289 |
# disable (NO) the todo list. This list is created by putting \todo |
290 |
# commands in the documentation. |
291 |
|
292 |
GENERATE_TODOLIST = YES |
293 |
|
294 |
# The GENERATE_TESTLIST tag can be used to enable (YES) or |
295 |
# disable (NO) the test list. This list is created by putting \test |
296 |
# commands in the documentation. |
297 |
|
298 |
GENERATE_TESTLIST = YES |
299 |
|
300 |
# The GENERATE_BUGLIST tag can be used to enable (YES) or |
301 |
# disable (NO) the bug list. This list is created by putting \bug |
302 |
# commands in the documentation. |
303 |
|
304 |
GENERATE_BUGLIST = YES |
305 |
|
306 |
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or |
307 |
# disable (NO) the deprecated list. This list is created by putting |
308 |
# \deprecated commands in the documentation. |
309 |
|
310 |
GENERATE_DEPRECATEDLIST= YES |
311 |
|
312 |
# The ENABLED_SECTIONS tag can be used to enable conditional |
313 |
# documentation sections, marked by \if sectionname ... \endif. |
314 |
|
315 |
ENABLED_SECTIONS = |
316 |
|
317 |
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines |
318 |
# the initial value of a variable or define consists of for it to appear in |
319 |
# the documentation. If the initializer consists of more lines than specified |
320 |
# here it will be hidden. Use a value of 0 to hide initializers completely. |
321 |
# The appearance of the initializer of individual variables and defines in the |
322 |
# documentation can be controlled using \showinitializer or \hideinitializer |
323 |
# command in the documentation regardless of this setting. |
324 |
|
325 |
MAX_INITIALIZER_LINES = 30 |
326 |
|
327 |
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
328 |
# at the bottom of the documentation of classes and structs. If set to YES the |
329 |
# list will mention the files that were used to generate the documentation. |
330 |
|
331 |
SHOW_USED_FILES = YES |
332 |
|
333 |
#--------------------------------------------------------------------------- |
334 |
# configuration options related to warning and progress messages |
335 |
#--------------------------------------------------------------------------- |
336 |
|
337 |
# The QUIET tag can be used to turn on/off the messages that are generated |
338 |
# by doxygen. Possible values are YES and NO. If left blank NO is used. |
339 |
|
340 |
QUIET = YES |
341 |
|
342 |
# The WARNINGS tag can be used to turn on/off the warning messages that are |
343 |
# generated by doxygen. Possible values are YES and NO. If left blank |
344 |
# NO is used. |
345 |
|
346 |
WARNINGS = YES |
347 |
|
348 |
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings |
349 |
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will |
350 |
# automatically be disabled. |
351 |
|
352 |
WARN_IF_UNDOCUMENTED = YES |
353 |
|
354 |
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for |
355 |
# potential errors in the documentation, such as not documenting some |
356 |
# parameters in a documented function, or documenting parameters that |
357 |
# don't exist or using markup commands wrongly. |
358 |
|
359 |
WARN_IF_DOC_ERROR = YES |
360 |
|
361 |
# The WARN_FORMAT tag determines the format of the warning messages that |
362 |
# doxygen can produce. The string should contain the $file, $line, and $text |
363 |
# tags, which will be replaced by the file and line number from which the |
364 |
# warning originated and the warning text. |
365 |
|
366 |
WARN_FORMAT = "$file:$line: $text" |
367 |
|
368 |
# The WARN_LOGFILE tag can be used to specify a file to which warning |
369 |
# and error messages should be written. If left blank the output is written |
370 |
# to stderr. |
371 |
|
372 |
WARN_LOGFILE = |
373 |
|
374 |
#--------------------------------------------------------------------------- |
375 |
# configuration options related to the input files |
376 |
#--------------------------------------------------------------------------- |
377 |
|
378 |
# The INPUT tag can be used to specify the files and/or directories that contain |
379 |
# documented source files. You may enter file names like "myfile.cpp" or |
380 |
# directories like "/usr/src/myproject". Separate the files or directories |
381 |
# with spaces. |
382 |
|
383 |
INPUT = src lib/eggdrop modules doc/developer/doxy |
384 |
|
385 |
# If the value of the INPUT tag contains directories, you can use the |
386 |
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
387 |
# and *.h) to filter out the source-files in the directories. If left |
388 |
# blank the following patterns are tested: |
389 |
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp |
390 |
# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc |
391 |
|
392 |
FILE_PATTERNS = *.c *.h |
393 |
|
394 |
# The RECURSIVE tag can be used to turn specify whether or not subdirectories |
395 |
# should be searched for input files as well. Possible values are YES and NO. |
396 |
# If left blank NO is used. |
397 |
|
398 |
RECURSIVE = YES |
399 |
|
400 |
# The EXCLUDE tag can be used to specify files and/or directories that should |
401 |
# excluded from the INPUT source files. This way you can easily exclude a |
402 |
# subdirectory from a directory tree whose root is specified with the INPUT tag. |
403 |
|
404 |
EXCLUDE = src/cryptapi.h |
405 |
|
406 |
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories |
407 |
# that are symbolic links (a Unix filesystem feature) are excluded from the input. |
408 |
|
409 |
EXCLUDE_SYMLINKS = NO |
410 |
|
411 |
# If the value of the INPUT tag contains directories, you can use the |
412 |
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude |
413 |
# certain files from those directories. |
414 |
|
415 |
EXCLUDE_PATTERNS = |
416 |
|
417 |
# The EXAMPLE_PATH tag can be used to specify one or more files or |
418 |
# directories that contain example code fragments that are included (see |
419 |
# the \include command). |
420 |
|
421 |
EXAMPLE_PATH = |
422 |
|
423 |
# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
424 |
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
425 |
# and *.h) to filter out the source-files in the directories. If left |
426 |
# blank all files are included. |
427 |
|
428 |
EXAMPLE_PATTERNS = |
429 |
|
430 |
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be |
431 |
# searched for input files to be used with the \include or \dontinclude |
432 |
# commands irrespective of the value of the RECURSIVE tag. |
433 |
# Possible values are YES and NO. If left blank NO is used. |
434 |
|
435 |
EXAMPLE_RECURSIVE = NO |
436 |
|
437 |
# The IMAGE_PATH tag can be used to specify one or more files or |
438 |
# directories that contain image that are included in the documentation (see |
439 |
# the \image command). |
440 |
|
441 |
IMAGE_PATH = |
442 |
|
443 |
# The INPUT_FILTER tag can be used to specify a program that doxygen should |
444 |
# invoke to filter for each input file. Doxygen will invoke the filter program |
445 |
# by executing (via popen()) the command <filter> <input-file>, where <filter> |
446 |
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an |
447 |
# input file. Doxygen will then use the output that the filter program writes |
448 |
# to standard output. |
449 |
|
450 |
INPUT_FILTER = |
451 |
|
452 |
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
453 |
# INPUT_FILTER) will be used to filter the input files when producing source |
454 |
# files to browse (i.e. when SOURCE_BROWSER is set to YES). |
455 |
|
456 |
FILTER_SOURCE_FILES = NO |
457 |
|
458 |
#--------------------------------------------------------------------------- |
459 |
# configuration options related to source browsing |
460 |
#--------------------------------------------------------------------------- |
461 |
|
462 |
# If the SOURCE_BROWSER tag is set to YES then a list of source files will |
463 |
# be generated. Documented entities will be cross-referenced with these sources. |
464 |
# Note: To get rid of all source code in the generated output, make sure also |
465 |
# VERBATIM_HEADERS is set to NO. |
466 |
|
467 |
SOURCE_BROWSER = YES |
468 |
|
469 |
# Setting the INLINE_SOURCES tag to YES will include the body |
470 |
# of functions and classes directly in the documentation. |
471 |
|
472 |
INLINE_SOURCES = YES |
473 |
|
474 |
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct |
475 |
# doxygen to hide any special comment blocks from generated source code |
476 |
# fragments. Normal C and C++ comments will always remain visible. |
477 |
|
478 |
STRIP_CODE_COMMENTS = YES |
479 |
|
480 |
# If the REFERENCED_BY_RELATION tag is set to YES (the default) |
481 |
# then for each documented function all documented |
482 |
# functions referencing it will be listed. |
483 |
|
484 |
REFERENCED_BY_RELATION = YES |
485 |
|
486 |
# If the REFERENCES_RELATION tag is set to YES (the default) |
487 |
# then for each documented function all documented entities |
488 |
# called/used by that function will be listed. |
489 |
|
490 |
REFERENCES_RELATION = YES |
491 |
|
492 |
# References will link to the documentation, not the source. |
493 |
|
494 |
REFERENCES_LINK_SOURCE = NO |
495 |
|
496 |
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
497 |
# will generate a verbatim copy of the header file for each class for |
498 |
# which an include is specified. Set to NO to disable this. |
499 |
|
500 |
VERBATIM_HEADERS = YES |
501 |
|
502 |
#--------------------------------------------------------------------------- |
503 |
# configuration options related to the alphabetical class index |
504 |
#--------------------------------------------------------------------------- |
505 |
|
506 |
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index |
507 |
# of all compounds will be generated. Enable this if the project |
508 |
# contains a lot of classes, structs, unions or interfaces. |
509 |
|
510 |
ALPHABETICAL_INDEX = YES |
511 |
|
512 |
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then |
513 |
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns |
514 |
# in which this list will be split (can be a number in the range [1..20]) |
515 |
|
516 |
COLS_IN_ALPHA_INDEX = 5 |
517 |
|
518 |
# In case all classes in a project start with a common prefix, all |
519 |
# classes will be put under the same header in the alphabetical index. |
520 |
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that |
521 |
# should be ignored while generating the index headers. |
522 |
|
523 |
IGNORE_PREFIX = |
524 |
|
525 |
#--------------------------------------------------------------------------- |
526 |
# configuration options related to the HTML output |
527 |
#--------------------------------------------------------------------------- |
528 |
|
529 |
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will |
530 |
# generate HTML output. |
531 |
|
532 |
GENERATE_HTML = YES |
533 |
|
534 |
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. |
535 |
# If a relative path is entered the value of OUTPUT_DIRECTORY will be |
536 |
# put in front of it. If left blank `html' will be used as the default path. |
537 |
|
538 |
HTML_OUTPUT = html |
539 |
|
540 |
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for |
541 |
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank |
542 |
# doxygen will generate files with .html extension. |
543 |
|
544 |
HTML_FILE_EXTENSION = .html |
545 |
|
546 |
# The HTML_HEADER tag can be used to specify a personal HTML header for |
547 |
# each generated HTML page. If it is left blank doxygen will generate a |
548 |
# standard header. |
549 |
|
550 |
HTML_HEADER = |
551 |
|
552 |
# The HTML_FOOTER tag can be used to specify a personal HTML footer for |
553 |
# each generated HTML page. If it is left blank doxygen will generate a |
554 |
# standard footer. |
555 |
|
556 |
HTML_FOOTER = |
557 |
|
558 |
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading |
559 |
# style sheet that is used by each HTML page. It can be used to |
560 |
# fine-tune the look of the HTML output. If the tag is left blank doxygen |
561 |
# will generate a default style sheet. Note that doxygen will try to copy |
562 |
# the style sheet file to the HTML output directory, so don't put your own |
563 |
# stylesheet in the HTML output directory as well, or it will be erased! |
564 |
|
565 |
HTML_STYLESHEET = |
566 |
|
567 |
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, |
568 |
# files or namespaces will be aligned in HTML using tables. If set to |
569 |
# NO a bullet list will be used. |
570 |
|
571 |
HTML_ALIGN_MEMBERS = YES |
572 |
|
573 |
# If the GENERATE_HTMLHELP tag is set to YES, additional index files |
574 |
# will be generated that can be used as input for tools like the |
575 |
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) |
576 |
# of the generated HTML documentation. |
577 |
|
578 |
GENERATE_HTMLHELP = NO |
579 |
|
580 |
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can |
581 |
# be used to specify the file name of the resulting .chm file. You |
582 |
# can add a path in front of the file if the result should not be |
583 |
# written to the html output directory. |
584 |
|
585 |
CHM_FILE = |
586 |
|
587 |
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can |
588 |
# be used to specify the location (absolute path including file name) of |
589 |
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run |
590 |
# the HTML help compiler on the generated index.hhp. |
591 |
|
592 |
HHC_LOCATION = |
593 |
|
594 |
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag |
595 |
# controls if a separate .chi index file is generated (YES) or that |
596 |
# it should be included in the master .chm file (NO). |
597 |
|
598 |
GENERATE_CHI = NO |
599 |
|
600 |
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag |
601 |
# controls whether a binary table of contents is generated (YES) or a |
602 |
# normal table of contents (NO) in the .chm file. |
603 |
|
604 |
BINARY_TOC = NO |
605 |
|
606 |
# The TOC_EXPAND flag can be set to YES to add extra items for group members |
607 |
# to the contents of the HTML help documentation and to the tree view. |
608 |
|
609 |
TOC_EXPAND = NO |
610 |
|
611 |
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at |
612 |
# top of each HTML page. The value NO (the default) enables the index and |
613 |
# the value YES disables it. |
614 |
|
615 |
DISABLE_INDEX = NO |
616 |
|
617 |
# This tag can be used to set the number of enum values (range [1..20]) |
618 |
# that doxygen will group on one line in the generated HTML documentation. |
619 |
|
620 |
ENUM_VALUES_PER_LINE = 4 |
621 |
|
622 |
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be |
623 |
# generated containing a tree-like index structure (just like the one that |
624 |
# is generated for HTML Help). For this to work a browser that supports |
625 |
# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, |
626 |
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are |
627 |
# probably better off using the HTML help feature. |
628 |
|
629 |
GENERATE_TREEVIEW = NO |
630 |
|
631 |
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be |
632 |
# used to set the initial width (in pixels) of the frame in which the tree |
633 |
# is shown. |
634 |
|
635 |
TREEVIEW_WIDTH = 250 |
636 |
|
637 |
#--------------------------------------------------------------------------- |
638 |
# Configuration options related to the preprocessor |
639 |
#--------------------------------------------------------------------------- |
640 |
|
641 |
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will |
642 |
# evaluate all C-preprocessor directives found in the sources and include |
643 |
# files. |
644 |
|
645 |
ENABLE_PREPROCESSING = YES |
646 |
|
647 |
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro |
648 |
# names in the source code. If set to NO (the default) only conditional |
649 |
# compilation will be performed. Macro expansion can be done in a controlled |
650 |
# way by setting EXPAND_ONLY_PREDEF to YES. |
651 |
|
652 |
MACRO_EXPANSION = NO |
653 |
|
654 |
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES |
655 |
# then the macro expansion is limited to the macros specified with the |
656 |
# PREDEFINED and EXPAND_AS_PREDEFINED tags. |
657 |
|
658 |
EXPAND_ONLY_PREDEF = NO |
659 |
|
660 |
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files |
661 |
# in the INCLUDE_PATH (see below) will be search if a #include is found. |
662 |
|
663 |
SEARCH_INCLUDES = YES |
664 |
|
665 |
# The INCLUDE_PATH tag can be used to specify one or more directories that |
666 |
# contain include files that are not input files but should be processed by |
667 |
# the preprocessor. |
668 |
|
669 |
INCLUDE_PATH = |
670 |
|
671 |
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
672 |
# patterns (like *.h and *.hpp) to filter out the header-files in the |
673 |
# directories. If left blank, the patterns specified with FILE_PATTERNS will |
674 |
# be used. |
675 |
|
676 |
INCLUDE_FILE_PATTERNS = |
677 |
|
678 |
# The PREDEFINED tag can be used to specify one or more macro names that |
679 |
# are defined before the preprocessor is started (similar to the -D option of |
680 |
# gcc). The argument of the tag is a list of macros of the form: name |
681 |
# or name=definition (no spaces). If the definition and the = are |
682 |
# omitted =1 is assumed. |
683 |
|
684 |
PREDEFINED = |
685 |
|
686 |
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then |
687 |
# this tag can be used to specify a list of macro names that should be expanded. |
688 |
# The macro definition that is found in the sources will be used. |
689 |
# Use the PREDEFINED tag if you want to use a different macro definition. |
690 |
|
691 |
EXPAND_AS_DEFINED = |
692 |
|
693 |
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then |
694 |
# doxygen's preprocessor will remove all function-like macros that are alone |
695 |
# on a line, have an all uppercase name, and do not end with a semicolon. Such |
696 |
# function macros are typically used for boiler-plate code, and will confuse the |
697 |
# parser if not removed. |
698 |
|
699 |
SKIP_FUNCTION_MACROS = YES |
700 |
|
701 |
#--------------------------------------------------------------------------- |
702 |
# Configuration::addtions related to external references |
703 |
#--------------------------------------------------------------------------- |
704 |
|
705 |
# The TAGFILES option can be used to specify one or more tagfiles. |
706 |
# Optionally an initial location of the external documentation |
707 |
# can be added for each tagfile. The format of a tag file without |
708 |
# this location is as follows: |
709 |
# TAGFILES = file1 file2 ... |
710 |
# Adding location for the tag files is done as follows: |
711 |
# TAGFILES = file1=loc1 "file2 = loc2" ... |
712 |
# where "loc1" and "loc2" can be relative or absolute paths or |
713 |
# URLs. If a location is present for each tag, the installdox tool |
714 |
# does not have to be run to correct the links. |
715 |
# Note that each tag file must have a unique name |
716 |
# (where the name does NOT include the path) |
717 |
# If a tag file is not located in the directory in which doxygen |
718 |
# is run, you must also specify the path to the tagfile here. |
719 |
|
720 |
TAGFILES = |
721 |
|
722 |
# When a file name is specified after GENERATE_TAGFILE, doxygen will create |
723 |
# a tag file that is based on the input files it reads. |
724 |
|
725 |
GENERATE_TAGFILE = |
726 |
|
727 |
# If the ALLEXTERNALS tag is set to YES all external classes will be listed |
728 |
# in the class index. If set to NO only the inherited external classes |
729 |
# will be listed. |
730 |
|
731 |
ALLEXTERNALS = NO |
732 |
|
733 |
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed |
734 |
# in the modules index. If set to NO, only the current project's groups will |
735 |
# be listed. |
736 |
|
737 |
EXTERNAL_GROUPS = YES |
738 |
|
739 |
# The PERL_PATH should be the absolute path and name of the perl script |
740 |
# interpreter (i.e. the result of `which perl'). |
741 |
|
742 |
PERL_PATH = /usr/bin/perl |
743 |
|
744 |
#--------------------------------------------------------------------------- |
745 |
# Configuration options related to the dot tool |
746 |
#--------------------------------------------------------------------------- |
747 |
|
748 |
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
749 |
# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or |
750 |
# super classes. Setting the tag to NO turns the diagrams off. Note that this |
751 |
# option is superseded by the HAVE_DOT option below. This is only a fallback. It is |
752 |
# recommended to install and use dot, since it yields more powerful graphs. |
753 |
|
754 |
CLASS_DIAGRAMS = YES |
755 |
|
756 |
# If set to YES, the inheritance and collaboration graphs will hide |
757 |
# inheritance and usage relations if the target is undocumented |
758 |
# or is not a class. |
759 |
|
760 |
HIDE_UNDOC_RELATIONS = NO |
761 |
|
762 |
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
763 |
# available from the path. This tool is part of Graphviz, a graph visualization |
764 |
# toolkit from AT&T and Lucent Bell Labs. The other options in this section |
765 |
# have no effect if this option is set to NO (the default) |
766 |
|
767 |
HAVE_DOT = YES |
768 |
|
769 |
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
770 |
# will generate a graph for each documented class showing the direct and |
771 |
# indirect inheritance relations. Setting this tag to YES will force the |
772 |
# the CLASS_DIAGRAMS tag to NO. |
773 |
|
774 |
CLASS_GRAPH = YES |
775 |
|
776 |
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
777 |
# will generate a graph for each documented class showing the direct and |
778 |
# indirect implementation dependencies (inheritance, containment, and |
779 |
# class references variables) of the class with other documented classes. |
780 |
|
781 |
COLLABORATION_GRAPH = NO |
782 |
|
783 |
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and |
784 |
# collaboration diagrams in a style similar to the OMG's Unified Modeling |
785 |
# Language. |
786 |
|
787 |
UML_LOOK = NO |
788 |
|
789 |
# If set to YES, the inheritance and collaboration graphs will show the |
790 |
# relations between templates and their instances. |
791 |
|
792 |
TEMPLATE_RELATIONS = YES |
793 |
|
794 |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT |
795 |
# tags are set to YES then doxygen will generate a graph for each documented |
796 |
# file showing the direct and indirect include dependencies of the file with |
797 |
# other documented files. |
798 |
|
799 |
INCLUDE_GRAPH = NO |
800 |
|
801 |
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and |
802 |
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each |
803 |
# documented header file showing the documented files that directly or |
804 |
# indirectly include this file. |
805 |
|
806 |
INCLUDED_BY_GRAPH = NO |
807 |
|
808 |
# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will |
809 |
# generate a call dependency graph for every global function or class method. |
810 |
# Note that enabling this option will significantly increase the time of a run. |
811 |
# So in most cases it will be better to enable call graphs for selected |
812 |
# functions only using the \callgraph command. |
813 |
|
814 |
CALL_GRAPH = NO |
815 |
|
816 |
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen |
817 |
# will graphical hierarchy of all classes instead of a textual one. |
818 |
|
819 |
GRAPHICAL_HIERARCHY = YES |
820 |
|
821 |
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
822 |
# generated by dot. Possible values are png, jpg, or gif |
823 |
# If left blank png will be used. |
824 |
|
825 |
DOT_IMAGE_FORMAT = png |
826 |
|
827 |
# The tag DOT_PATH can be used to specify the path where the dot tool can be |
828 |
# found. If left blank, it is assumed the dot tool can be found on the path. |
829 |
|
830 |
DOT_PATH = |
831 |
|
832 |
# The DOTFILE_DIRS tag can be used to specify one or more directories that |
833 |
# contain dot files that are included in the documentation (see the |
834 |
# \dotfile command). |
835 |
|
836 |
DOTFILE_DIRS = |
837 |
|
838 |
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width |
839 |
# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
840 |
# this value, doxygen will try to truncate the graph, so that it fits within |
841 |
# the specified constraint. Beware that most browsers cannot cope with very |
842 |
# large images. |
843 |
|
844 |
MAX_DOT_GRAPH_WIDTH = 1024 |
845 |
|
846 |
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height |
847 |
# (in pixels) of the graphs generated by dot. If a graph becomes larger than |
848 |
# this value, doxygen will try to truncate the graph, so that it fits within |
849 |
# the specified constraint. Beware that most browsers cannot cope with very |
850 |
# large images. |
851 |
|
852 |
MAX_DOT_GRAPH_HEIGHT = 1024 |
853 |
|
854 |
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the |
855 |
# graphs generated by dot. A depth value of 3 means that only nodes reachable |
856 |
# from the root by following a path via at most 3 edges will be shown. Nodes that |
857 |
# lay further from the root node will be omitted. Note that setting this option to |
858 |
# 1 or 2 may greatly reduce the computation time needed for large code bases. Also |
859 |
# note that a graph may be further truncated if the graph's image dimensions are |
860 |
# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). |
861 |
# If 0 is used for the depth value (the default), the graph is not depth-constrained. |
862 |
|
863 |
MAX_DOT_GRAPH_DEPTH = 0 |
864 |
|
865 |
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will |
866 |
# generate a legend page explaining the meaning of the various boxes and |
867 |
# arrows in the dot generated graphs. |
868 |
|
869 |
GENERATE_LEGEND = YES |
870 |
|
871 |
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will |
872 |
# remove the intermediate dot files that are used to generate |
873 |
# the various graphs. |
874 |
|
875 |
DOT_CLEANUP = YES |
876 |
|
877 |
#--------------------------------------------------------------------------- |
878 |
# Configuration::addtions related to the search engine |
879 |
#--------------------------------------------------------------------------- |
880 |
|
881 |
# The SEARCHENGINE tag specifies whether or not a search engine should be |
882 |
# used. If set to NO the values of all tags below this one will be ignored. |
883 |
|
884 |
SEARCHENGINE = NO |
885 |
GENERATE_LATEX = NO |