doc/Doxyfile.in

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