doc/src/Doxyfile

   1 #
   2 # ngIRCd -- The Next Generation IRC Daemon
   3 # Copyright (c)2001-2005 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 # $Id: Doxyfile,v 1.2 2005/07/23 00:48:38 alex Exp $
  12 #
  13
  14 # This file describes the settings to be used by the documentation system
  15 # doxygen (www.doxygen.org) for ngIRCd.
  16
  17 #---------------------------------------------------------------------------
  18 # Project related configuration options
  19 #---------------------------------------------------------------------------
  20
  21 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
  22 # by quotes) that should identify the project.
  23
  24 PROJECT_NAME           = ngIRCd
  25
  26 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
  27 # base path where the generated documentation will be put.
  28 # If a relative path is entered, it will be relative to the location
  29 # where doxygen was started. If left blank the current directory will be used.
  30
  31 OUTPUT_DIRECTORY       = .
  32
  33 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
  34 # can be used to strip a user-defined part of the path. Stripping is
  35 # only done if one of the specified strings matches the left-hand part of
  36 # the path. The tag can be used to show relative paths in the file list.
  37 # If left blank the directory from which doxygen is run is used as the
  38 # path to strip.
  39
  40 STRIP_FROM_PATH        = ../..
  41
  42 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
  43 # will interpret the first line (until the first dot) of a JavaDoc-style
  44 # comment as the brief description. If set to NO, the JavaDoc
  45 # comments will behave just like the Qt-style comments (thus requiring an
  46 # explicit @brief command for a brief description.
  47
  48 JAVADOC_AUTOBRIEF      = YES
  49
  50 # If the DETAILS_AT_TOP tag is set to YES then Doxygen
  51 # will output the detailed description near the top, like JavaDoc.
  52 # If set to NO, the detailed description appears after the member
  53 # documentation.
  54
  55 DETAILS_AT_TOP         = NO
  56
  57 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
  58 # sources only. Doxygen will then generate output that is more tailored for C.
  59 # For instance, some of the names that are used will be different. The list
  60 # of all members will be omitted, etc.
  61
  62 OPTIMIZE_OUTPUT_FOR_C  = YES
  63
  64 #---------------------------------------------------------------------------
  65 # Build related configuration options
  66 #---------------------------------------------------------------------------
  67
  68 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
  69 # documentation are documented, even if no documentation was available.
  70 # Private class members and static file members will be hidden unless
  71 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
  72
  73 EXTRACT_ALL            = YES
  74
  75 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
  76 # will be included in the documentation.
  77
  78 EXTRACT_PRIVATE        = YES
  79
  80 # If the EXTRACT_STATIC tag is set to YES all static members of a file
  81 # will be included in the documentation.
  82
  83 EXTRACT_STATIC         = YES
  84
  85 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
  86 # defined locally in source files will be included in the documentation.
  87 # If set to NO only classes defined in header files are included.
  88
  89 EXTRACT_LOCAL_CLASSES  = YES
  90
  91 #---------------------------------------------------------------------------
  92 # configuration options related to the input files
  93 #---------------------------------------------------------------------------
  94
  95 # The INPUT tag can be used to specify the files and/or directories that
  96 # contain documented source files. You may enter file names like "myfile.cpp"
  97 # or directories like "/usr/src/myproject". Separate the files or directories
  98 # with spaces.
  99
 100 INPUT                  = ../../src
 101
 102 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 103 # should be searched for input files as well. Possible values are YES and NO.
 104 # If left blank NO is used.
 105
 106 RECURSIVE              = YES
 107
 108 #---------------------------------------------------------------------------
 109 # configuration options related to source browsing
 110 #---------------------------------------------------------------------------
 111
 112 # If the SOURCE_BROWSER tag is set to YES then a list of source files will
 113 # be generated. Documented entities will be cross-referenced with these sources.
 114 # Note: To get rid of all source code in the generated output, make sure also
 115 # VERBATIM_HEADERS is set to NO.
 116
 117 SOURCE_BROWSER         = YES
 118
 119 #---------------------------------------------------------------------------
 120 # Output formats
 121 #---------------------------------------------------------------------------
 122
 123 GENERATE_HTML          = YES
 124
 125 HTML_OUTPUT            = html
 126 HTML_FILE_EXTENSION    = .html
 127 HTML_HEADER            = header.inc.html
 128 HTML_FOOTER            = footer.inc.html
 129 HTML_STYLESHEET        = ngircd-doc.css
 130
 131 GENERATE_HTMLHELP      = NO
 132 GENERATE_LATEX         = NO
 133 GENERATE_RTF           = NO
 134 GENERATE_MAN           = NO
 135 GENERATE_XML           = NO
 136 GENERATE_AUTOGEN_DEF   = NO
 137 GENERATE_PERLMOD       = NO
 138
 139 #---------------------------------------------------------------------------
 140 # Configuration options related to the preprocessor
 141 #---------------------------------------------------------------------------
 142
 143 # The PREDEFINED tag can be used to specify one or more macro names that
 144 # are defined before the preprocessor is started (similar to the -D option of
 145 # gcc). The argument of the tag is a list of macros of the form: name
 146 # or name=definition (no spaces). If the definition and the = are
 147 # omitted =1 is assumed. To prevent a macro definition from being
 148 # undefined via #undef or recursively expanded use the := operator
 149 # instead of the = operator.
 150
 151 PREDEFINED             = CONN_MODULE __client_c__
 152
 153 # -eof-