Doxyfile

   1 # vim: set expandtab tabstop=4 softtabstop=4 shiftwidth=4:
   2 # +--------------------------------------------------------------------+
   3 # |                       BIFE - Buil It FastEr                        |
   4 # +--------------------------------------------------------------------+
   5 # | This file is part of BIFE.                                         |
   6 # |                                                                    |
   7 # | BIFE is free software; you can redistribute it and/or modify it    |
   8 # | under the terms of the GNU General Public License as published by  |
   9 # | the Free Software Foundation; either version 2 of the License, or  |
  10 # | (at your option) any later version.                                |
  11 # |                                                                    |
  12 # | BIFE is distributed in the hope that it will be useful, but        |
  13 # | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  14 # | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   |
  15 # | General Public License for more details.                           |
  16 # |                                                                    |
  17 # | You should have received a copy of the GNU General Public License  |
  18 # | along with Hooks; if not, write to the Free Software Foundation,   |
  19 # | Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA      |
  20 # +--------------------------------------------------------------------+
  21 # | Created: Mon May 19 00:16:56 ART 2003                              |
  22 # | Authors: Leandro Lucarella <luca@lugmen.org.ar>                    |
  23 # +--------------------------------------------------------------------+
  24 #
  25 # $Id$
  26 #
  27
  28 # Doxyfile 1.3-rc3
  29 #---------------------------------------------------------------------------
  30 # General configuration options
  31 #---------------------------------------------------------------------------
  32 PROJECT_NAME           = "BIFE - Build It FastEr"
  33 PROJECT_NUMBER         = 0.8
  34 OUTPUT_DIRECTORY       = doc/api
  35 OUTPUT_LANGUAGE        = English
  36 EXTRACT_ALL            = YES
  37 EXTRACT_PRIVATE        = YES
  38 EXTRACT_STATIC         = YES
  39 EXTRACT_LOCAL_CLASSES  = YES
  40 HIDE_UNDOC_MEMBERS     = NO
  41 HIDE_UNDOC_CLASSES     = NO
  42 HIDE_FRIEND_COMPOUNDS  = NO
  43 HIDE_IN_BODY_DOCS      = NO
  44 BRIEF_MEMBER_DESC      = YES
  45 REPEAT_BRIEF           = YES
  46 ALWAYS_DETAILED_SEC    = YES
  47 INLINE_INHERITED_MEMB  = NO
  48 FULL_PATH_NAMES        = NO
  49 STRIP_FROM_PATH        =
  50 INTERNAL_DOCS          = YES
  51 CASE_SENSE_NAMES       = YES
  52 SHORT_NAMES            = NO
  53 HIDE_SCOPE_NAMES       = NO
  54 VERBATIM_HEADERS       = YES
  55 SHOW_INCLUDE_FILES     = YES
  56 JAVADOC_AUTOBRIEF      = YES
  57 MULTILINE_CPP_IS_BRIEF = NO
  58 DETAILS_AT_TOP         = NO
  59 INHERIT_DOCS           = YES
  60 INLINE_INFO            = YES
  61 SORT_MEMBER_DOCS       = YES
  62 DISTRIBUTE_GROUP_DOC   = NO
  63 TAB_SIZE               = 8
  64 GENERATE_TODOLIST      = YES
  65 GENERATE_TESTLIST      = YES
  66 GENERATE_BUGLIST       = YES
  67 GENERATE_DEPRECATEDLIST= YES
  68 ALIASES                =
  69 ENABLED_SECTIONS       =
  70 MAX_INITIALIZER_LINES  = 30
  71 OPTIMIZE_OUTPUT_FOR_C  = NO
  72 OPTIMIZE_OUTPUT_JAVA   = NO
  73 SHOW_USED_FILES        = YES
  74 #---------------------------------------------------------------------------
  75 # configuration options related to warning and progress messages
  76 #---------------------------------------------------------------------------
  77 QUIET                  = NO
  78 WARNINGS               = YES
  79 WARN_IF_UNDOCUMENTED   = YES
  80 WARN_IF_DOC_ERROR      = YES
  81 WARN_FORMAT            = "$file:$line: $text"
  82 WARN_LOGFILE           = doxygen.warn
  83 #---------------------------------------------------------------------------
  84 # configuration options related to the input files
  85 #---------------------------------------------------------------------------
  86 INPUT                  = src/
  87 FILE_PATTERNS          = *.php
  88 RECURSIVE              = YES
  89 EXCLUDE                = src/BIFE.php
  90 EXCLUDE_SYMLINKS       = NO
  91 EXCLUDE_PATTERNS       =
  92 EXAMPLE_PATH           =
  93 EXAMPLE_PATTERNS       =
  94 EXAMPLE_RECURSIVE      = NO
  95 IMAGE_PATH             =
  96 INPUT_FILTER           =
  97 FILTER_SOURCE_FILES    = NO
  98 #---------------------------------------------------------------------------
  99 # configuration options related to source browsing
 100 #---------------------------------------------------------------------------
 101 SOURCE_BROWSER         = YES
 102 INLINE_SOURCES         = NO
 103 STRIP_CODE_COMMENTS    = YES
 104 REFERENCED_BY_RELATION = YES
 105 REFERENCES_RELATION    = YES
 106 #---------------------------------------------------------------------------
 107 # configuration options related to the alphabetical class index
 108 #---------------------------------------------------------------------------
 109 ALPHABETICAL_INDEX     = YES
 110 COLS_IN_ALPHA_INDEX    = 5
 111 IGNORE_PREFIX          =
 112 #---------------------------------------------------------------------------
 113 # configuration options related to the HTML output
 114 #---------------------------------------------------------------------------
 115 GENERATE_HTML          = YES
 116 HTML_OUTPUT            = html
 117 HTML_FILE_EXTENSION    = .html
 118 HTML_HEADER            =
 119 HTML_FOOTER            =
 120 HTML_STYLESHEET        =
 121 HTML_ALIGN_MEMBERS     = YES
 122 GENERATE_HTMLHELP      = NO
 123 CHM_FILE               =
 124 HHC_LOCATION           =
 125 GENERATE_CHI           = NO
 126 BINARY_TOC             = NO
 127 TOC_EXPAND             = NO
 128 DISABLE_INDEX          = NO
 129 ENUM_VALUES_PER_LINE   = 4
 130 GENERATE_TREEVIEW      = YES
 131 TREEVIEW_WIDTH         = 200
 132 #---------------------------------------------------------------------------
 133 # configuration options related to the LaTeX output
 134 #---------------------------------------------------------------------------
 135 GENERATE_LATEX         = NO
 136 LATEX_OUTPUT           = latex
 137 LATEX_CMD_NAME         = latex
 138 MAKEINDEX_CMD_NAME     = makeindex
 139 COMPACT_LATEX          = NO
 140 PAPER_TYPE             = a4wide
 141 EXTRA_PACKAGES         =
 142 LATEX_HEADER           =
 143 PDF_HYPERLINKS         = YES
 144 USE_PDFLATEX           = NO
 145 LATEX_BATCHMODE        = NO
 146 #---------------------------------------------------------------------------
 147 # configuration options related to the RTF output
 148 #---------------------------------------------------------------------------
 149 GENERATE_RTF           = NO
 150 RTF_OUTPUT             = rtf
 151 COMPACT_RTF            = NO
 152 RTF_HYPERLINKS         = YES
 153 RTF_STYLESHEET_FILE    =
 154 RTF_EXTENSIONS_FILE    =
 155 #---------------------------------------------------------------------------
 156 # configuration options related to the man page output
 157 #---------------------------------------------------------------------------
 158 GENERATE_MAN           = NO
 159 MAN_OUTPUT             = man
 160 MAN_EXTENSION          = .3
 161 MAN_LINKS              = NO
 162 #---------------------------------------------------------------------------
 163 # configuration options related to the XML output
 164 #---------------------------------------------------------------------------
 165 GENERATE_XML           = NO
 166 XML_SCHEMA             =
 167 XML_DTD                =
 168 #---------------------------------------------------------------------------
 169 # configuration options for the AutoGen Definitions output
 170 #---------------------------------------------------------------------------
 171 GENERATE_AUTOGEN_DEF   = NO
 172 #---------------------------------------------------------------------------
 173 # configuration options related to the Perl module output
 174 #---------------------------------------------------------------------------
 175 GENERATE_PERLMOD       = NO
 176 PERLMOD_LATEX          = NO
 177 PERLMOD_PRETTY         = YES
 178 PERLMOD_MAKEVAR_PREFIX =
 179 #---------------------------------------------------------------------------
 180 # Configuration options related to the preprocessor
 181 #---------------------------------------------------------------------------
 182 ENABLE_PREPROCESSING   = YES
 183 MACRO_EXPANSION        = NO
 184 EXPAND_ONLY_PREDEF     = NO
 185 SEARCH_INCLUDES        = YES
 186 INCLUDE_PATH           =
 187 INCLUDE_FILE_PATTERNS  =
 188 PREDEFINED             =
 189 EXPAND_AS_DEFINED      =
 190 SKIP_FUNCTION_MACROS   = YES
 191 #---------------------------------------------------------------------------
 192 # Configuration::addtions related to external references
 193 #---------------------------------------------------------------------------
 194 TAGFILES               =
 195 GENERATE_TAGFILE       =
 196 ALLEXTERNALS           = NO
 197 EXTERNAL_GROUPS        = YES
 198 PERL_PATH              = /usr/bin/perl
 199 #---------------------------------------------------------------------------
 200 # Configuration options related to the dot tool
 201 #---------------------------------------------------------------------------
 202 CLASS_DIAGRAMS         = YES
 203 HIDE_UNDOC_RELATIONS   = YES
 204 HAVE_DOT               = YES
 205 CLASS_GRAPH            = YES
 206 COLLABORATION_GRAPH    = YES
 207 TEMPLATE_RELATIONS     = YES
 208 INCLUDE_GRAPH          = YES
 209 INCLUDED_BY_GRAPH      = YES
 210 GRAPHICAL_HIERARCHY    = YES
 211 DOT_IMAGE_FORMAT       = png
 212 DOT_PATH               =
 213 DOTFILE_DIRS           =
 214 MAX_DOT_GRAPH_WIDTH    = 1024
 215 MAX_DOT_GRAPH_HEIGHT   = 1024
 216 GENERATE_LEGEND        = YES
 217 DOT_CLEANUP            = YES
 218 #---------------------------------------------------------------------------
 219 # Configuration::addtions related to the search engine
 220 #---------------------------------------------------------------------------
 221 SEARCHENGINE           = NO
 222 CGI_NAME               = search.cgi
 223 CGI_URL                =
 224 DOC_URL                =
 225 DOC_ABSPATH            =
 226 BIN_ABSPATH            = /usr/local/bin/
 227 EXT_DOC_PATHS          =