tools/kerneldoc/subsys/common-Doxyfile

   1 # Doxyfile 1.5.2
   2
   3 # $FreeBSD$
   4
   5 #---------------------------------------------------------------------------
   6 # Project related configuration options
   7 #---------------------------------------------------------------------------
   8 DOXYFILE_ENCODING      = UTF-8
   9 PROJECT_NUMBER         =
  10 CREATE_SUBDIRS         = YES
  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        = $(DOXYGEN_SRC_PATH) $(DOXYGEN_DEST_PATH)
  29 STRIP_FROM_INC_PATH    =
  30 SHORT_NAMES            = NO
  31 JAVADOC_AUTOBRIEF      = NO
  32 MULTILINE_CPP_IS_BRIEF = NO
  33 INHERIT_DOCS           = YES
  34 SEPARATE_MEMBER_PAGES  = NO
  35 TAB_SIZE               = 8
  36 ALIASES                =
  37 OPTIMIZE_OUTPUT_FOR_C  = YES
  38 OPTIMIZE_OUTPUT_JAVA   = NO
  39 BUILTIN_STL_SUPPORT    = NO
  40 CPP_CLI_SUPPORT        = NO
  41 DISTRIBUTE_GROUP_DOC   = NO
  42 SUBGROUPING            = YES
  43 #---------------------------------------------------------------------------
  44 # Build related configuration options
  45 #---------------------------------------------------------------------------
  46 EXTRACT_PRIVATE        = YES
  47 EXTRACT_STATIC         = YES
  48 EXTRACT_LOCAL_CLASSES  = YES
  49 EXTRACT_LOCAL_METHODS  = NO
  50 HIDE_UNDOC_MEMBERS     = NO
  51 HIDE_UNDOC_CLASSES     = NO
  52 HIDE_FRIEND_COMPOUNDS  = NO
  53 HIDE_IN_BODY_DOCS      = NO
  54 INTERNAL_DOCS          = YES
  55 CASE_SENSE_NAMES       = YES
  56 HIDE_SCOPE_NAMES       = NO
  57 SHOW_INCLUDE_FILES     = YES
  58 INLINE_INFO            = YES
  59 SORT_MEMBER_DOCS       = YES
  60 SORT_BRIEF_DOCS        = NO
  61 SORT_BY_SCOPE_NAME     = NO
  62 GENERATE_TODOLIST      = YES
  63 GENERATE_TESTLIST      = YES
  64 GENERATE_BUGLIST       = YES
  65 GENERATE_DEPRECATEDLIST= YES
  66 ENABLED_SECTIONS       =
  67 MAX_INITIALIZER_LINES  = 30
  68 SHOW_USED_FILES        = YES
  69 SHOW_DIRECTORIES       = YES
  70 FILE_VERSION_FILTER    =
  71 #---------------------------------------------------------------------------
  72 # configuration options related to warning and progress messages
  73 #---------------------------------------------------------------------------
  74 QUIET                  = NO
  75 WARNINGS               = YES
  76 WARN_IF_UNDOCUMENTED   = YES
  77 WARN_IF_DOC_ERROR      = YES
  78 WARN_NO_PARAMDOC       = NO
  79 WARN_FORMAT            = "$file:$line: $text"
  80 WARN_LOGFILE           =
  81
  82 #---------------------------------------------------------------------------
  83 # configuration options related to the input files
  84 #---------------------------------------------------------------------------
  85 INPUT_ENCODING         = UTF-8
  86 FILE_PATTERNS          = *.c \
  87                          *.cc \
  88                          *.cxx \
  89                          *.cpp \
  90                          *.c++ \
  91                          *.java \
  92                          *.ii \
  93                          *.ixx \
  94                          *.ipp \
  95                          *.i++ \
  96                          *.inl \
  97                          *.h \
  98                          *.hh \
  99                          *.hxx \
 100                          *.hpp \
 101                          *.h++ \
 102                          *.idl \
 103                          *.odl \
 104                          *.cs \
 105                          *.php \
 106                          *.php3 \
 107                          *.inc \
 108                          *.m \
 109                          *.mm \
 110                          *.dox \
 111                          *.C \
 112                          *.CC \
 113                          *.C++ \
 114                          *.II \
 115                          *.I++ \
 116                          *.H \
 117                          *.HH \
 118                          *.H++ \
 119                          *.CS \
 120                          *.PHP \
 121                          *.PHP3 \
 122                          *.M \
 123                          *.MM
 124 RECURSIVE              = YES
 125 EXCLUDE                =
 126 EXCLUDE_SYMLINKS       = NO
 127 EXCLUDE_PATTERNS       = */.\#* */.svn/*
 128 EXCLUDE_SYMBOLS        =
 129 EXAMPLE_PATH           =
 130 EXAMPLE_PATTERNS       = *
 131 EXAMPLE_RECURSIVE      = NO
 132 IMAGE_PATH             =
 133 INPUT_FILTER           =
 134 FILTER_PATTERNS        =
 135 FILTER_SOURCE_FILES    = NO
 136 #---------------------------------------------------------------------------
 137 # configuration options related to source browsing
 138 #---------------------------------------------------------------------------
 139 SOURCE_BROWSER         = YES
 140 INLINE_SOURCES         = NO
 141 STRIP_CODE_COMMENTS    = YES
 142 REFERENCED_BY_RELATION = YES
 143 REFERENCES_RELATION    = YES
 144 REFERENCES_LINK_SOURCE = YES
 145 USE_HTAGS              = NO
 146 VERBATIM_HEADERS       = YES
 147 #---------------------------------------------------------------------------
 148 # configuration options related to the alphabetical class index
 149 #---------------------------------------------------------------------------
 150 ALPHABETICAL_INDEX     = YES
 151 COLS_IN_ALPHA_INDEX    = 5
 152 IGNORE_PREFIX          =
 153 #---------------------------------------------------------------------------
 154 # configuration options related to the HTML output
 155 #---------------------------------------------------------------------------
 156 GENERATE_HTML          = YES
 157 HTML_OUTPUT            = html
 158 HTML_FILE_EXTENSION    = .html
 159 HTML_HEADER            =
 160 HTML_FOOTER            =
 161 HTML_STYLESHEET        =
 162 HTML_ALIGN_MEMBERS     = YES
 163 GENERATE_HTMLHELP      = NO
 164 CHM_FILE               =
 165 HHC_LOCATION           =
 166 GENERATE_CHI           = NO
 167 BINARY_TOC             = NO
 168 TOC_EXPAND             = NO
 169 DISABLE_INDEX          = NO
 170 ENUM_VALUES_PER_LINE   = 4
 171 GENERATE_TREEVIEW      = YES
 172 TREEVIEW_WIDTH         = 250
 173 #---------------------------------------------------------------------------
 174 # configuration options related to the LaTeX output
 175 #---------------------------------------------------------------------------
 176 GENERATE_LATEX         = YES
 177 LATEX_OUTPUT           = latex
 178 LATEX_CMD_NAME         = latex
 179 MAKEINDEX_CMD_NAME     = makeindex
 180 COMPACT_LATEX          = NO
 181 PAPER_TYPE             = a4wide
 182 EXTRA_PACKAGES         =
 183 LATEX_HEADER           =
 184 PDF_HYPERLINKS         = YES
 185 USE_PDFLATEX           = YES
 186 LATEX_BATCHMODE        = NO
 187 LATEX_HIDE_INDICES     = NO
 188 #---------------------------------------------------------------------------
 189 # configuration options related to the RTF output
 190 #---------------------------------------------------------------------------
 191 GENERATE_RTF           = NO
 192 RTF_OUTPUT             = rtf
 193 COMPACT_RTF            = NO
 194 RTF_HYPERLINKS         = NO
 195 RTF_STYLESHEET_FILE    =
 196 RTF_EXTENSIONS_FILE    =
 197 #---------------------------------------------------------------------------
 198 # configuration options related to the man page output
 199 #---------------------------------------------------------------------------
 200 GENERATE_MAN           = NO
 201 MAN_OUTPUT             = man
 202 MAN_EXTENSION          = .3
 203 MAN_LINKS              = NO
 204 #---------------------------------------------------------------------------
 205 # configuration options related to the XML output
 206 #---------------------------------------------------------------------------
 207 GENERATE_XML           = NO
 208 XML_OUTPUT             = xml
 209 XML_SCHEMA             =
 210 XML_DTD                =
 211 XML_PROGRAMLISTING     = YES
 212 #---------------------------------------------------------------------------
 213 # configuration options for the AutoGen Definitions output
 214 #---------------------------------------------------------------------------
 215 GENERATE_AUTOGEN_DEF   = NO
 216 #---------------------------------------------------------------------------
 217 # configuration options related to the Perl module output
 218 #---------------------------------------------------------------------------
 219 GENERATE_PERLMOD       = NO
 220 PERLMOD_LATEX          = NO
 221 PERLMOD_PRETTY         = YES
 222 PERLMOD_MAKEVAR_PREFIX =
 223 #---------------------------------------------------------------------------
 224 # Configuration options related to the preprocessor
 225 #---------------------------------------------------------------------------
 226 ENABLE_PREPROCESSING   = YES
 227 MACRO_EXPANSION        = YES
 228 EXPAND_ONLY_PREDEF     = YES
 229 SEARCH_INCLUDES        = YES
 230 INCLUDE_PATH           = $(DOXYGEN_SRC_INCLUDE_PATH) \
 231                          .
 232 INCLUDE_FILE_PATTERNS  = *.h
 233 PREDEFINED             = _KERNEL \
 234                          __FreeBSD__=9 \
 235                          __${TARGET_ARCH}__=1 \
 236                          __${TARGET_ARCH}=1
 237 EXPAND_AS_DEFINED      =
 238 SKIP_FUNCTION_MACROS   = YES
 239 #---------------------------------------------------------------------------
 240 # Configuration::additions related to external references
 241 #---------------------------------------------------------------------------
 242 ALLEXTERNALS           = NO
 243 EXTERNAL_GROUPS        = YES
 244 PERL_PATH              = /usr/bin/perl
 245 #---------------------------------------------------------------------------
 246 # Configuration options related to the dot tool
 247 #---------------------------------------------------------------------------
 248 CLASS_DIAGRAMS         = NO
 249 MSCGEN_PATH            =
 250 HIDE_UNDOC_RELATIONS   = YES
 251 HAVE_DOT               = YES
 252 CLASS_GRAPH            = YES
 253 COLLABORATION_GRAPH    = YES
 254 GROUP_GRAPHS           = YES
 255 UML_LOOK               = NO
 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 DOT_TRANSPARENT        = NO
 268 DOT_MULTI_TARGETS      = YES
 269 GENERATE_LEGEND        = YES
 270 DOT_CLEANUP            = YES
 271 #---------------------------------------------------------------------------
 272 # Configuration::additions related to the search engine
 273 #---------------------------------------------------------------------------
 274 SEARCHENGINE           = NO