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