Doxyfile

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