build/doxyfile.ref

   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.ref
  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 \
  94                          = \
  95                          UTF-8
  96 INPUT_ENCODING         = UTF-8
  97 FILE_PATTERNS          = *_object.h \
  98                          cl_*.c \
  99                          *_object.c \
 100                          *_cl.c
 101 RECURSIVE              = YES
 102 EXCLUDE                =
 103 EXCLUDE_SYMLINKS       = NO
 104 EXCLUDE_PATTERNS       =
 105 EXCLUDE_SYMBOLS        = EXPORT_SYMBOL*
 106 EXAMPLE_PATH           =
 107 EXAMPLE_PATTERNS       = *
 108 EXAMPLE_RECURSIVE      = NO
 109 IMAGE_PATH             =
 110 INPUT_FILTER           =
 111 FILTER_PATTERNS        =
 112 FILTER_SOURCE_FILES    = NO
 113 #---------------------------------------------------------------------------
 114 # configuration options related to source browsing
 115 #---------------------------------------------------------------------------
 116 SOURCE_BROWSER         = YES
 117 INLINE_SOURCES         = NO
 118 STRIP_CODE_COMMENTS    = YES
 119 REFERENCED_BY_RELATION = YES
 120 REFERENCES_RELATION    = YES
 121 REFERENCES_LINK_SOURCE = YES
 122 USE_HTAGS              = NO
 123 VERBATIM_HEADERS       = YES
 124 #---------------------------------------------------------------------------
 125 # configuration options related to the alphabetical class index
 126 #---------------------------------------------------------------------------
 127 ALPHABETICAL_INDEX     = YES
 128 COLS_IN_ALPHA_INDEX    = 5
 129 IGNORE_PREFIX          =
 130 #---------------------------------------------------------------------------
 131 # configuration options related to the HTML output
 132 #---------------------------------------------------------------------------
 133 GENERATE_HTML          = YES
 134 HTML_OUTPUT            = html
 135 HTML_FILE_EXTENSION    = .html
 136 HTML_HEADER            =
 137 HTML_FOOTER            =
 138 HTML_STYLESHEET        =
 139 HTML_ALIGN_MEMBERS     = YES
 140 GENERATE_HTMLHELP      = NO
 141 HTML_DYNAMIC_SECTIONS  = NO
 142 CHM_FILE               =
 143 HHC_LOCATION           =
 144 GENERATE_CHI           = NO
 145 BINARY_TOC             = NO
 146 TOC_EXPAND             = NO
 147 DISABLE_INDEX          = NO
 148 ENUM_VALUES_PER_LINE   = 4
 149 GENERATE_TREEVIEW      = YES
 150 TREEVIEW_WIDTH         = 250
 151 #---------------------------------------------------------------------------
 152 # configuration options related to the LaTeX output
 153 #---------------------------------------------------------------------------
 154 GENERATE_LATEX         = NO
 155 LATEX_OUTPUT           = latex
 156 LATEX_CMD_NAME         = latex
 157 MAKEINDEX_CMD_NAME     = makeindex
 158 COMPACT_LATEX          = NO
 159 PAPER_TYPE             = a4wide
 160 EXTRA_PACKAGES         =
 161 LATEX_HEADER           =
 162 PDF_HYPERLINKS         = YES
 163 USE_PDFLATEX           = YES
 164 LATEX_BATCHMODE        = NO
 165 LATEX_HIDE_INDICES     = NO
 166 #---------------------------------------------------------------------------
 167 # configuration options related to the RTF output
 168 #---------------------------------------------------------------------------
 169 GENERATE_RTF           = NO
 170 RTF_OUTPUT             = rtf
 171 COMPACT_RTF            = NO
 172 RTF_HYPERLINKS         = YES
 173 RTF_STYLESHEET_FILE    =
 174 RTF_EXTENSIONS_FILE    =
 175 #---------------------------------------------------------------------------
 176 # configuration options related to the man page output
 177 #---------------------------------------------------------------------------
 178 GENERATE_MAN           = NO
 179 MAN_OUTPUT             = man
 180 MAN_EXTENSION          = .3
 181 MAN_LINKS              = NO
 182 #---------------------------------------------------------------------------
 183 # configuration options related to the XML output
 184 #---------------------------------------------------------------------------
 185 GENERATE_XML           = NO
 186 XML_OUTPUT             = xml
 187 XML_SCHEMA             =
 188 XML_DTD                =
 189 XML_PROGRAMLISTING     = YES
 190 #---------------------------------------------------------------------------
 191 # configuration options for the AutoGen Definitions output
 192 #---------------------------------------------------------------------------
 193 GENERATE_AUTOGEN_DEF   = NO
 194 #---------------------------------------------------------------------------
 195 # configuration options related to the Perl module output
 196 #---------------------------------------------------------------------------
 197 GENERATE_PERLMOD       = NO
 198 PERLMOD_LATEX          = NO
 199 PERLMOD_PRETTY         = YES
 200 PERLMOD_MAKEVAR_PREFIX =
 201 #---------------------------------------------------------------------------
 202 # Configuration options related to the preprocessor
 203 #---------------------------------------------------------------------------
 204 ENABLE_PREPROCESSING   = YES
 205 MACRO_EXPANSION        = NO
 206 EXPAND_ONLY_PREDEF     = NO
 207 SEARCH_INCLUDES        = YES
 208 INCLUDE_PATH           =
 209 INCLUDE_FILE_PATTERNS  =
 210 PREDEFINED             =
 211 EXPAND_AS_DEFINED      =
 212 SKIP_FUNCTION_MACROS   = YES
 213 #---------------------------------------------------------------------------
 214 # Configuration::additions related to external references
 215 #---------------------------------------------------------------------------
 216 TAGFILES               =
 217 GENERATE_TAGFILE       =
 218 ALLEXTERNALS           = NO
 219 EXTERNAL_GROUPS        = YES
 220 PERL_PATH              = /usr/bin/perl
 221 #---------------------------------------------------------------------------
 222 # Configuration options related to the dot tool
 223 #---------------------------------------------------------------------------
 224 CLASS_DIAGRAMS         = NO
 225 MSCGEN_PATH            =
 226 HIDE_UNDOC_RELATIONS   = YES
 227 HAVE_DOT               = YES
 228 CLASS_GRAPH            = YES
 229 COLLABORATION_GRAPH    = NO
 230 GROUP_GRAPHS           = NO
 231 UML_LOOK               = YES
 232 TEMPLATE_RELATIONS     = NO
 233 INCLUDE_GRAPH          = NO
 234 INCLUDED_BY_GRAPH      = NO
 235 CALL_GRAPH             = NO
 236 CALLER_GRAPH           = NO
 237 GRAPHICAL_HIERARCHY    = NO
 238 DIRECTORY_GRAPH        = YES
 239 DOT_IMAGE_FORMAT       = png
 240 DOT_PATH               =
 241 DOTFILE_DIRS           =
 242 DOT_GRAPH_MAX_NODES    = 50
 243 MAX_DOT_GRAPH_DEPTH    = 1000
 244 DOT_TRANSPARENT        = NO
 245 DOT_MULTI_TARGETS      = NO
 246 GENERATE_LEGEND        = YES
 247 DOT_CLEANUP            = YES
 248 #---------------------------------------------------------------------------
 249 # Configuration::additions related to the search engine
 250 #---------------------------------------------------------------------------
 251 SEARCHENGINE           = YES