build/doxyfile.api

   1 # Doxyfile 1.6.1
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = Lustre
   8 PROJECT_NUMBER         = 1.10
   9 OUTPUT_DIRECTORY       = doxygen.api
  10 CREATE_SUBDIRS         = NO
  11 OUTPUT_LANGUAGE        = English
  12 BRIEF_MEMBER_DESC      = YES
  13 REPEAT_BRIEF           = YES
  14 ABBREVIATE_BRIEF       = "The $name class" \
  15                          "The $name widget" \
  16                          "The $name file" \
  17                          is \
  18                          provides \
  19                          specifies \
  20                          contains \
  21                          represents \
  22                          a \
  23                          an \
  24                          the
  25 ALWAYS_DETAILED_SEC    = NO
  26 INLINE_INHERITED_MEMB  = NO
  27 FULL_PATH_NAMES        = YES
  28 STRIP_FROM_PATH        =
  29 STRIP_FROM_INC_PATH    =
  30 SHORT_NAMES            = NO
  31 JAVADOC_AUTOBRIEF      = YES
  32 QT_AUTOBRIEF           = NO
  33 MULTILINE_CPP_IS_BRIEF = NO
  34 INHERIT_DOCS           = YES
  35 SEPARATE_MEMBER_PAGES  = NO
  36 TAB_SIZE               = 8
  37 ALIASES                =
  38 OPTIMIZE_OUTPUT_FOR_C  = YES
  39 OPTIMIZE_OUTPUT_JAVA   = NO
  40 OPTIMIZE_FOR_FORTRAN   = NO
  41 OPTIMIZE_OUTPUT_VHDL   = NO
  42 EXTENSION_MAPPING      =
  43 BUILTIN_STL_SUPPORT    = NO
  44 CPP_CLI_SUPPORT        = NO
  45 SIP_SUPPORT            = NO
  46 IDL_PROPERTY_SUPPORT   = YES
  47 DISTRIBUTE_GROUP_DOC   = NO
  48 SUBGROUPING            = YES
  49 TYPEDEF_HIDES_STRUCT   = NO
  50 SYMBOL_CACHE_SIZE      = 0
  51 #---------------------------------------------------------------------------
  52 # Build related configuration options
  53 #---------------------------------------------------------------------------
  54 EXTRACT_ALL            = NO
  55 EXTRACT_PRIVATE        = NO
  56 EXTRACT_STATIC         = NO
  57 EXTRACT_LOCAL_CLASSES  = NO
  58 EXTRACT_LOCAL_METHODS  = NO
  59 EXTRACT_ANON_NSPACES   = NO
  60 HIDE_UNDOC_MEMBERS     = NO
  61 HIDE_UNDOC_CLASSES     = NO
  62 HIDE_FRIEND_COMPOUNDS  = NO
  63 HIDE_IN_BODY_DOCS      = NO
  64 INTERNAL_DOCS          = NO
  65 CASE_SENSE_NAMES       = YES
  66 HIDE_SCOPE_NAMES       = NO
  67 SHOW_INCLUDE_FILES     = YES
  68 INLINE_INFO            = YES
  69 SORT_MEMBER_DOCS       = YES
  70 SORT_BRIEF_DOCS        = NO
  71 SORT_MEMBERS_CTORS_1ST = NO
  72 SORT_GROUP_NAMES       = NO
  73 SORT_BY_SCOPE_NAME     = NO
  74 GENERATE_TODOLIST      = YES
  75 GENERATE_TESTLIST      = YES
  76 GENERATE_BUGLIST       = YES
  77 GENERATE_DEPRECATEDLIST= YES
  78 ENABLED_SECTIONS       =
  79 MAX_INITIALIZER_LINES  = 30
  80 SHOW_USED_FILES        = YES
  81 SHOW_DIRECTORIES       = NO
  82 SHOW_FILES             = YES
  83 SHOW_NAMESPACES        = YES
  84 FILE_VERSION_FILTER    =
  85 LAYOUT_FILE            =
  86 #---------------------------------------------------------------------------
  87 # configuration options related to warning and progress messages
  88 #---------------------------------------------------------------------------
  89 QUIET                  = YES
  90 WARNINGS               = YES
  91 WARN_IF_UNDOCUMENTED   = YES
  92 WARN_IF_DOC_ERROR      = YES
  93 WARN_NO_PARAMDOC       = NO
  94 WARN_FORMAT            = "$file:$line: $text  "
  95 WARN_LOGFILE           =
  96 #---------------------------------------------------------------------------
  97 # configuration options related to the input files
  98 #---------------------------------------------------------------------------
  99 INPUT                  = lustre/ \
 100                          lnet/ \
 101                          libcfs/
 102 INPUT_ENCODING         = UTF-8
 103 FILE_PATTERNS          = *.h \
 104                          *.c
 105 RECURSIVE              = YES
 106 EXCLUDE                =
 107 EXCLUDE_SYMLINKS       = NO
 108 EXCLUDE_PATTERNS       =
 109 EXCLUDE_SYMBOLS        = EXPORT_SYMBOL*
 110 EXAMPLE_PATH           =
 111 EXAMPLE_PATTERNS       = *
 112 EXAMPLE_RECURSIVE      = NO
 113 IMAGE_PATH             =
 114 INPUT_FILTER           =
 115 FILTER_PATTERNS        =
 116 FILTER_SOURCE_FILES    = NO
 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 = YES
 124 REFERENCES_RELATION    = YES
 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            = build/doxygen-header.html
 141 HTML_FOOTER            = build/doxygen-footer.html
 142 HTML_TIMESTAMP         = NO
 143 HTML_STYLESHEET        = build/doxygen-stylesheet.css
 144 HTML_ALIGN_MEMBERS     = YES
 145 HTML_DYNAMIC_SECTIONS  = NO
 146 GENERATE_DOCSET        = NO
 147 DOCSET_FEEDNAME        = "Doxygen generated docs"
 148 DOCSET_BUNDLE_ID       = org.doxygen.Project
 149 GENERATE_HTMLHELP      = NO
 150 CHM_FILE               =
 151 HHC_LOCATION           =
 152 GENERATE_CHI           = NO
 153 CHM_INDEX_ENCODING     =
 154 BINARY_TOC             = NO
 155 TOC_EXPAND             = NO
 156 GENERATE_QHP           = NO
 157 QCH_FILE               =
 158 QHP_NAMESPACE          = org.doxygen.Project
 159 QHP_VIRTUAL_FOLDER     = doc
 160 QHP_CUST_FILTER_NAME   =
 161 QHP_CUST_FILTER_ATTRS  =
 162 QHP_SECT_FILTER_ATTRS  =
 163 QHG_LOCATION           =
 164 DISABLE_INDEX          = NO
 165 ENUM_VALUES_PER_LINE   = 4
 166 GENERATE_TREEVIEW      = YES
 167 USE_INLINE_TREES       = NO
 168 TREEVIEW_WIDTH         = 250
 169 FORMULA_FONTSIZE       = 10
 170 SEARCHENGINE           = YES
 171 #---------------------------------------------------------------------------
 172 # configuration options related to the LaTeX output
 173 #---------------------------------------------------------------------------
 174 GENERATE_LATEX         = NO
 175 LATEX_OUTPUT           = latex
 176 LATEX_CMD_NAME         = latex
 177 MAKEINDEX_CMD_NAME     = makeindex
 178 COMPACT_LATEX          = NO
 179 PAPER_TYPE             = a4wide
 180 EXTRA_PACKAGES         =
 181 LATEX_HEADER           =
 182 PDF_HYPERLINKS         = YES
 183 USE_PDFLATEX           = YES
 184 LATEX_BATCHMODE        = NO
 185 LATEX_HIDE_INDICES     = NO
 186 LATEX_SOURCE_CODE      = NO
 187 #---------------------------------------------------------------------------
 188 # configuration options related to the RTF output
 189 #---------------------------------------------------------------------------
 190 GENERATE_RTF           = NO
 191 RTF_OUTPUT             = rtf
 192 COMPACT_RTF            = NO
 193 RTF_HYPERLINKS         = YES
 194 RTF_STYLESHEET_FILE    =
 195 RTF_EXTENSIONS_FILE    =
 196 #---------------------------------------------------------------------------
 197 # configuration options related to the man page output
 198 #---------------------------------------------------------------------------
 199 GENERATE_MAN           = NO
 200 MAN_OUTPUT             = man
 201 MAN_EXTENSION          = .3
 202 MAN_LINKS              = NO
 203 #---------------------------------------------------------------------------
 204 # configuration options related to the XML output
 205 #---------------------------------------------------------------------------
 206 GENERATE_XML           = NO
 207 XML_OUTPUT             = xml
 208 XML_SCHEMA             =
 209 XML_DTD                =
 210 XML_PROGRAMLISTING     = YES
 211 #---------------------------------------------------------------------------
 212 # configuration options for the AutoGen Definitions output
 213 #---------------------------------------------------------------------------
 214 GENERATE_AUTOGEN_DEF   = NO
 215 #---------------------------------------------------------------------------
 216 # configuration options related to the Perl module output
 217 #---------------------------------------------------------------------------
 218 GENERATE_PERLMOD       = NO
 219 PERLMOD_LATEX          = NO
 220 PERLMOD_PRETTY         = YES
 221 PERLMOD_MAKEVAR_PREFIX =
 222 #---------------------------------------------------------------------------
 223 # Configuration options related to the preprocessor
 224 #---------------------------------------------------------------------------
 225 ENABLE_PREPROCESSING   = YES
 226 MACRO_EXPANSION        = NO
 227 EXPAND_ONLY_PREDEF     = YES
 228 SEARCH_INCLUDES        = YES
 229 INCLUDE_PATH           =
 230 INCLUDE_FILE_PATTERNS  =
 231 PREDEFINED             = KERNEL_VERSION(a,b,c)=(((a)<<16)+((b)<<8)+(c))
 232 EXPAND_AS_DEFINED      =
 233 SKIP_FUNCTION_MACROS   = YES
 234 #---------------------------------------------------------------------------
 235 # Configuration::additions related to external references
 236 #---------------------------------------------------------------------------
 237 TAGFILES               =
 238 GENERATE_TAGFILE       =
 239 ALLEXTERNALS           = NO
 240 EXTERNAL_GROUPS        = YES
 241 PERL_PATH              = /usr/bin/perl
 242 #---------------------------------------------------------------------------
 243 # Configuration options related to the dot tool
 244 #---------------------------------------------------------------------------
 245 CLASS_DIAGRAMS         = YES
 246 MSCGEN_PATH            =
 247 HIDE_UNDOC_RELATIONS   = YES
 248 HAVE_DOT               = YES
 249 DOT_FONTNAME           = FreeSans
 250 DOT_FONTSIZE           = 10
 251 DOT_FONTPATH           =
 252 CLASS_GRAPH            = YES
 253 COLLABORATION_GRAPH    = YES
 254 GROUP_GRAPHS           = YES
 255 UML_LOOK               = YES
 256 TEMPLATE_RELATIONS     = NO
 257 INCLUDE_GRAPH          = YES
 258 INCLUDED_BY_GRAPH      = YES
 259 CALL_GRAPH             = YES
 260 CALLER_GRAPH           = YES
 261 GRAPHICAL_HIERARCHY    = YES
 262 DIRECTORY_GRAPH        = YES
 263 DOT_IMAGE_FORMAT       = png
 264 DOT_PATH               =
 265 DOTFILE_DIRS           =
 266 DOT_GRAPH_MAX_NODES    = 50
 267 MAX_DOT_GRAPH_DEPTH    = 1000
 268 DOT_TRANSPARENT        = NO
 269 DOT_MULTI_TARGETS      = NO
 270 GENERATE_LEGEND        = YES
 271 DOT_CLEANUP            = YES