doc/Doxyfile.in

   1 # Doxyfile 1.8.4
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = @PROJECT_NAME@
   8 PROJECT_NUMBER         = @PROJECT_APIVER@
   9 PROJECT_BRIEF          = "@PROJECT_DESCRIPTION@"
  10 PROJECT_LOGO           =
  11 OUTPUT_DIRECTORY       = @DOC_OUTPUT_PATH@
  12 CREATE_SUBDIRS         = NO
  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        = @CMAKE_SOURCE_DIR@
  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  = YES
  32 OPTIMIZE_OUTPUT_JAVA   = NO
  33 OPTIMIZE_FOR_FORTRAN   = NO
  34 OPTIMIZE_OUTPUT_VHDL   = NO
  35 EXTENSION_MAPPING      =
  36 MARKDOWN_SUPPORT       = YES
  37 AUTOLINK_SUPPORT       = YES
  38 BUILTIN_STL_SUPPORT    = NO
  39 CPP_CLI_SUPPORT        = NO
  40 SIP_SUPPORT            = NO
  41 IDL_PROPERTY_SUPPORT   = YES
  42 DISTRIBUTE_GROUP_DOC   = NO
  43 SUBGROUPING            = YES
  44 INLINE_GROUPED_CLASSES = NO
  45 INLINE_SIMPLE_STRUCTS  = NO
  46 TYPEDEF_HIDES_STRUCT   = NO
  47 LOOKUP_CACHE_SIZE      = 0
  48 #---------------------------------------------------------------------------
  49 # Build related configuration options
  50 #---------------------------------------------------------------------------
  51 EXTRACT_ALL            = NO
  52 EXTRACT_PRIVATE        = NO
  53 EXTRACT_PACKAGE        = NO
  54 EXTRACT_STATIC         = NO
  55 EXTRACT_LOCAL_CLASSES  = NO
  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       = YES
  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                  = @CMAKE_CURRENT_SOURCE_DIR@/ \
 100                          @CMAKE_SOURCE_DIR@/src/ \
 101                          @CMAKE_SOURCE_DIR@/examples/
 102 INPUT_ENCODING         = UTF-8
 103 FILE_PATTERNS          = *.dox \
 104                          *.h \
 105                          *.c
 106 RECURSIVE              = NO
 107 EXCLUDE                =
 108 EXCLUDE_SYMLINKS       = NO
 109 EXCLUDE_PATTERNS       =
 110 EXCLUDE_SYMBOLS        =
 111 EXAMPLE_PATH           = @CMAKE_SOURCE_DIR@/examples/
 112 EXAMPLE_PATTERNS       = *.c
 113 EXAMPLE_RECURSIVE      = NO
 114 IMAGE_PATH             =
 115 INPUT_FILTER           =
 116 FILTER_PATTERNS        =
 117 FILTER_SOURCE_FILES    = NO
 118 FILTER_SOURCE_PATTERNS =
 119 USE_MDFILE_AS_MAINPAGE =
 120 #---------------------------------------------------------------------------
 121 # configuration options related to source browsing
 122 #---------------------------------------------------------------------------
 123 SOURCE_BROWSER         = YES
 124 INLINE_SOURCES         = YES
 125 STRIP_CODE_COMMENTS    = YES
 126 REFERENCED_BY_RELATION = NO
 127 REFERENCES_RELATION    = NO
 128 REFERENCES_LINK_SOURCE = YES
 129 USE_HTAGS              = NO
 130 VERBATIM_HEADERS       = YES
 131 #---------------------------------------------------------------------------
 132 # configuration options related to the alphabetical class index
 133 #---------------------------------------------------------------------------
 134 ALPHABETICAL_INDEX     = YES
 135 COLS_IN_ALPHA_INDEX    = 5
 136 IGNORE_PREFIX          =
 137 #---------------------------------------------------------------------------
 138 # configuration options related to the HTML output
 139 #---------------------------------------------------------------------------
 140 GENERATE_HTML          = YES
 141 HTML_OUTPUT            = html
 142 HTML_FILE_EXTENSION    = .html
 143 HTML_HEADER            =
 144 HTML_FOOTER            =
 145 HTML_STYLESHEET        =
 146 HTML_EXTRA_STYLESHEET  =
 147 HTML_EXTRA_FILES       =
 148 HTML_COLORSTYLE_HUE    = 220
 149 HTML_COLORSTYLE_SAT    = 100
 150 HTML_COLORSTYLE_GAMMA  = 80
 151 HTML_TIMESTAMP         = YES
 152 HTML_DYNAMIC_SECTIONS  = NO
 153 HTML_INDEX_NUM_ENTRIES = 100
 154 GENERATE_DOCSET        = NO
 155 DOCSET_FEEDNAME        = "Doxygen generated docs"
 156 DOCSET_BUNDLE_ID       = org.doxygen.Project
 157 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 158 DOCSET_PUBLISHER_NAME  = Publisher
 159 GENERATE_HTMLHELP      = NO
 160 CHM_FILE               =
 161 HHC_LOCATION           =
 162 GENERATE_CHI           = NO
 163 CHM_INDEX_ENCODING     =
 164 BINARY_TOC             = NO
 165 TOC_EXPAND             = NO
 166 GENERATE_QHP           = NO
 167 QCH_FILE               =
 168 QHP_NAMESPACE          = org.doxygen.Project
 169 QHP_VIRTUAL_FOLDER     = doc
 170 QHP_CUST_FILTER_NAME   =
 171 QHP_CUST_FILTER_ATTRS  =
 172 QHP_SECT_FILTER_ATTRS  =
 173 QHG_LOCATION           =
 174 GENERATE_ECLIPSEHELP   = NO
 175 ECLIPSE_DOC_ID         = org.doxygen.Project
 176 DISABLE_INDEX          = NO
 177 GENERATE_TREEVIEW      = NO
 178 ENUM_VALUES_PER_LINE   = 4
 179 TREEVIEW_WIDTH         = 250
 180 EXT_LINKS_IN_WINDOW    = NO
 181 FORMULA_FONTSIZE       = 10
 182 FORMULA_TRANSPARENT    = YES
 183 USE_MATHJAX            = NO
 184 MATHJAX_FORMAT         = HTML-CSS
 185 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 186 MATHJAX_EXTENSIONS     =
 187 MATHJAX_CODEFILE       =
 188 SEARCHENGINE           = YES
 189 SERVER_BASED_SEARCH    = NO
 190 EXTERNAL_SEARCH        = NO
 191 SEARCHENGINE_URL       =
 192 SEARCHDATA_FILE        = searchdata.xml
 193 EXTERNAL_SEARCH_ID     =
 194 EXTRA_SEARCH_MAPPINGS  =
 195 #---------------------------------------------------------------------------
 196 # configuration options related to the LaTeX output
 197 #---------------------------------------------------------------------------
 198 GENERATE_LATEX         = NO
 199 LATEX_OUTPUT           = latex
 200 LATEX_CMD_NAME         = latex
 201 MAKEINDEX_CMD_NAME     = makeindex
 202 COMPACT_LATEX          = NO
 203 PAPER_TYPE             = a4
 204 EXTRA_PACKAGES         =
 205 LATEX_HEADER           =
 206 LATEX_FOOTER           =
 207 LATEX_EXTRA_FILES      =
 208 PDF_HYPERLINKS         = YES
 209 USE_PDFLATEX           = YES
 210 LATEX_BATCHMODE        = NO
 211 LATEX_HIDE_INDICES     = NO
 212 LATEX_SOURCE_CODE      = NO
 213 LATEX_BIB_STYLE        = plain
 214 #---------------------------------------------------------------------------
 215 # configuration options related to the RTF output
 216 #---------------------------------------------------------------------------
 217 GENERATE_RTF           = NO
 218 RTF_OUTPUT             = rtf
 219 COMPACT_RTF            = NO
 220 RTF_HYPERLINKS         = NO
 221 RTF_STYLESHEET_FILE    =
 222 RTF_EXTENSIONS_FILE    =
 223 #---------------------------------------------------------------------------
 224 # configuration options related to the man page output
 225 #---------------------------------------------------------------------------
 226 GENERATE_MAN           = NO
 227 MAN_OUTPUT             = man
 228 MAN_EXTENSION          = .3
 229 MAN_LINKS              = NO
 230 #---------------------------------------------------------------------------
 231 # configuration options related to the XML output
 232 #---------------------------------------------------------------------------
 233 GENERATE_XML           = NO
 234 XML_OUTPUT             = xml
 235 XML_SCHEMA             =
 236 XML_DTD                =
 237 XML_PROGRAMLISTING     = YES
 238 #---------------------------------------------------------------------------
 239 # configuration options related to the DOCBOOK output
 240 #---------------------------------------------------------------------------
 241 GENERATE_DOCBOOK       = NO
 242 DOCBOOK_OUTPUT         = docbook
 243 #---------------------------------------------------------------------------
 244 # configuration options for the AutoGen Definitions output
 245 #---------------------------------------------------------------------------
 246 GENERATE_AUTOGEN_DEF   = NO
 247 #---------------------------------------------------------------------------
 248 # configuration options related to the Perl module output
 249 #---------------------------------------------------------------------------
 250 GENERATE_PERLMOD       = NO
 251 PERLMOD_LATEX          = NO
 252 PERLMOD_PRETTY         = YES
 253 PERLMOD_MAKEVAR_PREFIX =
 254 #---------------------------------------------------------------------------
 255 # Configuration options related to the preprocessor
 256 #---------------------------------------------------------------------------
 257 ENABLE_PREPROCESSING   = YES
 258 MACRO_EXPANSION        = NO
 259 EXPAND_ONLY_PREDEF     = NO
 260 SEARCH_INCLUDES        = YES
 261 INCLUDE_PATH           =
 262 INCLUDE_FILE_PATTERNS  =
 263 PREDEFINED             =
 264 EXPAND_AS_DEFINED      =
 265 SKIP_FUNCTION_MACROS   = YES
 266 #---------------------------------------------------------------------------
 267 # Configuration::additions related to external references
 268 #---------------------------------------------------------------------------
 269 TAGFILES               =
 270 GENERATE_TAGFILE       =
 271 ALLEXTERNALS           = NO
 272 EXTERNAL_GROUPS        = YES
 273 EXTERNAL_PAGES         = YES
 274 PERL_PATH              = /usr/bin/perl
 275 #---------------------------------------------------------------------------
 276 # Configuration options related to the dot tool
 277 #---------------------------------------------------------------------------
 278 CLASS_DIAGRAMS         = NO
 279 MSCGEN_PATH            =
 280 HIDE_UNDOC_RELATIONS   = YES
 281 HAVE_DOT               = NO
 282 DOT_NUM_THREADS        = 0
 283 DOT_FONTNAME           = Helvetica
 284 DOT_FONTSIZE           = 10
 285 DOT_FONTPATH           =
 286 CLASS_GRAPH            = YES
 287 COLLABORATION_GRAPH    = YES
 288 GROUP_GRAPHS           = YES
 289 UML_LOOK               = NO
 290 UML_LIMIT_NUM_FIELDS   = 10
 291 TEMPLATE_RELATIONS     = NO
 292 INCLUDE_GRAPH          = YES
 293 INCLUDED_BY_GRAPH      = YES
 294 CALL_GRAPH             = NO
 295 CALLER_GRAPH           = NO
 296 GRAPHICAL_HIERARCHY    = YES
 297 DIRECTORY_GRAPH        = YES
 298 DOT_IMAGE_FORMAT       = png
 299 INTERACTIVE_SVG        = NO
 300 DOT_PATH               =
 301 DOTFILE_DIRS           =
 302 MSCFILE_DIRS           =
 303 DOT_GRAPH_MAX_NODES    = 50
 304 MAX_DOT_GRAPH_DEPTH    = 0
 305 DOT_TRANSPARENT        = NO
 306 DOT_MULTI_TARGETS      = YES
 307 GENERATE_LEGEND        = YES
 308 DOT_CLEANUP            = YES