doc/Doxyfile.in

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