Subversion Repositories HelenOS-doc

# Doxyfile 1.4.2

#---------------------------------------------------------------------------

# Project related configuration options

#---------------------------------------------------------------------------

PROJECT_NAME           = "HelenOS Kernel"

PROJECT_NUMBER         = "0.2.0"

OUTPUT_DIRECTORY       = $(DOCDIR)/doc/kernel

CREATE_SUBDIRS         = NO

OUTPUT_LANGUAGE        = English

USE_WINDOWS_ENCODING   = NO

BRIEF_MEMBER_DESC      = YES

REPEAT_BRIEF           = NO

ABBREVIATE_BRIEF       = "The $name class" \

                         "The $name widget" \

                         "The $name file" \

                         is \

                         provides \

                         specifies \

                         contains \

                         represents \

                         a \

                         an \

                         the

ALWAYS_DETAILED_SEC    = NO

INLINE_INHERITED_MEMB  = NO

FULL_PATH_NAMES        = YES

STRIP_FROM_PATH        = 

STRIP_FROM_INC_PATH    = 

SHORT_NAMES            = NO

JAVADOC_AUTOBRIEF      = NO

MULTILINE_CPP_IS_BRIEF = NO

DETAILS_AT_TOP         = NO

INHERIT_DOCS           = NO

DISTRIBUTE_GROUP_DOC   = NO

SEPARATE_MEMBER_PAGES  = NO

TAB_SIZE               = 8

ALIASES                = 

OPTIMIZE_OUTPUT_FOR_C  = YES

OPTIMIZE_OUTPUT_JAVA   = NO

SUBGROUPING            = NO

#---------------------------------------------------------------------------

# Build related configuration options

#---------------------------------------------------------------------------

EXTRACT_ALL            = YES

EXTRACT_PRIVATE        = NO

EXTRACT_STATIC         = YES

EXTRACT_LOCAL_CLASSES  = YES

EXTRACT_LOCAL_METHODS  = YES

HIDE_UNDOC_MEMBERS     = YES

HIDE_UNDOC_CLASSES     = YES

HIDE_FRIEND_COMPOUNDS  = NO

HIDE_IN_BODY_DOCS      = NO

INTERNAL_DOCS          = NO

CASE_SENSE_NAMES       = YES

HIDE_SCOPE_NAMES       = YES

SHOW_INCLUDE_FILES     = NO

INLINE_INFO            = NO

SORT_MEMBER_DOCS       = YES

SORT_BRIEF_DOCS        = NO

SORT_BY_SCOPE_NAME     = YES

GENERATE_TODOLIST      = NO

GENERATE_TESTLIST      = NO

GENERATE_BUGLIST       = NO

GENERATE_DEPRECATEDLIST= NO

ENABLED_SECTIONS       = 

MAX_INITIALIZER_LINES  = 30

SHOW_USED_FILES        = NO

SHOW_DIRECTORIES       = YES

FILE_VERSION_FILTER    = 

#---------------------------------------------------------------------------

# configuration options related to warning and progress messages

#---------------------------------------------------------------------------

QUIET                  = NO

WARNINGS               = YES

WARN_IF_UNDOCUMENTED   = NO

WARN_IF_DOC_ERROR      = YES

WARN_NO_PARAMDOC       = NO

WARN_FORMAT            = "$file:$line: $text"

WARN_LOGFILE           = 

#---------------------------------------------------------------------------

# configuration options related to the input files

#---------------------------------------------------------------------------

INPUT                  = $(SRCDIR)/kernel/doc \

			 $(SRCDIR)/kernel/generic \

			 $(SRCDIR)/kernel/genarch \

			 $(SRCDIR)/kernel/arch

FILE_PATTERNS          = *.c \

                         *.h

RECURSIVE              = YES

EXCLUDE                = 

EXCLUDE_SYMLINKS       = YES

EXCLUDE_PATTERNS       = 

EXAMPLE_PATH           = 

EXAMPLE_PATTERNS       = *

EXAMPLE_RECURSIVE      = NO

IMAGE_PATH             = 

INPUT_FILTER           = 

FILTER_PATTERNS        = 

FILTER_SOURCE_FILES    = NO

#---------------------------------------------------------------------------

# configuration options related to source browsing

#---------------------------------------------------------------------------

SOURCE_BROWSER         = YES

INLINE_SOURCES         = NO

STRIP_CODE_COMMENTS    = YES

REFERENCED_BY_RELATION = YES

REFERENCES_RELATION    = YES

VERBATIM_HEADERS       = NO

#---------------------------------------------------------------------------

# configuration options related to the alphabetical class index

#---------------------------------------------------------------------------

ALPHABETICAL_INDEX     = YES

COLS_IN_ALPHA_INDEX    = 5

IGNORE_PREFIX          = 

#---------------------------------------------------------------------------

# configuration options related to the HTML output

#---------------------------------------------------------------------------

GENERATE_HTML          = YES

HTML_OUTPUT            = html

HTML_FILE_EXTENSION    = .html

HTML_HEADER            = 

HTML_FOOTER            = 

HTML_STYLESHEET        = 

HTML_ALIGN_MEMBERS     = YES

GENERATE_HTMLHELP      = NO

CHM_FILE               = 

HHC_LOCATION           = 

GENERATE_CHI           = NO

BINARY_TOC             = NO

TOC_EXPAND             = NO

DISABLE_INDEX          = NO

ENUM_VALUES_PER_LINE   = 4

GENERATE_TREEVIEW      = NO

TREEVIEW_WIDTH         = 250

#---------------------------------------------------------------------------

# configuration options related to the LaTeX output

#---------------------------------------------------------------------------

GENERATE_LATEX         = NO

LATEX_OUTPUT           = latex

LATEX_CMD_NAME         = latex

MAKEINDEX_CMD_NAME     = makeindex

COMPACT_LATEX          = NO

PAPER_TYPE             = a4wide

EXTRA_PACKAGES         = 

LATEX_HEADER           = 

PDF_HYPERLINKS         = YES

USE_PDFLATEX           = YES

LATEX_BATCHMODE        = NO

LATEX_HIDE_INDICES     = NO

#---------------------------------------------------------------------------

# configuration options related to the RTF output

#---------------------------------------------------------------------------

GENERATE_RTF           = NO

RTF_OUTPUT             = rtf

COMPACT_RTF            = NO

RTF_HYPERLINKS         = NO

RTF_STYLESHEET_FILE    = 

RTF_EXTENSIONS_FILE    = 

#---------------------------------------------------------------------------

# configuration options related to the man page output

#---------------------------------------------------------------------------

GENERATE_MAN           = NO

MAN_OUTPUT             = man

MAN_EXTENSION          = .2

MAN_LINKS              = YES

#---------------------------------------------------------------------------

# configuration options related to the XML output

#---------------------------------------------------------------------------

GENERATE_XML           = NO

XML_OUTPUT             = xml

XML_SCHEMA             = 

XML_DTD                = 

XML_PROGRAMLISTING     = YES

#---------------------------------------------------------------------------

# configuration options for the AutoGen Definitions output

#---------------------------------------------------------------------------

GENERATE_AUTOGEN_DEF   = NO

#---------------------------------------------------------------------------

# configuration options related to the Perl module output

#---------------------------------------------------------------------------

GENERATE_PERLMOD       = NO

PERLMOD_LATEX          = NO

PERLMOD_PRETTY         = YES

PERLMOD_MAKEVAR_PREFIX = 

#---------------------------------------------------------------------------

# Configuration options related to the preprocessor   

#---------------------------------------------------------------------------

ENABLE_PREPROCESSING   = YES

MACRO_EXPANSION        = NO

EXPAND_ONLY_PREDEF     = NO

SEARCH_INCLUDES        = YES

INCLUDE_PATH           = 

INCLUDE_FILE_PATTERNS  = 

PREDEFINED             = CONFIG_SMP \

			 CONFIG_HT

EXPAND_AS_DEFINED      = 

SKIP_FUNCTION_MACROS   = NO

#---------------------------------------------------------------------------

# Configuration::additions related to external references   

#---------------------------------------------------------------------------

TAGFILES               = 

GENERATE_TAGFILE       = 

ALLEXTERNALS           = NO

EXTERNAL_GROUPS        = YES

PERL_PATH              = /usr/bin/perl

#---------------------------------------------------------------------------

# Configuration options related to the dot tool   

#---------------------------------------------------------------------------

CLASS_DIAGRAMS         = YES

HIDE_UNDOC_RELATIONS   = YES

HAVE_DOT               = $(DOT)

CLASS_GRAPH            = NO

COLLABORATION_GRAPH    = NO

GROUP_GRAPHS           = NO

UML_LOOK               = NO

TEMPLATE_RELATIONS     = NO

INCLUDE_GRAPH          = YES

INCLUDED_BY_GRAPH      = YES

CALL_GRAPH             = YES

GRAPHICAL_HIERARCHY    = YES

DIRECTORY_GRAPH        = NO

DOT_IMAGE_FORMAT       = png

DOT_PATH               = 

DOTFILE_DIRS           = 

MAX_DOT_GRAPH_WIDTH    = 1024

MAX_DOT_GRAPH_HEIGHT   = 1024

MAX_DOT_GRAPH_DEPTH    = 1000

DOT_TRANSPARENT        = NO

DOT_MULTI_TARGETS      = NO

GENERATE_LEGEND        = YES

DOT_CLEANUP            = YES

#---------------------------------------------------------------------------

# Configuration::additions related to the search engine   

#---------------------------------------------------------------------------

SEARCHENGINE           = NO