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