ceph/src/Beast/doc/source.dox

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