doc/doxytmpl.dxy

   1 #---------------------------------------------------------------------------
   2 # Project related configuration options
   3 #---------------------------------------------------------------------------
   4 DOXYFILE_ENCODING      = UTF-8
   5 CREATE_SUBDIRS         = NO
   6 OUTPUT_LANGUAGE        = English
   7 BRIEF_MEMBER_DESC      = YES
   8 REPEAT_BRIEF           = YES
   9 ABBREVIATE_BRIEF       = "The $name class " \
  10                          "The $name widget " \
  11                          "The $name file " \
  12                          is \
  13                          provides \
  14                          specifies \
  15                          contains \
  16                          represents \
  17                          a \
  18                          an \
  19                          the
  20 ALWAYS_DETAILED_SEC    = NO
  21 INLINE_INHERITED_MEMB  = NO
  22 FULL_PATH_NAMES        = YES
  23 STRIP_FROM_PATH        = /Applications/
  24 STRIP_FROM_INC_PATH    =
  25 SHORT_NAMES            = NO
  26 JAVADOC_AUTOBRIEF      = NO
  27 QT_AUTOBRIEF           = NO
  28 MULTILINE_CPP_IS_BRIEF = NO
  29 INHERIT_DOCS           = YES
  30 SEPARATE_MEMBER_PAGES  = NO
  31 TAB_SIZE               = 8
  32 ALIASES                =
  33 OPTIMIZE_OUTPUT_FOR_C  = YES
  34 OPTIMIZE_OUTPUT_JAVA   = NO
  35 BUILTIN_STL_SUPPORT    = NO
  36 CPP_CLI_SUPPORT        = NO
  37 DISTRIBUTE_GROUP_DOC   = NO
  38 SUBGROUPING            = YES
  39 #---------------------------------------------------------------------------
  40 # Build related configuration options
  41 #---------------------------------------------------------------------------
  42 EXTRACT_ALL            = NO
  43 EXTRACT_PRIVATE        = NO
  44 EXTRACT_STATIC         = NO
  45 EXTRACT_LOCAL_CLASSES  = YES
  46 EXTRACT_LOCAL_METHODS  = NO
  47 EXTRACT_ANON_NSPACES   = NO
  48 HIDE_UNDOC_MEMBERS     = YES
  49 HIDE_UNDOC_CLASSES     = YES
  50 HIDE_FRIEND_COMPOUNDS  = NO
  51 HIDE_IN_BODY_DOCS      = NO
  52 INTERNAL_DOCS          = NO
  53 CASE_SENSE_NAMES       = NO
  54 HIDE_SCOPE_NAMES       = NO
  55 SHOW_INCLUDE_FILES     = YES
  56 INLINE_INFO            = YES
  57 SORT_MEMBER_DOCS       = YES
  58 SORT_BRIEF_DOCS        = NO
  59 SORT_BY_SCOPE_NAME     = NO
  60 GENERATE_TODOLIST      = YES
  61 GENERATE_TESTLIST      = YES
  62 GENERATE_BUGLIST       = YES
  63 GENERATE_DEPRECATEDLIST= YES
  64 ENABLED_SECTIONS       =
  65 MAX_INITIALIZER_LINES  = 30
  66 SHOW_USED_FILES        = YES
  67 FILE_VERSION_FILTER    =
  68 #---------------------------------------------------------------------------
  69 # configuration options related to warning and progress messages
  70 #---------------------------------------------------------------------------
  71 QUIET                  = YES
  72 WARNINGS               = YES
  73 WARN_IF_DOC_ERROR      = YES
  74 WARN_NO_PARAMDOC       = YES
  75 WARN_FORMAT            = "$file:$line: $text "
  76 WARN_LOGFILE           =
  77 #---------------------------------------------------------------------------
  78 # configuration options related to the input files
  79 #---------------------------------------------------------------------------
  80 INPUT_ENCODING         = UTF-8
  81 FILE_PATTERNS          = *.c \
  82                          *.cc \
  83                          *.cxx \
  84                          *.cpp \
  85                          *.c++ \
  86                          *.d \
  87                          *.java \
  88                          *.ii \
  89                          *.ixx \
  90                          *.ipp \
  91                          *.i++ \
  92                          *.inl \
  93                          *.h \
  94                          *.hh \
  95                          *.hxx \
  96                          *.hpp \
  97                          *.h++ \
  98                          *.idl \
  99                          *.odl \
 100                          *.cs \
 101                          *.php \
 102                          *.php3 \
 103                          *.inc \
 104                          *.m \
 105                          *.mm \
 106                          *.dox
 107 RECURSIVE              = YES
 108 EXCLUDE                =
 109 EXCLUDE_SYMLINKS       = NO
 110 EXCLUDE_PATTERNS       = */.svn
 111 EXCLUDE_SYMBOLS        =
 112 EXAMPLE_PATTERNS       = *
 113 EXAMPLE_RECURSIVE      = NO
 114 IMAGE_PATH             =
 115 INPUT_FILTER           =
 116 FILTER_PATTERNS        =
 117 FILTER_SOURCE_FILES    = NO
 118 #---------------------------------------------------------------------------
 119 # configuration options related to source browsing
 120 #---------------------------------------------------------------------------
 121 SOURCE_BROWSER         = NO
 122 INLINE_SOURCES         = NO
 123 STRIP_CODE_COMMENTS    = YES
 124 REFERENCED_BY_RELATION = NO
 125 REFERENCES_RELATION    = NO
 126 REFERENCES_LINK_SOURCE = YES
 127 USE_HTAGS              = NO
 128 VERBATIM_HEADERS       = NO
 129 #---------------------------------------------------------------------------
 130 # configuration options related to the alphabetical class index
 131 #---------------------------------------------------------------------------
 132 ALPHABETICAL_INDEX     = NO
 133 COLS_IN_ALPHA_INDEX    = 5
 134 IGNORE_PREFIX          =
 135 #---------------------------------------------------------------------------
 136 # configuration options related to the HTML output
 137 #---------------------------------------------------------------------------
 138 GENERATE_HTML          = YES
 139 HTML_OUTPUT            = html
 140 HTML_FILE_EXTENSION    = .html
 141 HTML_STYLESHEET        =
 142 GENERATE_HTMLHELP      = NO
 143 HTML_DYNAMIC_SECTIONS  = NO
 144 CHM_FILE               =
 145 HHC_LOCATION           =
 146 GENERATE_CHI           = NO
 147 BINARY_TOC             = NO
 148 TOC_EXPAND             = NO
 149 DISABLE_INDEX          = NO
 150 ENUM_VALUES_PER_LINE   = 4
 151 GENERATE_TREEVIEW      = NO
 152 TREEVIEW_WIDTH         = 250
 153 #---------------------------------------------------------------------------
 154 # configuration options related to the LaTeX output
 155 #---------------------------------------------------------------------------
 156 GENERATE_LATEX         = NO
 157 LATEX_OUTPUT           = latex
 158 LATEX_CMD_NAME         = latex
 159 MAKEINDEX_CMD_NAME     = makeindex
 160 COMPACT_LATEX          = NO
 161 PAPER_TYPE             = a4wide
 162 EXTRA_PACKAGES         =
 163 LATEX_HEADER           =
 164 PDF_HYPERLINKS         = NO
 165 USE_PDFLATEX           = NO
 166 LATEX_BATCHMODE        = NO
 167 LATEX_HIDE_INDICES     = NO
 168 #---------------------------------------------------------------------------
 169 # configuration options related to the RTF output
 170 #---------------------------------------------------------------------------
 171 GENERATE_RTF           = NO
 172 RTF_OUTPUT             = rtf
 173 COMPACT_RTF            = NO
 174 RTF_HYPERLINKS         = NO
 175 RTF_STYLESHEET_FILE    =
 176 RTF_EXTENSIONS_FILE    =
 177 #---------------------------------------------------------------------------
 178 # configuration options related to the man page output
 179 #---------------------------------------------------------------------------
 180 GENERATE_MAN           = YES
 181 MAN_OUTPUT             = man
 182 MAN_EXTENSION          = .3
 183 MAN_LINKS              = YES
 184 #---------------------------------------------------------------------------
 185 # configuration options related to the XML output
 186 #---------------------------------------------------------------------------
 187 GENERATE_XML           = NO
 188 XML_OUTPUT             = xml
 189 XML_PROGRAMLISTING     = YES
 190 #---------------------------------------------------------------------------
 191 # configuration options for the AutoGen Definitions output
 192 #---------------------------------------------------------------------------
 193 GENERATE_AUTOGEN_DEF   = NO
 194 #---------------------------------------------------------------------------
 195 # configuration options related to the Perl module output
 196 #---------------------------------------------------------------------------
 197 GENERATE_PERLMOD       = NO
 198 PERLMOD_LATEX          = NO
 199 PERLMOD_PRETTY         = YES
 200 PERLMOD_MAKEVAR_PREFIX =
 201 #---------------------------------------------------------------------------
 202 # Configuration options related to the preprocessor
 203 #---------------------------------------------------------------------------
 204 ENABLE_PREPROCESSING   = YES
 205 MACRO_EXPANSION        = NO
 206 EXPAND_ONLY_PREDEF     = NO
 207 SEARCH_INCLUDES        = YES
 208 INCLUDE_PATH           =
 209 INCLUDE_FILE_PATTERNS  =
 210 PREDEFINED             = DOXY
 211 EXPAND_AS_DEFINED      =
 212 SKIP_FUNCTION_MACROS   = YES
 213 #---------------------------------------------------------------------------
 214 # Configuration::additions related to external references
 215 #---------------------------------------------------------------------------
 216 TAGFILES               =
 217 GENERATE_TAGFILE       =
 218 ALLEXTERNALS           = NO
 219 EXTERNAL_GROUPS        = YES
 220 #---------------------------------------------------------------------------
 221 # Configuration options related to the dot tool
 222 #---------------------------------------------------------------------------
 223 CLASS_DIAGRAMS         = NO
 224 HIDE_UNDOC_RELATIONS   = YES
 225 HAVE_DOT               = YES
 226 CLASS_GRAPH            = YES
 227 COLLABORATION_GRAPH    = YES
 228 GROUP_GRAPHS           = YES
 229 UML_LOOK               = NO
 230 TEMPLATE_RELATIONS     = NO
 231 INCLUDE_GRAPH          = YES
 232 INCLUDED_BY_GRAPH      = YES
 233 CALL_GRAPH             = NO
 234 CALLER_GRAPH           = NO
 235 GRAPHICAL_HIERARCHY    = YES
 236 DIRECTORY_GRAPH        = YES
 237 DOT_IMAGE_FORMAT       = png
 238 DOTFILE_DIRS           =
 239 DOT_GRAPH_MAX_NODES    = 50
 240 MAX_DOT_GRAPH_DEPTH    = 1000
 241 DOT_TRANSPARENT        = NO
 242 DOT_MULTI_TARGETS      = NO
 243 GENERATE_LEGEND        = YES
 244 DOT_CLEANUP            = YES
 245 #---------------------------------------------------------------------------
 246 # Configuration::additions related to the search engine
 247 #---------------------------------------------------------------------------
 248 SEARCHENGINE           = NO