site_scons/Doxyfile.template

   1 # Doxyfile 1.4.2
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = ""
   7 PROJECT_NUMBER         = "Version 0.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           = NO
  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    = NO
  26 INLINE_INHERITED_MEMB  = NO
  27 FULL_PATH_NAMES        = NO
  28 STRIP_FROM_PATH        =
  29 STRIP_FROM_INC_PATH    =
  30 SHORT_NAMES            = NO
  31 JAVADOC_AUTOBRIEF      = NO
  32 MULTILINE_CPP_IS_BRIEF = NO
  33 DETAILS_AT_TOP         = YES
  34 INHERIT_DOCS           = YES
  35 DISTRIBUTE_GROUP_DOC   = NO
  36 SEPARATE_MEMBER_PAGES  = NO
  37 TAB_SIZE               = 8
  38 ALIASES                =
  39 OPTIMIZE_OUTPUT_FOR_C  = NO
  40 OPTIMIZE_OUTPUT_JAVA   = NO
  41 SUBGROUPING            = YES
  42 #---------------------------------------------------------------------------
  43 # Build related configuration options
  44 #---------------------------------------------------------------------------
  45 EXTRACT_ALL            = YES
  46 EXTRACT_PRIVATE        = YES
  47 EXTRACT_STATIC         = YES
  48 EXTRACT_LOCAL_CLASSES  = YES
  49 EXTRACT_LOCAL_METHODS  = NO
  50 HIDE_UNDOC_MEMBERS     = NO
  51 HIDE_UNDOC_CLASSES     = NO
  52 HIDE_FRIEND_COMPOUNDS  = NO
  53 HIDE_IN_BODY_DOCS      = NO
  54 INTERNAL_DOCS          = YES
  55 CASE_SENSE_NAMES       = YES
  56 HIDE_SCOPE_NAMES       = NO
  57 SHOW_INCLUDE_FILES     = YES
  58 INLINE_INFO            = YES
  59 SORT_MEMBER_DOCS       = YES
  60 SORT_BRIEF_DOCS        = NO
  61 SORT_BY_SCOPE_NAME     = YES
  62 GENERATE_TODOLIST      = YES
  63 GENERATE_TESTLIST      = YES
  64 GENERATE_BUGLIST       = YES
  65 GENERATE_DEPRECATEDLIST= YES
  66 ENABLED_SECTIONS       =
  67 MAX_INITIALIZER_LINES  = 30
  68 SHOW_USED_FILES        = YES
  69 SHOW_DIRECTORIES       = YES
  70 FILE_VERSION_FILTER    =
  71 #---------------------------------------------------------------------------
  72 # configuration options related to warning and progress messages
  73 #---------------------------------------------------------------------------
  74 QUIET                  = NO
  75 WARNINGS               = YES
  76 WARN_IF_UNDOCUMENTED   = NO
  77 WARN_IF_DOC_ERROR      = YES
  78 WARN_NO_PARAMDOC       = NO
  79 WARN_FORMAT            = "$file:$line: $text"
  80 WARN_LOGFILE           =
  81 #---------------------------------------------------------------------------
  82 # configuration options related to the input files
  83 #---------------------------------------------------------------------------
  84 INPUT                  = .
  85 FILE_PATTERNS          = *.c \
  86                          *.cc \
  87                          *.cxx \
  88                          *.cpp \
  89                          *.c++ \
  90                          *.d \
  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                          *.cci \
 125                          *.ct \
 126                          *.cti \
 127                          *.ih \
 128                          *.mpp
 129 RECURSIVE              = NO
 130 EXCLUDE                = doc
 131 EXCLUDE_SYMLINKS       = NO
 132 EXCLUDE_PATTERNS       = *.test.cc
 133 EXAMPLE_PATH           =
 134 EXAMPLE_PATTERNS       = *
 135 EXAMPLE_RECURSIVE      = NO
 136 IMAGE_PATH             =
 137 INPUT_FILTER           =
 138 FILTER_PATTERNS        =
 139 FILTER_SOURCE_FILES    = NO
 140 #---------------------------------------------------------------------------
 141 # configuration options related to source browsing
 142 #---------------------------------------------------------------------------
 143 SOURCE_BROWSER         = YES
 144 INLINE_SOURCES         = NO
 145 STRIP_CODE_COMMENTS    = YES
 146 REFERENCED_BY_RELATION = YES
 147 REFERENCES_RELATION    = YES
 148 VERBATIM_HEADERS       = YES
 149 #---------------------------------------------------------------------------
 150 # configuration options related to the alphabetical class index
 151 #---------------------------------------------------------------------------
 152 ALPHABETICAL_INDEX     = YES
 153 COLS_IN_ALPHA_INDEX    = 5
 154 IGNORE_PREFIX          =
 155 #---------------------------------------------------------------------------
 156 # configuration options related to the HTML output
 157 #---------------------------------------------------------------------------
 158 GENERATE_HTML          = YES
 159 HTML_OUTPUT            = html
 160 HTML_FILE_EXTENSION    = .html
 161 HTML_HEADER            =
 162 HTML_FOOTER            =
 163 HTML_STYLESHEET        =
 164 HTML_ALIGN_MEMBERS     = YES
 165 GENERATE_HTMLHELP      = NO
 166 CHM_FILE               =
 167 HHC_LOCATION           =
 168 GENERATE_CHI           = NO
 169 BINARY_TOC             = NO
 170 TOC_EXPAND             = NO
 171 DISABLE_INDEX          = NO
 172 ENUM_VALUES_PER_LINE   = 4
 173 GENERATE_TREEVIEW      = NO
 174 TREEVIEW_WIDTH         = 250
 175 #---------------------------------------------------------------------------
 176 # configuration options related to the LaTeX output
 177 #---------------------------------------------------------------------------
 178 GENERATE_LATEX         = NO
 179 LATEX_OUTPUT           = latex
 180 LATEX_CMD_NAME         = latex
 181 MAKEINDEX_CMD_NAME     = makeindex
 182 COMPACT_LATEX          = NO
 183 PAPER_TYPE             = a4wide
 184 EXTRA_PACKAGES         =
 185 LATEX_HEADER           =
 186 PDF_HYPERLINKS         = NO
 187 USE_PDFLATEX           = NO
 188 LATEX_BATCHMODE        = NO
 189 LATEX_HIDE_INDICES     = NO
 190 #---------------------------------------------------------------------------
 191 # configuration options related to the RTF output
 192 #---------------------------------------------------------------------------
 193 GENERATE_RTF           = NO
 194 RTF_OUTPUT             = rtf
 195 COMPACT_RTF            = NO
 196 RTF_HYPERLINKS         = NO
 197 RTF_STYLESHEET_FILE    =
 198 RTF_EXTENSIONS_FILE    =
 199 #---------------------------------------------------------------------------
 200 # configuration options related to the man page output
 201 #---------------------------------------------------------------------------
 202 GENERATE_MAN           = NO
 203 MAN_OUTPUT             = man
 204 MAN_EXTENSION          = .3
 205 MAN_LINKS              = NO
 206 #---------------------------------------------------------------------------
 207 # configuration options related to the XML output
 208 #---------------------------------------------------------------------------
 209 GENERATE_XML           = NO
 210 XML_OUTPUT             = xml
 211 XML_SCHEMA             =
 212 XML_DTD                =
 213 XML_PROGRAMLISTING     = YES
 214 #---------------------------------------------------------------------------
 215 # configuration options for the AutoGen Definitions output
 216 #---------------------------------------------------------------------------
 217 GENERATE_AUTOGEN_DEF   = NO
 218 #---------------------------------------------------------------------------
 219 # configuration options related to the Perl module output
 220 #---------------------------------------------------------------------------
 221 GENERATE_PERLMOD       = NO
 222 PERLMOD_LATEX          = NO
 223 PERLMOD_PRETTY         = YES
 224 PERLMOD_MAKEVAR_PREFIX =
 225 #---------------------------------------------------------------------------
 226 # Configuration options related to the preprocessor
 227 #---------------------------------------------------------------------------
 228 ENABLE_PREPROCESSING   = YES
 229 MACRO_EXPANSION        = YES
 230 EXPAND_ONLY_PREDEF     = YES
 231 SEARCH_INCLUDES        = YES
 232 INCLUDE_PATH           = libs
 233 INCLUDE_FILE_PATTERNS  =
 234 PREDEFINED             = DOXYGEN
 235 EXPAND_AS_DEFINED      = DefineCommand
 236 SKIP_FUNCTION_MACROS   = YES
 237 #---------------------------------------------------------------------------
 238 # Configuration::additions related to external references
 239 #---------------------------------------------------------------------------
 240 TAGFILES               =
 241 GENERATE_TAGFILE       =
 242 ALLEXTERNALS           = NO
 243 EXTERNAL_GROUPS        = YES
 244 PERL_PATH              = /usr/bin/perl
 245 #---------------------------------------------------------------------------
 246 # Configuration options related to the dot tool
 247 #---------------------------------------------------------------------------
 248 CLASS_DIAGRAMS         = YES
 249 HIDE_UNDOC_RELATIONS   = NO
 250 HAVE_DOT               = YES
 251 CLASS_GRAPH            = YES
 252 COLLABORATION_GRAPH    = YES
 253 GROUP_GRAPHS           = YES
 254 UML_LOOK               = NO
 255 TEMPLATE_RELATIONS     = NO
 256 INCLUDE_GRAPH          = YES
 257 INCLUDED_BY_GRAPH      = YES
 258 CALL_GRAPH             = NO
 259 GRAPHICAL_HIERARCHY    = NO
 260 DIRECTORY_GRAPH        = NO
 261 DOT_IMAGE_FORMAT       = png
 262 DOT_PATH               =
 263 DOTFILE_DIRS           =
 264 MAX_DOT_GRAPH_WIDTH    = 800
 265 MAX_DOT_GRAPH_HEIGHT   = 1200
 266 MAX_DOT_GRAPH_DEPTH    = 1000
 267 DOT_TRANSPARENT        = NO
 268 DOT_MULTI_TARGETS      = YES
 269 GENERATE_LEGEND        = YES
 270 DOT_CLEANUP            = NO
 271 #---------------------------------------------------------------------------
 272 # Configuration::additions related to the search engine
 273 #---------------------------------------------------------------------------
 274 SEARCHENGINE           = NO