tools/kerneldoc/subsys/common-Doxyfile

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