base/Doxyfile

   1 # Doxyfile 1.3.2
   2
   3 #---------------------------------------------------------------------------
   4 # General configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = "BIFE Base"
   7 PROJECT_NUMBER         = 1.0.0beta3
   8 OUTPUT_DIRECTORY       = api
   9 OUTPUT_LANGUAGE        = English
  10 USE_WINDOWS_ENCODING   = NO
  11 EXTRACT_ALL            = YES
  12 EXTRACT_PRIVATE        = YES
  13 EXTRACT_STATIC         = YES
  14 EXTRACT_LOCAL_CLASSES  = YES
  15 HIDE_UNDOC_MEMBERS     = NO
  16 HIDE_UNDOC_CLASSES     = NO
  17 HIDE_FRIEND_COMPOUNDS  = NO
  18 HIDE_IN_BODY_DOCS      = NO
  19 BRIEF_MEMBER_DESC      = YES
  20 REPEAT_BRIEF           = YES
  21 ALWAYS_DETAILED_SEC    = YES
  22 INLINE_INHERITED_MEMB  = NO
  23 FULL_PATH_NAMES        = NO
  24 STRIP_FROM_PATH        =
  25 INTERNAL_DOCS          = YES
  26 CASE_SENSE_NAMES       = YES
  27 SHORT_NAMES            = NO
  28 HIDE_SCOPE_NAMES       = NO
  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               = 4
  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                =
  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 VERBATIM_HEADERS       = YES
  81 #---------------------------------------------------------------------------
  82 # configuration options related to the alphabetical class index
  83 #---------------------------------------------------------------------------
  84 ALPHABETICAL_INDEX     = YES
  85 COLS_IN_ALPHA_INDEX    = 5
  86 IGNORE_PREFIX          =
  87 #---------------------------------------------------------------------------
  88 # configuration options related to the HTML output
  89 #---------------------------------------------------------------------------
  90 GENERATE_HTML          = YES
  91 HTML_OUTPUT            = html
  92 HTML_FILE_EXTENSION    = .html
  93 HTML_HEADER            =
  94 HTML_FOOTER            =
  95 HTML_STYLESHEET        =
  96 HTML_ALIGN_MEMBERS     = YES
  97 GENERATE_HTMLHELP      = NO
  98 CHM_FILE               =
  99 HHC_LOCATION           =
 100 GENERATE_CHI           = NO
 101 BINARY_TOC             = NO
 102 TOC_EXPAND             = NO
 103 DISABLE_INDEX          = NO
 104 ENUM_VALUES_PER_LINE   = 4
 105 GENERATE_TREEVIEW      = YES
 106 TREEVIEW_WIDTH         = 200
 107 #---------------------------------------------------------------------------
 108 # configuration options related to the LaTeX output
 109 #---------------------------------------------------------------------------
 110 GENERATE_LATEX         = NO
 111 LATEX_OUTPUT           = latex
 112 LATEX_CMD_NAME         = latex
 113 MAKEINDEX_CMD_NAME     = makeindex
 114 COMPACT_LATEX          = NO
 115 PAPER_TYPE             = a4wide
 116 EXTRA_PACKAGES         =
 117 LATEX_HEADER           =
 118 PDF_HYPERLINKS         = YES
 119 USE_PDFLATEX           = NO
 120 LATEX_BATCHMODE        = NO
 121 LATEX_HIDE_INDICES     = NO
 122 #---------------------------------------------------------------------------
 123 # configuration options related to the RTF output
 124 #---------------------------------------------------------------------------
 125 GENERATE_RTF           = NO
 126 RTF_OUTPUT             = rtf
 127 COMPACT_RTF            = NO
 128 RTF_HYPERLINKS         = YES
 129 RTF_STYLESHEET_FILE    =
 130 RTF_EXTENSIONS_FILE    =
 131 #---------------------------------------------------------------------------
 132 # configuration options related to the man page output
 133 #---------------------------------------------------------------------------
 134 GENERATE_MAN           = NO
 135 MAN_OUTPUT             = man
 136 MAN_EXTENSION          = .3
 137 MAN_LINKS              = NO
 138 #---------------------------------------------------------------------------
 139 # configuration options related to the XML output
 140 #---------------------------------------------------------------------------
 141 GENERATE_XML           = NO
 142 XML_OUTPUT             = xml
 143 XML_SCHEMA             =
 144 XML_DTD                =
 145 #---------------------------------------------------------------------------
 146 # configuration options for the AutoGen Definitions output
 147 #---------------------------------------------------------------------------
 148 GENERATE_AUTOGEN_DEF   = NO
 149 #---------------------------------------------------------------------------
 150 # configuration options related to the Perl module output
 151 #---------------------------------------------------------------------------
 152 GENERATE_PERLMOD       = NO
 153 PERLMOD_LATEX          = NO
 154 PERLMOD_PRETTY         = YES
 155 PERLMOD_MAKEVAR_PREFIX =
 156 #---------------------------------------------------------------------------
 157 # Configuration options related to the preprocessor
 158 #---------------------------------------------------------------------------
 159 ENABLE_PREPROCESSING   = YES
 160 MACRO_EXPANSION        = NO
 161 EXPAND_ONLY_PREDEF     = NO
 162 SEARCH_INCLUDES        = YES
 163 INCLUDE_PATH           =
 164 INCLUDE_FILE_PATTERNS  =
 165 PREDEFINED             =
 166 EXPAND_AS_DEFINED      =
 167 SKIP_FUNCTION_MACROS   = YES
 168 #---------------------------------------------------------------------------
 169 # Configuration::addtions related to external references
 170 #---------------------------------------------------------------------------
 171 TAGFILES               =
 172 GENERATE_TAGFILE       =
 173 ALLEXTERNALS           = NO
 174 EXTERNAL_GROUPS        = YES
 175 PERL_PATH              = /usr/bin/perl
 176 #---------------------------------------------------------------------------
 177 # Configuration options related to the dot tool
 178 #---------------------------------------------------------------------------
 179 CLASS_DIAGRAMS         = YES
 180 HIDE_UNDOC_RELATIONS   = YES
 181 HAVE_DOT               = YES
 182 CLASS_GRAPH            = YES
 183 COLLABORATION_GRAPH    = YES
 184 UML_LOOK               = YES
 185 TEMPLATE_RELATIONS     = YES
 186 INCLUDE_GRAPH          = YES
 187 INCLUDED_BY_GRAPH      = YES
 188 CALL_GRAPH             = YES
 189 GRAPHICAL_HIERARCHY    = YES
 190 DOT_IMAGE_FORMAT       = png
 191 DOT_PATH               =
 192 DOTFILE_DIRS           =
 193 MAX_DOT_GRAPH_WIDTH    = 1024
 194 MAX_DOT_GRAPH_HEIGHT   = 1024
 195 MAX_DOT_GRAPH_DEPTH    = 0
 196 GENERATE_LEGEND        = YES
 197 DOT_CLEANUP            = YES
 198 #---------------------------------------------------------------------------
 199 # Configuration::addtions related to the search engine
 200 #---------------------------------------------------------------------------
 201 SEARCHENGINE           = NO
 202 CGI_NAME               = search.cgi
 203 CGI_URL                =
 204 DOC_URL                =
 205 DOC_ABSPATH            =
 206 BIN_ABSPATH            = /usr/local/bin/
 207 EXT_DOC_PATHS          =