Warning, /network/telepathy-logger-qt/doxygen.cfg.in is written in an unsupported language. File is not indexed.
0001 # This file describes the settings to be used by the documentation system
0002 # doxygen (www.doxygen.org) for a project
0003 #
0004 # All text after a hash (#) is considered a comment and will be ignored
0005 # The format is:
0006 # TAG = value [value, ...]
0007 # For lists items can also be appended using:
0008 # TAG += value [value, ...]
0009 # Values that contain spaces should be placed between quotes (" ")
0010
0011 #---------------------------------------------------------------------------
0012 # Project related configuration options
0013 #---------------------------------------------------------------------------
0014
0015 # This tag specifies the encoding used for all characters in the config file
0016 # that follow. The default is UTF-8 which is also the encoding used for all
0017 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
0018 # iconv built into libc) for the transcoding. See
0019 # http://www.gnu.org/software/libiconv for the list of possible encodings.
0020
0021 DOXYFILE_ENCODING = UTF-8
0022
0023 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
0024 # by quotes) that should identify the project.
0025
0026 PROJECT_NAME = ${PROJECT_NAME}
0027
0028 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
0029 # This could be handy for archiving the generated documentation or
0030 # if some version control system is used.
0031
0032 PROJECT_NUMBER = ${PACKAGE_VERSION}
0033
0034 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
0035 # base path where the generated documentation will be put.
0036 # If a relative path is entered, it will be relative to the location
0037 # where doxygen was started. If left blank the current directory will be used.
0038
0039 OUTPUT_DIRECTORY = ${abs_top_builddir}/doc
0040
0041
0042 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
0043 # 4096 sub-directories (in 2 levels) under the output directory of each output
0044 # format and will distribute the generated files over these directories.
0045 # Enabling this option can be useful when feeding doxygen a huge amount of
0046 # source files, where putting all generated files in the same directory would
0047 # otherwise cause performance problems for the file system.
0048
0049 CREATE_SUBDIRS = NO
0050
0051 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
0052 # documentation generated by doxygen is written. Doxygen will use this
0053 # information to generate all constant output in the proper language.
0054 # The default language is English, other supported languages are:
0055 # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
0056 # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
0057 # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
0058 # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
0059 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
0060 # and Ukrainian.
0061
0062 OUTPUT_LANGUAGE = English
0063
0064 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
0065 # include brief member descriptions after the members that are listed in
0066 # the file and class documentation (similar to JavaDoc).
0067 # Set to NO to disable this.
0068
0069 BRIEF_MEMBER_DESC = YES
0070
0071 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
0072 # the brief description of a member or function before the detailed description.
0073 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
0074 # brief descriptions will be completely suppressed.
0075
0076 REPEAT_BRIEF = YES
0077
0078 # This tag implements a quasi-intelligent brief description abbreviator
0079 # that is used to form the text in various listings. Each string
0080 # in this list, if found as the leading text of the brief description, will be
0081 # stripped from the text and the result after processing the whole list, is
0082 # used as the annotated text. Otherwise, the brief description is used as-is.
0083 # If left blank, the following values are used ("$name" is automatically
0084 # replaced with the name of the entity): "The $name class" "The $name widget"
0085 # "The $name file" "is" "provides" "specifies" "contains"
0086 # "represents" "a" "an" "the"
0087
0088 ABBREVIATE_BRIEF = "The \$name class" \
0089 "The \$name file" \
0090 is \
0091 provides \
0092 specifies \
0093 contains \
0094 represents \
0095 a \
0096 an \
0097 the
0098
0099 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
0100 # Doxygen will generate a detailed section even if there is only a brief
0101 # description.
0102
0103 ALWAYS_DETAILED_SEC = YES
0104
0105 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
0106 # inherited members of a class in the documentation of that class as if those
0107 # members were ordinary class members. Constructors, destructors and assignment
0108 # operators of the base classes will not be shown.
0109
0110 INLINE_INHERITED_MEMB = NO
0111
0112 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
0113 # path before files name in the file list and in the header files. If set
0114 # to NO the shortest path that makes the file name unique will be used.
0115
0116 FULL_PATH_NAMES = NO
0117
0118 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
0119 # can be used to strip a user-defined part of the path. Stripping is
0120 # only done if one of the specified strings matches the left-hand part of
0121 # the path. The tag can be used to show relative paths in the file list.
0122 # If left blank the directory from which doxygen is run is used as the
0123 # path to strip.
0124
0125 STRIP_FROM_PATH = ${abs_top_srcdir}
0126
0127 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
0128 # the path mentioned in the documentation of a class, which tells
0129 # the reader which header file to include in order to use a class.
0130 # If left blank only the name of the header file containing the class
0131 # definition is used. Otherwise one should specify the include paths that
0132 # are normally passed to the compiler using the -I flag.
0133
0134 STRIP_FROM_INC_PATH = $abs_top_srcdir} ${abs_top_builddir}
0135
0136 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
0137 # (but less readable) file names. This can be useful is your file systems
0138 # doesn't support long names like on DOS, Mac, or CD-ROM.
0139
0140 SHORT_NAMES = YES
0141
0142 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
0143 # will interpret the first line (until the first dot) of a JavaDoc-style
0144 # comment as the brief description. If set to NO, the JavaDoc
0145 # comments will behave just like regular Qt-style comments
0146 # (thus requiring an explicit @brief command for a brief description.)
0147
0148 JAVADOC_AUTOBRIEF = NO
0149
0150 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will
0151 # interpret the first line (until the first dot) of a Qt-style
0152 # comment as the brief description. If set to NO, the comments
0153 # will behave just like regular Qt-style comments (thus requiring
0154 # an explicit \brief command for a brief description.)
0155
0156 QT_AUTOBRIEF = NO
0157
0158 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
0159 # treat a multi-line C++ special comment block (i.e. a block of //! or ///
0160 # comments) as a brief description. This used to be the default behaviour.
0161 # The new default is to treat a multi-line C++ comment block as a detailed
0162 # description. Set this tag to YES if you prefer the old behaviour instead.
0163
0164 MULTILINE_CPP_IS_BRIEF = NO
0165
0166 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
0167 # member inherits the documentation from any documented member that it
0168 # re-implements.
0169
0170 INHERIT_DOCS = YES
0171
0172 # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
0173 # a new page for each member. If set to NO, the documentation of a member will
0174 # be part of the file/class/namespace that contains it.
0175
0176 SEPARATE_MEMBER_PAGES = NO
0177
0178 # The TAB_SIZE tag can be used to set the number of spaces in a tab.
0179 # Doxygen uses this value to replace tabs by spaces in code fragments.
0180
0181 TAB_SIZE = 4
0182
0183 # This tag can be used to specify a number of aliases that acts
0184 # as commands in the documentation. An alias has the form "name=value".
0185 # For example adding "sideeffect=\par Side Effects:\n" will allow you to
0186 # put the command \sideeffect (or @sideeffect) in the documentation, which
0187 # will result in a user-defined paragraph with heading "Side Effects:".
0188 # You can put \n's in the value part of an alias to insert newlines.
0189
0190 ALIASES =
0191
0192 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
0193 # sources only. Doxygen will then generate output that is more tailored for C.
0194 # For instance, some of the names that are used will be different. The list
0195 # of all members will be omitted, etc.
0196
0197 OPTIMIZE_OUTPUT_FOR_C = NO
0198
0199 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
0200 # sources only. Doxygen will then generate output that is more tailored for
0201 # Java. For instance, namespaces will be presented as packages, qualified
0202 # scopes will look different, etc.
0203
0204 OPTIMIZE_OUTPUT_JAVA = NO
0205
0206 # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
0207 # sources only. Doxygen will then generate output that is more tailored for
0208 # Fortran.
0209
0210 OPTIMIZE_FOR_FORTRAN = NO
0211
0212 # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
0213 # sources. Doxygen will then generate output that is tailored for
0214 # VHDL.
0215
0216 OPTIMIZE_OUTPUT_VHDL = NO
0217
0218 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
0219 # to include (a tag file for) the STL sources as input, then you should
0220 # set this tag to YES in order to let doxygen match functions declarations and
0221 # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
0222 # func(std::string) {}). This also make the inheritance and collaboration
0223 # diagrams that involve STL classes more complete and accurate.
0224
0225 BUILTIN_STL_SUPPORT = YES
0226
0227 # If you use Microsoft's C++/CLI language, you should set this option to YES to
0228 # enable parsing support.
0229
0230 CPP_CLI_SUPPORT = NO
0231
0232 # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
0233 # Doxygen will parse them like normal C++ but will assume all classes use public
0234 # instead of private inheritance when no explicit protection keyword is present.
0235
0236 SIP_SUPPORT = NO
0237
0238 # For Microsoft's IDL there are propget and propput attributes to indicate getter
0239 # and setter methods for a property. Setting this option to YES (the default)
0240 # will make doxygen to replace the get and set methods by a property in the
0241 # documentation. This will only work if the methods are indeed getting or
0242 # setting a simple type. If this is not the case, or you want to show the
0243 # methods anyway, you should set this option to NO.
0244
0245 IDL_PROPERTY_SUPPORT = NO
0246
0247 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
0248 # tag is set to YES, then doxygen will reuse the documentation of the first
0249 # member in the group (if any) for the other members of the group. By default
0250 # all members of a group must be documented explicitly.
0251
0252 DISTRIBUTE_GROUP_DOC = YES
0253
0254 # Set the SUBGROUPING tag to YES (the default) to allow class member groups of
0255 # the same type (for instance a group of public functions) to be put as a
0256 # subgroup of that type (e.g. under the Public Functions section). Set it to
0257 # NO to prevent subgrouping. Alternatively, this can be done per class using
0258 # the \nosubgrouping command.
0259
0260 SUBGROUPING = YES
0261
0262 # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
0263 # is documented as struct, union, or enum with the name of the typedef. So
0264 # typedef struct TypeS {} TypeT, will appear in the documentation as a struct
0265 # with name TypeT. When disabled the typedef will appear as a member of a file,
0266 # namespace, or class. And the struct will be named TypeS. This can typically
0267 # be useful for C code in case the coding convention dictates that all compound
0268 # types are typedef'ed and only the typedef is referenced, never the tag name.
0269
0270 TYPEDEF_HIDES_STRUCT = NO
0271
0272 #---------------------------------------------------------------------------
0273 # Build related configuration options
0274 #---------------------------------------------------------------------------
0275
0276 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
0277 # documentation are documented, even if no documentation was available.
0278 # Private class members and static file members will be hidden unless
0279 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
0280
0281 EXTRACT_ALL = YES
0282
0283 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
0284 # will be included in the documentation.
0285
0286 EXTRACT_PRIVATE = NO
0287
0288 # If the EXTRACT_STATIC tag is set to YES all static members of a file
0289 # will be included in the documentation.
0290
0291 EXTRACT_STATIC = NO
0292
0293 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
0294 # defined locally in source files will be included in the documentation.
0295 # If set to NO only classes defined in header files are included.
0296
0297 EXTRACT_LOCAL_CLASSES = NO
0298
0299 # This flag is only useful for Objective-C code. When set to YES local
0300 # methods, which are defined in the implementation section but not in
0301 # the interface are included in the documentation.
0302 # If set to NO (the default) only methods in the interface are included.
0303
0304 EXTRACT_LOCAL_METHODS = NO
0305
0306 # If this flag is set to YES, the members of anonymous namespaces will be
0307 # extracted and appear in the documentation as a namespace called
0308 # 'anonymous_namespace{file}', where file will be replaced with the base
0309 # name of the file that contains the anonymous namespace. By default
0310 # anonymous namespace are hidden.
0311
0312 EXTRACT_ANON_NSPACES = NO
0313
0314 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
0315 # undocumented members of documented classes, files or namespaces.
0316 # If set to NO (the default) these members will be included in the
0317 # various overviews, but no documentation section is generated.
0318 # This option has no effect if EXTRACT_ALL is enabled.
0319
0320 HIDE_UNDOC_MEMBERS = NO
0321
0322 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
0323 # undocumented classes that are normally visible in the class hierarchy.
0324 # If set to NO (the default) these classes will be included in the various
0325 # overviews. This option has no effect if EXTRACT_ALL is enabled.
0326
0327 HIDE_UNDOC_CLASSES = NO
0328
0329 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
0330 # friend (class|struct|union) declarations.
0331 # If set to NO (the default) these declarations will be included in the
0332 # documentation.
0333
0334 HIDE_FRIEND_COMPOUNDS = YES
0335
0336 # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
0337 # documentation blocks found inside the body of a function.
0338 # If set to NO (the default) these blocks will be appended to the
0339 # function's detailed documentation block.
0340
0341 HIDE_IN_BODY_DOCS = NO
0342
0343 # The INTERNAL_DOCS tag determines if documentation
0344 # that is typed after a \internal command is included. If the tag is set
0345 # to NO (the default) then the documentation will be excluded.
0346 # Set it to YES to include the internal documentation.
0347
0348 INTERNAL_DOCS = NO
0349
0350 # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
0351 # file names in lower-case letters. If set to YES upper-case letters are also
0352 # allowed. This is useful if you have classes or files whose names only differ
0353 # in case and if your file system supports case sensitive file names. Windows
0354 # and Mac users are advised to set this option to NO.
0355
0356 CASE_SENSE_NAMES = YES
0357
0358 # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
0359 # will show members with their full class and namespace scopes in the
0360 # documentation. If set to YES the scope will be hidden.
0361
0362 HIDE_SCOPE_NAMES = NO
0363
0364 # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
0365 # will put a list of the files that are included by a file in the documentation
0366 # of that file.
0367
0368 SHOW_INCLUDE_FILES = YES
0369
0370 # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
0371 # is inserted in the documentation for inline members.
0372
0373 INLINE_INFO = YES
0374
0375 # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
0376 # will sort the (detailed) documentation of file and class members
0377 # alphabetically by member name. If set to NO the members will appear in
0378 # declaration order.
0379
0380 SORT_MEMBER_DOCS = NO
0381
0382 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
0383 # brief documentation of file, namespace and class members alphabetically
0384 # by member name. If set to NO (the default) the members will appear in
0385 # declaration order.
0386
0387 SORT_BRIEF_DOCS = NO
0388
0389 # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
0390 # hierarchy of group names into alphabetical order. If set to NO (the default)
0391 # the group names will appear in their defined order.
0392
0393 SORT_GROUP_NAMES = NO
0394
0395 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
0396 # sorted by fully-qualified names, including namespaces. If set to
0397 # NO (the default), the class list will be sorted only by class name,
0398 # not including the namespace part.
0399 # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
0400 # Note: This option applies only to the class list, not to the
0401 # alphabetical list.
0402
0403 SORT_BY_SCOPE_NAME = NO
0404
0405 # The GENERATE_TODOLIST tag can be used to enable (YES) or
0406 # disable (NO) the todo list. This list is created by putting \todo
0407 # commands in the documentation.
0408
0409 GENERATE_TODOLIST = YES
0410
0411 # The GENERATE_TESTLIST tag can be used to enable (YES) or
0412 # disable (NO) the test list. This list is created by putting \test
0413 # commands in the documentation.
0414
0415 GENERATE_TESTLIST = NO
0416
0417 # The GENERATE_BUGLIST tag can be used to enable (YES) or
0418 # disable (NO) the bug list. This list is created by putting \bug
0419 # commands in the documentation.
0420
0421 GENERATE_BUGLIST = NO
0422
0423 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
0424 # disable (NO) the deprecated list. This list is created by putting
0425 # \deprecated commands in the documentation.
0426
0427 GENERATE_DEPRECATEDLIST= YES
0428
0429 # The ENABLED_SECTIONS tag can be used to enable conditional
0430 # documentation sections, marked by \if sectionname ... \endif.
0431
0432 ENABLED_SECTIONS =
0433
0434 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines
0435 # the initial value of a variable or define consists of for it to appear in
0436 # the documentation. If the initializer consists of more lines than specified
0437 # here it will be hidden. Use a value of 0 to hide initializers completely.
0438 # The appearance of the initializer of individual variables and defines in the
0439 # documentation can be controlled using \showinitializer or \hideinitializer
0440 # command in the documentation regardless of this setting.
0441
0442 MAX_INITIALIZER_LINES = 0
0443
0444 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated
0445 # at the bottom of the documentation of classes and structs. If set to YES the
0446 # list will mention the files that were used to generate the documentation.
0447
0448 SHOW_USED_FILES = NO
0449
0450 # If the sources in your project are distributed over multiple directories
0451 # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
0452 # in the documentation. The default is NO.
0453
0454 SHOW_DIRECTORIES = NO
0455
0456 # Set the SHOW_FILES tag to NO to disable the generation of the Files page.
0457 # This will remove the Files entry from the Quick Index and from the
0458 # Folder Tree View (if specified). The default is YES.
0459
0460 SHOW_FILES = NO
0461
0462 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the
0463 # Namespaces page. This will remove the Namespaces entry from the Quick Index
0464 # and from the Folder Tree View (if specified). The default is YES.
0465
0466 SHOW_NAMESPACES = YES
0467
0468 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
0469 # doxygen should invoke to get the current version for each file (typically from
0470 # the version control system). Doxygen will invoke the program by executing (via
0471 # popen()) the command <command> <input-file>, where <command> is the value of
0472 # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
0473 # provided by doxygen. Whatever the program writes to standard output
0474 # is used as the file version. See the manual for examples.
0475
0476 FILE_VERSION_FILTER =
0477
0478 #---------------------------------------------------------------------------
0479 # configuration options related to warning and progress messages
0480 #---------------------------------------------------------------------------
0481
0482 # The QUIET tag can be used to turn on/off the messages that are generated
0483 # by doxygen. Possible values are YES and NO. If left blank NO is used.
0484
0485 QUIET = NO
0486
0487 # The WARNINGS tag can be used to turn on/off the warning messages that are
0488 # generated by doxygen. Possible values are YES and NO. If left blank
0489 # NO is used.
0490
0491 WARNINGS = YES
0492
0493 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
0494 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
0495 # automatically be disabled.
0496
0497 WARN_IF_UNDOCUMENTED = YES
0498
0499 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
0500 # potential errors in the documentation, such as not documenting some
0501 # parameters in a documented function, or documenting parameters that
0502 # don't exist or using markup commands wrongly.
0503
0504 WARN_IF_DOC_ERROR = YES
0505
0506 # This WARN_NO_PARAMDOC option can be abled to get warnings for
0507 # functions that are documented, but have no documentation for their parameters
0508 # or return value. If set to NO (the default) doxygen will only warn about
0509 # wrong or incomplete parameter documentation, but not about the absence of
0510 # documentation.
0511
0512 WARN_NO_PARAMDOC = YES
0513
0514 # The WARN_FORMAT tag determines the format of the warning messages that
0515 # doxygen can produce. The string should contain the $file, $line, and $text
0516 # tags, which will be replaced by the file and line number from which the
0517 # warning originated and the warning text. Optionally the format may contain
0518 # $version, which will be replaced by the version of the file (if it could
0519 # be obtained via FILE_VERSION_FILTER)
0520
0521 WARN_FORMAT = "\$file:\$line: \$text"
0522
0523 # The WARN_LOGFILE tag can be used to specify a file to which warning
0524 # and error messages should be written. If left blank the output is written
0525 # to stderr.
0526
0527 WARN_LOGFILE = doxygen.log
0528
0529 #---------------------------------------------------------------------------
0530 # configuration options related to the input files
0531 #---------------------------------------------------------------------------
0532
0533 # The INPUT tag can be used to specify the files and/or directories that contain
0534 # documented source files. You may enter file names like "myfile.cpp" or
0535 # directories like "/usr/src/myproject". Separate the files or directories
0536 # with spaces.
0537
0538 INPUT = ${abs_top_srcdir}/TelepathyLoggerQt ${abs_top_builddir}/TelepathyLoggerQt
0539
0540 # This tag can be used to specify the character encoding of the source files
0541 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
0542 # also the default input encoding. Doxygen uses libiconv (or the iconv built
0543 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
0544 # the list of possible encodings.
0545
0546 INPUT_ENCODING = UTF-8
0547
0548 # If the value of the INPUT tag contains directories, you can use the
0549 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0550 # and *.h) to filter out the source-files in the directories. If left
0551 # blank the following patterns are tested:
0552 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
0553 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
0554
0555 FILE_PATTERNS = *.cpp \
0556 *.cc \
0557 *.cxx \
0558 *.h \
0559 *.hh \
0560 *.hxx \
0561 *.hpp \
0562 *.dox
0563
0564 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
0565 # should be searched for input files as well. Possible values are YES and NO.
0566 # If left blank NO is used.
0567
0568 RECURSIVE = YES
0569
0570 # The EXCLUDE tag can be used to specify files and/or directories that should
0571 # excluded from the INPUT source files. This way you can easily exclude a
0572 # subdirectory from a directory tree whose root is specified with the INPUT tag.
0573
0574 EXCLUDE =
0575
0576 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
0577 # directories that are symbolic links (a Unix filesystem feature) are excluded
0578 # from the input.
0579
0580 EXCLUDE_SYMLINKS = NO
0581
0582 # If the value of the INPUT tag contains directories, you can use the
0583 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
0584 # certain files from those directories. Note that the wildcards are matched
0585 # against the file with absolute path, so to exclude all test directories
0586 # for example use the pattern */test/*
0587
0588 EXCLUDE_PATTERNS = */.svn/* \
0589 */.git/* \
0590 */cmake/* \
0591 *.moc.* \
0592 */tests/* \
0593 *-internal.* \
0594 future*
0595
0596 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
0597 # (namespaces, classes, functions, etc.) that should be excluded from the
0598 # output. The symbol name can be a fully qualified name, a word, or if the
0599 # wildcard * is used, a substring. Examples: ANamespace, AClass,
0600 # AClass::ANamespace, ANamespace::*Test
0601
0602 EXCLUDE_SYMBOLS =
0603
0604 # The EXAMPLE_PATH tag can be used to specify one or more files or
0605 # directories that contain example code fragments that are included (see
0606 # the \include command).
0607
0608 EXAMPLE_PATH = ${abs_top_srcdir}/examples
0609
0610 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
0611 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
0612 # and *.h) to filter out the source-files in the directories. If left
0613 # blank all files are included.
0614
0615 EXAMPLE_PATTERNS = *
0616
0617 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
0618 # searched for input files to be used with the \include or \dontinclude
0619 # commands irrespective of the value of the RECURSIVE tag.
0620 # Possible values are YES and NO. If left blank NO is used.
0621
0622 EXAMPLE_RECURSIVE = YES
0623
0624 # The IMAGE_PATH tag can be used to specify one or more files or
0625 # directories that contain image that are included in the documentation (see
0626 # the \image command).
0627
0628 IMAGE_PATH =
0629
0630 # The INPUT_FILTER tag can be used to specify a program that doxygen should
0631 # invoke to filter for each input file. Doxygen will invoke the filter program
0632 # by executing (via popen()) the command <filter> <input-file>, where <filter>
0633 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
0634 # input file. Doxygen will then use the output that the filter program writes
0635 # to standard output. If FILTER_PATTERNS is specified, this tag will be
0636 # ignored.
0637
0638 INPUT_FILTER =
0639
0640 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
0641 # basis. Doxygen will compare the file name with each pattern and apply the
0642 # filter if there is a match. The filters are a list of the form:
0643 # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
0644 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
0645 # is applied to all files.
0646
0647 FILTER_PATTERNS =
0648
0649 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
0650 # INPUT_FILTER) will be used to filter the input files when producing source
0651 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
0652
0653 FILTER_SOURCE_FILES = NO
0654
0655 #---------------------------------------------------------------------------
0656 # configuration options related to source browsing
0657 #---------------------------------------------------------------------------
0658
0659 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
0660 # be generated. Documented entities will be cross-referenced with these sources.
0661 # Note: To get rid of all source code in the generated output, make sure also
0662 # VERBATIM_HEADERS is set to NO.
0663
0664 SOURCE_BROWSER = NO
0665
0666 # Setting the INLINE_SOURCES tag to YES will include the body
0667 # of functions and classes directly in the documentation.
0668
0669 INLINE_SOURCES = NO
0670
0671 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
0672 # doxygen to hide any special comment blocks from generated source code
0673 # fragments. Normal C and C++ comments will always remain visible.
0674
0675 STRIP_CODE_COMMENTS = YES
0676
0677 # If the REFERENCED_BY_RELATION tag is set to YES
0678 # then for each documented function all documented
0679 # functions referencing it will be listed.
0680
0681 REFERENCED_BY_RELATION = NO
0682
0683 # If the REFERENCES_RELATION tag is set to YES
0684 # then for each documented function all documented entities
0685 # called/used by that function will be listed.
0686
0687 REFERENCES_RELATION = NO
0688
0689 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
0690 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
0691 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
0692 # link to the source code. Otherwise they will link to the documentstion.
0693
0694 REFERENCES_LINK_SOURCE = YES
0695
0696 # If the USE_HTAGS tag is set to YES then the references to source code
0697 # will point to the HTML generated by the htags(1) tool instead of doxygen
0698 # built-in source browser. The htags tool is part of GNU's global source
0699 # tagging system (see http://www.gnu.org/software/global/global.html). You
0700 # will need version 4.8.6 or higher.
0701
0702 USE_HTAGS = NO
0703
0704 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
0705 # will generate a verbatim copy of the header file for each class for
0706 # which an include is specified. Set to NO to disable this.
0707
0708 VERBATIM_HEADERS = YES
0709
0710 #---------------------------------------------------------------------------
0711 # configuration options related to the alphabetical class index
0712 #---------------------------------------------------------------------------
0713
0714 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
0715 # of all compounds will be generated. Enable this if the project
0716 # contains a lot of classes, structs, unions or interfaces.
0717
0718 ALPHABETICAL_INDEX = NO
0719
0720 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
0721 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
0722 # in which this list will be split (can be a number in the range [1..20])
0723
0724 COLS_IN_ALPHA_INDEX = 5
0725
0726 # In case all classes in a project start with a common prefix, all
0727 # classes will be put under the same header in the alphabetical index.
0728 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that
0729 # should be ignored while generating the index headers.
0730
0731 IGNORE_PREFIX =
0732
0733 #---------------------------------------------------------------------------
0734 # configuration options related to the HTML output
0735 #---------------------------------------------------------------------------
0736
0737 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
0738 # generate HTML output.
0739
0740 GENERATE_HTML = ${GENERATE_HTML}
0741
0742 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
0743 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0744 # put in front of it. If left blank `html' will be used as the default path.
0745
0746 HTML_OUTPUT = html
0747
0748 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
0749 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
0750 # doxygen will generate files with .html extension.
0751
0752 HTML_FILE_EXTENSION = .html
0753
0754 # The HTML_HEADER tag can be used to specify a personal HTML header for
0755 # each generated HTML page. If it is left blank doxygen will generate a
0756 # standard header.
0757
0758 HTML_HEADER =
0759
0760 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
0761 # each generated HTML page. If it is left blank doxygen will generate a
0762 # standard footer.
0763
0764 HTML_FOOTER =
0765
0766 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
0767 # style sheet that is used by each HTML page. It can be used to
0768 # fine-tune the look of the HTML output. If the tag is left blank doxygen
0769 # will generate a default style sheet. Note that doxygen will try to copy
0770 # the style sheet file to the HTML output directory, so don't put your own
0771 # stylesheet in the HTML output directory as well, or it will be erased!
0772
0773 HTML_STYLESHEET =
0774
0775 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
0776 # files or namespaces will be aligned in HTML using tables. If set to
0777 # NO a bullet list will be used.
0778
0779 HTML_ALIGN_MEMBERS = NO
0780
0781 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
0782 # will be generated that can be used as input for tools like the
0783 # Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
0784 # of the generated HTML documentation.
0785
0786 GENERATE_HTMLHELP = ${GENERATE_CHM}
0787
0788 # If the GENERATE_DOCSET tag is set to YES, additional index files
0789 # will be generated that can be used as input for Apple's Xcode 3
0790 # integrated development environment, introduced with OSX 10.5 (Leopard).
0791 # To create a documentation set, doxygen will generate a Makefile in the
0792 # HTML output directory. Running make will produce the docset in that
0793 # directory and running "make install" will install the docset in
0794 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
0795 # it at startup.
0796
0797 GENERATE_DOCSET = NO
0798
0799 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
0800 # feed. A documentation feed provides an umbrella under which multiple
0801 # documentation sets from a single provider (such as a company or product suite)
0802 # can be grouped.
0803
0804 DOCSET_FEEDNAME = "Doxygen generated docs"
0805
0806 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
0807 # should uniquely identify the documentation set bundle. This should be a
0808 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
0809 # will append .docset to the name.
0810
0811 DOCSET_BUNDLE_ID = org.doxygen.Project
0812
0813 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
0814 # documentation will contain sections that can be hidden and shown after the
0815 # page has loaded. For this to work a browser that supports
0816 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
0817 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
0818
0819 HTML_DYNAMIC_SECTIONS = NO
0820
0821 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
0822 # be used to specify the file name of the resulting .chm file. You
0823 # can add a path in front of the file if the result should not be
0824 # written to the html output directory.
0825
0826 CHM_FILE = ../${PROJECT}.chm
0827
0828 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
0829 # be used to specify the location (absolute path including file name) of
0830 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
0831 # the HTML help compiler on the generated index.hhp.
0832
0833 HHC_LOCATION = ${HHC_PATH}
0834
0835 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
0836 # controls if a separate .chi index file is generated (YES) or that
0837 # it should be included in the master .chm file (NO).
0838
0839 GENERATE_CHI = ${GENERATE_CHI}
0840
0841 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
0842 # is used to encode HtmlHelp index (hhk), content (hhc) and project file
0843 # content.
0844
0845 CHM_INDEX_ENCODING =
0846
0847 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
0848 # controls whether a binary table of contents is generated (YES) or a
0849 # normal table of contents (NO) in the .chm file.
0850
0851 BINARY_TOC = NO
0852
0853 # The TOC_EXPAND flag can be set to YES to add extra items for group members
0854 # to the contents of the HTML help documentation and to the tree view.
0855
0856 TOC_EXPAND = NO
0857
0858 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
0859 # top of each HTML page. The value NO (the default) enables the index and
0860 # the value YES disables it.
0861
0862 DISABLE_INDEX = YES
0863
0864 # This tag can be used to set the number of enum values (range [1..20])
0865 # that doxygen will group on one line in the generated HTML documentation.
0866
0867 ENUM_VALUES_PER_LINE = 4
0868
0869 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
0870 # structure should be generated to display hierarchical information.
0871 # If the tag value is set to FRAME, a side panel will be generated
0872 # containing a tree-like index structure (just like the one that
0873 # is generated for HTML Help). For this to work a browser that supports
0874 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
0875 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
0876 # probably better off using the HTML help feature. Other possible values
0877 # for this tag are: HIERARCHIES, which will generate the Groups, Directories,
0878 # and Class Hiererachy pages using a tree view instead of an ordered list;
0879 # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
0880 # disables this behavior completely. For backwards compatibility with previous
0881 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
0882 # respectively.
0883
0884 GENERATE_TREEVIEW = NO
0885
0886 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
0887 # used to set the initial width (in pixels) of the frame in which the tree
0888 # is shown.
0889
0890 TREEVIEW_WIDTH = 250
0891
0892 # Use this tag to change the font size of Latex formulas included
0893 # as images in the HTML documentation. The default is 10. Note that
0894 # when you change the font size after a successful doxygen run you need
0895 # to manually remove any form_*.png images from the HTML output directory
0896 # to force them to be regenerated.
0897
0898 FORMULA_FONTSIZE = 10
0899
0900 #---------------------------------------------------------------------------
0901 # configuration options related to the LaTeX output
0902 #---------------------------------------------------------------------------
0903
0904 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
0905 # generate Latex output.
0906
0907 GENERATE_LATEX = ${GENERATE_LATEX}
0908
0909 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
0910 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0911 # put in front of it. If left blank `latex' will be used as the default path.
0912
0913 LATEX_OUTPUT = latex
0914
0915 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
0916 # invoked. If left blank `latex' will be used as the default command name.
0917
0918 LATEX_CMD_NAME = latex
0919
0920 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
0921 # generate index for LaTeX. If left blank `makeindex' will be used as the
0922 # default command name.
0923
0924 MAKEINDEX_CMD_NAME = makeindex
0925
0926 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
0927 # LaTeX documents. This may be useful for small projects and may help to
0928 # save some trees in general.
0929
0930 COMPACT_LATEX = NO
0931
0932 # The PAPER_TYPE tag can be used to set the paper type that is used
0933 # by the printer. Possible values are: a4, a4wide, letter, legal and
0934 # executive. If left blank a4wide will be used.
0935
0936 PAPER_TYPE = ${PAPER_SIZE}
0937
0938 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
0939 # packages that should be included in the LaTeX output.
0940
0941 EXTRA_PACKAGES =
0942
0943 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
0944 # the generated latex document. The header should contain everything until
0945 # the first chapter. If it is left blank doxygen will generate a
0946 # standard header. Notice: only use this tag if you know what you are doing!
0947
0948 LATEX_HEADER =
0949
0950 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
0951 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
0952 # contain links (just like the HTML output) instead of page references
0953 # This makes the output suitable for online browsing using a pdf viewer.
0954
0955 PDF_HYPERLINKS = NO
0956
0957 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
0958 # plain latex in the generated Makefile. Set this option to YES to get a
0959 # higher quality PDF documentation.
0960
0961 USE_PDFLATEX = NO
0962
0963 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
0964 # command to the generated LaTeX files. This will instruct LaTeX to keep
0965 # running if errors occur, instead of asking the user for help.
0966 # This option is also used when generating formulas in HTML.
0967
0968 LATEX_BATCHMODE = YES
0969
0970 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
0971 # include the index chapters (such as File Index, Compound Index, etc.)
0972 # in the output.
0973
0974 LATEX_HIDE_INDICES = NO
0975
0976 #---------------------------------------------------------------------------
0977 # configuration options related to the RTF output
0978 #---------------------------------------------------------------------------
0979
0980 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
0981 # The RTF output is optimized for Word 97 and may not look very pretty with
0982 # other RTF readers or editors.
0983
0984 GENERATE_RTF = ${GENERATE_RTF}
0985
0986 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
0987 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
0988 # put in front of it. If left blank `rtf' will be used as the default path.
0989
0990 RTF_OUTPUT = rtf
0991
0992 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
0993 # RTF documents. This may be useful for small projects and may help to
0994 # save some trees in general.
0995
0996 COMPACT_RTF = NO
0997
0998 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
0999 # will contain hyperlink fields. The RTF file will
1000 # contain links (just like the HTML output) instead of page references.
1001 # This makes the output suitable for online browsing using WORD or other
1002 # programs which support those fields.
1003 # Note: wordpad (write) and others do not support links.
1004
1005 RTF_HYPERLINKS = NO
1006
1007 # Load stylesheet definitions from file. Syntax is similar to doxygen's
1008 # config file, i.e. a series of assignments. You only have to provide
1009 # replacements, missing definitions are set to their default value.
1010
1011 RTF_STYLESHEET_FILE =
1012
1013 # Set optional variables used in the generation of an rtf document.
1014 # Syntax is similar to doxygen's config file.
1015
1016 RTF_EXTENSIONS_FILE =
1017
1018 #---------------------------------------------------------------------------
1019 # configuration options related to the man page output
1020 #---------------------------------------------------------------------------
1021
1022 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
1023 # generate man pages
1024
1025 GENERATE_MAN = ${GENERATE_MAN}
1026
1027 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
1028 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1029 # put in front of it. If left blank `man' will be used as the default path.
1030
1031 MAN_OUTPUT = man
1032
1033 # The MAN_EXTENSION tag determines the extension that is added to
1034 # the generated man pages (default is the subroutine's section .3)
1035
1036 MAN_EXTENSION = .1
1037
1038 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
1039 # then it will generate one additional man file for each entity
1040 # documented in the real man page(s). These additional files
1041 # only source the real man page, but without them the man command
1042 # would be unable to find the correct page. The default is NO.
1043
1044 MAN_LINKS = NO
1045
1046 #---------------------------------------------------------------------------
1047 # configuration options related to the XML output
1048 #---------------------------------------------------------------------------
1049
1050 # If the GENERATE_XML tag is set to YES Doxygen will
1051 # generate an XML file that captures the structure of
1052 # the code including all documentation.
1053
1054 GENERATE_XML = ${GENERATE_XML}
1055
1056 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
1057 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1058 # put in front of it. If left blank `xml' will be used as the default path.
1059
1060 XML_OUTPUT = xml
1061
1062 # The XML_SCHEMA tag can be used to specify an XML schema,
1063 # which can be used by a validating XML parser to check the
1064 # syntax of the XML files.
1065
1066 XML_SCHEMA =
1067
1068 # The XML_DTD tag can be used to specify an XML DTD,
1069 # which can be used by a validating XML parser to check the
1070 # syntax of the XML files.
1071
1072 XML_DTD =
1073
1074 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
1075 # dump the program listings (including syntax highlighting
1076 # and cross-referencing information) to the XML output. Note that
1077 # enabling this will significantly increase the size of the XML output.
1078
1079 XML_PROGRAMLISTING = YES
1080
1081 #---------------------------------------------------------------------------
1082 # configuration options for the AutoGen Definitions output
1083 #---------------------------------------------------------------------------
1084
1085 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
1086 # generate an AutoGen Definitions (see autogen.sf.net) file
1087 # that captures the structure of the code including all
1088 # documentation. Note that this feature is still experimental
1089 # and incomplete at the moment.
1090
1091 GENERATE_AUTOGEN_DEF = NO
1092
1093 #---------------------------------------------------------------------------
1094 # configuration options related to the Perl module output
1095 #---------------------------------------------------------------------------
1096
1097 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
1098 # generate a Perl module file that captures the structure of
1099 # the code including all documentation. Note that this
1100 # feature is still experimental and incomplete at the
1101 # moment.
1102
1103 GENERATE_PERLMOD = NO
1104
1105 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
1106 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
1107 # to generate PDF and DVI output from the Perl module output.
1108
1109 PERLMOD_LATEX = NO
1110
1111 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
1112 # nicely formatted so it can be parsed by a human reader. This is useful
1113 # if you want to understand what is going on. On the other hand, if this
1114 # tag is set to NO the size of the Perl module output will be much smaller
1115 # and Perl will parse it just the same.
1116
1117 PERLMOD_PRETTY = YES
1118
1119 # The names of the make variables in the generated doxyrules.make file
1120 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
1121 # This is useful so different doxyrules.make files included by the same
1122 # Makefile don't overwrite each other's variables.
1123
1124 PERLMOD_MAKEVAR_PREFIX =
1125
1126 #---------------------------------------------------------------------------
1127 # Configuration options related to the preprocessor
1128 #---------------------------------------------------------------------------
1129
1130 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
1131 # evaluate all C-preprocessor directives found in the sources and include
1132 # files.
1133
1134 ENABLE_PREPROCESSING = YES
1135
1136 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
1137 # names in the source code. If set to NO (the default) only conditional
1138 # compilation will be performed. Macro expansion can be done in a controlled
1139 # way by setting EXPAND_ONLY_PREDEF to YES.
1140
1141 MACRO_EXPANSION = NO
1142
1143 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
1144 # then the macro expansion is limited to the macros specified with the
1145 # PREDEFINED and EXPAND_AS_DEFINED tags.
1146
1147 MACRO_EXPANSION = YES
1148 EXPAND_ONLY_PREDEF = NO
1149
1150 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
1151 # in the INCLUDE_PATH (see below) will be search if a #include is found.
1152
1153 SEARCH_INCLUDES = YES
1154
1155 # The INCLUDE_PATH tag can be used to specify one or more directories that
1156 # contain include files that are not input files but should be processed by
1157 # the preprocessor.
1158
1159 INCLUDE_PATH = ${abs_top_srcdir} ${abs_top_builddir}
1160
1161 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
1162 # patterns (like *.h and *.hpp) to filter out the header-files in the
1163 # directories. If left blank, the patterns specified with FILE_PATTERNS will
1164 # be used.
1165
1166 INCLUDE_FILE_PATTERNS = *
1167
1168 # The PREDEFINED tag can be used to specify one or more macro names that
1169 # are defined before the preprocessor is started (similar to the -D option of
1170 # gcc). The argument of the tag is a list of macros of the form: name
1171 # or name=definition (no spaces). If the definition and the = are
1172 # omitted =1 is assumed. To prevent a macro definition from being
1173 # undefined via #undef or recursively expanded use the := operator
1174 # instead of the = operator.
1175
1176 PREDEFINED =
1177
1178 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1179 # this tag can be used to specify a list of macro names that should be expanded.
1180 # The macro definition that is found in the sources will be used.
1181 # Use the PREDEFINED tag if you want to use a different macro definition.
1182
1183 EXPAND_AS_DEFINED =
1184
1185 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
1186 # doxygen's preprocessor will remove all function-like macros that are alone
1187 # on a line, have an all uppercase name, and do not end with a semicolon. Such
1188 # function macros are typically used for boiler-plate code, and will confuse
1189 # the parser if not removed.
1190
1191 SKIP_FUNCTION_MACROS = YES
1192
1193 #---------------------------------------------------------------------------
1194 # Configuration::additions related to external references
1195 #---------------------------------------------------------------------------
1196
1197 # The TAGFILES option can be used to specify one or more tagfiles.
1198 # Optionally an initial location of the external documentation
1199 # can be added for each tagfile. The format of a tag file without
1200 # this location is as follows:
1201 # TAGFILES = file1 file2 ...
1202 # Adding location for the tag files is done as follows:
1203 # TAGFILES = file1=loc1 "file2 = loc2" ...
1204 # where "loc1" and "loc2" can be relative or absolute paths or
1205 # URLs. If a location is present for each tag, the installdox tool
1206 # does not have to be run to correct the links.
1207 # Note that each tag file must have a unique name
1208 # (where the name does NOT include the path)
1209 # If a tag file is not located in the directory in which doxygen
1210 # is run, you must also specify the path to the tagfile here.
1211
1212 TAGFILES =
1213
1214 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
1215 # a tag file that is based on the input files it reads.
1216
1217 GENERATE_TAGFILE = ${abs_top_builddir}/doc/${PROJECT}.tag
1218
1219 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
1220 # in the class index. If set to NO only the inherited external classes
1221 # will be listed.
1222
1223 ALLEXTERNALS = NO
1224
1225 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
1226 # in the modules index. If set to NO, only the current project's groups will
1227 # be listed.
1228
1229 EXTERNAL_GROUPS = YES
1230
1231 # The PERL_PATH should be the absolute path and name of the perl script
1232 # interpreter (i.e. the result of `which perl').
1233
1234 PERL_PATH = ${PERL_PATH}
1235
1236 #---------------------------------------------------------------------------
1237 # Configuration options related to the dot tool
1238 # Configuration options related to the dot tool
1239 #---------------------------------------------------------------------------
1240
1241 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
1242 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
1243 # or super classes. Setting the tag to NO turns the diagrams off. Note that
1244 # this option is superseded by the HAVE_DOT option below. This is only a
1245 # fallback. It is recommended to install and use dot, since it yields more
1246 # powerful graphs.
1247
1248 CLASS_DIAGRAMS = NO
1249
1250 # You can define message sequence charts within doxygen comments using the \msc
1251 # command. Doxygen will then run the mscgen tool (see
1252 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
1253 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
1254 # the mscgen tool resides. If left empty the tool is assumed to be found in the
1255 # default search path.
1256
1257 MSCGEN_PATH =
1258
1259 # If set to YES, the inheritance and collaboration graphs will hide
1260 # inheritance and usage relations if the target is undocumented
1261 # or is not a class.
1262
1263 HIDE_UNDOC_RELATIONS = YES
1264
1265 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
1266 # available from the path. This tool is part of Graphviz, a graph visualization
1267 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
1268 # have no effect if this option is set to NO (the default)
1269
1270 HAVE_DOT = ${HAVE_DOT}
1271
1272 # By default doxygen will write a font called FreeSans.ttf to the output
1273 # directory and reference it in all dot files that doxygen generates. This
1274 # font does not include all possible unicode characters however, so when you need
1275 # these (or just want a differently looking font) you can specify the font name
1276 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
1277 # which can be done by putting it in a standard location or by setting the
1278 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
1279 # containing the font.
1280
1281 DOT_FONTNAME = FreeSans
1282
1283 # By default doxygen will tell dot to use the output directory to look for the
1284 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
1285 # different font using DOT_FONTNAME you can set the path where dot
1286 # can find it using this tag.
1287
1288 DOT_FONTPATH =
1289
1290 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
1291 # will generate a graph for each documented class showing the direct and
1292 # indirect inheritance relations. Setting this tag to YES will force the
1293 # the CLASS_DIAGRAMS tag to NO.
1294
1295 CLASS_GRAPH = YES
1296
1297 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
1298 # will generate a graph for each documented class showing the direct and
1299 # indirect implementation dependencies (inheritance, containment, and
1300 # class references variables) of the class with other documented classes.
1301
1302 COLLABORATION_GRAPH = NO
1303
1304 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
1305 # will generate a graph for groups, showing the direct groups dependencies
1306
1307 GROUP_GRAPHS = YES
1308
1309 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
1310 # collaboration diagrams in a style similar to the OMG's Unified Modeling
1311 # Language.
1312
1313 UML_LOOK = NO
1314
1315 # If set to YES, the inheritance and collaboration graphs will show the
1316 # relations between templates and their instances.
1317
1318 TEMPLATE_RELATIONS = NO
1319
1320 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
1321 # tags are set to YES then doxygen will generate a graph for each documented
1322 # file showing the direct and indirect include dependencies of the file with
1323 # other documented files.
1324
1325 INCLUDE_GRAPH = YES
1326
1327 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
1328 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
1329 # documented header file showing the documented files that directly or
1330 # indirectly include this file.
1331
1332 INCLUDED_BY_GRAPH = YES
1333
1334 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
1335 # doxygen will generate a call dependency graph for every global function
1336 # or class method. Note that enabling this option will significantly increase
1337 # the time of a run. So in most cases it will be better to enable call graphs
1338 # for selected functions only using the \callgraph command.
1339
1340 CALL_GRAPH = NO
1341
1342 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
1343 # doxygen will generate a caller dependency graph for every global function
1344 # or class method. Note that enabling this option will significantly increase
1345 # the time of a run. So in most cases it will be better to enable caller
1346 # graphs for selected functions only using the \callergraph command.
1347
1348 CALLER_GRAPH = NO
1349
1350 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
1351 # will graphical hierarchy of all classes instead of a textual one.
1352
1353 GRAPHICAL_HIERARCHY = YES
1354
1355 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
1356 # then doxygen will show the dependencies a directory has on other directories
1357 # in a graphical way. The dependency relations are determined by the #include
1358 # relations between the files in the directories.
1359
1360 DIRECTORY_GRAPH = YES
1361
1362 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
1363 # generated by dot. Possible values are png, jpg, or gif
1364 # If left blank png will be used.
1365
1366 DOT_IMAGE_FORMAT = png
1367
1368 # The tag DOT_PATH can be used to specify the path where the dot tool can be
1369 # found. If left blank, it is assumed the dot tool can be found in the path.
1370
1371 DOT_PATH = ${DOT_PATH}
1372
1373 # The DOTFILE_DIRS tag can be used to specify one or more directories that
1374 # contain dot files that are included in the documentation (see the
1375 # \dotfile command).
1376
1377 DOTFILE_DIRS =
1378
1379 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
1380 # nodes that will be shown in the graph. If the number of nodes in a graph
1381 # becomes larger than this value, doxygen will truncate the graph, which is
1382 # visualized by representing a node as a red box. Note that doxygen if the
1383 # number of direct children of the root node in a graph is already larger than
1384 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
1385 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1386
1387 DOT_GRAPH_MAX_NODES = 50
1388
1389 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
1390 # graphs generated by dot. A depth value of 3 means that only nodes reachable
1391 # from the root by following a path via at most 3 edges will be shown. Nodes
1392 # that lay further from the root node will be omitted. Note that setting this
1393 # option to 1 or 2 may greatly reduce the computation time needed for large
1394 # code bases. Also note that the size of a graph can be further restricted by
1395 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1396
1397 MAX_DOT_GRAPH_DEPTH = 0
1398
1399 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
1400 # background. This is enabled by default, which results in a transparent
1401 # background. Warning: Depending on the platform used, enabling this option
1402 # may lead to badly anti-aliased labels on the edges of a graph (i.e. they
1403 # become hard to read).
1404
1405 DOT_TRANSPARENT = YES
1406
1407 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
1408 # files in one run (i.e. multiple -o and -T options on the command line). This
1409 # makes dot run faster, but since only newer versions of dot (>1.8.10)
1410 # support this, this feature is disabled by default.
1411
1412 DOT_MULTI_TARGETS = NO
1413
1414 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
1415 # generate a legend page explaining the meaning of the various boxes and
1416 # arrows in the dot generated graphs.
1417
1418 GENERATE_LEGEND = YES
1419
1420 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
1421 # remove the intermediate dot files that are used to generate
1422 # the various graphs.
1423
1424 DOT_CLEANUP = YES
1425
1426 #---------------------------------------------------------------------------
1427 # Configuration::additions related to the search engine
1428 #---------------------------------------------------------------------------
1429 # The SEARCHENGINE tag specifies whether or not a search engine should be
1430 # used. If set to NO the values of all tags below this one will be ignored.
1431 SEARCHENGINE = NO
1432
1433 GENERATE_QHP = ${GENERATE_QHP}
1434 QHP_NAMESPACE = "org.freedesktop.Telepathy.Logger.Qt"
1435 QHP_VIRTUAL_FOLDER = "${PROJECT_NAME}-${PACKAGE_VERSION}"
1436 QCH_FILE = ${abs_top_builddir}/doc/help/telepathy-logger-qt4.qch
1437 QHG_LOCATION = "${QHELPGENERATOR_EXECUTABLE}"
1438
1439 ### TelepathyLoggerQt Settings
1440 ALIASES = \
1441 "intern=\par<b>Internal use only.</b>" \
1442 "reimp=\par<b>Reimplemented from superclass.</b>" \
1443 "obsolete=@deprecated" \
1444 "feature=\xrefitem features \"Feature(s)\" \"Features\"" \
1445 "maintainer=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \
1446 "unmaintained=\xrefitem unmaintained \"Unmaintained\" \"Unmaintained\"" \
1447 "requirement=\xrefitem requirements \"Requirement(s)\" \"Requirements\"" \
1448 "faq=\xrefitem FAQ \"F.A.Q.\" \"F.A.Q.\"" \
1449 "authors=\xrefitem authors \"Author(s)\" \"Authors\"" \
1450 "maintainers=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \
1451 "glossary=\xrefitem glossary \"TelepathyLoggerQt Glossary\" \"TelepathyLoggerQt Glossary\"" \
1452 "acronym=\b "\
1453 "licenses=\xrefitem licenses \"License(s)\" \"Licenses\"" \
1454 "short=@brief "\
1455 "FIXME=\xrefitem fixme \"Fixme\" \"Fixme\"" \
1456 "bc=\xrefitem bc \"Binary Compatible\" \"Binary Compatible\"" \
1457 "telepathy=<a href=\"http://telepathy.freedesktop.org\">Telepathy</a>" \
1458 "dbus=<a href=\"http://dbus.freedesktop.org\">D-Bus</a>" \
1459 "artistic=<a href=\"http://www.opensource.org/licenses/artistic-license.php\">Artistic</a>" \
1460 "bsd=<a href=\"http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5\">BSD</a>" \
1461 "x11=<a href=\"http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3\">X11</a>" \
1462 "gpl=<a href=\"http://www.fsf.org/licensing/licenses/gpl.html#SEC1\">GPL</a>" \
1463 "lgpl=<a href=\"http://www.fsf.org/licensing/licenses/lgpl.html#SEC1\">LGPL</a>" \
1464 "qpl=<a href=\"http://www.trolltech.com/products/qt/licenses\">QPL</a>"
1465
1466 PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
1467 TELEPATHY_LOGGER_QT_EXPORT="" \
1468 TELEPATHY_LOGGER_QT_NO_EXPORT="" \
1469 Q_SLOTS="slots" \
1470 Q_SIGNALS="signals"