Changeset - r2035:95539876fc78
[Not reviewed]
master
0 0 1
celestar - 19 years ago 2005-07-11 09:00:49
celestar@openttd.org
(svn r2544) -Add: Added the Doxyfile to the trunk. run "doxygen" to generate html-based documentation on the source code on the fly (about 9MB in size currently).
documentation will be stored in docs/source/html/ (request by blathijs)
1 file changed with 234 insertions and 0 deletions:
Doxyfile
234
0 comments (0 inline, 0 general)
Doxyfile
Show inline comments
 
new file 100644
 
# Doxyfile 1.4.1-KDevelop
 

	
 
#---------------------------------------------------------------------------
 
# Project related configuration options
 
#---------------------------------------------------------------------------
 
PROJECT_NAME           = openttd.kdevelop
 
OUTPUT_DIRECTORY       = docs/source/
 
CREATE_SUBDIRS         = NO
 
OUTPUT_LANGUAGE        = English
 
USE_WINDOWS_ENCODING   = NO
 
BRIEF_MEMBER_DESC      = YES
 
REPEAT_BRIEF           = YES
 
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        = /home/vici/
 
STRIP_FROM_INC_PATH    =
 
SHORT_NAMES            = NO
 
JAVADOC_AUTOBRIEF      = NO
 
MULTILINE_CPP_IS_BRIEF = NO
 
DETAILS_AT_TOP         = NO
 
INHERIT_DOCS           = YES
 
DISTRIBUTE_GROUP_DOC   = NO
 
TAB_SIZE               = 8
 
ALIASES                =
 
OPTIMIZE_OUTPUT_FOR_C  = YES
 
OPTIMIZE_OUTPUT_JAVA   = NO
 
SUBGROUPING            = YES
 
#---------------------------------------------------------------------------
 
# Build related configuration options
 
#---------------------------------------------------------------------------
 
EXTRACT_ALL            = NO
 
EXTRACT_PRIVATE        = YES
 
EXTRACT_STATIC         = YES
 
EXTRACT_LOCAL_CLASSES  = YES
 
EXTRACT_LOCAL_METHODS  = YES
 
HIDE_UNDOC_MEMBERS     = NO
 
HIDE_UNDOC_CLASSES     = NO
 
HIDE_FRIEND_COMPOUNDS  = NO
 
HIDE_IN_BODY_DOCS      = NO
 
INTERNAL_DOCS          = NO
 
CASE_SENSE_NAMES       = YES
 
HIDE_SCOPE_NAMES       = NO
 
SHOW_INCLUDE_FILES     = YES
 
INLINE_INFO            = YES
 
SORT_MEMBER_DOCS       = YES
 
SORT_BRIEF_DOCS        = NO
 
SORT_BY_SCOPE_NAME     = NO
 
GENERATE_TODOLIST      = YES
 
GENERATE_TESTLIST      = YES
 
GENERATE_BUGLIST       = YES
 
GENERATE_DEPRECATEDLIST= YES
 
ENABLED_SECTIONS       =
 
MAX_INITIALIZER_LINES  = 30
 
SHOW_USED_FILES        = YES
 
SHOW_DIRECTORIES       = YES
 
FILE_VERSION_FILTER    =
 
#---------------------------------------------------------------------------
 
# configuration options related to warning and progress messages
 
#---------------------------------------------------------------------------
 
QUIET                  = NO
 
WARNINGS               = YES
 
WARN_IF_UNDOCUMENTED   = YES
 
WARN_IF_DOC_ERROR      = YES
 
WARN_NO_PARAMDOC       = NO
 
WARN_FORMAT            = "$file:$line: $text"
 
WARN_LOGFILE           =
 
#---------------------------------------------------------------------------
 
# configuration options related to the input files
 
#---------------------------------------------------------------------------
 
INPUT                  = /home/vici/openttd/trunk
 
FILE_PATTERNS          = *.c \
 
                         *.cc \
 
                         *.cxx \
 
                         *.cpp \
 
                         *.c++ \
 
                         *.h \
 
RECURSIVE              = YES
 
EXCLUDE                =
 
EXCLUDE_SYMLINKS       = NO
 
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       = YES
 
#---------------------------------------------------------------------------
 
# configuration options related to the alphabetical class index
 
#---------------------------------------------------------------------------
 
ALPHABETICAL_INDEX     = NO
 
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      = YES
 
CHM_FILE               =
 
HHC_LOCATION           =
 
GENERATE_CHI           = NO
 
BINARY_TOC             = NO
 
TOC_EXPAND             = YES
 
DISABLE_INDEX          = NO
 
ENUM_VALUES_PER_LINE   = 4
 
GENERATE_TREEVIEW      = YES
 
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         = NO
 
USE_PDFLATEX           = NO
 
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           = YES
 
MAN_OUTPUT             = man
 
MAN_EXTENSION          = .3
 
MAN_LINKS              = NO
 
#---------------------------------------------------------------------------
 
# 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             =
 
EXPAND_AS_DEFINED      =
 
SKIP_FUNCTION_MACROS   = YES
 
#---------------------------------------------------------------------------
 
# Configuration::additions related to external references
 
#---------------------------------------------------------------------------
 
TAGFILES               =
 
GENERATE_TAGFILE       = openttd.tag
 
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               = NO
 
CLASS_GRAPH            = YES
 
COLLABORATION_GRAPH    = YES
 
GROUP_GRAPHS           = YES
 
UML_LOOK               = NO
 
TEMPLATE_RELATIONS     = NO
 
INCLUDE_GRAPH          = YES
 
INCLUDED_BY_GRAPH      = YES
 
CALL_GRAPH             = NO
 
GRAPHICAL_HIERARCHY    = YES
 
DIRECTORY_GRAPH        = YES
 
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
0 comments (0 inline, 0 general)