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