tools/kerneldoc/Doxyfile

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