build/doxyfile.api

   1 # Doxyfile 1.5.3
   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       = apidoc.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 DETAILS_AT_TOP         = NO
  35 INHERIT_DOCS           = YES
  36 SEPARATE_MEMBER_PAGES  = NO
  37 TAB_SIZE               = 8
  38 ALIASES                =
  39 OPTIMIZE_OUTPUT_FOR_C  = YES
  40 OPTIMIZE_OUTPUT_JAVA   = NO
  41 BUILTIN_STL_SUPPORT    = NO
  42 CPP_CLI_SUPPORT        = NO
  43 DISTRIBUTE_GROUP_DOC   = NO
  44 SUBGROUPING            = YES
  45 #---------------------------------------------------------------------------
  46 # Build related configuration options
  47 #---------------------------------------------------------------------------
  48 EXTRACT_ALL            = YES
  49 EXTRACT_PRIVATE        = YES
  50 EXTRACT_STATIC         = YES
  51 EXTRACT_LOCAL_CLASSES  = YES
  52 EXTRACT_LOCAL_METHODS  = NO
  53 EXTRACT_ANON_NSPACES   = NO
  54 HIDE_UNDOC_MEMBERS     = NO
  55 HIDE_UNDOC_CLASSES     = NO
  56 HIDE_FRIEND_COMPOUNDS  = NO
  57 HIDE_IN_BODY_DOCS      = NO
  58 INTERNAL_DOCS          = NO
  59 CASE_SENSE_NAMES       = YES
  60 HIDE_SCOPE_NAMES       = NO
  61 SHOW_INCLUDE_FILES     = YES
  62 INLINE_INFO            = YES
  63 SORT_MEMBER_DOCS       = YES
  64 SORT_BRIEF_DOCS        = NO
  65 SORT_BY_SCOPE_NAME     = NO
  66 GENERATE_TODOLIST      = YES
  67 GENERATE_TESTLIST      = YES
  68 GENERATE_BUGLIST       = YES
  69 GENERATE_DEPRECATEDLIST= YES
  70 ENABLED_SECTIONS       =
  71 MAX_INITIALIZER_LINES  = 30
  72 SHOW_USED_FILES        = YES
  73 SHOW_DIRECTORIES       = NO
  74 FILE_VERSION_FILTER    =
  75 #---------------------------------------------------------------------------
  76 # configuration options related to warning and progress messages
  77 #---------------------------------------------------------------------------
  78 QUIET                  = NO
  79 WARNINGS               = YES
  80 WARN_IF_UNDOCUMENTED   = YES
  81 WARN_IF_DOC_ERROR      = YES
  82 WARN_NO_PARAMDOC       = NO
  83 WARN_FORMAT            = "$file:$line: $text"
  84 WARN_LOGFILE           =
  85 #---------------------------------------------------------------------------
  86 # configuration options related to the input files
  87 #---------------------------------------------------------------------------
  88 INPUT                  = lustre/include \
  89                          lustre/obdclass \
  90                          lustre/llite \
  91                          lustre/lov \
  92                          lustre/osc \
  93 INPUT_ENCODING         = UTF-8
  94 FILE_PATTERNS          = *_object.h \
  95                          cl_*.c \
  96                          *_object.c \
  97                          *_cl.c
  98 RECURSIVE              = YES
  99 EXCLUDE                =
 100 EXCLUDE_SYMLINKS       = NO
 101 EXCLUDE_PATTERNS       =
 102 EXCLUDE_SYMBOLS        = EXPORT_SYMBOL*
 103 EXAMPLE_PATH           =
 104 EXAMPLE_PATTERNS       = *
 105 EXAMPLE_RECURSIVE      = NO
 106 IMAGE_PATH             =
 107 INPUT_FILTER           =
 108 FILTER_PATTERNS        =
 109 FILTER_SOURCE_FILES    = NO
 110 #---------------------------------------------------------------------------
 111 # configuration options related to source browsing
 112 #---------------------------------------------------------------------------
 113 SOURCE_BROWSER         = YES
 114 INLINE_SOURCES         = YES
 115 STRIP_CODE_COMMENTS    = YES
 116 REFERENCED_BY_RELATION = YES
 117 REFERENCES_RELATION    = YES
 118 REFERENCES_LINK_SOURCE = YES
 119 USE_HTAGS              = NO
 120 VERBATIM_HEADERS       = YES
 121 #---------------------------------------------------------------------------
 122 # configuration options related to the alphabetical class index
 123 #---------------------------------------------------------------------------
 124 ALPHABETICAL_INDEX     = YES
 125 COLS_IN_ALPHA_INDEX    = 5
 126 IGNORE_PREFIX          =
 127 #---------------------------------------------------------------------------
 128 # configuration options related to the HTML output
 129 #---------------------------------------------------------------------------
 130 GENERATE_HTML          = YES
 131 HTML_OUTPUT            = html
 132 HTML_FILE_EXTENSION    = .html
 133 HTML_HEADER            =
 134 HTML_FOOTER            =
 135 HTML_STYLESHEET        =
 136 HTML_ALIGN_MEMBERS     = YES
 137 GENERATE_HTMLHELP      = NO
 138 HTML_DYNAMIC_SECTIONS  = NO
 139 CHM_FILE               =
 140 HHC_LOCATION           =
 141 GENERATE_CHI           = NO
 142 BINARY_TOC             = NO
 143 TOC_EXPAND             = NO
 144 DISABLE_INDEX          = NO
 145 ENUM_VALUES_PER_LINE   = 4
 146 GENERATE_TREEVIEW      = YES
 147 TREEVIEW_WIDTH         = 250
 148 #---------------------------------------------------------------------------
 149 # configuration options related to the LaTeX output
 150 #---------------------------------------------------------------------------
 151 GENERATE_LATEX         = YES
 152 LATEX_OUTPUT           = latex
 153 LATEX_CMD_NAME         = latex
 154 MAKEINDEX_CMD_NAME     = makeindex
 155 COMPACT_LATEX          = NO
 156 PAPER_TYPE             = a4wide
 157 EXTRA_PACKAGES         =
 158 LATEX_HEADER           =
 159 PDF_HYPERLINKS         = YES
 160 USE_PDFLATEX           = YES
 161 LATEX_BATCHMODE        = NO
 162 LATEX_HIDE_INDICES     = NO
 163 #---------------------------------------------------------------------------
 164 # configuration options related to the RTF output
 165 #---------------------------------------------------------------------------
 166 GENERATE_RTF           = YES
 167 RTF_OUTPUT             = rtf
 168 COMPACT_RTF            = NO
 169 RTF_HYPERLINKS         = YES
 170 RTF_STYLESHEET_FILE    =
 171 RTF_EXTENSIONS_FILE    =
 172 #---------------------------------------------------------------------------
 173 # configuration options related to the man page output
 174 #---------------------------------------------------------------------------
 175 GENERATE_MAN           = YES
 176 MAN_OUTPUT             = man
 177 MAN_EXTENSION          = .3
 178 MAN_LINKS              = NO
 179 #---------------------------------------------------------------------------
 180 # configuration options related to the XML output
 181 #---------------------------------------------------------------------------
 182 GENERATE_XML           = NO
 183 XML_OUTPUT             = xml
 184 XML_SCHEMA             =
 185 XML_DTD                =
 186 XML_PROGRAMLISTING     = YES
 187 #---------------------------------------------------------------------------
 188 # configuration options for the AutoGen Definitions output
 189 #---------------------------------------------------------------------------
 190 GENERATE_AUTOGEN_DEF   = NO
 191 #---------------------------------------------------------------------------
 192 # configuration options related to the Perl module output
 193 #---------------------------------------------------------------------------
 194 GENERATE_PERLMOD       = NO
 195 PERLMOD_LATEX          = NO
 196 PERLMOD_PRETTY         = YES
 197 PERLMOD_MAKEVAR_PREFIX =
 198 #---------------------------------------------------------------------------
 199 # Configuration options related to the preprocessor
 200 #---------------------------------------------------------------------------
 201 ENABLE_PREPROCESSING   = YES
 202 MACRO_EXPANSION        = NO
 203 EXPAND_ONLY_PREDEF     = NO
 204 SEARCH_INCLUDES        = YES
 205 INCLUDE_PATH           =
 206 INCLUDE_FILE_PATTERNS  =
 207 PREDEFINED             =
 208 EXPAND_AS_DEFINED      =
 209 SKIP_FUNCTION_MACROS   = YES
 210 #---------------------------------------------------------------------------
 211 # Configuration::additions related to external references
 212 #---------------------------------------------------------------------------
 213 TAGFILES               =
 214 GENERATE_TAGFILE       =
 215 ALLEXTERNALS           = NO
 216 EXTERNAL_GROUPS        = YES
 217 PERL_PATH              = /usr/bin/perl
 218 #---------------------------------------------------------------------------
 219 # Configuration options related to the dot tool
 220 #---------------------------------------------------------------------------
 221 CLASS_DIAGRAMS         = NO
 222 MSCGEN_PATH            =
 223 HIDE_UNDOC_RELATIONS   = YES
 224 HAVE_DOT               = YES
 225 CLASS_GRAPH            = YES
 226 COLLABORATION_GRAPH    = YES
 227 GROUP_GRAPHS           = YES
 228 UML_LOOK               = YES
 229 TEMPLATE_RELATIONS     = NO
 230 INCLUDE_GRAPH          = YES
 231 INCLUDED_BY_GRAPH      = YES
 232 CALL_GRAPH             = YES
 233 CALLER_GRAPH           = YES
 234 GRAPHICAL_HIERARCHY    = YES
 235 DIRECTORY_GRAPH        = YES
 236 DOT_IMAGE_FORMAT       = png
 237 DOT_PATH               =
 238 DOTFILE_DIRS           =
 239 DOT_GRAPH_MAX_NODES    = 50
 240 MAX_DOT_GRAPH_DEPTH    = 1000
 241 DOT_TRANSPARENT        = NO
 242 DOT_MULTI_TARGETS      = NO
 243 GENERATE_LEGEND        = YES
 244 DOT_CLEANUP            = YES
 245 #---------------------------------------------------------------------------
 246 # Configuration::additions related to the search engine
 247 #---------------------------------------------------------------------------
 248 SEARCHENGINE           = YES