docs/reference/Doxyfile.in

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