doc/src/Doxyfile

   1 #
   2 # ngIRCd -- The Next Generation IRC Daemon
   3 # Copyright (c)2001-2010 Alexander Barton (alex@barton.de)
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 # Please read the file COPYING, README and AUTHORS for more information.
  10 #
  11 # This file describes the settings to be used by the documentation system
  12 # doxygen (www.doxygen.org) for ngIRCd.
  13 #
  14
  15 #---------------------------------------------------------------------------
  16 # Project related configuration options
  17 #---------------------------------------------------------------------------
  18
  19 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  20 # by quotes) that should identify the project.
  21
  22 PROJECT_NAME           = ngIRCd
  23
  24 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  25 # base path where the generated documentation will be put.
  26 # If a relative path is entered, it will be relative to the location
  27 # where doxygen was started. If left blank the current directory will be used.
  28
  29 OUTPUT_DIRECTORY       = .
  30
  31 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  32 # can be used to strip a user-defined part of the path. Stripping is
  33 # only done if one of the specified strings matches the left-hand part of
  34 # the path. The tag can be used to show relative paths in the file list.
  35 # If left blank the directory from which doxygen is run is used as the
  36 # path to strip.
  37
  38 STRIP_FROM_PATH        = ../..
  39
  40 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  41 # will interpret the first line (until the first dot) of a JavaDoc-style
  42 # comment as the brief description. If set to NO, the JavaDoc
  43 # comments will behave just like the Qt-style comments (thus requiring an
  44 # explicit @brief command for a brief description.
  45
  46 JAVADOC_AUTOBRIEF      = YES
  47
  48 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  49 # sources only. Doxygen will then generate output that is more tailored for C.
  50 # For instance, some of the names that are used will be different. The list
  51 # of all members will be omitted, etc.
  52
  53 OPTIMIZE_OUTPUT_FOR_C  = YES
  54
  55 #---------------------------------------------------------------------------
  56 # Build related configuration options
  57 #---------------------------------------------------------------------------
  58
  59 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  60 # documentation are documented, even if no documentation was available.
  61 # Private class members and static file members will be hidden unless
  62 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  63
  64 EXTRACT_ALL            = YES
  65
  66 # If the EXTRACT_STATIC tag is set to YES all static members of a file
  67 # will be included in the documentation.
  68
  69 EXTRACT_STATIC         = YES
  70
  71 # If the sources in your project are distributed over multiple directories
  72 # then setting the SHOW_DIRECTORIES tag to YES will show the directory
  73 # hierarchy in the documentation. The default is NO.
  74
  75 SHOW_DIRECTORIES       = YES
  76
  77 #---------------------------------------------------------------------------
  78 # configuration options related to the input files
  79 #---------------------------------------------------------------------------
  80
  81 # The INPUT tag can be used to specify the files and/or directories that
  82 # contain documented source files. You may enter file names like "myfile.cpp"
  83 # or directories like "/usr/src/myproject". Separate the files or directories
  84 # with spaces.
  85
  86 INPUT                  = ../../src
  87
  88 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
  89 # should be searched for input files as well. Possible values are YES and NO.
  90 # If left blank NO is used.
  91
  92 RECURSIVE              = YES
  93
  94 #---------------------------------------------------------------------------
  95 # configuration options related to source browsing
  96 #---------------------------------------------------------------------------
  97
  98 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
  99 # be generated. Documented entities will be cross-referenced with these sources.
 100 # Note: To get rid of all source code in the generated output, make sure also
 101 # VERBATIM_HEADERS is set to NO.
 102
 103 SOURCE_BROWSER         = YES
 104
 105 # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
 106 # doxygen to hide any special comment blocks from generated source code
 107 # fragments. Normal C and C++ comments will always remain visible.
 108
 109 STRIP_CODE_COMMENTS    = NO
 110
 111 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
 112 # function all documented functions referencing it will be listed.
 113
 114 REFERENCED_BY_RELATION = YES
 115
 116 # If the REFERENCES_RELATION tag is set to YES then for each documented
 117 # function all documented entities called/used by that function will be listed.
 118
 119 REFERENCES_RELATION    = YES
 120
 121 #---------------------------------------------------------------------------
 122 # Output formats
 123 #---------------------------------------------------------------------------
 124
 125 GENERATE_HTML          = YES
 126
 127 # The HTML_FOOTER tag can be used to specify a personal HTML footer for each
 128 # generated HTML page. If it is left blank doxygen will generate a standard
 129 # footer.
 130
 131 HTML_FOOTER            = footer.inc.html
 132
 133 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
 134 # documentation will contain sections that can be hidden and shown after the
 135 # page has loaded. For this to work a browser that supports JavaScript and
 136 # DHTML is required (for instance Mozilla 1.0+, Firefox Netscape 6.0+,
 137 # Internet explorer 5.0+, Konqueror, or Safari).
 138
 139 HTML_DYNAMIC_SECTIONS  = YES
 140
 141 GENERATE_DOCSET        = NO
 142 GENERATE_HTMLHELP      = NO
 143 GENERATE_LATEX         = NO
 144 GENERATE_RTF           = NO
 145 GENERATE_MAN           = NO
 146 GENERATE_XML           = NO
 147 GENERATE_AUTOGEN_DEF   = NO
 148 GENERATE_PERLMOD       = NO
 149
 150 #---------------------------------------------------------------------------
 151 # Configuration options related to the preprocessor
 152 #---------------------------------------------------------------------------
 153
 154 # The PREDEFINED tag can be used to specify one or more macro names that
 155 # are defined before the preprocessor is started (similar to the -D option of
 156 # gcc). The argument of the tag is a list of macros of the form: name
 157 # or name=definition (no spaces). If the definition and the = are
 158 # omitted =1 is assumed. To prevent a macro definition from being
 159 # undefined via #undef or recursively expanded use the := operator
 160 # instead of the = operator.
 161
 162 PREDEFINED             = DEBUG ZLIB PAM ZEROCONF CONN_MODULE __client_c__
 163
 164 # -eof-