Doxyfile 66.8 KB
Newer Older
1
# Doxyfile 1.7.1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
#       TAG = value [value, ...]
# For lists items can also be appended using:
#       TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

17
18
19
20
21
# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
# http://www.gnu.org/software/libiconv for the list of possible encodings.
22
23
24

DOXYFILE_ENCODING      = UTF-8

25
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
26
27
# by quotes) that should identify the project.

28
PROJECT_NAME           = "Poppler Qt4 "
29

30
31
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
32
33
# if some version control system is used.

Albert Astals Cid's avatar
0.32.0    
Albert Astals Cid committed
34
PROJECT_NUMBER         = 0.32.0
35

36
37
38
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
39
40
# where doxygen was started. If left blank the current directory will be used.

41
OUTPUT_DIRECTORY       =
42

43
44
45
46
47
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
# format and will distribute the generated files over these directories.
# Enabling this option can be useful when feeding doxygen a huge amount of
# source files, where putting all generated files in the same directory would
48
49
50
51
# otherwise cause performance problems for the file system.

CREATE_SUBDIRS         = NO

52
53
54
55
56
57
58
59
60
61
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak,
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
62
63
64

OUTPUT_LANGUAGE        = English

65
66
67
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
68
69
# Set to NO to disable this.

Albert Astals Cid's avatar
Albert Astals Cid committed
70
BRIEF_MEMBER_DESC      = NO
71

72
73
74
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
75
76
77
78
# brief descriptions will be completely suppressed.

REPEAT_BRIEF           = YES

79
80
81
82
83
84
85
86
# This tag implements a quasi-intelligent brief description abbreviator
# that is used to form the text in various listings. Each string
# in this list, if found as the leading text of the brief description, will be
# stripped from the text and the result after processing the whole list, is
# used as the annotated text. Otherwise, the brief description is used as-is.
# If left blank, the following values are used ("$name" is automatically
# replaced with the name of the entity): "The $name class" "The $name widget"
# "The $name file" "is" "provides" "specifies" "contains"
87
88
# "represents" "a" "an" "the"

89
ABBREVIATE_BRIEF       =
90

91
92
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
93
94
95
96
# description.

ALWAYS_DETAILED_SEC    = NO

97
98
99
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
100
101
102
103
# operators of the base classes will not be shown.

INLINE_INHERITED_MEMB  = NO

104
105
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
106
107
108
109
# to NO the shortest path that makes the file name unique will be used.

FULL_PATH_NAMES        = YES

110
111
112
113
114
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the
115
116
# path to strip.

117
STRIP_FROM_PATH        =
118

119
120
121
122
123
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
# the reader which header file to include in order to use a class.
# If left blank only the name of the header file containing the class
# definition is used. Otherwise one should specify the include paths that
124
125
# are normally passed to the compiler using the -I flag.

126
STRIP_FROM_INC_PATH    =
127

128
129
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
130
131
132
133
# doesn't support long names like on DOS, Mac, or CD-ROM.

SHORT_NAMES            = NO

134
135
136
137
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like regular Qt-style comments
138
# (thus requiring an explicit @brief command for a brief description.)
139

140
JAVADOC_AUTOBRIEF      = YES
141

142
143
144
145
# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
# interpret the first line (until the first dot) of a Qt-style
# comment as the brief description. If set to NO, the comments
# will behave just like regular Qt-style comments (thus requiring
146
147
148
149
# an explicit \brief command for a brief description.)

QT_AUTOBRIEF           = NO

150
151
152
153
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
154
155
156
157
# description. Set this tag to YES if you prefer the old behaviour instead.

MULTILINE_CPP_IS_BRIEF = NO

158
159
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
160
161
162
163
# re-implements.

INHERIT_DOCS           = YES

164
165
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
# a new page for each member. If set to NO, the documentation of a member will
166
# be part of the file/class/namespace that contains it.
167

168
SEPARATE_MEMBER_PAGES  = NO
169

170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171
172
173
174
# Doxygen uses this value to replace tabs by spaces in code fragments.

TAB_SIZE               = 8

175
176
177
178
179
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user-defined paragraph with heading "Side Effects:".
180
181
# You can put \n's in the value part of an alias to insert newlines.

182
ALIASES                =
183

184
185
186
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
# For instance, some of the names that are used will be different. The list
187
188
189
190
# of all members will be omitted, etc.

OPTIMIZE_OUTPUT_FOR_C  = NO

191
192
193
194
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
# sources only. Doxygen will then generate output that is more tailored for
# Java. For instance, namespaces will be presented as packages, qualified
# scopes will look different, etc.
195
196
197

OPTIMIZE_OUTPUT_JAVA   = NO

198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources only. Doxygen will then generate output that is more tailored for
# Fortran.

OPTIMIZE_FOR_FORTRAN   = NO

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for
# VHDL.

OPTIMIZE_OUTPUT_VHDL   = NO

# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given extension.
# Doxygen has a built-in mapping, but you can override or extend it using this
# tag. The format is ext=language, where ext is a file extension, and language
# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.

EXTENSION_MAPPING      =

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should
# set this tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
# func(std::string) {}). This also make the inheritance and collaboration
227
228
229
230
231
232
233
234
235
# diagrams that involve STL classes more complete and accurate.

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.

CPP_CLI_SUPPORT        = NO

236
237
# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
# Doxygen will parse them like normal C++ but will assume all classes use public
238
239
240
241
# instead of private inheritance when no explicit protection keyword is present.

SIP_SUPPORT            = NO

242
243
244
245
246
247
248
249
250
251
252
253
# For Microsoft's IDL there are propget and propput attributes to indicate getter
# and setter methods for a property. Setting this option to YES (the default)
# will make doxygen to replace the get and set methods by a property in the
# documentation. This will only work if the methods are indeed getting or
# setting a simple type. If this is not the case, or you want to show the
# methods anyway, you should set this option to NO.

IDL_PROPERTY_SUPPORT   = YES

# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
254
255
256
257
# all members of a group must be documented explicitly.

DISTRIBUTE_GROUP_DOC   = NO

258
259
260
261
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
# NO to prevent subgrouping. Alternatively, this can be done per class using
262
263
264
265
# the \nosubgrouping command.

SUBGROUPING            = YES

266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
# is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically
# be useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.

TYPEDEF_HIDES_STRUCT   = NO

# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penality.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will rougly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols

SYMBOL_CACHE_SIZE      = 0

292
293
294
295
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------

296
297
298
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
299
300
301
302
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES

EXTRACT_ALL            = NO

303
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
304
305
306
307
# will be included in the documentation.

EXTRACT_PRIVATE        = NO

308
# If the EXTRACT_STATIC tag is set to YES all static members of a file
309
310
311
312
# will be included in the documentation.

EXTRACT_STATIC         = NO

313
314
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
315
316
# If set to NO only classes defined in header files are included.

Albert Astals Cid's avatar
Albert Astals Cid committed
317
EXTRACT_LOCAL_CLASSES  = NO
318

319
320
321
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
322
323
324
325
# If set to NO (the default) only methods in the interface are included.

EXTRACT_LOCAL_METHODS  = NO

326
327
328
329
330
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base
# name of the file that contains the anonymous namespace. By default
# anonymous namespace are hidden.
331
332
333

EXTRACT_ANON_NSPACES   = NO

334
335
336
337
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
338
339
340
341
# This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_MEMBERS     = NO

342
343
344
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these classes will be included in the various
345
346
347
348
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES     = NO

349
350
351
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
# friend (class|struct|union) declarations.
# If set to NO (the default) these declarations will be included in the
352
353
# documentation.

Albert Astals Cid's avatar
Albert Astals Cid committed
354
HIDE_FRIEND_COMPOUNDS  = YES
355

356
357
358
# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
# documentation blocks found inside the body of a function.
# If set to NO (the default) these blocks will be appended to the
359
360
361
362
# function's detailed documentation block.

HIDE_IN_BODY_DOCS      = NO

363
364
365
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
366
367
368
369
# Set it to YES to include the internal documentation.

INTERNAL_DOCS          = NO

370
371
372
373
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower-case letters. If set to YES upper-case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
374
375
376
377
# and Mac users are advised to set this option to NO.

CASE_SENSE_NAMES       = YES

378
379
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
380
381
382
383
# documentation. If set to YES the scope will be hidden.

HIDE_SCOPE_NAMES       = NO

384
385
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put a list of the files that are included by a file in the documentation
386
387
388
389
# of that file.

SHOW_INCLUDE_FILES     = YES

390
391
392
393
394
395
396
# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
# will list include files with double quotes in the documentation
# rather than with sharp brackets.

FORCE_LOCAL_INCLUDES   = NO

# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
397
398
# is inserted in the documentation for inline members.

Albert Astals Cid's avatar
Albert Astals Cid committed
399
INLINE_INFO            = NO
400

401
402
403
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
404
405
406
407
# declaration order.

SORT_MEMBER_DOCS       = YES

408
409
410
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
# brief documentation of file, namespace and class members alphabetically
# by member name. If set to NO (the default) the members will appear in
411
412
# declaration order.

Albert Astals Cid's avatar
Albert Astals Cid committed
413
SORT_BRIEF_DOCS        = YES
414

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# will sort the (brief and detailed) documentation of class members so that
# constructors and destructors are listed first. If set to NO (the default)
# the constructors will appear in the respective orders defined by
# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.

SORT_MEMBERS_CTORS_1ST = NO

# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.

SORT_GROUP_NAMES       = NO

# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to
# NO (the default), the class list will be sorted only by class name,
# not including the namespace part.
435
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
436
# Note: This option applies only to the class list, not to the
437
438
# alphabetical list.

Albert Astals Cid's avatar
Albert Astals Cid committed
439
SORT_BY_SCOPE_NAME     = YES
440

441
442
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
443
444
445
446
# commands in the documentation.

GENERATE_TODOLIST      = YES

447
448
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
449
450
451
452
# commands in the documentation.

GENERATE_TESTLIST      = YES

453
454
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
455
456
457
458
# commands in the documentation.

GENERATE_BUGLIST       = YES

459
460
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
461
462
463
464
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES

465
# The ENABLED_SECTIONS tag can be used to enable conditional
466
467
# documentation sections, marked by \if sectionname ... \endif.

468
ENABLED_SECTIONS       =
469

470
471
472
473
474
475
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consists of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
476
477
478
479
# command in the documentation regardless of this setting.

MAX_INITIALIZER_LINES  = 30

480
481
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
482
483
484
485
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES        = YES

486
487
# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
488
# in the documentation. The default is NO.
489

Albert Astals Cid's avatar
Albert Astals Cid committed
490
SHOW_DIRECTORIES       = NO
491

492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
# This will remove the Files entry from the Quick Index and from the
# Folder Tree View (if specified). The default is YES.

SHOW_FILES             = YES

# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
# Namespaces page.
# This will remove the Namespaces entry from the Quick Index
# and from the Folder Tree View (if specified). The default is YES.

SHOW_NAMESPACES        = YES

# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
# the version control system). Doxygen will invoke the program by executing (via
# popen()) the command <command> <input-file>, where <command> is the value of
# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
# provided by doxygen. Whatever the program writes to standard output
511
512
# is used as the file version. See the manual for examples.

513
514
515
516
517
518
519
520
521
522
FILE_VERSION_FILTER    =

# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
# by doxygen. The layout file controls the global structure of the generated
# output files in an output format independent way. The create the layout file
# that represents doxygen's defaults, run doxygen with the -l option.
# You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file.

LAYOUT_FILE            =
523
524
525
526
527

#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------

528
# The QUIET tag can be used to turn on/off the messages that are generated
529
530
531
532
# by doxygen. Possible values are YES and NO. If left blank NO is used.

QUIET                  = NO

533
534
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
535
536
537
538
# NO is used.

WARNINGS               = YES

539
540
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
541
542
543
544
# automatically be disabled.

WARN_IF_UNDOCUMENTED   = YES

545
546
547
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
548
549
550
551
# don't exist or using markup commands wrongly.

WARN_IF_DOC_ERROR      = YES

552
553
554
555
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
# or return value. If set to NO (the default) doxygen will only warn about
# wrong or incomplete parameter documentation, but not about the absence of
556
557
558
559
# documentation.

WARN_NO_PARAMDOC       = NO

560
561
562
563
564
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text. Optionally the format may contain
# $version, which will be replaced by the version of the file (if it could
565
566
# be obtained via FILE_VERSION_FILTER)

567
WARN_FORMAT            = "$file:$line: $text "
568

569
570
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
571
572
# to stderr.

573
WARN_LOGFILE           =
574
575
576
577
578

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

579
580
581
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
582
583
# with spaces.

584
INPUT                  = Mainpage.dox \
585
                         poppler-annotation.h \
586
                         poppler-form.h \
587
588
                         poppler-link.h \
                         poppler-qt4.h \
589
                         poppler-optcontent.h \
590
                         poppler-page-transition.h
591

592
593
594
595
596
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
# also the default input encoding. Doxygen uses libiconv (or the iconv built
# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
# the list of possible encodings.
597
598
599

INPUT_ENCODING         = UTF-8

600
601
602
603
604
605
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
606

607
FILE_PATTERNS          =
608

609
610
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
611
612
613
614
# If left blank NO is used.

RECURSIVE              = NO

615
616
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
617
618
# subdirectory from a directory tree whose root is specified with the INPUT tag.

619
EXCLUDE                =
620

621
622
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded
623
624
625
626
# from the input.

EXCLUDE_SYMLINKS       = NO

627
628
629
630
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories. Note that the wildcards are matched
# against the file with absolute path, so to exclude all test directories
631
# for example use the pattern */test/*
632

633
EXCLUDE_PATTERNS       =
634

635
636
637
638
639
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
# output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
640

641
EXCLUDE_SYMBOLS        =
642

643
644
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
645
646
# the \include command).

647
EXAMPLE_PATH           =
648

649
650
651
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
652
653
# blank all files are included.

654
EXAMPLE_PATTERNS       =
655

656
657
658
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
659
660
661
662
# Possible values are YES and NO. If left blank NO is used.

EXAMPLE_RECURSIVE      = NO

663
664
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
665
666
# the \image command).

667
IMAGE_PATH             =
668

669
670
671
672
673
674
675
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter>
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.
# If FILTER_PATTERNS is specified, this tag will be
676
677
# ignored.

678
INPUT_FILTER           =
679

680
681
682
683
684
685
686
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis.
# Doxygen will compare the file name with each pattern and apply the
# filter if there is a match.
# The filters are a list of the form:
# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
687
688
# is applied to all files.

689
FILTER_PATTERNS        =
690

691
692
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
693
694
695
696
697
698
699
700
# files to browse (i.e. when SOURCE_BROWSER is set to YES).

FILTER_SOURCE_FILES    = NO

#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------

701
702
703
704
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
# Note: To get rid of all source code in the generated output, make sure also
# VERBATIM_HEADERS is set to NO.
705
706
707

SOURCE_BROWSER         = NO

708
# Setting the INLINE_SOURCES tag to YES will include the body
709
710
711
712
# of functions and classes directly in the documentation.

INLINE_SOURCES         = NO

713
714
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
715
716
717
718
# fragments. Normal C and C++ comments will always remain visible.

STRIP_CODE_COMMENTS    = YES

719
720
# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
721
722
723
724
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

725
726
# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
727
728
729
730
# called/used by that function will be listed.

REFERENCES_RELATION    = YES

731
732
733
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
734
735
# link to the source code.
# Otherwise they will link to the documentation.
736
737
738

REFERENCES_LINK_SOURCE = YES

739
740
741
742
# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
743
744
745
746
# will need version 4.8.6 or higher.

USE_HTAGS              = NO

747
748
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
749
750
751
752
753
754
755
756
# which an include is specified. Set to NO to disable this.

VERBATIM_HEADERS       = YES

#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------

757
758
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
759
760
# contains a lot of classes, structs, unions or interfaces.

761
ALPHABETICAL_INDEX     = YES
762

763
764
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
765
766
767
768
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX    = 5

769
770
771
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
772
773
# should be ignored while generating the index headers.

774
IGNORE_PREFIX          =
775
776
777
778
779

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------

780
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
781
782
783
784
# generate HTML output.

GENERATE_HTML          = YES

785
786
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
787
788
# put in front of it. If left blank `html' will be used as the default path.

789
HTML_OUTPUT            = APIDOCS-html
790

791
792
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
793
794
795
796
# doxygen will generate files with .html extension.

HTML_FILE_EXTENSION    = .html

797
798
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
799
800
# standard header.

801
HTML_HEADER            =
802

803
804
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
805
806
# standard footer.

807
HTML_FOOTER            =
808

809
810
811
812
813
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet. Note that doxygen will try to copy
# the style sheet file to the HTML output directory, so don't put your own
814
815
# stylesheet in the HTML output directory as well, or it will be erased!

816
HTML_STYLESHEET        =
817

818
819
820
821
822
823
824
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
# Doxygen will adjust the colors in the stylesheet and background images
# according to this color. Hue is specified as an angle on a colorwheel,
# see http://en.wikipedia.org/wiki/Hue for more information.
# For instance the value 0 represents red, 60 is yellow, 120 is green,
# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
# The allowed range is 0 to 359.
825

826
HTML_COLORSTYLE_HUE    = 220
827

828
829
830
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
# the colors in the HTML output. For a value of 0 the output will use
# grayscales only. A value of 255 will produce the most vivid colors.
831

832
833
834
835
836
837
838
839
840
841
HTML_COLORSTYLE_SAT    = 100

# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
# the luminance component of the colors in the HTML output. Values below
# 100 gradually make the output lighter, whereas values above 100 make
# the output darker. The value divided by 100 is the actual gamma applied,
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
# and 100 does not change the gamma.

HTML_COLORSTYLE_GAMMA  = 80
842

843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP         = YES

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.

HTML_ALIGN_MEMBERS     = YES

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
# page has loaded. For this to work a browser that supports
# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
859
860
861
862
# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).

HTML_DYNAMIC_SECTIONS  = NO

863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
# If the GENERATE_DOCSET tag is set to YES, additional index files
# will be generated that can be used as input for Apple's Xcode 3
# integrated development environment, introduced with OSX 10.5 (Leopard).
# To create a documentation set, doxygen will generate a Makefile in the
# HTML output directory. Running make will produce the docset in that
# directory and running "make install" will install the docset in
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# it at startup.
# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
# for more information.

GENERATE_DOCSET        = NO

# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# feed. A documentation feed provides an umbrella under which multiple
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.

DOCSET_FEEDNAME        = "Doxygen generated docs"

# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.

DOCSET_BUNDLE_ID       = org.doxygen.Project

# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.

DOCSET_PUBLISHER_ID    = org.doxygen.Publisher

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

DOCSET_PUBLISHER_NAME  = Publisher

# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# of the generated HTML documentation.

GENERATE_HTMLHELP      = NO

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
910
911
# written to the html output directory.

912
CHM_FILE               =
913

914
915
916
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
917
918
# the HTML help compiler on the generated index.hhp.

919
HHC_LOCATION           =
920

921
922
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
923
924
925
926
# it should be included in the master .chm file (NO).

GENERATE_CHI           = NO

927
928
929
930
931
932
933
934
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
# is used to encode HtmlHelp index (hhk), content (hhc) and project file
# content.

CHM_INDEX_ENCODING     =

# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
935
936
937
938
# normal table of contents (NO) in the .chm file.

BINARY_TOC             = NO

939
# The TOC_EXPAND flag can be set to YES to add extra items for group members
940
941
942
943
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND             = NO

944
945
946
947
948
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
# that can be used as input for Qt's qhelpgenerator to generate a
# Qt Compressed Help (.qch) of the generated HTML documentation.

949
GENERATE_QHP           = YES
950
951
952
953
954

# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
# be used to specify the file name of the resulting .qch file.
# The path specified is relative to the HTML output folder.

955
QCH_FILE               = poppler-qt4.qch
956
957
958
959
960

# The QHP_NAMESPACE tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#namespace

961
QHP_NAMESPACE          = org.freedesktop.poppler.qt4
962
963
964
965
966
967
968
969
970
971
972

# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
# Qt Help Project output. For more information please see
# http://doc.trolltech.com/qthelpproject.html#virtual-folders

QHP_VIRTUAL_FOLDER     = doc

# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
# add. For more information please see
# http://doc.trolltech.com/qthelpproject.html#custom-filters

973
QHP_CUST_FILTER_NAME   = "Poppler 0.15.0"
974
975
976
977
978
979

# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see
# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
# Qt Help Project / Custom Filters</a>.

980
QHP_CUST_FILTER_ATTRS  = poppler
981
982
983
984
985
986
987

# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's
# filter section matches.
# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
# Qt Help Project / Filter Attributes</a>.

988
QHP_SECT_FILTER_ATTRS  = poppler
989
990
991
992
993
994

# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
# be used to specify the location of Qt's qhelpgenerator.
# If non-empty doxygen will try to run qhelpgenerator on the generated
# .qhp file.

995
QHG_LOCATION           = qhelpgenerator
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015

# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
#  will be generated, which together with the HTML files, form an Eclipse help
# plugin. To install this plugin and make it available under the help contents
# menu in Eclipse, the contents of the directory containing the HTML and XML
# files needs to be copied into the plugins directory of eclipse. The name of
# the directory within the plugins directory should be the same as
# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
# the help appears.

GENERATE_ECLIPSEHELP   = NO

# A unique identifier for the eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have
# this name.

ECLIPSE_DOC_ID         = org.doxygen.Project

# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
1016
1017
1018
1019
# the value YES disables it.

DISABLE_INDEX          = NO

1020
# This tag can be used to set the number of enum values (range [1..20])
1021
1022
1023
1024
# that doxygen will group on one line in the generated HTML documentation.

ENUM_VALUES_PER_LINE   = 4

1025
1026
1027
1028
1029
1030
1031
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information.
# If the tag value is set to YES, a side panel will be generated
# containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.
1032
1033
1034

GENERATE_TREEVIEW      = NO

1035
1036
1037
1038
1039
1040
1041
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.

USE_INLINE_TREES       = NO

# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
1042
1043
1044
1045
# is shown.

TREEVIEW_WIDTH         = 250

1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
# links to external symbols imported via tag files in a separate window.

EXT_LINKS_IN_WINDOW    = NO

# Use this tag to change the font size of Latex formulas included
# as images in the HTML documentation. The default is 10. Note that
# when you change the font size after a successful doxygen run you need
# to manually remove any form_*.png images from the HTML output directory
# to force them to be regenerated.

FORMULA_FONTSIZE       = 10

# Use the FORMULA_TRANPARENT tag to determine whether or not the images
# generated for formulas are transparent PNGs. Transparent PNGs are
# not supported properly for IE 6.0, but are supported on all modern browsers.
# Note that when changing this option you need to delete any form_*.png files
# in the HTML output before the changes have effect.

FORMULA_TRANSPARENT    = YES

# When the SEARCHENGINE tag is enabled doxygen will generate a search box
# for the HTML output. The underlying search engine uses javascript
# and DHTML and should work on any modern browser. Note that when using
# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
# (GENERATE_DOCSET) there is already a search function so this one should
# typically be disabled. For large projects the javascript based search engine
# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.

SEARCHENGINE           = NO

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a PHP enabled web server instead of at the web client
# using Javascript. Doxygen will generate the search PHP script and index
# file to put on the web server. The advantage of the server
# based approach is that it scales better to large projects and allows
# full text search. The disadvances is that it is more difficult to setup
# and does not have live searching capabilities.

SERVER_BASED_SEARCH    = NO

1087
1088
1089
1090
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------

1091
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1092
1093
1094
1095
# generate Latex output.

GENERATE_LATEX         = YES

1096
1097
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1098
1099
# put in front of it. If left blank `latex' will be used as the default path.

1100
LATEX_OUTPUT           = APIDOCS-latex
1101

1102
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1103
# invoked. If left blank `latex' will be used as the default command name.
1104
1105
1106
# Note that when enabling USE_PDFLATEX this option is only used for
# generating bitmaps for formulas in the HTML output, but not in the
# Makefile that is written to the output directory.
1107
1108
1109

LATEX_CMD_NAME         = latex

1110
1111
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
1112
1113
1114
1115
# default command name.

MAKEINDEX_CMD_NAME     = makeindex

1116
1117
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
1118
1119
1120
1121
# save some trees in general.

COMPACT_LATEX          = NO

1122
1123
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
1124
1125
1126
1127
# executive. If left blank a4wide will be used.

PAPER_TYPE             = a4wide

1128
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
1129
1130
# packages that should be included in the LaTeX output.

1131
EXTRA_PACKAGES         =
1132

1133
1134
1135
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
1136
1137
# standard header. Notice: only use this tag if you know what you are doing!

1138
LATEX_HEADER           =
1139

1140
1141
1142
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
1143
1144
1145
1146
# This makes the output suitable for online browsing using a pdf viewer.

PDF_HYPERLINKS         = NO

1147
1148
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
1149
1150
1151
1152
# higher quality PDF documentation.

USE_PDFLATEX           = NO

1153
1154
1155
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
1156
1157
1158
1159
# This option is also used when generating formulas in HTML.

LATEX_BATCHMODE        = NO

1160
1161
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
# include the index chapters (such as File Index, Compound Index, etc.)
1162
1163
1164
1165
# in the output.

LATEX_HIDE_INDICES     = NO

1166
1167
1168
1169
1170
1171
1172
# If LATEX_SOURCE_CODE is set to YES then doxygen will include
# source code with syntax highlighting in the LaTeX output.
# Note that which sources are shown also depends on other settings
# such as SOURCE_BROWSER.

LATEX_SOURCE_CODE      = NO

1173
1174
1175
1176
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------

1177
1178
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimized for Word 97 and may not look very pretty with
1179
1180
1181
1182
# other RTF readers or editors.

GENERATE_RTF           = NO

1183
1184
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1185
1186
1187
1188
# put in front of it. If left blank `rtf' will be used as the default path.

RTF_OUTPUT             = rtf

1189
1190
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
1191
1192
1193
1194
# save some trees in general.

COMPACT_RTF            = NO

1195
1196
1197
1198
1199
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
1200
1201
1202
1203
# Note: wordpad (write) and others do not support links.

RTF_HYPERLINKS         = NO

1204
1205
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assignments. You only have to provide
1206
1207
# replacements, missing definitions are set to their default value.

1208
RTF_STYLESHEET_FILE    =
1209

1210
# Set optional variables used in the generation of an rtf document.
1211
1212
# Syntax is similar to doxygen's config file.

1213
RTF_EXTENSIONS_FILE    =
1214
1215
1216
1217
1218

#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------

1219
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1220
1221
1222
1223
# generate man pages

GENERATE_MAN           = NO

1224
1225
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1226
1227
1228
1229
# put in front of it. If left blank `man' will be used as the default path.

MAN_OUTPUT             = man

1230
# The MAN_EXTENSION tag determines the extension that is added to
1231
1232
1233
1234
# the generated man pages (default is the subroutine's section .3)

MAN_EXTENSION          = .3

1235
1236
1237
1238
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
1239
1240
1241
1242
1243
1244
1245
1246
# would be unable to find the correct page. The default is NO.

MAN_LINKS              = NO

#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------

1247
1248
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
1249
1250
1251
1252
# the code including all documentation.

GENERATE_XML           = NO

1253
1254
# The XML_OUTPUT tag is used to specify where the XML pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
1255
1256
1257
1258
# put in front of it. If left blank `xml' will be used as the default path.

XML_OUTPUT             = xml

1259
1260
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
1261
1262
# syntax of the XML files.

1263
XML_SCHEMA             =
1264

1265
1266
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
1267
1268
# syntax of the XML files.

1269
XML_DTD                =
1270

1271
1272
1273
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that
1274
1275
1276
1277
1278
1279
1280
1281
# enabling this will significantly increase the size of the XML output.

XML_PROGRAMLISTING     = YES

#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------

1282
1283
1284
1285
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
1286
1287
1288
1289
1290
1291
1292
1293
# and incomplete at the moment.

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------

1294
1295
1296
1297
# If the GENERATE_PERLMOD tag is set to YES Doxygen will
# generate a Perl module file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
1298
1299
1300
1301
# moment.

GENERATE_PERLMOD       = NO

1302
1303
# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
# the necessary Makefile rules, Perl scripts and LaTeX code to be able
1304
1305
1306
1307
# to generate PDF and DVI output from the Perl module output.

PERLMOD_LATEX          = NO

1308
1309
1310
1311
1312
1313
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
# nicely formatted so it can be parsed by a human reader.
# This is useful
# if you want to understand what is going on.
# On the other hand, if this
# tag is set to NO the size of the Perl module output will be much smaller
1314
1315
1316
1317
# and Perl will parse it just the same.

PERLMOD_PRETTY         = YES

1318
1319
1320
# The names of the make variables in the generated doxyrules.make file
# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
# This is useful so different doxyrules.make files included by the same
1321
1322
# Makefile don't overwrite each other's variables.

1323
PERLMOD_MAKEVAR_PREFIX =
1324
1325

#---------------------------------------------------------------------------
1326
# Configuration options related to the preprocessor
1327
1328
#---------------------------------------------------------------------------

1329
1330
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
1331
1332
1333
1334
# files.

ENABLE_PREPROCESSING   = YES

1335
1336
1337
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
1338
1339
# way by setting EXPAND_ONLY_PREDEF to YES.

1340
MACRO_EXPANSION        = YES
1341

1342
1343
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
1344
# PREDEFINED and EXPAND_AS_DEFINED tags.
1345

1346
EXPAND_ONLY_PREDEF     = YES
1347

1348
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1349
1350
1351
1352
# in the INCLUDE_PATH (see below) will be search if a #include is found.

SEARCH_INCLUDES        = YES

1353
1354
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
1355
1356
# the preprocessor.

1357
INCLUDE_PATH           =
1358

1359
1360
1361
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
1362
1363
# be used.

1364
INCLUDE_FILE_PATTERNS  =
1365

1366
1367
1368
1369
1370
1371
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed. To prevent a macro definition from being
# undefined via #undef or recursively expanded use the := operator
1372
1373
# instead of the = operator.

1374
1375
PREDEFINED             = "Q_DECL_DEPRECATED=" \
                         "POPPLER_QT4_EXPORT="
1376

1377
1378
1379
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
1380
1381
# Use the PREDEFINED tag if you want to use a different macro definition.

1382
EXPAND_AS_DEFINED      =
1383