Doxyfile

   1 # Doxyfile 1.4.6
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = SuperTux
   7 PROJECT_NUMBER         = SVN
   8 OUTPUT_DIRECTORY       = docs/doxygen
   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    = NO
  26 INLINE_INHERITED_MEMB  = NO
  27 FULL_PATH_NAMES        = YES
  28 STRIP_FROM_PATH        =
  29 STRIP_FROM_INC_PATH    =
  30 SHORT_NAMES            = NO
  31 JAVADOC_AUTOBRIEF      = YES
  32 MULTILINE_CPP_IS_BRIEF = NO
  33 DETAILS_AT_TOP         = NO
  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    = YES
  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  = YES
  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          = NO
  56 CASE_SENSE_NAMES       = YES
  57 HIDE_SCOPE_NAMES       = NO
  58 SHOW_INCLUDE_FILES     = YES
  59 INLINE_INFO            = YES
  60 SORT_MEMBER_DOCS       = YES
  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       = NO
  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                  = src/
  86 FILE_PATTERNS          = *.cpp \
  87                          *.hpp
  88 RECURSIVE              = YES
  89 EXCLUDE                =
  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_PATTERNS        =
  98 FILTER_SOURCE_FILES    = NO
  99 #---------------------------------------------------------------------------
 100 # configuration options related to source browsing
 101 #---------------------------------------------------------------------------
 102 SOURCE_BROWSER         = YES
 103 INLINE_SOURCES         = YES
 104 STRIP_CODE_COMMENTS    = YES
 105 REFERENCED_BY_RELATION = YES
 106 REFERENCES_RELATION    = YES
 107 USE_HTAGS              = NO
 108 VERBATIM_HEADERS       = YES
 109 #---------------------------------------------------------------------------
 110 # configuration options related to the alphabetical class index
 111 #---------------------------------------------------------------------------
 112 ALPHABETICAL_INDEX     = NO
 113 COLS_IN_ALPHA_INDEX    = 5
 114 IGNORE_PREFIX          =
 115 #---------------------------------------------------------------------------
 116 # configuration options related to the HTML output
 117 #---------------------------------------------------------------------------
 118 GENERATE_HTML          = YES
 119 HTML_OUTPUT            = html
 120 HTML_FILE_EXTENSION    = .html
 121 HTML_HEADER            =
 122 HTML_FOOTER            =
 123 HTML_STYLESHEET        =
 124 HTML_ALIGN_MEMBERS     = YES
 125 GENERATE_HTMLHELP      = NO
 126 CHM_FILE               =
 127 HHC_LOCATION           =
 128 GENERATE_CHI           = NO
 129 BINARY_TOC             = NO
 130 TOC_EXPAND             = NO
 131 DISABLE_INDEX          = NO
 132 ENUM_VALUES_PER_LINE   = 4
 133 GENERATE_TREEVIEW      = YES
 134 TREEVIEW_WIDTH         = 250
 135 #---------------------------------------------------------------------------
 136 # configuration options related to the LaTeX output
 137 #---------------------------------------------------------------------------
 138 GENERATE_LATEX         = NO
 139 LATEX_OUTPUT           = latex
 140 LATEX_CMD_NAME         = latex
 141 MAKEINDEX_CMD_NAME     = makeindex
 142 COMPACT_LATEX          = NO
 143 PAPER_TYPE             = a4wide
 144 EXTRA_PACKAGES         =
 145 LATEX_HEADER           =
 146 PDF_HYPERLINKS         = NO
 147 USE_PDFLATEX           = NO
 148 LATEX_BATCHMODE        = NO
 149 LATEX_HIDE_INDICES     = NO
 150 #---------------------------------------------------------------------------
 151 # configuration options related to the RTF output
 152 #---------------------------------------------------------------------------
 153 GENERATE_RTF           = NO
 154 RTF_OUTPUT             = rtf
 155 COMPACT_RTF            = NO
 156 RTF_HYPERLINKS         = NO
 157 RTF_STYLESHEET_FILE    =
 158 RTF_EXTENSIONS_FILE    =
 159 #---------------------------------------------------------------------------
 160 # configuration options related to the man page output
 161 #---------------------------------------------------------------------------
 162 GENERATE_MAN           = NO
 163 MAN_OUTPUT             = man
 164 MAN_EXTENSION          = .3
 165 MAN_LINKS              = NO
 166 #---------------------------------------------------------------------------
 167 # configuration options related to the XML output
 168 #---------------------------------------------------------------------------
 169 GENERATE_XML           = NO
 170 XML_OUTPUT             = xml
 171 XML_SCHEMA             =
 172 XML_DTD                =
 173 XML_PROGRAMLISTING     = YES
 174 #---------------------------------------------------------------------------
 175 # configuration options for the AutoGen Definitions output
 176 #---------------------------------------------------------------------------
 177 GENERATE_AUTOGEN_DEF   = NO
 178 #---------------------------------------------------------------------------
 179 # configuration options related to the Perl module output
 180 #---------------------------------------------------------------------------
 181 GENERATE_PERLMOD       = NO
 182 PERLMOD_LATEX          = NO
 183 PERLMOD_PRETTY         = YES
 184 PERLMOD_MAKEVAR_PREFIX =
 185 #---------------------------------------------------------------------------
 186 # Configuration options related to the preprocessor
 187 #---------------------------------------------------------------------------
 188 ENABLE_PREPROCESSING   = YES
 189 MACRO_EXPANSION        = NO
 190 EXPAND_ONLY_PREDEF     = NO
 191 SEARCH_INCLUDES        = YES
 192 INCLUDE_PATH           =
 193 INCLUDE_FILE_PATTERNS  =
 194 PREDEFINED             =
 195 EXPAND_AS_DEFINED      =
 196 SKIP_FUNCTION_MACROS   = YES
 197 #---------------------------------------------------------------------------
 198 # Configuration::additions related to external references
 199 #---------------------------------------------------------------------------
 200 TAGFILES               =
 201 GENERATE_TAGFILE       =
 202 ALLEXTERNALS           = NO
 203 EXTERNAL_GROUPS        = YES
 204 PERL_PATH              = /usr/bin/perl
 205 #---------------------------------------------------------------------------
 206 # Configuration options related to the dot tool
 207 #---------------------------------------------------------------------------
 208 CLASS_DIAGRAMS         = NO
 209 HIDE_UNDOC_RELATIONS   = NO
 210 HAVE_DOT               = YES
 211 CLASS_GRAPH            = YES
 212 COLLABORATION_GRAPH    = YES
 213 GROUP_GRAPHS           = YES
 214 UML_LOOK               = NO
 215 TEMPLATE_RELATIONS     = YES
 216 INCLUDE_GRAPH          = YES
 217 INCLUDED_BY_GRAPH      = YES
 218 CALL_GRAPH             = YES
 219 GRAPHICAL_HIERARCHY    = YES
 220 DIRECTORY_GRAPH        = YES
 221 DOT_IMAGE_FORMAT       = png
 222 DOT_PATH               =
 223 DOTFILE_DIRS           =
 224 MAX_DOT_GRAPH_WIDTH    = 1024
 225 MAX_DOT_GRAPH_HEIGHT   = 1024
 226 MAX_DOT_GRAPH_DEPTH    = 1000
 227 DOT_TRANSPARENT        = NO
 228 DOT_MULTI_TARGETS      = YES
 229 GENERATE_LEGEND        = YES
 230 DOT_CLEANUP            = YES
 231 #---------------------------------------------------------------------------
 232 # Configuration::additions related to the search engine
 233 #---------------------------------------------------------------------------
 234 SEARCHENGINE           = NO