Doxyfile.in

   1 # Doxyfile 1.0.0
   2
   3 # This file describes the settings to be used by doxygen for a project
   4 #
   5 # All text after a hash (#) is considered a comment and will be ignored
   6 # The format is:
   7 #       TAG = value [value, ...]
   8 # Values that contain spaces should be placed between quotes (" ")
   9
  10 #---------------------------------------------------------------------------
  11 # General configuration options
  12 #---------------------------------------------------------------------------
  13
  14 # The PROJECT_NAME tag is a single word (or a sequence of word surrounded
  15 # by quotes) that should identify the project.
  16
  17 PROJECT_NAME         = @PACKAGE@
  18
  19 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
  20 # This could be handy for archiving the generated documentation or
  21 # if some version control system is used.
  22
  23 PROJECT_NUMBER       = @VERSION@
  24
  25 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  26 # base path where the generated documentation will be put.
  27 # If a relative path is entered, it will be relative to the location
  28 # where doxygen was started. If left blank the current directory will be used.
  29
  30 OUTPUT_DIRECTORY     = doxygen
  31
  32 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
  33 # documentation generated by doxygen is written. Doxygen will use this
  34 # information to generate all constant output in the proper language.
  35 # The default language is English, other supported languages are:
  36 # Dutch, French, Italian, Czech, Swedish, German and Japanese
  37
  38 OUTPUT_LANGUAGE      = English
  39
  40 # The QUIET tag can be used to turn on/off the messages that are generated
  41 # by doxygen. Possible values are YES and NO. If left blank NO is used.
  42
  43 QUIET                = NO
  44
  45 # The WARNINGS tag can be used to turn on/off the warning messages that are
  46 # generated by doxygen. Possible values are YES and NO. If left blank
  47 # NO is used.
  48
  49 WARNINGS             = YES
  50
  51 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
  52 # top of each HTML page. The value NO (the default) enables the index and
  53 # the value YES disables it.
  54
  55 DISABLE_INDEX        = NO
  56
  57 # If the EXTRACT_ALL tag is set to YES all classes and functions will be
  58 # included in the documentation, even if no documentation was available.
  59
  60 EXTRACT_ALL          = YES
  61
  62 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  63 # will be included in the documentation.
  64
  65 EXTRACT_PRIVATE      = NO
  66
  67 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
  68 # undocumented members inside documented classes or files.
  69
  70 HIDE_UNDOC_MEMBERS   = NO
  71
  72 # If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all
  73 # undocumented classes.
  74
  75 HIDE_UNDOC_CLASSES   = NO
  76
  77 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
  78 # include brief member descriptions after the members that are listed in
  79 # the file and class documentation (similar to JavaDoc).
  80 # Set to NO to disable this.
  81
  82 BRIEF_MEMBER_DESC    = YES
  83
  84 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
  85 # the brief description of a member or function before the detailed description.
  86 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  87 # brief descriptions will be completely suppressed.
  88
  89 REPEAT_BRIEF         = YES
  90
  91 # If the ALWAYS_DETAILS_SEC and REPEAT_BRIEF tags are both set to YES then
  92 # Doxygen will generate a detailed section even if there is only a brief
  93 # description.
  94
  95 ALWAYS_DETAILED_SEC  = NO
  96
  97 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
  98 # path before files name in the file list and in the header files. If set
  99 # to NO the shortest path that makes the file name unique will be used.
 100
 101 FULL_PATH_NAMES      = YES
 102
 103 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
 104 # can be used to strip a user defined part of the path. Stripping is
 105 # only done if one of the specified strings matches the left-hand part of
 106 # the path.
 107
 108 STRIP_FROM_PATH      = @POPT_SOURCE_PATH@/
 109
 110 # The INTERNAL_DOCS tag determines if documentation
 111 # that is typed after a \internal command is included. If the tag is set
 112 # to NO (the default) then the documentation will be excluded.
 113 # Set it to YES to include the internal documentation.
 114
 115 INTERNAL_DOCS        = NO
 116
 117 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
 118 # generate a class diagram (in Html and LaTeX) for classes with base or
 119 # super classes. Setting the tag to NO turns the diagrams off.
 120
 121 CLASS_DIAGRAMS       = YES
 122
 123 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
 124 # be generated. Documented entities will be cross-referenced with these sources.
 125
 126 SOURCE_BROWSER       = YES
 127
 128 # Setting the INLINE_SOURCES tag to YES will include the body
 129 # of functions and classes directly in the documentation.
 130
 131 INLINE_SOURCES       = NO
 132
 133 # If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen
 134 # will only generate file names in lower case letters. If set to
 135 # YES upper case letters are also allowed. This is useful if you have
 136 # classes or files whose names only differ in case and if your file system
 137 # supports case sensitive file names.
 138
 139 CASE_SENSE_NAMES     = NO
 140
 141 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
 142 # will generate a verbatim copy of the header file for each class for
 143 # which an include is specified. Set to NO to disable this.
 144
 145 VERBATIM_HEADERS     = YES
 146
 147 # If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen
 148 # will interpret the first line (until the first dot) of a JavaDoc-style
 149 # comment as the brief description. If set to NO, the Javadoc-style will
 150 # behave just like the Qt-style comments.
 151
 152 JAVADOC_AUTOBRIEF    = YES
 153
 154 # if the INHERIT_DOCS tag is set to YES (the default) then an undocumented
 155 # member inherits the documentation from any documented member that it
 156 # reimplements.
 157
 158 INHERIT_DOCS         = YES
 159
 160 # if the INLINE_INFO tag is set to YES (the default) then a tag [inline]
 161 # is inserted in the documentation for inline members.
 162
 163 INLINE_INFO          = YES
 164
 165 # the TAB_SIZE tag can be used to set the number of spaces in a tab.
 166 # Doxygen uses this value to replace tabs by spaces in code fragments.
 167
 168 TAB_SIZE             = 8
 169
 170 #---------------------------------------------------------------------------
 171 # configuration options related to the input files
 172 #---------------------------------------------------------------------------
 173
 174 # The INPUT tag can be used to specify the files and/or directories that contain
 175 # documented source files. You may enter file names like "myfile.cpp" or
 176 # directories like "/usr/src/myproject". Separate the files or directories
 177 # with spaces.
 178
 179 INPUT                = \
 180         ./findme.c \
 181         ./findme.h \
 182         ./popt.c \
 183         ./popt.h \
 184         ./poptconfig.c \
 185         ./popthelp.c \
 186         ./poptint.h \
 187         ./poptparse.c \
 188         ./system.h
 189
 190 # If the value of the INPUT tag contains directories, you can use the
 191 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 192 # and *.h) to filter out the source-files in the directories. If left
 193 # blank all files are included.
 194
 195 FILE_PATTERNS        = *.c *.h
 196
 197 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 198 # should be searched for input files as well. Possible values are YES and NO.
 199 # If left blank NO is used.
 200
 201 RECURSIVE            = NO
 202
 203 # The EXCLUDE tag can be used to specify files and/or directories that should
 204 # excluded from the INPUT source files. This way you can easily exclude a
 205 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 206
 207 EXCLUDE              =
 208
 209 # If the value of the INPUT tag contains directories, you can use the
 210 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
 211 # certain files from those directories.
 212
 213 EXCLUDE_PATTERNS     =
 214
 215 # The EXAMPLE_PATH tag can be used to specify one or more files or
 216 # directories that contain example code fragments that are included (see
 217 # the \include command).
 218
 219 EXAMPLE_PATH         =
 220
 221 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 222 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
 223 # and *.h) to filter out the source-files in the directories. If left
 224 # blank all files are included.
 225
 226 EXAMPLE_PATTERNS     =
 227
 228 # The IMAGE_PATH tag can be used to specify one or more files or
 229 # directories that contain image that are included in the documentation (see
 230 # the \image command).
 231
 232 IMAGE_PATH           =
 233
 234 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 235 # invoke to filter for each input file. Doxygen will invoke the filter program
 236 # by executing (via popen()) the command <filter> <input-file>, where <filter>
 237 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
 238 # input file. Doxygen will then use the output that the filter program writes
 239 # to standard output.
 240
 241 INPUT_FILTER         =
 242
 243 #---------------------------------------------------------------------------
 244 # configuration options related to the HTML output
 245 #---------------------------------------------------------------------------
 246
 247 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
 248 # generate HTML output
 249
 250 GENERATE_HTML        = YES
 251
 252 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
 253 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 254 # put in front of it. If left blank `html' will be used as the default path.
 255
 256 HTML_OUTPUT          =
 257
 258 # The HTML_HEADER tag can be used to specify a personal HTML header for
 259 # each generated HTML page. If it is left blank doxygen will generate a
 260 # standard header.
 261
 262 HTML_HEADER          =
 263
 264 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 265 # each generated HTML page. If it is left blank doxygen will generate a
 266 # standard footer.
 267
 268 HTML_FOOTER          =
 269
 270 # The HTML_STYLESHEET tag can be used to specify a user defined cascading
 271 # style sheet that is used by each HTML page. It can be used to
 272 # fine-tune the look of the HTML output. If the tag is left blank doxygen
 273 # will generate a default style sheet
 274
 275 HTML_STYLESHEET      =
 276
 277 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
 278 # files or namespaces will be aligned in HTML using tables. If set to
 279 # NO a bullet list will be used.
 280
 281 HTML_ALIGN_MEMBERS   = YES
 282
 283 # If the GENERATE_HTMLHELP tag is set to YES, additional index files
 284 # will be generated that can be used as input for tools like the
 285 # Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
 286 # of the generated HTML documentation.
 287
 288 GENERATE_HTMLHELP    = NO
 289
 290 # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
 291 # of all compounds will be generated. Enable this if the project
 292 # contains a lot of classes, structs, unions or interfaces.
 293
 294 ALPHABETICAL_INDEX   = NO
 295
 296 # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
 297 # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
 298 # in which this list will be split (can be a number in the range [1..20])
 299
 300 COLS_IN_ALPHA_INDEX  = 5
 301
 302 #---------------------------------------------------------------------------
 303 # configuration options related to the LaTeX output
 304 #---------------------------------------------------------------------------
 305
 306 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
 307 # generate Latex output.
 308
 309 GENERATE_LATEX       = NO
 310
 311 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
 312 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 313 # put in front of it. If left blank `latex' will be used as the default path.
 314
 315 LATEX_OUTPUT         =
 316
 317 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
 318 # LaTeX documents. This may be useful for small projects and may help to
 319 # save some trees in general.
 320
 321 COMPACT_LATEX        = NO
 322
 323 # The PAPER_TYPE tag can be used to set the paper type that is used
 324 # by the printer. Possible values are: a4, a4wide, letter, legal and
 325 # executive. If left blank a4wide will be used.
 326
 327 PAPER_TYPE           = a4wide
 328
 329 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
 330 # packages that should be included in the LaTeX output.
 331
 332 EXTRA_PACKAGES       =
 333
 334 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
 335 # the generated latex document. The header should contain everything until
 336 # the first chapter. If it is left blank doxygen will generate a
 337 # standard header. Notice: only use this tag if you know what you are doing!
 338
 339 LATEX_HEADER         =
 340
 341 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
 342 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
 343 # contain links (just like the HTML output) instead of page references
 344 # This makes the output suitable for online browsing using a pdf viewer.
 345
 346 PDF_HYPERLINKS       = NO
 347
 348 #---------------------------------------------------------------------------
 349 # configuration options related to the man page output
 350 #---------------------------------------------------------------------------
 351
 352 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
 353 # generate man pages
 354
 355 GENERATE_MAN         = YES
 356
 357 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
 358 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 359 # put in front of it. If left blank `man' will be used as the default path.
 360
 361 MAN_OUTPUT           =
 362
 363 # The MAN_EXTENSION tag determines the extension that is added to
 364 # the generated man pages (default is the subroutine's section .3)
 365
 366 MAN_EXTENSION        = .3
 367
 368 #---------------------------------------------------------------------------
 369 # Configuration options related to the preprocessor
 370 #---------------------------------------------------------------------------
 371
 372 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
 373 # evaluate all C-preprocessor directives found in the sources and include
 374 # files.
 375
 376 ENABLE_PREPROCESSING = YES
 377
 378 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
 379 # names in the source code. If set to NO (the default) only conditional
 380 # compilation will be performed.
 381
 382 MACRO_EXPANSION      = YES
 383
 384 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
 385 # in the INCLUDE_PATH (see below) will be search if a #include is found.
 386
 387 SEARCH_INCLUDES      = YES
 388
 389 # The INCLUDE_PATH tag can be used to specify one or more directories that
 390 # contain include files that are not input files but should be processed by
 391 # the preprocessor.
 392
 393 INCLUDE_PATH         =
 394
 395 # The PREDEFINED tag can be used to specify one or more macro names that
 396 # are defined before the preprocessor is started (similar to the -D option of
 397 # gcc). The argument of the tag is a list of macros of the form: name
 398 # or name=definition (no spaces). If the definition and the = are
 399 # omitted =1 is assumed.
 400
 401 PREDEFINED           =
 402
 403 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
 404 # then the macro expansion is limited to the macros specified with the
 405 # PREDEFINED tag.
 406
 407 EXPAND_ONLY_PREDEF   = NO
 408
 409 #---------------------------------------------------------------------------
 410 # Configuration options related to external references
 411 #---------------------------------------------------------------------------
 412
 413 # The TAGFILES tag can be used to specify one or more tagfiles.
 414
 415 TAGFILES             =
 416
 417 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 418 # a tag file that is based on the input files it reads.
 419
 420 GENERATE_TAGFILE     =
 421
 422 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
 423 # in the class index. If set to NO only the inherited external classes
 424 # will be listed.
 425
 426 ALLEXTERNALS         = NO
 427
 428 # The PERL_PATH should be the absolute path and name of the perl script
 429 # interpreter (i.e. the result of `which perl').
 430
 431 PERL_PATH            = /usr/bin/perl
 432
 433 #---------------------------------------------------------------------------
 434 # Configuration options related to the search engine
 435 #---------------------------------------------------------------------------
 436
 437 # The SEARCHENGINE tag specifies whether or not a search engine should be
 438 # used. If set to NO the values of all tags below this one will be ignored.
 439
 440 SEARCHENGINE         = NO
 441
 442 # The CGI_NAME tag should be the name of the CGI script that
 443 # starts the search engine (doxysearch) with the correct parameters.
 444 # A script with this name will be generated by doxygen.
 445
 446 CGI_NAME             = search.cgi
 447
 448 # The CGI_URL tag should be the absolute URL to the directory where the
 449 # cgi binaries are located. See the documentation of your http daemon for
 450 # details.
 451
 452 CGI_URL              =
 453
 454 # The DOC_URL tag should be the absolute URL to the directory where the
 455 # documentation is located. If left blank the absolute path to the
 456 # documentation, with file:// prepended to it, will be used.
 457
 458 DOC_URL              =
 459
 460 # The DOC_ABSPATH tag should be the absolute path to the directory where the
 461 # documentation is located. If left blank the directory on the local machine
 462 # will be used.
 463
 464 DOC_ABSPATH          =
 465
 466 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
 467 # is installed.
 468
 469 BIN_ABSPATH          = /usr/local/bin/
 470
 471 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
 472 # documentation generated for other projects. This allows doxysearch to search
 473 # the documentation for these projects as well.
 474
 475 EXT_DOC_PATHS        =