Changeset - r23022:731ae1300799
[Not reviewed]
master
0 1 0
Charles Pigott - 6 years ago 2018-10-27 17:39:15
charlespigott@googlemail.com
Update: Doxyfile
1 file changed with 145 insertions and 25 deletions:
Doxyfile
145
25
0 comments (0 inline, 0 general)
Doxyfile
Show inline comments
 
@@ -8,9 +8,14 @@
 
#---------------------------------------------------------------------------
 
# Project related configuration options
 
#---------------------------------------------------------------------------
 
DOXYFILE_ENCODING      = UTF-8
 
PROJECT_NAME           = OpenTTD
 
PROJECT_NUMBER         =
 
PROJECT_BRIEF          =
 
PROJECT_LOGO           =
 
OUTPUT_DIRECTORY       = docs/source/
 
CREATE_SUBDIRS         = NO
 
ALLOW_UNICODE_NAMES    = NO
 
OUTPUT_LANGUAGE        = English
 
BRIEF_MEMBER_DESC      = YES
 
REPEAT_BRIEF           = YES
 
@@ -32,22 +37,42 @@ STRIP_FROM_PATH        = ./
 
STRIP_FROM_INC_PATH    =
 
SHORT_NAMES            = NO
 
JAVADOC_AUTOBRIEF      = YES
 
QT_AUTOBRIEF           = NO
 
MULTILINE_CPP_IS_BRIEF = NO
 
INHERIT_DOCS           = YES
 
DISTRIBUTE_GROUP_DOC   = NO
 
SEPARATE_MEMBER_PAGES  = NO
 
TAB_SIZE               = 2
 
ALIASES                =
 
TCL_SUBST              =
 
OPTIMIZE_OUTPUT_FOR_C  = YES
 
OPTIMIZE_OUTPUT_JAVA   = NO
 
OPTIMIZE_FOR_FORTRAN   = NO
 
OPTIMIZE_OUTPUT_VHDL   = NO
 
EXTENSION_MAPPING      =
 
MARKDOWN_SUPPORT       = YES
 
TOC_INCLUDE_HEADINGS   = 0
 
AUTOLINK_SUPPORT       = YES
 
BUILTIN_STL_SUPPORT    = NO
 
CPP_CLI_SUPPORT        = NO
 
SIP_SUPPORT            = NO
 
IDL_PROPERTY_SUPPORT   = YES
 
DISTRIBUTE_GROUP_DOC   = NO
 
GROUP_NESTED_COMPOUNDS = NO
 
SUBGROUPING            = YES
 
INLINE_GROUPED_CLASSES = NO
 
INLINE_SIMPLE_STRUCTS  = NO
 
TYPEDEF_HIDES_STRUCT   = NO
 
LOOKUP_CACHE_SIZE      = 0
 
#---------------------------------------------------------------------------
 
# Build related configuration options
 
#---------------------------------------------------------------------------
 
EXTRACT_ALL            = NO
 
EXTRACT_PRIVATE        = YES
 
EXTRACT_PACKAGE        = NO
 
EXTRACT_STATIC         = YES
 
EXTRACT_LOCAL_CLASSES  = YES
 
EXTRACT_LOCAL_METHODS  = YES
 
EXTRACT_ANON_NSPACES   = NO
 
HIDE_UNDOC_MEMBERS     = NO
 
HIDE_UNDOC_CLASSES     = NO
 
HIDE_FRIEND_COMPOUNDS  = NO
 
@@ -55,11 +80,17 @@ HIDE_IN_BODY_DOCS      = NO
 
INTERNAL_DOCS          = NO
 
CASE_SENSE_NAMES       = YES
 
HIDE_SCOPE_NAMES       = NO
 
HIDE_COMPOUND_REFERENCE= NO
 
SHOW_INCLUDE_FILES     = YES
 
SHOW_GROUPED_MEMB_INC  = NO
 
FORCE_LOCAL_INCLUDES   = NO
 
INLINE_INFO            = YES
 
SORT_MEMBER_DOCS       = YES
 
SORT_BRIEF_DOCS        = NO
 
SORT_MEMBERS_CTORS_1ST = NO
 
SORT_GROUP_NAMES       = NO
 
SORT_BY_SCOPE_NAME     = NO
 
STRICT_PROTO_MATCHING  = NO
 
GENERATE_TODOLIST      = YES
 
GENERATE_TESTLIST      = YES
 
GENERATE_BUGLIST       = YES
 
@@ -67,22 +98,27 @@ GENERATE_DEPRECATEDLIST= YES
 
ENABLED_SECTIONS       =
 
MAX_INITIALIZER_LINES  = 30
 
SHOW_USED_FILES        = YES
 
SHOW_DIRECTORIES       = YES
 
SHOW_FILES             = YES
 
SHOW_NAMESPACES        = YES
 
FILE_VERSION_FILTER    =
 
LAYOUT_FILE            =
 
CITE_BIB_FILES         =
 
#---------------------------------------------------------------------------
 
# configuration options related to warning and progress messages
 
# 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_AS_ERROR          = NO
 
WARN_FORMAT            = "$file:$line: $text"
 
WARN_LOGFILE           =
 
#---------------------------------------------------------------------------
 
# configuration options related to the input files
 
# Configuration options related to the input files
 
#---------------------------------------------------------------------------
 
INPUT                  = ./src/
 
INPUT_ENCODING         = UTF-8
 
FILE_PATTERNS          = *.c \
 
                         *.cc \
 
                         *.cxx \
 
@@ -93,31 +129,39 @@ FILE_PATTERNS          = *.c \
 
RECURSIVE              = YES
 
EXCLUDE                =
 
EXCLUDE_SYMLINKS       = NO
 
EXCLUDE_PATTERNS       = */3rdparty */.svn */script/api
 
EXCLUDE_PATTERNS       = */3rdparty \
 
                         */.svn \
 
                         */script/api
 
EXCLUDE_SYMBOLS        =
 
EXAMPLE_PATH           =
 
EXAMPLE_PATTERNS       = *
 
EXAMPLE_RECURSIVE      = NO
 
IMAGE_PATH             =./docs/
 
IMAGE_PATH             = ./docs/
 
INPUT_FILTER           =
 
FILTER_PATTERNS        =
 
FILTER_SOURCE_FILES    = NO
 
FILTER_SOURCE_PATTERNS =
 
USE_MDFILE_AS_MAINPAGE =
 
#---------------------------------------------------------------------------
 
# configuration options related to source browsing
 
# Configuration options related to source browsing
 
#---------------------------------------------------------------------------
 
SOURCE_BROWSER         = YES
 
INLINE_SOURCES         = NO
 
STRIP_CODE_COMMENTS    = YES
 
REFERENCED_BY_RELATION = YES
 
REFERENCES_RELATION    = YES
 
REFERENCES_LINK_SOURCE = YES
 
SOURCE_TOOLTIPS        = YES
 
USE_HTAGS              = NO
 
VERBATIM_HEADERS       = YES
 
#---------------------------------------------------------------------------
 
# configuration options related to the alphabetical class index
 
# 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
 
# Configuration options related to the HTML output
 
#---------------------------------------------------------------------------
 
GENERATE_HTML          = YES
 
HTML_OUTPUT            = html
 
@@ -125,19 +169,58 @@ HTML_FILE_EXTENSION    = .html
 
HTML_HEADER            =
 
HTML_FOOTER            =
 
HTML_STYLESHEET        =
 
HTML_ALIGN_MEMBERS     = YES
 
HTML_EXTRA_STYLESHEET  =
 
HTML_EXTRA_FILES       =
 
HTML_COLORSTYLE_HUE    = 220
 
HTML_COLORSTYLE_SAT    = 100
 
HTML_COLORSTYLE_GAMMA  = 80
 
HTML_TIMESTAMP         = NO
 
HTML_DYNAMIC_MENUS     = YES
 
HTML_DYNAMIC_SECTIONS  = NO
 
HTML_INDEX_NUM_ENTRIES = 100
 
GENERATE_DOCSET        = NO
 
DOCSET_FEEDNAME        = "Doxygen generated docs"
 
DOCSET_BUNDLE_ID       = org.doxygen.Project
 
DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 
DOCSET_PUBLISHER_NAME  = Publisher
 
GENERATE_HTMLHELP      = YES
 
CHM_FILE               =
 
HHC_LOCATION           =
 
GENERATE_CHI           = NO
 
CHM_INDEX_ENCODING     =
 
BINARY_TOC             = NO
 
TOC_EXPAND             = YES
 
GENERATE_QHP           = NO
 
QCH_FILE               =
 
QHP_NAMESPACE          = org.doxygen.Project
 
QHP_VIRTUAL_FOLDER     = doc
 
QHP_CUST_FILTER_NAME   =
 
QHP_CUST_FILTER_ATTRS  =
 
QHP_SECT_FILTER_ATTRS  =
 
QHG_LOCATION           =
 
GENERATE_ECLIPSEHELP   = NO
 
ECLIPSE_DOC_ID         = org.doxygen.Project
 
DISABLE_INDEX          = NO
 
ENUM_VALUES_PER_LINE   = 4
 
GENERATE_TREEVIEW      = YES
 
ENUM_VALUES_PER_LINE   = 4
 
TREEVIEW_WIDTH         = 250
 
EXT_LINKS_IN_WINDOW    = NO
 
FORMULA_FONTSIZE       = 10
 
FORMULA_TRANSPARENT    = YES
 
USE_MATHJAX            = NO
 
MATHJAX_FORMAT         = HTML-CSS
 
MATHJAX_RELPATH        = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/
 
MATHJAX_EXTENSIONS     =
 
MATHJAX_CODEFILE       =
 
SEARCHENGINE           = NO
 
SERVER_BASED_SEARCH    = NO
 
EXTERNAL_SEARCH        = NO
 
SEARCHENGINE_URL       =
 
SEARCHDATA_FILE        = searchdata.xml
 
EXTERNAL_SEARCH_ID     =
 
EXTRA_SEARCH_MAPPINGS  =
 
#---------------------------------------------------------------------------
 
# configuration options related to the LaTeX output
 
# Configuration options related to the LaTeX output
 
#---------------------------------------------------------------------------
 
GENERATE_LATEX         = NO
 
LATEX_OUTPUT           = latex
 
@@ -147,12 +230,18 @@ COMPACT_LATEX          = NO
 
PAPER_TYPE             = a4wide
 
EXTRA_PACKAGES         =
 
LATEX_HEADER           =
 
LATEX_FOOTER           =
 
LATEX_EXTRA_STYLESHEET =
 
LATEX_EXTRA_FILES      =
 
PDF_HYPERLINKS         = NO
 
USE_PDFLATEX           = NO
 
LATEX_BATCHMODE        = NO
 
LATEX_HIDE_INDICES     = NO
 
LATEX_SOURCE_CODE      = NO
 
LATEX_BIB_STYLE        = plain
 
LATEX_TIMESTAMP        = NO
 
#---------------------------------------------------------------------------
 
# configuration options related to the RTF output
 
# Configuration options related to the RTF output
 
#---------------------------------------------------------------------------
 
GENERATE_RTF           = NO
 
RTF_OUTPUT             = rtf
 
@@ -160,27 +249,33 @@ COMPACT_RTF            = NO
 
RTF_HYPERLINKS         = NO
 
RTF_STYLESHEET_FILE    =
 
RTF_EXTENSIONS_FILE    =
 
RTF_SOURCE_CODE        = NO
 
#---------------------------------------------------------------------------
 
# configuration options related to the man page output
 
# Configuration options related to the man page output
 
#---------------------------------------------------------------------------
 
GENERATE_MAN           = NO
 
MAN_OUTPUT             = man
 
MAN_EXTENSION          = .3
 
MAN_SUBDIR             =
 
MAN_LINKS              = NO
 
#---------------------------------------------------------------------------
 
# configuration options related to the XML output
 
# 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
 
# Configuration options related to the DOCBOOK output
 
#---------------------------------------------------------------------------
 
GENERATE_DOCBOOK       = NO
 
DOCBOOK_OUTPUT         = docbook
 
DOCBOOK_PROGRAMLISTING = NO
 
#---------------------------------------------------------------------------
 
# Configuration options for the AutoGen Definitions output
 
#---------------------------------------------------------------------------
 
GENERATE_AUTOGEN_DEF   = NO
 
#---------------------------------------------------------------------------
 
# configuration options related to the Perl module output
 
# Configuration options related to the Perl module output
 
#---------------------------------------------------------------------------
 
GENERATE_PERLMOD       = NO
 
PERLMOD_LATEX          = NO
 
@@ -195,42 +290,67 @@ EXPAND_ONLY_PREDEF     = YES
 
SEARCH_INCLUDES        = YES
 
INCLUDE_PATH           =
 
INCLUDE_FILE_PATTERNS  =
 
PREDEFINED             = ENABLE_NETWORK WITH_ZLIB WITH_LZO WITH_LZMA WITH_SDL WITH_PNG WITH_FONTCONFIG WITH_FREETYPE WITH_ICU_SORT WITH_ICU_LAYOUT UNICODE _UNICODE _GNU_SOURCE FINAL=
 
PREDEFINED             = ENABLE_NETWORK \
 
                         WITH_ZLIB \
 
                         WITH_LZO \
 
                         WITH_LZMA \
 
                         WITH_SDL \
 
                         WITH_PNG \
 
                         WITH_FONTCONFIG \
 
                         WITH_FREETYPE \
 
                         WITH_ICU_SORT \
 
                         WITH_ICU_LAYOUT \
 
                         UNICODE \
 
                         _UNICODE \
 
                         _GNU_SOURCE \
 
                         FINAL=
 
EXPAND_AS_DEFINED      =
 
SKIP_FUNCTION_MACROS   = YES
 
#---------------------------------------------------------------------------
 
# Configuration::additions related to external references
 
# Configuration options related to external references
 
#---------------------------------------------------------------------------
 
TAGFILES               =
 
GENERATE_TAGFILE       = objs/openttd.tag
 
ALLEXTERNALS           = NO
 
EXTERNAL_GROUPS        = YES
 
EXTERNAL_PAGES         = YES
 
PERL_PATH              = /usr/bin/perl
 
#---------------------------------------------------------------------------
 
# Configuration options related to the dot tool
 
#---------------------------------------------------------------------------
 
CLASS_DIAGRAMS         = YES
 
MSCGEN_PATH            =
 
DIA_PATH               =
 
HIDE_UNDOC_RELATIONS   = YES
 
HAVE_DOT               = NO
 
DOT_NUM_THREADS        = 0
 
DOT_FONTNAME           = Helvetica
 
DOT_FONTSIZE           = 10
 
DOT_FONTPATH           =
 
CLASS_GRAPH            = YES
 
COLLABORATION_GRAPH    = YES
 
GROUP_GRAPHS           = YES
 
UML_LOOK               = NO
 
UML_LIMIT_NUM_FIELDS   = 10
 
TEMPLATE_RELATIONS     = NO
 
INCLUDE_GRAPH          = YES
 
INCLUDED_BY_GRAPH      = YES
 
CALL_GRAPH             = NO
 
CALLER_GRAPH           = NO
 
GRAPHICAL_HIERARCHY    = YES
 
DIRECTORY_GRAPH        = YES
 
DOT_IMAGE_FORMAT       = png
 
INTERACTIVE_SVG        = NO
 
DOT_PATH               =
 
DOTFILE_DIRS           =
 
MSCFILE_DIRS           =
 
DIAFILE_DIRS           =
 
PLANTUML_JAR_PATH      =
 
PLANTUML_CFG_FILE      =
 
PLANTUML_INCLUDE_PATH  =
 
DOT_GRAPH_MAX_NODES    = 50
 
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)