Doxyfile

   1 # Doxyfile 1.3-rc3
   2
   3 #---------------------------------------------------------------------------
   4 # General configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "BIFE - Build It FastEr"
   7 PROJECT_NUMBER         = 0.5
   8 OUTPUT_DIRECTORY       = doc/api
   9 OUTPUT_LANGUAGE        = English
  10 EXTRACT_ALL            = YES
  11 EXTRACT_PRIVATE        = YES
  12 EXTRACT_STATIC         = YES
  13 EXTRACT_LOCAL_CLASSES  = YES
  14 HIDE_UNDOC_MEMBERS     = NO
  15 HIDE_UNDOC_CLASSES     = NO
  16 HIDE_FRIEND_COMPOUNDS  = NO
  17 HIDE_IN_BODY_DOCS      = NO
  18 BRIEF_MEMBER_DESC      = YES
  19 REPEAT_BRIEF           = YES
  20 ALWAYS_DETAILED_SEC    = YES
  21 INLINE_INHERITED_MEMB  = NO
  22 FULL_PATH_NAMES        = NO
  23 STRIP_FROM_PATH        =
  24 INTERNAL_DOCS          = YES
  25 CASE_SENSE_NAMES       = YES
  26 SHORT_NAMES            = NO
  27 HIDE_SCOPE_NAMES       = NO
  28 VERBATIM_HEADERS       = YES
  29 SHOW_INCLUDE_FILES     = YES
  30 JAVADOC_AUTOBRIEF      = YES
  31 MULTILINE_CPP_IS_BRIEF = NO
  32 DETAILS_AT_TOP         = NO
  33 INHERIT_DOCS           = YES
  34 INLINE_INFO            = YES
  35 SORT_MEMBER_DOCS       = YES
  36 DISTRIBUTE_GROUP_DOC   = NO
  37 TAB_SIZE               = 8
  38 GENERATE_TODOLIST      = YES
  39 GENERATE_TESTLIST      = YES
  40 GENERATE_BUGLIST       = YES
  41 GENERATE_DEPRECATEDLIST= YES
  42 ALIASES                =
  43 ENABLED_SECTIONS       =
  44 MAX_INITIALIZER_LINES  = 30
  45 OPTIMIZE_OUTPUT_FOR_C  = NO
  46 OPTIMIZE_OUTPUT_JAVA   = NO
  47 SHOW_USED_FILES        = YES
  48 #---------------------------------------------------------------------------
  49 # configuration options related to warning and progress messages
  50 #---------------------------------------------------------------------------
  51 QUIET                  = NO
  52 WARNINGS               = YES
  53 WARN_IF_UNDOCUMENTED   = YES
  54 WARN_IF_DOC_ERROR      = YES
  55 WARN_FORMAT            = "$file:$line: $text"
  56 WARN_LOGFILE           = doxygen.warn
  57 #---------------------------------------------------------------------------
  58 # configuration options related to the input files
  59 #---------------------------------------------------------------------------
  60 INPUT                  = src/
  61 FILE_PATTERNS          = *.php
  62 RECURSIVE              = YES
  63 EXCLUDE                = src/BIFE.php
  64 EXCLUDE_SYMLINKS       = NO
  65 EXCLUDE_PATTERNS       =
  66 EXAMPLE_PATH           =
  67 EXAMPLE_PATTERNS       =
  68 EXAMPLE_RECURSIVE      = NO
  69 IMAGE_PATH             =
  70 INPUT_FILTER           =
  71 FILTER_SOURCE_FILES    = NO
  72 #---------------------------------------------------------------------------
  73 # configuration options related to source browsing
  74 #---------------------------------------------------------------------------
  75 SOURCE_BROWSER         = YES
  76 INLINE_SOURCES         = NO
  77 STRIP_CODE_COMMENTS    = YES
  78 REFERENCED_BY_RELATION = YES
  79 REFERENCES_RELATION    = YES
  80 #---------------------------------------------------------------------------
  81 # configuration options related to the alphabetical class index
  82 #---------------------------------------------------------------------------
  83 ALPHABETICAL_INDEX     = YES
  84 COLS_IN_ALPHA_INDEX    = 5
  85 IGNORE_PREFIX          =
  86 #---------------------------------------------------------------------------
  87 # configuration options related to the HTML output
  88 #---------------------------------------------------------------------------
  89 GENERATE_HTML          = YES
  90 HTML_OUTPUT            = html
  91 HTML_FILE_EXTENSION    = .html
  92 HTML_HEADER            =
  93 HTML_FOOTER            =
  94 HTML_STYLESHEET        =
  95 HTML_ALIGN_MEMBERS     = YES
  96 GENERATE_HTMLHELP      = NO
  97 CHM_FILE               =
  98 HHC_LOCATION           =
  99 GENERATE_CHI           = NO
 100 BINARY_TOC             = NO
 101 TOC_EXPAND             = NO
 102 DISABLE_INDEX          = NO
 103 ENUM_VALUES_PER_LINE   = 4
 104 GENERATE_TREEVIEW      = YES
 105 TREEVIEW_WIDTH         = 200
 106 #---------------------------------------------------------------------------
 107 # configuration options related to the LaTeX output
 108 #---------------------------------------------------------------------------
 109 GENERATE_LATEX         = NO
 110 LATEX_OUTPUT           = latex
 111 LATEX_CMD_NAME         = latex
 112 MAKEINDEX_CMD_NAME     = makeindex
 113 COMPACT_LATEX          = NO
 114 PAPER_TYPE             = a4wide
 115 EXTRA_PACKAGES         =
 116 LATEX_HEADER           =
 117 PDF_HYPERLINKS         = NO
 118 USE_PDFLATEX           = NO
 119 LATEX_BATCHMODE        = NO
 120 #---------------------------------------------------------------------------
 121 # configuration options related to the RTF output
 122 #---------------------------------------------------------------------------
 123 GENERATE_RTF           = NO
 124 RTF_OUTPUT             = rtf
 125 COMPACT_RTF            = NO
 126 RTF_HYPERLINKS         = NO
 127 RTF_STYLESHEET_FILE    =
 128 RTF_EXTENSIONS_FILE    =
 129 #---------------------------------------------------------------------------
 130 # configuration options related to the man page output
 131 #---------------------------------------------------------------------------
 132 GENERATE_MAN           = NO
 133 MAN_OUTPUT             = man
 134 MAN_EXTENSION          = .3
 135 MAN_LINKS              = NO
 136 #---------------------------------------------------------------------------
 137 # configuration options related to the XML output
 138 #---------------------------------------------------------------------------
 139 GENERATE_XML           = NO
 140 XML_SCHEMA             =
 141 XML_DTD                =
 142 #---------------------------------------------------------------------------
 143 # configuration options for the AutoGen Definitions output
 144 #---------------------------------------------------------------------------
 145 GENERATE_AUTOGEN_DEF   = NO
 146 #---------------------------------------------------------------------------
 147 # configuration options related to the Perl module output
 148 #---------------------------------------------------------------------------
 149 GENERATE_PERLMOD       = NO
 150 PERLMOD_LATEX          = NO
 151 PERLMOD_PRETTY         = YES
 152 PERLMOD_MAKEVAR_PREFIX =
 153 #---------------------------------------------------------------------------
 154 # Configuration options related to the preprocessor
 155 #---------------------------------------------------------------------------
 156 ENABLE_PREPROCESSING   = YES
 157 MACRO_EXPANSION        = NO
 158 EXPAND_ONLY_PREDEF     = NO
 159 SEARCH_INCLUDES        = YES
 160 INCLUDE_PATH           =
 161 INCLUDE_FILE_PATTERNS  =
 162 PREDEFINED             =
 163 EXPAND_AS_DEFINED      =
 164 SKIP_FUNCTION_MACROS   = YES
 165 #---------------------------------------------------------------------------
 166 # Configuration::addtions related to external references
 167 #---------------------------------------------------------------------------
 168 TAGFILES               =
 169 GENERATE_TAGFILE       =
 170 ALLEXTERNALS           = NO
 171 EXTERNAL_GROUPS        = YES
 172 PERL_PATH              = /usr/bin/perl
 173 #---------------------------------------------------------------------------
 174 # Configuration options related to the dot tool
 175 #---------------------------------------------------------------------------
 176 CLASS_DIAGRAMS         = YES
 177 HIDE_UNDOC_RELATIONS   = YES
 178 HAVE_DOT               = YES
 179 CLASS_GRAPH            = YES
 180 COLLABORATION_GRAPH    = YES
 181 TEMPLATE_RELATIONS     = YES
 182 INCLUDE_GRAPH          = YES
 183 INCLUDED_BY_GRAPH      = YES
 184 GRAPHICAL_HIERARCHY    = YES
 185 DOT_IMAGE_FORMAT       = png
 186 DOT_PATH               =
 187 DOTFILE_DIRS           =
 188 MAX_DOT_GRAPH_WIDTH    = 1024
 189 MAX_DOT_GRAPH_HEIGHT   = 1024
 190 GENERATE_LEGEND        = YES
 191 DOT_CLEANUP            = YES
 192 #---------------------------------------------------------------------------
 193 # Configuration::addtions related to the search engine
 194 #---------------------------------------------------------------------------
 195 SEARCHENGINE           = NO
 196 CGI_NAME               = search.cgi
 197 CGI_URL                =
 198 DOC_URL                =
 199 DOC_ABSPATH            =
 200 BIN_ABSPATH            = /usr/local/bin/
 201 EXT_DOC_PATHS          =