Doxyfile

   1 # Doxyfile 1.4.7
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "Quassel IRC"
   7 PROJECT_NUMBER         = 0.1
   8 OUTPUT_DIRECTORY       = doc
   9 CREATE_SUBDIRS         = NO
  10 OUTPUT_LANGUAGE        = English
  11 USE_WINDOWS_ENCODING   = NO
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       = "The $name class" \
  15                          "The $name widget" \
  16                          "The $name file" \
  17                          is \
  18                          provides \
  19                          specifies \
  20                          contains \
  21                          represents \
  22                          a \
  23                          an \
  24                          the
  25 ALWAYS_DETAILED_SEC    = YES
  26 INLINE_INHERITED_MEMB  = YES
  27 FULL_PATH_NAMES        = NO
  28 STRIP_FROM_PATH        = /
  29 STRIP_FROM_INC_PATH    =
  30 SHORT_NAMES            = YES
  31 JAVADOC_AUTOBRIEF      = NO
  32 MULTILINE_CPP_IS_BRIEF = NO
  33 DETAILS_AT_TOP         = YES
  34 INHERIT_DOCS           = YES
  35 SEPARATE_MEMBER_PAGES  = NO
  36 TAB_SIZE               = 8
  37 ALIASES                =
  38 OPTIMIZE_OUTPUT_FOR_C  = NO
  39 OPTIMIZE_OUTPUT_JAVA   = NO
  40 BUILTIN_STL_SUPPORT    = NO
  41 DISTRIBUTE_GROUP_DOC   = NO
  42 SUBGROUPING            = YES
  43 #---------------------------------------------------------------------------
  44 # Build related configuration options
  45 #---------------------------------------------------------------------------
  46 EXTRACT_ALL            = YES
  47 EXTRACT_PRIVATE        = YES
  48 EXTRACT_STATIC         = YES
  49 EXTRACT_LOCAL_CLASSES  = NO
  50 EXTRACT_LOCAL_METHODS  = NO
  51 HIDE_UNDOC_MEMBERS     = NO
  52 HIDE_UNDOC_CLASSES     = NO
  53 HIDE_FRIEND_COMPOUNDS  = NO
  54 HIDE_IN_BODY_DOCS      = NO
  55 INTERNAL_DOCS          = YES
  56 CASE_SENSE_NAMES       = YES
  57 HIDE_SCOPE_NAMES       = YES
  58 SHOW_INCLUDE_FILES     = YES
  59 INLINE_INFO            = YES
  60 SORT_MEMBER_DOCS       = NO
  61 SORT_BRIEF_DOCS        = NO
  62 SORT_BY_SCOPE_NAME     = NO
  63 GENERATE_TODOLIST      = YES
  64 GENERATE_TESTLIST      = YES
  65 GENERATE_BUGLIST       = YES
  66 GENERATE_DEPRECATEDLIST= YES
  67 ENABLED_SECTIONS       =
  68 MAX_INITIALIZER_LINES  = 30
  69 SHOW_USED_FILES        = YES
  70 SHOW_DIRECTORIES       = YES
  71 FILE_VERSION_FILTER    =
  72 #---------------------------------------------------------------------------
  73 # configuration options related to warning and progress messages
  74 #---------------------------------------------------------------------------
  75 QUIET                  = YES
  76 WARNINGS               = YES
  77 WARN_IF_UNDOCUMENTED   = YES
  78 WARN_IF_DOC_ERROR      = YES
  79 WARN_NO_PARAMDOC       = NO
  80 WARN_FORMAT            = "$file:$line: $text"
  81 WARN_LOGFILE           =
  82 #---------------------------------------------------------------------------
  83 # configuration options related to the input files
  84 #---------------------------------------------------------------------------
  85 INPUT                  = /home/sputnick/shared/Development/quassel/
  86 FILE_PATTERNS          = *.c \
  87                          *.cc \
  88                          *.cxx \
  89                          *.cpp \
  90                          *.c++ \
  91                          *.java \
  92                          *.ii \
  93                          *.ixx \
  94                          *.ipp \
  95                          *.i++ \
  96                          *.inl \
  97                          *.h \
  98                          *.hh \
  99                          *.hxx \
 100                          *.hpp \
 101                          *.h++ \
 102                          *.idl \
 103                          *.odl \
 104                          *.cs \
 105                          *.php \
 106                          *.php3 \
 107                          *.inc \
 108                          *.m \
 109                          *.mm \
 110                          *.dox \
 111                          *.C \
 112                          *.CC \
 113                          *.C++ \
 114                          *.II \
 115                          *.I++ \
 116                          *.H \
 117                          *.HH \
 118                          *.H++ \
 119                          *.CS \
 120                          *.PHP \
 121                          *.PHP3 \
 122                          *.M \
 123                          *.MM \
 124                          *.C \
 125                          *.H \
 126                          *.tlh \
 127                          *.diff \
 128                          *.patch \
 129                          *.moc \
 130                          *.xpm \
 131                          *.dox
 132 RECURSIVE              = YES
 133 EXCLUDE                =
 134 EXCLUDE_SYMLINKS       = NO
 135 EXCLUDE_PATTERNS       =
 136 EXAMPLE_PATH           =
 137 EXAMPLE_PATTERNS       = *
 138 EXAMPLE_RECURSIVE      = NO
 139 IMAGE_PATH             =
 140 INPUT_FILTER           =
 141 FILTER_PATTERNS        =
 142 FILTER_SOURCE_FILES    = NO
 143 #---------------------------------------------------------------------------
 144 # configuration options related to source browsing
 145 #---------------------------------------------------------------------------
 146 SOURCE_BROWSER         = YES
 147 INLINE_SOURCES         = NO
 148 STRIP_CODE_COMMENTS    = YES
 149 REFERENCED_BY_RELATION = YES
 150 REFERENCES_RELATION    = YES
 151 REFERENCES_LINK_SOURCE = YES
 152 USE_HTAGS              = NO
 153 VERBATIM_HEADERS       = YES
 154 #---------------------------------------------------------------------------
 155 # configuration options related to the alphabetical class index
 156 #---------------------------------------------------------------------------
 157 ALPHABETICAL_INDEX     = YES
 158 COLS_IN_ALPHA_INDEX    = 5
 159 IGNORE_PREFIX          =
 160 #---------------------------------------------------------------------------
 161 # configuration options related to the HTML output
 162 #---------------------------------------------------------------------------
 163 GENERATE_HTML          = YES
 164 HTML_OUTPUT            = html
 165 HTML_FILE_EXTENSION    = .html
 166 HTML_HEADER            =
 167 HTML_FOOTER            =
 168 HTML_STYLESHEET        =
 169 HTML_ALIGN_MEMBERS     = YES
 170 GENERATE_HTMLHELP      = NO
 171 CHM_FILE               =
 172 HHC_LOCATION           =
 173 GENERATE_CHI           = NO
 174 BINARY_TOC             = NO
 175 TOC_EXPAND             = NO
 176 DISABLE_INDEX          = NO
 177 ENUM_VALUES_PER_LINE   = 4
 178 GENERATE_TREEVIEW      = NO
 179 TREEVIEW_WIDTH         = 250
 180 #---------------------------------------------------------------------------
 181 # configuration options related to the LaTeX output
 182 #---------------------------------------------------------------------------
 183 GENERATE_LATEX         = NO
 184 LATEX_OUTPUT           = latex
 185 LATEX_CMD_NAME         = latex
 186 MAKEINDEX_CMD_NAME     = makeindex
 187 COMPACT_LATEX          = NO
 188 PAPER_TYPE             = a4wide
 189 EXTRA_PACKAGES         =
 190 LATEX_HEADER           =
 191 PDF_HYPERLINKS         = NO
 192 USE_PDFLATEX           = YES
 193 LATEX_BATCHMODE        = NO
 194 LATEX_HIDE_INDICES     = NO
 195 #---------------------------------------------------------------------------
 196 # configuration options related to the RTF output
 197 #---------------------------------------------------------------------------
 198 GENERATE_RTF           = NO
 199 RTF_OUTPUT             = rtf
 200 COMPACT_RTF            = NO
 201 RTF_HYPERLINKS         = YES
 202 RTF_STYLESHEET_FILE    =
 203 RTF_EXTENSIONS_FILE    =
 204 #---------------------------------------------------------------------------
 205 # configuration options related to the man page output
 206 #---------------------------------------------------------------------------
 207 GENERATE_MAN           = NO
 208 MAN_OUTPUT             = man
 209 MAN_EXTENSION          = .3
 210 MAN_LINKS              = NO
 211 #---------------------------------------------------------------------------
 212 # configuration options related to the XML output
 213 #---------------------------------------------------------------------------
 214 GENERATE_XML           = NO
 215 XML_OUTPUT             = xml
 216 XML_SCHEMA             =
 217 XML_DTD                =
 218 XML_PROGRAMLISTING     = YES
 219 #---------------------------------------------------------------------------
 220 # configuration options for the AutoGen Definitions output
 221 #---------------------------------------------------------------------------
 222 GENERATE_AUTOGEN_DEF   = NO
 223 #---------------------------------------------------------------------------
 224 # configuration options related to the Perl module output
 225 #---------------------------------------------------------------------------
 226 GENERATE_PERLMOD       = NO
 227 PERLMOD_LATEX          = NO
 228 PERLMOD_PRETTY         = YES
 229 PERLMOD_MAKEVAR_PREFIX =
 230 #---------------------------------------------------------------------------
 231 # Configuration options related to the preprocessor
 232 #---------------------------------------------------------------------------
 233 ENABLE_PREPROCESSING   = NO
 234 MACRO_EXPANSION        = NO
 235 EXPAND_ONLY_PREDEF     = YES
 236 SEARCH_INCLUDES        = YES
 237 INCLUDE_PATH           =
 238 INCLUDE_FILE_PATTERNS  =
 239 PREDEFINED             =
 240 EXPAND_AS_DEFINED      =
 241 SKIP_FUNCTION_MACROS   = YES
 242 #---------------------------------------------------------------------------
 243 # Configuration::additions related to external references
 244 #---------------------------------------------------------------------------
 245 TAGFILES               =
 246 GENERATE_TAGFILE       = quassel.tag
 247 ALLEXTERNALS           = YES
 248 EXTERNAL_GROUPS        = YES
 249 PERL_PATH              = /usr/bin/perl
 250 #---------------------------------------------------------------------------
 251 # Configuration options related to the dot tool
 252 #---------------------------------------------------------------------------
 253 CLASS_DIAGRAMS         = YES
 254 HIDE_UNDOC_RELATIONS   = YES
 255 HAVE_DOT               = YES
 256 CLASS_GRAPH            = YES
 257 COLLABORATION_GRAPH    = YES
 258 GROUP_GRAPHS           = YES
 259 UML_LOOK               = YES
 260 TEMPLATE_RELATIONS     = NO
 261 INCLUDE_GRAPH          = YES
 262 INCLUDED_BY_GRAPH      = YES
 263 CALL_GRAPH             = NO
 264 CALLER_GRAPH           = NO
 265 GRAPHICAL_HIERARCHY    = YES
 266 DIRECTORY_GRAPH        = YES
 267 DOT_IMAGE_FORMAT       = png
 268 DOT_PATH               =
 269 DOTFILE_DIRS           =
 270 MAX_DOT_GRAPH_WIDTH    = 1024
 271 MAX_DOT_GRAPH_HEIGHT   = 1024
 272 MAX_DOT_GRAPH_DEPTH    = 1000
 273 DOT_TRANSPARENT        = NO
 274 DOT_MULTI_TARGETS      = NO
 275 GENERATE_LEGEND        = YES
 276 DOT_CLEANUP            = YES
 277 #---------------------------------------------------------------------------
 278 # Configuration::additions related to the search engine
 279 #---------------------------------------------------------------------------
 280 SEARCHENGINE           = NO