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