ceph/src/spdk/ocf/doc/doxygen.cfg

   1 # Doxyfile 1.8.6
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = "Open CAS Framework"
   8 PROJECT_NUMBER         =
   9 PROJECT_BRIEF          = "Open source framework of Cache Acceleration Software"
  10 PROJECT_LOGO           =
  11 OUTPUT_DIRECTORY       = .
  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       = "The $name class" \
  18                          "The $name widget" \
  19                          "The $name file" \
  20                          is \
  21                          provides \
  22                          specifies \
  23                          contains \
  24                          represents \
  25                          a \
  26                          an \
  27                          the
  28 ALWAYS_DETAILED_SEC    = NO
  29 INLINE_INHERITED_MEMB  = NO
  30 FULL_PATH_NAMES        = NO
  31 STRIP_FROM_PATH        =
  32 STRIP_FROM_INC_PATH    =
  33 SHORT_NAMES            = NO
  34 JAVADOC_AUTOBRIEF      = NO
  35 QT_AUTOBRIEF           = NO
  36 MULTILINE_CPP_IS_BRIEF = NO
  37 INHERIT_DOCS           = YES
  38 SEPARATE_MEMBER_PAGES  = NO
  39 TAB_SIZE               = 8
  40 ALIASES                =
  41 TCL_SUBST              =
  42 OPTIMIZE_OUTPUT_FOR_C  = YES
  43 OPTIMIZE_OUTPUT_JAVA   = NO
  44 OPTIMIZE_FOR_FORTRAN   = NO
  45 OPTIMIZE_OUTPUT_VHDL   = NO
  46 EXTENSION_MAPPING      =
  47 MARKDOWN_SUPPORT       = YES
  48 AUTOLINK_SUPPORT       = YES
  49 BUILTIN_STL_SUPPORT    = NO
  50 CPP_CLI_SUPPORT        = NO
  51 SIP_SUPPORT            = NO
  52 IDL_PROPERTY_SUPPORT   = YES
  53 DISTRIBUTE_GROUP_DOC   = NO
  54 GROUP_NESTED_COMPOUNDS = NO
  55 SUBGROUPING            = YES
  56 INLINE_GROUPED_CLASSES = NO
  57 INLINE_SIMPLE_STRUCTS  = NO
  58 TYPEDEF_HIDES_STRUCT   = NO
  59 LOOKUP_CACHE_SIZE      = 0
  60 #---------------------------------------------------------------------------
  61 # Build related configuration options
  62 #---------------------------------------------------------------------------
  63 EXTRACT_ALL            = NO
  64 EXTRACT_PRIVATE        = NO
  65 EXTRACT_PACKAGE        = NO
  66 EXTRACT_STATIC         = NO
  67 EXTRACT_LOCAL_CLASSES  = YES
  68 EXTRACT_LOCAL_METHODS  = NO
  69 EXTRACT_ANON_NSPACES   = NO
  70 HIDE_UNDOC_MEMBERS     = NO
  71 HIDE_UNDOC_CLASSES     = NO
  72 HIDE_FRIEND_COMPOUNDS  = NO
  73 HIDE_IN_BODY_DOCS      = NO
  74 INTERNAL_DOCS          = NO
  75 CASE_SENSE_NAMES       = NO
  76 HIDE_SCOPE_NAMES       = YES
  77 HIDE_COMPOUND_REFERENCE= NO
  78 SHOW_INCLUDE_FILES     = YES
  79 SHOW_GROUPED_MEMB_INC  = NO
  80 FORCE_LOCAL_INCLUDES   = NO
  81 INLINE_INFO            = YES
  82 SORT_MEMBER_DOCS       = YES
  83 SORT_BRIEF_DOCS        = NO
  84 SORT_MEMBERS_CTORS_1ST = NO
  85 SORT_GROUP_NAMES       = NO
  86 SORT_BY_SCOPE_NAME     = NO
  87 STRICT_PROTO_MATCHING  = NO
  88 GENERATE_TODOLIST      = YES
  89 GENERATE_TESTLIST      = YES
  90 GENERATE_BUGLIST       = YES
  91 GENERATE_DEPRECATEDLIST= YES
  92 ENABLED_SECTIONS       =
  93 MAX_INITIALIZER_LINES  = 30
  94 SHOW_USED_FILES        = YES
  95 SHOW_FILES             = YES
  96 SHOW_NAMESPACES        = YES
  97 FILE_VERSION_FILTER    =
  98 LAYOUT_FILE            =
  99 CITE_BIB_FILES         =
 100 #---------------------------------------------------------------------------
 101 # Configuration options related to warning and progress messages
 102 #---------------------------------------------------------------------------
 103 QUIET                  = NO
 104 WARNINGS               = YES
 105 WARN_IF_UNDOCUMENTED   = YES
 106 WARN_IF_DOC_ERROR      = YES
 107 WARN_NO_PARAMDOC       = NO
 108 WARN_AS_ERROR          = NO
 109 WARN_FORMAT            = "$file:$line: $text"
 110 WARN_LOGFILE           =
 111 #---------------------------------------------------------------------------
 112 # Configuration options related to the input files
 113 #---------------------------------------------------------------------------
 114 INPUT                  = ../inc HOME.md
 115 INPUT_ENCODING         = UTF-8
 116 FILE_PATTERNS          = *.c \
 117                          *.h \
 118                          *.md
 119 RECURSIVE              = YES
 120 EXCLUDE                =
 121 EXCLUDE_SYMLINKS       = NO
 122 EXCLUDE_PATTERNS       =
 123 EXCLUDE_SYMBOLS        =
 124 EXAMPLE_PATH           =
 125 EXAMPLE_PATTERNS       = *
 126 EXAMPLE_RECURSIVE      = NO
 127 IMAGE_PATH             = ./img/
 128 INPUT_FILTER           =
 129 FILTER_PATTERNS        =
 130 FILTER_SOURCE_FILES    = NO
 131 FILTER_SOURCE_PATTERNS =
 132 USE_MDFILE_AS_MAINPAGE = HOME.md
 133 #---------------------------------------------------------------------------
 134 # Configuration options related to source browsing
 135 #---------------------------------------------------------------------------
 136 SOURCE_BROWSER         = NO
 137 INLINE_SOURCES         = NO
 138 STRIP_CODE_COMMENTS    = YES
 139 REFERENCED_BY_RELATION = NO
 140 REFERENCES_RELATION    = NO
 141 REFERENCES_LINK_SOURCE = YES
 142 SOURCE_TOOLTIPS        = YES
 143 USE_HTAGS              = NO
 144 VERBATIM_HEADERS       = YES
 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 # Configuration options related to the HTML output
 153 #---------------------------------------------------------------------------
 154 GENERATE_HTML          = YES
 155 HTML_OUTPUT            = html
 156 HTML_FILE_EXTENSION    = .html
 157 #HTML_HEADER            = header.html
 158 #HTML_FOOTER            = footer.html
 159 HTML_STYLESHEET        =
 160 HTML_EXTRA_STYLESHEET  =
 161 HTML_EXTRA_FILES       =
 162 HTML_COLORSTYLE_HUE    = 220
 163 HTML_COLORSTYLE_SAT    = 100
 164 HTML_COLORSTYLE_GAMMA  = 80
 165 HTML_TIMESTAMP         = NO
 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          = org.doxygen.Project
 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   = 4
 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           = YES
 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     = YES
 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        = NO
 276 EXPAND_ONLY_PREDEF     = NO
 277 SEARCH_INCLUDES        = YES
 278 INCLUDE_PATH           =
 279 INCLUDE_FILE_PATTERNS  =
 280 PREDEFINED             =
 281 EXPAND_AS_DEFINED      =
 282 SKIP_FUNCTION_MACROS   = YES
 283 #---------------------------------------------------------------------------
 284 # Configuration options related to external references
 285 #---------------------------------------------------------------------------
 286 TAGFILES               =
 287 GENERATE_TAGFILE       =
 288 ALLEXTERNALS           = NO
 289 EXTERNAL_GROUPS        = YES
 290 EXTERNAL_PAGES         = YES
 291 PERL_PATH              = /usr/bin/perl
 292 #---------------------------------------------------------------------------
 293 # Configuration options related to the dot tool
 294 #---------------------------------------------------------------------------
 295 CLASS_DIAGRAMS         = YES
 296 MSCGEN_PATH            =
 297 DIA_PATH               =
 298 HIDE_UNDOC_RELATIONS   = YES
 299 HAVE_DOT               = NO
 300 DOT_NUM_THREADS        = 0
 301 DOT_FONTNAME           = Helvetica
 302 DOT_FONTSIZE           = 10
 303 DOT_FONTPATH           =
 304 CLASS_GRAPH            = YES
 305 COLLABORATION_GRAPH    = YES
 306 GROUP_GRAPHS           = YES
 307 UML_LOOK               = NO
 308 UML_LIMIT_NUM_FIELDS   = 10
 309 TEMPLATE_RELATIONS     = NO
 310 INCLUDE_GRAPH          = YES
 311 INCLUDED_BY_GRAPH      = YES
 312 CALL_GRAPH             = NO
 313 CALLER_GRAPH           = NO
 314 GRAPHICAL_HIERARCHY    = YES
 315 DIRECTORY_GRAPH        = YES
 316 DOT_IMAGE_FORMAT       = png
 317 INTERACTIVE_SVG        = NO
 318 DOT_PATH               =
 319 DOTFILE_DIRS           =
 320 MSCFILE_DIRS           =
 321 DIAFILE_DIRS           =
 322 PLANTUML_JAR_PATH      =
 323 PLANTUML_INCLUDE_PATH  =
 324 DOT_GRAPH_MAX_NODES    = 50
 325 MAX_DOT_GRAPH_DEPTH    = 0
 326 DOT_TRANSPARENT        = NO
 327 DOT_MULTI_TARGETS      = NO
 328 GENERATE_LEGEND        = YES
 329 DOT_CLEANUP            = YES