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