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