Doxyfile

   1 # Doxyfile 1.8.0
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = Doxygen
   8 PROJECT_NUMBER         =
   9 PROJECT_BRIEF          =
  10 PROJECT_LOGO           =
  11 OUTPUT_DIRECTORY       = doxygen_docs
  12 CREATE_SUBDIRS         = YES
  13 OUTPUT_LANGUAGE        = English
  14 BRIEF_MEMBER_DESC      = YES
  15 REPEAT_BRIEF           = YES
  16 ABBREVIATE_BRIEF       =
  17 ALWAYS_DETAILED_SEC    = NO
  18 INLINE_INHERITED_MEMB  = NO
  19 FULL_PATH_NAMES        = YES
  20 STRIP_FROM_PATH        =
  21 STRIP_FROM_INC_PATH    =
  22 SHORT_NAMES            = NO
  23 JAVADOC_AUTOBRIEF      = YES
  24 QT_AUTOBRIEF           = NO
  25 MULTILINE_CPP_IS_BRIEF = NO
  26 INHERIT_DOCS           = YES
  27 SEPARATE_MEMBER_PAGES  = NO
  28 TAB_SIZE               = 8
  29 ALIASES                =
  30 TCL_SUBST              =
  31 OPTIMIZE_OUTPUT_FOR_C  = NO
  32 OPTIMIZE_OUTPUT_JAVA   = NO
  33 OPTIMIZE_FOR_FORTRAN   = NO
  34 OPTIMIZE_OUTPUT_VHDL   = NO
  35 EXTENSION_MAPPING      =
  36 MARKDOWN_SUPPORT       = YES
  37 BUILTIN_STL_SUPPORT    = NO
  38 CPP_CLI_SUPPORT        = NO
  39 SIP_SUPPORT            = NO
  40 IDL_PROPERTY_SUPPORT   = YES
  41 DISTRIBUTE_GROUP_DOC   = NO
  42 SUBGROUPING            = YES
  43 INLINE_GROUPED_CLASSES = NO
  44 INLINE_SIMPLE_STRUCTS  = NO
  45 TYPEDEF_HIDES_STRUCT   = NO
  46 SYMBOL_CACHE_SIZE      = 0
  47 LOOKUP_CACHE_SIZE      = 0
  48 #---------------------------------------------------------------------------
  49 # Build related configuration options
  50 #---------------------------------------------------------------------------
  51 EXTRACT_ALL            = YES
  52 EXTRACT_PRIVATE        = YES
  53 EXTRACT_PACKAGE        = NO
  54 EXTRACT_STATIC         = YES
  55 EXTRACT_LOCAL_CLASSES  = YES
  56 EXTRACT_LOCAL_METHODS  = NO
  57 EXTRACT_ANON_NSPACES   = NO
  58 HIDE_UNDOC_MEMBERS     = NO
  59 HIDE_UNDOC_CLASSES     = NO
  60 HIDE_FRIEND_COMPOUNDS  = NO
  61 HIDE_IN_BODY_DOCS      = NO
  62 INTERNAL_DOCS          = NO
  63 CASE_SENSE_NAMES       = NO
  64 HIDE_SCOPE_NAMES       = NO
  65 SHOW_INCLUDE_FILES     = YES
  66 FORCE_LOCAL_INCLUDES   = NO
  67 INLINE_INFO            = YES
  68 SORT_MEMBER_DOCS       = YES
  69 SORT_BRIEF_DOCS        = NO
  70 SORT_MEMBERS_CTORS_1ST = NO
  71 SORT_GROUP_NAMES       = NO
  72 SORT_BY_SCOPE_NAME     = NO
  73 STRICT_PROTO_MATCHING  = NO
  74 GENERATE_TODOLIST      = YES
  75 GENERATE_TESTLIST      = YES
  76 GENERATE_BUGLIST       = YES
  77 GENERATE_DEPRECATEDLIST= YES
  78 ENABLED_SECTIONS       =
  79 MAX_INITIALIZER_LINES  = 30
  80 SHOW_USED_FILES        = YES
  81 SHOW_FILES             = YES
  82 SHOW_NAMESPACES        = YES
  83 FILE_VERSION_FILTER    =
  84 LAYOUT_FILE            =
  85 CITE_BIB_FILES         =
  86 #---------------------------------------------------------------------------
  87 # configuration options related to warning and progress messages
  88 #---------------------------------------------------------------------------
  89 QUIET                  = NO
  90 WARNINGS               = YES
  91 WARN_IF_UNDOCUMENTED   = YES
  92 WARN_IF_DOC_ERROR      = YES
  93 WARN_NO_PARAMDOC       = NO
  94 WARN_FORMAT            = "$file:$line: $text "
  95 WARN_LOGFILE           =
  96 #---------------------------------------------------------------------------
  97 # configuration options related to the input files
  98 #---------------------------------------------------------------------------
  99 INPUT                  = src
 100 INPUT_ENCODING         = UTF-8
 101 FILE_PATTERNS          = *.h \
 102                          *.cpp \
 103                          *.md
 104 RECURSIVE              = NO
 105 EXCLUDE                = src/code.cpp \
 106                          src/ce_lex.cpp \
 107                          src/ce_parse.cpp \
 108                          src/declinfo.cpp \
 109                          src/defargs.cpp \
 110                          src/doxytag.cpp \
 111                          src/pre.cpp \
 112                          src/scanner.cpp \
 113                          src/tag.cpp \
 114                          src/doctokenizer.cpp \
 115                          src/logos.cpp \
 116                          src/suffixtree.cpp \
 117                          src/suffixtree.h \
 118                          src/searchindex.cpp \
 119                          src/searchindex.h \
 120                          src/commentcnv.cpp \
 121                          src/commentscan.cpp \
 122                          src/pycode.cpp \
 123                          src/config.cpp \
 124                          src/pyscanner.cpp \
 125                          src/fortranscanner.cpp \
 126                          src/fortrancode.cpp \
 127                          src/vhdlscanner.cpp \
 128                          src/vhdlparser.cpp \
 129                          src/vhdlcode.cpp \
 130                          src/tclscanner.cpp \
 131                          src/lodepng.cpp \
 132                          src/doxygen_css.h \
 133                          src/doxygen_js.h \
 134                          src/doxygen_php.h \
 135                          src/compound_xsd.h \
 136                          src/layout_default.h \
 137                          src/bib2xhtml.h \
 138                          src/doxygen_bst.h \
 139                          src/header_html.h \
 140                          src/index_xsd.h \
 141                          src/jquery_js.h \
 142                          src/jquery_fx_js.h \
 143                          src/jquery_ui_js.h \
 144                          src/navtree_css.h \
 145                          src/navtree_hs.h \
 146                          src/search_css.h \
 147                          src/search_functions_php.h \
 148                          src/search_opensearch_php.h \
 149                          src/search_js.h \
 150                          src/sizzle_js.h
 151 EXCLUDE_SYMLINKS       = NO
 152 EXCLUDE_PATTERNS       =
 153 EXCLUDE_SYMBOLS        =
 154 EXAMPLE_PATH           =
 155 EXAMPLE_PATTERNS       =
 156 EXAMPLE_RECURSIVE      = NO
 157 IMAGE_PATH             =
 158 INPUT_FILTER           =
 159 FILTER_PATTERNS        =
 160 FILTER_SOURCE_FILES    = NO
 161 FILTER_SOURCE_PATTERNS =
 162 #---------------------------------------------------------------------------
 163 # configuration options related to source browsing
 164 #---------------------------------------------------------------------------
 165 SOURCE_BROWSER         = YES
 166 INLINE_SOURCES         = NO
 167 STRIP_CODE_COMMENTS    = YES
 168 REFERENCED_BY_RELATION = YES
 169 REFERENCES_RELATION    = YES
 170 REFERENCES_LINK_SOURCE = YES
 171 USE_HTAGS              = NO
 172 VERBATIM_HEADERS       = YES
 173 #---------------------------------------------------------------------------
 174 # configuration options related to the alphabetical class index
 175 #---------------------------------------------------------------------------
 176 ALPHABETICAL_INDEX     = YES
 177 COLS_IN_ALPHA_INDEX    = 5
 178 IGNORE_PREFIX          =
 179 #---------------------------------------------------------------------------
 180 # configuration options related to the HTML output
 181 #---------------------------------------------------------------------------
 182 GENERATE_HTML          = YES
 183 HTML_OUTPUT            =
 184 HTML_FILE_EXTENSION    = .html
 185 HTML_HEADER            =
 186 HTML_FOOTER            =
 187 HTML_STYLESHEET        =
 188 HTML_EXTRA_FILES       =
 189 HTML_COLORSTYLE_HUE    = 220
 190 HTML_COLORSTYLE_SAT    = 100
 191 HTML_COLORSTYLE_GAMMA  = 80
 192 HTML_TIMESTAMP         = YES
 193 HTML_DYNAMIC_SECTIONS  = YES
 194 GENERATE_DOCSET        = YES
 195 DOCSET_FEEDNAME        = "Doxygen docs"
 196 DOCSET_BUNDLE_ID       = org.doxygen.Doxygen
 197 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 198 DOCSET_PUBLISHER_NAME  = Publisher
 199 GENERATE_HTMLHELP      = NO
 200 CHM_FILE               =
 201 HHC_LOCATION           =
 202 GENERATE_CHI           = NO
 203 CHM_INDEX_ENCODING     =
 204 BINARY_TOC             = NO
 205 TOC_EXPAND             = NO
 206 GENERATE_QHP           = NO
 207 QCH_FILE               =
 208 QHP_NAMESPACE          = org.doxygen.Project
 209 QHP_VIRTUAL_FOLDER     = doc
 210 QHP_CUST_FILTER_NAME   =
 211 QHP_CUST_FILTER_ATTRS  =
 212 QHP_SECT_FILTER_ATTRS  =
 213 QHG_LOCATION           =
 214 GENERATE_ECLIPSEHELP   = NO
 215 ECLIPSE_DOC_ID         = org.doxygen.Project
 216 DISABLE_INDEX          = YES
 217 GENERATE_TREEVIEW      = YES
 218 ENUM_VALUES_PER_LINE   = 4
 219 TREEVIEW_WIDTH         = 250
 220 EXT_LINKS_IN_WINDOW    = NO
 221 FORMULA_FONTSIZE       = 10
 222 FORMULA_TRANSPARENT    = YES
 223 USE_MATHJAX            = NO
 224 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
 225 MATHJAX_EXTENSIONS     =
 226 SEARCHENGINE           = YES
 227 SERVER_BASED_SEARCH    = NO
 228 #---------------------------------------------------------------------------
 229 # configuration options related to the LaTeX output
 230 #---------------------------------------------------------------------------
 231 GENERATE_LATEX         = NO
 232 LATEX_OUTPUT           =
 233 LATEX_CMD_NAME         = latex
 234 MAKEINDEX_CMD_NAME     = makeindex
 235 COMPACT_LATEX          = NO
 236 PAPER_TYPE             = a4wide
 237 EXTRA_PACKAGES         =
 238 LATEX_HEADER           =
 239 LATEX_FOOTER           =
 240 PDF_HYPERLINKS         = YES
 241 USE_PDFLATEX           = NO
 242 LATEX_BATCHMODE        = NO
 243 LATEX_HIDE_INDICES     = NO
 244 LATEX_SOURCE_CODE      = NO
 245 LATEX_BIB_STYLE        = plain
 246 #---------------------------------------------------------------------------
 247 # configuration options related to the RTF output
 248 #---------------------------------------------------------------------------
 249 GENERATE_RTF           = NO
 250 RTF_OUTPUT             =
 251 COMPACT_RTF            = NO
 252 RTF_HYPERLINKS         = NO
 253 RTF_STYLESHEET_FILE    =
 254 RTF_EXTENSIONS_FILE    =
 255 #---------------------------------------------------------------------------
 256 # configuration options related to the man page output
 257 #---------------------------------------------------------------------------
 258 GENERATE_MAN           = NO
 259 MAN_OUTPUT             =
 260 MAN_EXTENSION          = .3
 261 MAN_LINKS              = NO
 262 #---------------------------------------------------------------------------
 263 # configuration options related to the XML output
 264 #---------------------------------------------------------------------------
 265 GENERATE_XML           = NO
 266 XML_OUTPUT             = xml
 267 XML_SCHEMA             =
 268 XML_DTD                =
 269 XML_PROGRAMLISTING     = YES
 270 #---------------------------------------------------------------------------
 271 # configuration options for the AutoGen Definitions output
 272 #---------------------------------------------------------------------------
 273 GENERATE_AUTOGEN_DEF   = NO
 274 #---------------------------------------------------------------------------
 275 # configuration options related to the Perl module output
 276 #---------------------------------------------------------------------------
 277 GENERATE_PERLMOD       = NO
 278 PERLMOD_LATEX          = NO
 279 PERLMOD_PRETTY         = YES
 280 PERLMOD_MAKEVAR_PREFIX =
 281 #---------------------------------------------------------------------------
 282 # Configuration options related to the preprocessor
 283 #---------------------------------------------------------------------------
 284 ENABLE_PREPROCESSING   = YES
 285 MACRO_EXPANSION        = YES
 286 EXPAND_ONLY_PREDEF     = YES
 287 SEARCH_INCLUDES        = YES
 288 INCLUDE_PATH           =
 289 INCLUDE_FILE_PATTERNS  =
 290 PREDEFINED             =
 291 EXPAND_AS_DEFINED      =
 292 SKIP_FUNCTION_MACROS   = YES
 293 #---------------------------------------------------------------------------
 294 # Configuration::additions related to external references
 295 #---------------------------------------------------------------------------
 296 TAGFILES               = qtools_docs/qtools.tag=../../qtools_docs/html
 297 GENERATE_TAGFILE       =
 298 ALLEXTERNALS           = NO
 299 EXTERNAL_GROUPS        = YES
 300 PERL_PATH              = /usr/bin/perl
 301 #---------------------------------------------------------------------------
 302 # Configuration options related to the dot tool
 303 #---------------------------------------------------------------------------
 304 CLASS_DIAGRAMS         = NO
 305 MSCGEN_PATH            =
 306 HIDE_UNDOC_RELATIONS   = YES
 307 HAVE_DOT               = YES
 308 DOT_NUM_THREADS        = 0
 309 DOT_FONTNAME           = Helvetica
 310 DOT_FONTSIZE           = 10
 311 DOT_FONTPATH           =
 312 CLASS_GRAPH            = YES
 313 COLLABORATION_GRAPH    = YES
 314 GROUP_GRAPHS           = YES
 315 UML_LOOK               = NO
 316 UML_LIMIT_NUM_FIELDS   = 10
 317 TEMPLATE_RELATIONS     = YES
 318 INCLUDE_GRAPH          = YES
 319 INCLUDED_BY_GRAPH      = YES
 320 CALL_GRAPH             = NO
 321 CALLER_GRAPH           = NO
 322 GRAPHICAL_HIERARCHY    = YES
 323 DIRECTORY_GRAPH        = YES
 324 DOT_IMAGE_FORMAT       = svg
 325 INTERACTIVE_SVG        = YES
 326 DOT_PATH               =
 327 DOTFILE_DIRS           =
 328 MSCFILE_DIRS           =
 329 DOT_GRAPH_MAX_NODES    = 50
 330 MAX_DOT_GRAPH_DEPTH    = 0
 331 DOT_TRANSPARENT        = NO
 332 DOT_MULTI_TARGETS      = NO
 333 GENERATE_LEGEND        = YES
 334 DOT_CLEANUP            = NO