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