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                = lnet/klnds/ciblnd/ \
 107                          lnet/klnds/gmlnd/ \
 108                          lnet/klnds/iiblnd/ \
 109                          lnet/klnds/mxlnd/ \
 110                          lnet/klnds/openiblnd/ \
 111                          lnet/klnds/qswlnd/ \
 112                          lnet/klnds/ralnd/ \
 113                          lnet/klnds/viblnd/
 114 EXCLUDE_SYMLINKS       = NO
 115 EXCLUDE_PATTERNS       =
 116 EXCLUDE_SYMBOLS        = EXPORT_SYMBOL*
 117 EXAMPLE_PATH           =
 118 EXAMPLE_PATTERNS       = *
 119 EXAMPLE_RECURSIVE      = NO
 120 IMAGE_PATH             =
 121 INPUT_FILTER           =
 122 FILTER_PATTERNS        =
 123 FILTER_SOURCE_FILES    = NO
 124 #---------------------------------------------------------------------------
 125 # configuration options related to source browsing
 126 #---------------------------------------------------------------------------
 127 SOURCE_BROWSER         = YES
 128 INLINE_SOURCES         = YES
 129 STRIP_CODE_COMMENTS    = YES
 130 REFERENCED_BY_RELATION = YES
 131 REFERENCES_RELATION    = YES
 132 REFERENCES_LINK_SOURCE = YES
 133 USE_HTAGS              = NO
 134 VERBATIM_HEADERS       = YES
 135 #---------------------------------------------------------------------------
 136 # configuration options related to the alphabetical class index
 137 #---------------------------------------------------------------------------
 138 ALPHABETICAL_INDEX     = YES
 139 COLS_IN_ALPHA_INDEX    = 5
 140 IGNORE_PREFIX          =
 141 #---------------------------------------------------------------------------
 142 # configuration options related to the HTML output
 143 #---------------------------------------------------------------------------
 144 GENERATE_HTML          = YES
 145 HTML_OUTPUT            = html
 146 HTML_FILE_EXTENSION    = .html
 147 HTML_HEADER            = build/doxygen-header.html
 148 HTML_FOOTER            = build/doxygen-footer.html
 149 HTML_TIMESTAMP         = NO
 150 HTML_STYLESHEET        = build/doxygen-stylesheet.css
 151 HTML_ALIGN_MEMBERS     = YES
 152 HTML_DYNAMIC_SECTIONS  = NO
 153 GENERATE_DOCSET        = NO
 154 DOCSET_FEEDNAME        = "Doxygen generated docs"
 155 DOCSET_BUNDLE_ID       = org.doxygen.Project
 156 GENERATE_HTMLHELP      = NO
 157 CHM_FILE               =
 158 HHC_LOCATION           =
 159 GENERATE_CHI           = NO
 160 CHM_INDEX_ENCODING     =
 161 BINARY_TOC             = NO
 162 TOC_EXPAND             = NO
 163 GENERATE_QHP           = NO
 164 QCH_FILE               =
 165 QHP_NAMESPACE          = org.doxygen.Project
 166 QHP_VIRTUAL_FOLDER     = doc
 167 QHP_CUST_FILTER_NAME   =
 168 QHP_CUST_FILTER_ATTRS  =
 169 QHP_SECT_FILTER_ATTRS  =
 170 QHG_LOCATION           =
 171 DISABLE_INDEX          = NO
 172 ENUM_VALUES_PER_LINE   = 4
 173 GENERATE_TREEVIEW      = YES
 174 USE_INLINE_TREES       = NO
 175 TREEVIEW_WIDTH         = 250
 176 FORMULA_FONTSIZE       = 10
 177 SEARCHENGINE           = YES
 178 #---------------------------------------------------------------------------
 179 # configuration options related to the LaTeX output
 180 #---------------------------------------------------------------------------
 181 GENERATE_LATEX         = NO
 182 LATEX_OUTPUT           = latex
 183 LATEX_CMD_NAME         = latex
 184 MAKEINDEX_CMD_NAME     = makeindex
 185 COMPACT_LATEX          = NO
 186 PAPER_TYPE             = a4wide
 187 EXTRA_PACKAGES         =
 188 LATEX_HEADER           =
 189 PDF_HYPERLINKS         = YES
 190 USE_PDFLATEX           = YES
 191 LATEX_BATCHMODE        = NO
 192 LATEX_HIDE_INDICES     = NO
 193 LATEX_SOURCE_CODE      = NO
 194 #---------------------------------------------------------------------------
 195 # configuration options related to the RTF output
 196 #---------------------------------------------------------------------------
 197 GENERATE_RTF           = NO
 198 RTF_OUTPUT             = rtf
 199 COMPACT_RTF            = NO
 200 RTF_HYPERLINKS         = YES
 201 RTF_STYLESHEET_FILE    =
 202 RTF_EXTENSIONS_FILE    =
 203 #---------------------------------------------------------------------------
 204 # configuration options related to the man page output
 205 #---------------------------------------------------------------------------
 206 GENERATE_MAN           = NO
 207 MAN_OUTPUT             = man
 208 MAN_EXTENSION          = .3
 209 MAN_LINKS              = NO
 210 #---------------------------------------------------------------------------
 211 # configuration options related to the XML output
 212 #---------------------------------------------------------------------------
 213 GENERATE_XML           = NO
 214 XML_OUTPUT             = xml
 215 XML_SCHEMA             =
 216 XML_DTD                =
 217 XML_PROGRAMLISTING     = YES
 218 #---------------------------------------------------------------------------
 219 # configuration options for the AutoGen Definitions output
 220 #---------------------------------------------------------------------------
 221 GENERATE_AUTOGEN_DEF   = NO
 222 #---------------------------------------------------------------------------
 223 # configuration options related to the Perl module output
 224 #---------------------------------------------------------------------------
 225 GENERATE_PERLMOD       = NO
 226 PERLMOD_LATEX          = NO
 227 PERLMOD_PRETTY         = YES
 228 PERLMOD_MAKEVAR_PREFIX =
 229 #---------------------------------------------------------------------------
 230 # Configuration options related to the preprocessor
 231 #---------------------------------------------------------------------------
 232 ENABLE_PREPROCESSING   = YES
 233 MACRO_EXPANSION        = NO
 234 EXPAND_ONLY_PREDEF     = YES
 235 SEARCH_INCLUDES        = YES
 236 INCLUDE_PATH           =
 237 INCLUDE_FILE_PATTERNS  =
 238 PREDEFINED             = KERNEL_VERSION(a,b,c)=(((a)<<16)+((b)<<8)+(c))
 239 EXPAND_AS_DEFINED      =
 240 SKIP_FUNCTION_MACROS   = YES
 241 #---------------------------------------------------------------------------
 242 # Configuration::additions related to external references
 243 #---------------------------------------------------------------------------
 244 TAGFILES               =
 245 GENERATE_TAGFILE       =
 246 ALLEXTERNALS           = NO
 247 EXTERNAL_GROUPS        = YES
 248 PERL_PATH              = /usr/bin/perl
 249 #---------------------------------------------------------------------------
 250 # Configuration options related to the dot tool
 251 #---------------------------------------------------------------------------
 252 CLASS_DIAGRAMS         = YES
 253 MSCGEN_PATH            =
 254 HIDE_UNDOC_RELATIONS   = YES
 255 HAVE_DOT               = YES
 256 DOT_FONTNAME           = FreeSans
 257 DOT_FONTSIZE           = 10
 258 DOT_FONTPATH           =
 259 CLASS_GRAPH            = YES
 260 COLLABORATION_GRAPH    = YES
 261 GROUP_GRAPHS           = YES
 262 UML_LOOK               = YES
 263 TEMPLATE_RELATIONS     = NO
 264 INCLUDE_GRAPH          = YES
 265 INCLUDED_BY_GRAPH      = YES
 266 CALL_GRAPH             = YES
 267 CALLER_GRAPH           = YES
 268 GRAPHICAL_HIERARCHY    = YES
 269 DIRECTORY_GRAPH        = YES
 270 DOT_IMAGE_FORMAT       = png
 271 DOT_PATH               =
 272 DOTFILE_DIRS           =
 273 DOT_GRAPH_MAX_NODES    = 50
 274 MAX_DOT_GRAPH_DEPTH    = 1000
 275 DOT_TRANSPARENT        = NO
 276 DOT_MULTI_TARGETS      = NO
 277 GENERATE_LEGEND        = YES
 278 DOT_CLEANUP            = YES