doxygen/doxygen.conf

   1 # Doxyfile 1.5.2
   2
   3 # This file describes the settings to be used by the documentation system
   4 # doxygen (www.doxygen.org) for a project
   5 #
   6 # All text after a hash (#) is considered a comment and will be ignored
   7 # The format is:
   8 #       TAG = value [value, ...]
   9 # For lists items can also be appended using:
  10 #       TAG += value [value, ...]
  11 # Values that contain spaces should be placed between quotes (" ")
  12
  13 #---------------------------------------------------------------------------
  14 # Project related configuration options
  15 #---------------------------------------------------------------------------
  16
  17 DOXYFILE_ENCODING      = UTF-8
  18 PROJECT_NAME           = SLP-Developer Library
  19 PROJECT_NUMBER         =
  20 OUTPUT_DIRECTORY       = ./doxygen_output
  21 CREATE_SUBDIRS         = NO
  22 OUTPUT_LANGUAGE        = English
  23 BRIEF_MEMBER_DESC      = YES
  24 REPEAT_BRIEF           = YES
  25 ABBREVIATE_BRIEF       = NO
  26 ALWAYS_DETAILED_SEC    = YES
  27 INLINE_INHERITED_MEMB  = NO
  28 FULL_PATH_NAMES        = NO
  29 STRIP_FROM_PATH        =
  30 STRIP_FROM_INC_PATH    =
  31 SHORT_NAMES            = YES
  32 JAVADOC_AUTOBRIEF      = NO
  33 MULTILINE_CPP_IS_BRIEF = NO
  34 DETAILS_AT_TOP         = YES
  35 INHERIT_DOCS           = YES
  36 SEPARATE_MEMBER_PAGES  = YES
  37 TAB_SIZE               = 8
  38 ALIASES                =
  39 OPTIMIZE_OUTPUT_FOR_C  = NO
  40 OPTIMIZE_OUTPUT_JAVA   = NO
  41 BUILTIN_STL_SUPPORT    = NO
  42 CPP_CLI_SUPPORT        = NO
  43 DISTRIBUTE_GROUP_DOC   = NO
  44 SUBGROUPING            = YES
  45
  46 #---------------------------------------------------------------------------
  47 # Build related configuration options
  48 #---------------------------------------------------------------------------
  49
  50 EXTRACT_ALL            = YES
  51 EXTRACT_PRIVATE        = YES
  52 EXTRACT_STATIC         = YES
  53 EXTRACT_LOCAL_CLASSES  = NO
  54 EXTRACT_LOCAL_METHODS  = YES
  55 HIDE_UNDOC_MEMBERS     = YES
  56 HIDE_UNDOC_CLASSES     = YES
  57 HIDE_FRIEND_COMPOUNDS  = YES
  58 HIDE_IN_BODY_DOCS      = NO
  59 INTERNAL_DOCS          = NO
  60 CASE_SENSE_NAMES       = YES
  61 HIDE_SCOPE_NAMES       = NO
  62 SHOW_INCLUDE_FILES     = YES
  63 INLINE_INFO            = YES
  64 SORT_MEMBER_DOCS       = YES
  65 SORT_BRIEF_DOCS        = YES
  66 SORT_BY_SCOPE_NAME     = YES
  67 SORT_GROUP_NAMES     = YES
  68 GENERATE_TODOLIST      = NO
  69 USE_INLINE_TREES      = NO
  70 SHOW_NAMESPACES         = NO
  71 HTML DYNAMIC SECTIONS           = YES
  72 GENERATE_TESTLIST      = NO
  73 GENERATE_BUGLIST       = NO
  74 GENERATE_DEPRECATEDLIST= NO
  75 ENABLED_SECTIONS       =
  76 MAX_INITIALIZER_LINES  = 30
  77 SHOW_USED_FILES        = YES
  78 SHOW_DIRECTORIES       = NO
  79 FILE_VERSION_FILTER    =
  80
  81 #---------------------------------------------------------------------------
  82 # configuration options related to warning and progress messages
  83 #---------------------------------------------------------------------------
  84
  85 # The QUIET tag can be used to turn on/off the messages that are generated
  86 # by doxygen. Possible values are YES and NO. If left blank NO is used.
  87
  88 QUIET                  = NO
  89
  90 # The WARNINGS tag can be used to turn on/off the warning messages that are
  91 # generated by doxygen. Possible values are YES and NO. If left blank
  92 # NO is used.
  93
  94 WARNINGS               = YES
  95
  96 # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
  97 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
  98 # automatically be disabled.
  99
 100 WARN_IF_UNDOCUMENTED   = YES
 101
 102 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
 103 # potential errors in the documentation, such as not documenting some
 104 # parameters in a documented function, or documenting parameters that
 105 # don't exist or using markup commands wrongly.
 106
 107 WARN_IF_DOC_ERROR      = YES
 108
 109 # This WARN_NO_PARAMDOC option can be abled to get warnings for
 110 # functions that are documented, but have no documentation for their parameters
 111 # or return value. If set to NO (the default) doxygen will only warn about
 112 # wrong or incomplete parameter documentation, but not about the absence of
 113 # documentation.
 114
 115 WARN_NO_PARAMDOC       = NO
 116
 117 # The WARN_FORMAT tag determines the format of the warning messages that
 118 # doxygen can produce. The string should contain the $file, $line, and $text
 119 # tags, which will be replaced by the file and line number from which the
 120 # warning originated and the warning text. Optionally the format may contain
 121 # $version, which will be replaced by the version of the file (if it could
 122 # be obtained via FILE_VERSION_FILTER)
 123
 124 WARN_FORMAT            = "$file:$line: $text"
 125
 126 # The WARN_LOGFILE tag can be used to specify a file to which warning
 127 # and error messages should be written. If left blank the output is written
 128 # to stderr.
 129
 130 WARN_LOGFILE           =
 131
 132 #---------------------------------------------------------------------------
 133 # configuration options related to the input files
 134 #---------------------------------------------------------------------------
 135
 136 # The INPUT tag can be used to specify the files and/or directories that contain
 137 # documented source files. You may enter file names like "myfile.cpp" or
 138 # directories like "/usr/src/myproject". Separate the files or directories
 139 # with spaces.
 140
 141 #INPUT                  = ..
 142 INPUT                  = ../src/commonlib/include/net_nfc_typedef.h ../src/clientlib/include/net_nfc_target_info.h ../src/clientlib/include/net_nfc_llcp.h ../src/clientlib/include/net_nfc_exchanger.h ../src/clientlib/include/net_nfc_ndef_message.h ../src/clientlib/include/net_nfc_data.h ../src/clientlib/include/net_nfc_ndef_record.h ../src/clientlib/include/net_nfc_apdu.h ../src/clientlib/include/net_nfc_tag.h ../src/clientlib/include/net_nfc.h ../src/clientlib/include/net_nfc_ndef_message_handover.h ../src/clientlib/include/net_nfc_tag_felica.h ../src/clientlib/include/net_nfc_tag_jewel.h ../src/clientlib/include/net_nfc_tag_mifare.h
 143
 144
 145 # This tag can be used to specify the character encoding of the source files that
 146 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
 147 # input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
 148 # See http://www.gnu.org/software/libiconv for the list of possible encodings.
 149
 150 INPUT_ENCODING         = UTF-8
 151 FILE_PATTERNS          = *.h \
 152                          *.doxy
 153 RECURSIVE              = YES
 154 EXCLUDE                =
 155 EXCLUDE_SYMLINKS       = NO
 156 EXCLUDE_PATTERNS       = */test/* \
 157                         */debian/* \
 158                         */lost+found/* \
 159                         */i386/* \
 160                         */arm/* \
 161                         */simulator/*  \
 162                         *test* \
 163                         */voda3rd/*
 164 EXCLUDE_SYMBOLS        =
 165 EXAMPLE_PATH           =
 166 EXAMPLE_PATTERNS       =
 167 EXAMPLE_RECURSIVE      = NO
 168 IMAGE_PATH             = ../image
 169 INPUT_FILTER           =
 170 FILTER_PATTERNS        =
 171 FILTER_SOURCE_FILES    = NO
 172
 173 #---------------------------------------------------------------------------
 174 # configuration options related to source browsing
 175 #---------------------------------------------------------------------------
 176
 177 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
 178 # be generated. Documented entities will be cross-referenced with these sources.
 179 # Note: To get rid of all source code in the generated output, make sure also
 180 # VERBATIM_HEADERS is set to NO.
 181
 182 SOURCE_BROWSER         = NO
 183
 184 # Setting the INLINE_SOURCES tag to YES will include the body
 185 # of functions and classes directly in the documentation.
 186
 187 INLINE_SOURCES         = NO
 188
 189 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
 190 # doxygen to hide any special comment blocks from generated source code
 191 # fragments. Normal C and C++ comments will always remain visible.
 192
 193 STRIP_CODE_COMMENTS    = YES
 194
 195 # If the REFERENCED_BY_RELATION tag is set to YES (the default)
 196 # then for each documented function all documented
 197 # functions referencing it will be listed.
 198
 199 REFERENCED_BY_RELATION = YES
 200
 201 # If the REFERENCES_RELATION tag is set to YES (the default)
 202 # then for each documented function all documented entities
 203 # called/used by that function will be listed.
 204
 205 REFERENCES_RELATION    = YES
 206
 207 # If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
 208 # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
 209 # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
 210 # link to the source code.  Otherwise they will link to the documentstion.
 211
 212 REFERENCES_LINK_SOURCE = YES
 213
 214 # If the USE_HTAGS tag is set to YES then the references to source code
 215 # will point to the HTML generated by the htags(1) tool instead of doxygen
 216 # built-in source browser. The htags tool is part of GNU's global source
 217 # tagging system (see http://www.gnu.org/software/global/global.html). You
 218 # will need version 4.8.6 or higher.
 219
 220 USE_HTAGS              = NO
 221
 222 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
 223 # will generate a verbatim copy of the header file for each class for
 224 # which an include is specified. Set to NO to disable this.
 225
 226 VERBATIM_HEADERS       = YES
 227
 228 #---------------------------------------------------------------------------
 229 # configuration options related to the alphabetical class index
 230 #---------------------------------------------------------------------------
 231
 232 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
 233 # of all compounds will be generated. Enable this if the project
 234 # contains a lot of classes, structs, unions or interfaces.
 235
 236 ALPHABETICAL_INDEX     = YES
 237 COLS_IN_ALPHA_INDEX    = 10
 238 IGNORE_PREFIX          =
 239
 240 #---------------------------------------------------------------------------
 241 # configuration options related to the HTML output
 242 #---------------------------------------------------------------------------
 243
 244 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
 245 # generate HTML output.
 246
 247 GENERATE_HTML          = YES
 248
 249 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
 250 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 251 # put in front of it. If left blank `html' will be used as the default path.
 252
 253 HTML_OUTPUT            = html
 254
 255 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
 256 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
 257 # doxygen will generate files with .html extension.
 258
 259 HTML_FILE_EXTENSION    = .html
 260
 261 # The HTML_HEADER tag can be used to specify a personal HTML header for
 262 # each generated HTML page. If it is left blank doxygen will generate a
 263 # standard header.
 264
 265 HTML_HEADER            =
 266
 267 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 268 # each generated HTML page. If it is left blank doxygen will generate a
 269 # standard footer.
 270
 271 HTML_FOOTER            =
 272
 273 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 274 # style sheet that is used by each HTML page. It can be used to
 275 # fine-tune the look of the HTML output. If the tag is left blank doxygen
 276 # will generate a default style sheet. Note that doxygen will try to copy
 277 # the style sheet file to the HTML output directory, so don't put your own
 278 # stylesheet in the HTML output directory as well, or it will be erased!
 279
 280 HTML_STYLESHEET        =./slp_doxy.css
 281
 282 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
 283 # files or namespaces will be aligned in HTML using tables. If set to
 284 # NO a bullet list will be used.
 285
 286 HTML_ALIGN_MEMBERS     = YES
 287
 288 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
 289 # will be generated that can be used as input for tools like the
 290 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
 291 # of the generated HTML documentation.
 292
 293 GENERATE_HTMLHELP      = YES
 294
 295 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
 296 # be used to specify the file name of the resulting .chm file. You
 297 # can add a path in front of the file if the result should not be
 298 # written to the html output directory.
 299
 300 CHM_FILE               =
 301
 302 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
 303 # be used to specify the location (absolute path including file name) of
 304 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
 305 # the HTML help compiler on the generated index.hhp.
 306
 307 HHC_LOCATION           =
 308
 309 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
 310 # controls if a separate .chi index file is generated (YES) or that
 311 # it should be included in the master .chm file (NO).
 312
 313 GENERATE_CHI           = NO
 314
 315 # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
 316 # controls whether a binary table of contents is generated (YES) or a
 317 # normal table of contents (NO) in the .chm file.
 318
 319 BINARY_TOC             = NO
 320
 321 # The TOC_EXPAND flag can be set to YES to add extra items for group members
 322 # to the contents of the HTML help documentation and to the tree view.
 323
 324 TOC_EXPAND             = NO
 325
 326 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
 327 # top of each HTML page. The value NO (the default) enables the index and
 328 # the value YES disables it.
 329
 330 DISABLE_INDEX          = NO
 331
 332 # This tag can be used to set the number of enum values (range [1..20])
 333 # that doxygen will group on one line in the generated HTML documentation.
 334
 335 ENUM_VALUES_PER_LINE   = 4
 336
 337 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
 338 # generated containing a tree-like index structure (just like the one that
 339 # is generated for HTML Help). For this to work a browser that supports
 340 # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
 341 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
 342 # probably better off using the HTML help feature.
 343
 344 GENERATE_TREEVIEW      = YES
 345
 346 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
 347 # used to set the initial width (in pixels) of the frame in which the tree
 348 # is shown.
 349
 350 TREEVIEW_WIDTH         = 190
 351
 352 #---------------------------------------------------------------------------
 353 # configuration options related to the LaTeX output
 354 #---------------------------------------------------------------------------
 355
 356 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 357 # generate Latex output.
 358
 359 GENERATE_LATEX         = NO
 360
 361 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
 362 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 363 # put in front of it. If left blank `latex' will be used as the default path.
 364
 365 LATEX_OUTPUT           = latex
 366
 367 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
 368 # invoked. If left blank `latex' will be used as the default command name.
 369
 370 LATEX_CMD_NAME         = latex
 371
 372 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
 373 # generate index for LaTeX. If left blank `makeindex' will be used as the
 374 # default command name.
 375
 376 MAKEINDEX_CMD_NAME     = makeindex
 377
 378 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
 379 # LaTeX documents. This may be useful for small projects and may help to
 380 # save some trees in general.
 381
 382 COMPACT_LATEX          = NO
 383
 384 # The PAPER_TYPE tag can be used to set the paper type that is used
 385 # by the printer. Possible values are: a4, a4wide, letter, legal and
 386 # executive. If left blank a4wide will be used.
 387
 388 PAPER_TYPE             = a4wide
 389
 390 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
 391 # packages that should be included in the LaTeX output.
 392
 393 EXTRA_PACKAGES         =
 394
 395 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
 396 # the generated latex document. The header should contain everything until
 397 # the first chapter. If it is left blank doxygen will generate a
 398 # standard header. Notice: only use this tag if you know what you are doing!
 399
 400 LATEX_HEADER           =
 401
 402 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
 403 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
 404 # contain links (just like the HTML output) instead of page references
 405 # This makes the output suitable for online browsing using a pdf viewer.
 406
 407 PDF_HYPERLINKS         = NO
 408
 409 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
 410 # plain latex in the generated Makefile. Set this option to YES to get a
 411 # higher quality PDF documentation.
 412
 413 USE_PDFLATEX           = NO
 414
 415 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
 416 # command to the generated LaTeX files. This will instruct LaTeX to keep
 417 # running if errors occur, instead of asking the user for help.
 418 # This option is also used when generating formulas in HTML.
 419
 420 LATEX_BATCHMODE        = NO
 421
 422 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
 423 # include the index chapters (such as File Index, Compound Index, etc.)
 424 # in the output.
 425
 426 LATEX_HIDE_INDICES     = NO
 427
 428 #---------------------------------------------------------------------------
 429 # configuration options related to the RTF output
 430 #---------------------------------------------------------------------------
 431
 432 # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
 433 # The RTF output is optimized for Word 97 and may not look very pretty with
 434 # other RTF readers or editors.
 435
 436 GENERATE_RTF           = NO
 437
 438 # The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
 439 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 440 # put in front of it. If left blank `rtf' will be used as the default path.
 441
 442 RTF_OUTPUT             = rtf
 443
 444 # If the COMPACT_RTF tag is set to YES Doxygen generates more compact
 445 # RTF documents. This may be useful for small projects and may help to
 446 # save some trees in general.
 447
 448 COMPACT_RTF            = NO
 449
 450 # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
 451 # will contain hyperlink fields. The RTF file will
 452 # contain links (just like the HTML output) instead of page references.
 453 # This makes the output suitable for online browsing using WORD or other
 454 # programs which support those fields.
 455 # Note: wordpad (write) and others do not support links.
 456
 457 RTF_HYPERLINKS         = NO
 458
 459 # Load stylesheet definitions from file. Syntax is similar to doxygen's
 460 # config file, i.e. a series of assignments. You only have to provide
 461 # replacements, missing definitions are set to their default value.
 462
 463 RTF_STYLESHEET_FILE    =
 464
 465 # Set optional variables used in the generation of an rtf document.
 466 # Syntax is similar to doxygen's config file.
 467
 468 RTF_EXTENSIONS_FILE    =
 469
 470 #---------------------------------------------------------------------------
 471 # configuration options related to the man page output
 472 #---------------------------------------------------------------------------
 473
 474 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
 475 # generate man pages
 476
 477 GENERATE_MAN           = NO
 478
 479 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
 480 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 481 # put in front of it. If left blank `man' will be used as the default path.
 482
 483 MAN_OUTPUT             = man
 484
 485 # The MAN_EXTENSION tag determines the extension that is added to
 486 # the generated man pages (default is the subroutine's section .3)
 487
 488 MAN_EXTENSION          = .3
 489
 490 # If the MAN_LINKS tag is set to YES and Doxygen generates man output,
 491 # then it will generate one additional man file for each entity
 492 # documented in the real man page(s). These additional files
 493 # only source the real man page, but without them the man command
 494 # would be unable to find the correct page. The default is NO.
 495
 496 MAN_LINKS              = NO
 497
 498 #---------------------------------------------------------------------------
 499 # configuration options related to the XML output
 500 #---------------------------------------------------------------------------
 501
 502 # If the GENERATE_XML tag is set to YES Doxygen will
 503 # generate an XML file that captures the structure of
 504 # the code including all documentation.
 505
 506 GENERATE_XML           = NO
 507
 508 # The XML_OUTPUT tag is used to specify where the XML pages will be put.
 509 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 510 # put in front of it. If left blank `xml' will be used as the default path.
 511
 512 XML_OUTPUT             = xml
 513
 514 # The XML_SCHEMA tag can be used to specify an XML schema,
 515 # which can be used by a validating XML parser to check the
 516 # syntax of the XML files.
 517
 518 XML_SCHEMA             =
 519
 520 # The XML_DTD tag can be used to specify an XML DTD,
 521 # which can be used by a validating XML parser to check the
 522 # syntax of the XML files.
 523
 524 XML_DTD                =
 525
 526 # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
 527 # dump the program listings (including syntax highlighting
 528 # and cross-referencing information) to the XML output. Note that
 529 # enabling this will significantly increase the size of the XML output.
 530
 531 XML_PROGRAMLISTING     = YES
 532
 533 #---------------------------------------------------------------------------
 534 # configuration options for the AutoGen Definitions output
 535 #---------------------------------------------------------------------------
 536
 537 # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
 538 # generate an AutoGen Definitions (see autogen.sf.net) file
 539 # that captures the structure of the code including all
 540 # documentation. Note that this feature is still experimental
 541 # and incomplete at the moment.
 542
 543 GENERATE_AUTOGEN_DEF   = NO
 544
 545 #---------------------------------------------------------------------------
 546 # configuration options related to the Perl module output
 547 #---------------------------------------------------------------------------
 548
 549 # If the GENERATE_PERLMOD tag is set to YES Doxygen will
 550 # generate a Perl module file that captures the structure of
 551 # the code including all documentation. Note that this
 552 # feature is still experimental and incomplete at the
 553 # moment.
 554
 555 GENERATE_PERLMOD       = NO
 556
 557 # If the PERLMOD_LATEX tag is set to YES Doxygen will generate
 558 # the necessary Makefile rules, Perl scripts and LaTeX code to be able
 559 # to generate PDF and DVI output from the Perl module output.
 560
 561 PERLMOD_LATEX          = YES
 562
 563 # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
 564 # nicely formatted so it can be parsed by a human reader.  This is useful
 565 # if you want to understand what is going on.  On the other hand, if this
 566 # tag is set to NO the size of the Perl module output will be much smaller
 567 # and Perl will parse it just the same.
 568
 569 PERLMOD_PRETTY         = YES
 570
 571 # The names of the make variables in the generated doxyrules.make file
 572 # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
 573 # This is useful so different doxyrules.make files included by the same
 574 # Makefile don't overwrite each other's variables.
 575
 576 PERLMOD_MAKEVAR_PREFIX =
 577
 578 #---------------------------------------------------------------------------
 579 # Configuration options related to the preprocessor
 580 #---------------------------------------------------------------------------
 581
 582 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
 583 # evaluate all C-preprocessor directives found in the sources and include
 584 # files.
 585
 586 ENABLE_PREPROCESSING   = YES
 587
 588 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
 589 # names in the source code. If set to NO (the default) only conditional
 590 # compilation will be performed. Macro expansion can be done in a controlled
 591 # way by setting EXPAND_ONLY_PREDEF to YES.
 592
 593 MACRO_EXPANSION        = NO
 594
 595 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
 596 # then the macro expansion is limited to the macros specified with the
 597 # PREDEFINED and EXPAND_AS_DEFINED tags.
 598
 599 EXPAND_ONLY_PREDEF     = NO
 600
 601 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
 602 # in the INCLUDE_PATH (see below) will be search if a #include is found.
 603
 604 SEARCH_INCLUDES        = YES
 605
 606 # The INCLUDE_PATH tag can be used to specify one or more directories that
 607 # contain include files that are not input files but should be processed by
 608 # the preprocessor.
 609
 610 INCLUDE_PATH           =
 611
 612 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 613 # patterns (like *.h and *.hpp) to filter out the header-files in the
 614 # directories. If left blank, the patterns specified with FILE_PATTERNS will
 615 # be used.
 616
 617 INCLUDE_FILE_PATTERNS  =
 618
 619 # The PREDEFINED tag can be used to specify one or more macro names that
 620 # are defined before the preprocessor is started (similar to the -D option of
 621 # gcc). The argument of the tag is a list of macros of the form: name
 622 # or name=definition (no spaces). If the definition and the = are
 623 # omitted =1 is assumed. To prevent a macro definition from being
 624 # undefined via #undef or recursively expanded use the := operator
 625 # instead of the = operator.
 626
 627 PREDEFINED             =
 628
 629 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 630 # this tag can be used to specify a list of macro names that should be expanded.
 631 # The macro definition that is found in the sources will be used.
 632 # Use the PREDEFINED tag if you want to use a different macro definition.
 633
 634 EXPAND_AS_DEFINED      =
 635
 636 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
 637 # doxygen's preprocessor will remove all function-like macros that are alone
 638 # on a line, have an all uppercase name, and do not end with a semicolon. Such
 639 # function macros are typically used for boiler-plate code, and will confuse
 640 # the parser if not removed.
 641
 642 SKIP_FUNCTION_MACROS   = YES
 643
 644 #---------------------------------------------------------------------------
 645 # Configuration::additions related to external references
 646 #---------------------------------------------------------------------------
 647
 648 # The TAGFILES option can be used to specify one or more tagfiles.
 649 # Optionally an initial location of the external documentation
 650 # can be added for each tagfile. The format of a tag file without
 651 # this location is as follows:
 652 #   TAGFILES = file1 file2 ...
 653 # Adding location for the tag files is done as follows:
 654 #   TAGFILES = file1=loc1 "file2 = loc2" ...
 655 # where "loc1" and "loc2" can be relative or absolute paths or
 656 # URLs. If a location is present for each tag, the installdox tool
 657 # does not have to be run to correct the links.
 658 # Note that each tag file must have a unique name
 659 # (where the name does NOT include the path)
 660 # If a tag file is not located in the directory in which doxygen
 661 # is run, you must also specify the path to the tagfile here.
 662
 663 TAGFILES               =
 664
 665 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 666 # a tag file that is based on the input files it reads.
 667
 668 GENERATE_TAGFILE       =
 669
 670 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
 671 # in the class index. If set to NO only the inherited external classes
 672 # will be listed.
 673
 674 ALLEXTERNALS           = NO
 675
 676 # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
 677 # in the modules index. If set to NO, only the current project's groups will
 678 # be listed.
 679
 680 EXTERNAL_GROUPS        = YES
 681
 682 # The PERL_PATH should be the absolute path and name of the perl script
 683 # interpreter (i.e. the result of `which perl').
 684
 685 PERL_PATH              = /usr/bin/perl
 686
 687 #---------------------------------------------------------------------------
 688 # Configuration options related to the dot tool
 689 #---------------------------------------------------------------------------
 690
 691 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
 692 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
 693 # or super classes. Setting the tag to NO turns the diagrams off. Note that
 694 # this option is superseded by the HAVE_DOT option below. This is only a
 695 # fallback. It is recommended to install and use dot, since it yields more
 696 # powerful graphs.
 697
 698 CLASS_DIAGRAMS         = NO
 699
 700 # You can define message sequence charts within doxygen comments using the \msc
 701 # command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
 702 # produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
 703 # specify the directory where the mscgen tool resides. If left empty the tool is assumed to
 704 # be found in the default search path.
 705
 706 MSCGEN_PATH            =
 707
 708 # If set to YES, the inheritance and collaboration graphs will hide
 709 # inheritance and usage relations if the target is undocumented
 710 # or is not a class.
 711
 712 HIDE_UNDOC_RELATIONS   = YES
 713
 714 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
 715 # available from the path. This tool is part of Graphviz, a graph visualization
 716 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
 717 # have no effect if this option is set to NO (the default)
 718
 719 HAVE_DOT               = NO
 720
 721 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
 722 # will generate a graph for each documented class showing the direct and
 723 # indirect inheritance relations. Setting this tag to YES will force the
 724 # the CLASS_DIAGRAMS tag to NO.
 725
 726 CLASS_GRAPH            = NO
 727
 728 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
 729 # will generate a graph for each documented class showing the direct and
 730 # indirect implementation dependencies (inheritance, containment, and
 731 # class references variables) of the class with other documented classes.
 732
 733 COLLABORATION_GRAPH    = NO
 734
 735 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
 736 # will generate a graph for groups, showing the direct groups dependencies
 737
 738 GROUP_GRAPHS           = NO
 739
 740 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
 741 # collaboration diagrams in a style similar to the OMG's Unified Modeling
 742 # Language.
 743
 744 UML_LOOK               = NO
 745
 746 # If set to YES, the inheritance and collaboration graphs will show the
 747 # relations between templates and their instances.
 748
 749 TEMPLATE_RELATIONS     = NO
 750
 751 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
 752 # tags are set to YES then doxygen will generate a graph for each documented
 753 # file showing the direct and indirect include dependencies of the file with
 754 # other documented files.
 755
 756 INCLUDE_GRAPH          = NO
 757
 758 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
 759 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
 760 # documented header file showing the documented files that directly or
 761 # indirectly include this file.
 762
 763 INCLUDED_BY_GRAPH      = NO
 764
 765 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
 766 # generate a call dependency graph for every global function or class method.
 767 # Note that enabling this option will significantly increase the time of a run.
 768 # So in most cases it will be better to enable call graphs for selected
 769 # functions only using the \callgraph command.
 770
 771 CALL_GRAPH             = NO
 772
 773 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will
 774 # generate a caller dependency graph for every global function or class method.
 775 # Note that enabling this option will significantly increase the time of a run.
 776 # So in most cases it will be better to enable caller graphs for selected
 777 # functions only using the \callergraph command.
 778
 779 CALLER_GRAPH           = NO
 780
 781 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
 782 # will graphical hierarchy of all classes instead of a textual one.
 783
 784 GRAPHICAL_HIERARCHY    = NO
 785
 786 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
 787 # then doxygen will show the dependencies a directory has on other directories
 788 # in a graphical way. The dependency relations are determined by the #include
 789 # relations between the files in the directories.
 790
 791 DIRECTORY_GRAPH        = NO
 792
 793 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
 794 # generated by dot. Possible values are png, jpg, or gif
 795 # If left blank png will be used.
 796
 797 DOT_IMAGE_FORMAT       = jpg
 798
 799 # The tag DOT_PATH can be used to specify the path where the dot tool can be
 800 # found. If left blank, it is assumed the dot tool can be found in the path.
 801
 802 DOT_PATH               =
 803
 804 # The DOTFILE_DIRS tag can be used to specify one or more directories that
 805 # contain dot files that are included in the documentation (see the
 806 # \dotfile command).
 807
 808 DOTFILE_DIRS           =
 809
 810 # The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
 811 # nodes that will be shown in the graph. If the number of nodes in a graph
 812 # becomes larger than this value, doxygen will truncate the graph, which is
 813 # visualized by representing a node as a red box. Note that doxygen will always
 814 # show the root nodes and its direct children regardless of this setting.
 815
 816 DOT_GRAPH_MAX_NODES    = 50
 817
 818 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
 819 # background. This is disabled by default, which results in a white background.
 820 # Warning: Depending on the platform used, enabling this option may lead to
 821 # badly anti-aliased labels on the edges of a graph (i.e. they become hard to
 822 # read).
 823
 824 DOT_TRANSPARENT        = NO
 825
 826 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
 827 # files in one run (i.e. multiple -o and -T options on the command line). This
 828 # makes dot run faster, but since only newer versions of dot (>1.8.10)
 829 # support this, this feature is disabled by default.
 830
 831 DOT_MULTI_TARGETS      = NO
 832
 833 # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
 834 # generate a legend page explaining the meaning of the various boxes and
 835 # arrows in the dot generated graphs.
 836
 837 GENERATE_LEGEND        = NO
 838
 839 # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
 840 # remove the intermediate dot files that are used to generate
 841 # the various graphs.
 842
 843 DOT_CLEANUP            = NO
 844
 845 #---------------------------------------------------------------------------
 846 # Configuration::additions related to the search engine
 847 #---------------------------------------------------------------------------
 848
 849 # The SEARCHENGINE tag specifies whether or not a search engine should be
 850 # used. If set to NO the values of all tags below this one will be ignored.
 851
 852 SEARCHENGINE           = YES