Archives/OpenTTD-patches
2
0
Fork 0
mirror of https://github.com/JGRennison/OpenTTD-patches.git synced 2024-10-31 15:20:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
aa06b73137
OpenTTD-patches/Doxyfile.in

351 lines
12 KiB
Plaintext
Raw Normal View History

(svn r17248) -Fix: add GPL license notice where appropriate
2009-08-21 20:21:05 +00:00
# This file is part of OpenTTD.
# OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
# OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
DOXYFILE_ENCODING = UTF-8
Add: [Doxygen] Add the current version of documentation in header (#7940) While at it, renamed the project names to reflect how we currently refer to them.
2020-01-15 22:07:37 +00:00
PROJECT_NAME = "OpenTTD Source"
Add: [CMake] targets to generate documentation
2020-12-10 22:57:27 +00:00
PROJECT_NUMBER = ${REV_VERSION}
Update: Doxyfile
2018-10-27 17:39:15 +00:00
PROJECT_BRIEF =
PROJECT_LOGO =
Add: [CMake] targets to generate documentation
2020-12-10 22:57:27 +00:00
OUTPUT_DIRECTORY = ${CPACK_BINARY_DIR}/docs/source/
Doc: Lots and lots of doxymentation fixes
2018-10-28 02:17:36 +00:00
CREATE_SUBDIRS = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
ALLOW_UNICODE_NAMES = NO
(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)
2005-07-11 09:00:49 +00:00
OUTPUT_LANGUAGE = English
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
(svn r2545) -Fix: Modified the Doxyfile so that it works on other computers (than mine) as well :)
2005-07-11 09:12:41 +00:00
STRIP_FROM_PATH = ./
(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)
2005-07-11 09:00:49 +00:00
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
(svn r2557) -Add: Added the AUTOBRIEF option to the Doxyfile
2005-07-13 09:51:01 +00:00
JAVADOC_AUTOBRIEF = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
QT_AUTOBRIEF = NO
(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)
2005-07-11 09:00:49 +00:00
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
SEPARATE_MEMBER_PAGES = NO
(svn r2545) -Fix: Modified the Doxyfile so that it works on other computers (than mine) as well :)
2005-07-11 09:12:41 +00:00
TAB_SIZE = 2
(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)
2005-07-11 09:00:49 +00:00
ALIASES =
Update: Doxyfile
2018-10-27 17:39:15 +00:00
TCL_SUBST =
(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)
2005-07-11 09:00:49 +00:00
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
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
(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)
2005-07-11 09:00:49 +00:00
SUBGROUPING = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS = NO
TYPEDEF_HIDES_STRUCT = NO
LOOKUP_CACHE_SIZE = 0
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = NO
EXTRACT_PRIVATE = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
EXTRACT_PACKAGE = NO
(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)
2005-07-11 09:00:49 +00:00
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = YES
Doc: Lots and lots of doxymentation fixes
2018-10-28 02:17:36 +00:00
EXTRACT_ANON_NSPACES = YES
(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)
2005-07-11 09:00:49 +00:00
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
Update: Doxyfile
2018-10-27 17:39:15 +00:00
HIDE_COMPOUND_REFERENCE= NO
(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)
2005-07-11 09:00:49 +00:00
SHOW_INCLUDE_FILES = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
SHOW_GROUPED_MEMB_INC = NO
FORCE_LOCAL_INCLUDES = NO
(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)
2005-07-11 09:00:49 +00:00
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES = NO
(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)
2005-07-11 09:00:49 +00:00
SORT_BY_SCOPE_NAME = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
STRICT_PROTO_MATCHING = NO
(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)
2005-07-11 09:00:49 +00:00
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
SHOW_FILES = YES
SHOW_NAMESPACES = YES
(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)
2005-07-11 09:00:49 +00:00
FILE_VERSION_FILTER =
Update: Doxyfile
2018-10-27 17:39:15 +00:00
LAYOUT_FILE =
CITE_BIB_FILES =
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to warning and progress messages
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
WARN_AS_ERROR = NO
(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)
2005-07-11 09:00:49 +00:00
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the input files
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.
2008-05-06 15:11:33 +00:00
INPUT = ./src/
Update: Doxyfile
2018-10-27 17:39:15 +00:00
INPUT_ENCODING = UTF-8
(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)
2005-07-11 09:00:49 +00:00
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.h \
(svn r19102) -Codechange; let doxygen parse as much code as possible
2010-02-12 12:11:03 +00:00
*.hpp
(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)
2005-07-11 09:00:49 +00:00
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
EXCLUDE_PATTERNS = */3rdparty \
*/script/api
EXCLUDE_SYMBOLS =
(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)
2005-07-11 09:00:49 +00:00
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
IMAGE_PATH = ./docs/
(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)
2005-07-11 09:00:49 +00:00
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to source browsing
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS = YES
USE_HTAGS = NO
(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)
2005-07-11 09:00:49 +00:00
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the alphabetical class index
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the HTML output
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
Update: Doxyfile
2018-10-27 17:39:15 +00:00
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
Doc: Lots and lots of doxymentation fixes
2018-10-28 02:17:36 +00:00
GENERATE_HTMLHELP = NO
(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)
2005-07-11 09:00:49 +00:00
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
CHM_INDEX_ENCODING =
(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)
2005-07-11 09:00:49 +00:00
BINARY_TOC = NO
TOC_EXPAND = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
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
(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)
2005-07-11 09:00:49 +00:00
DISABLE_INDEX = NO
GENERATE_TREEVIEW = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
ENUM_VALUES_PER_LINE = 4
(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)
2005-07-11 09:00:49 +00:00
TREEVIEW_WIDTH = 250
Update: Doxyfile
2018-10-27 17:39:15 +00:00
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 =
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the LaTeX output
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
Update: Doxyfile
2018-10-27 17:39:15 +00:00
LATEX_FOOTER =
LATEX_EXTRA_STYLESHEET =
LATEX_EXTRA_FILES =
(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)
2005-07-11 09:00:49 +00:00
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
LATEX_SOURCE_CODE = NO
LATEX_BIB_STYLE = plain
LATEX_TIMESTAMP = NO
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the RTF output
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
Update: Doxyfile
2018-10-27 17:39:15 +00:00
RTF_SOURCE_CODE = NO
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the man page output
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
(svn r14116) -Change [Doxygen]: making man-pages of the exports of the source isn't very useful as OpenTTD isn't a library.
2008-08-20 22:43:19 +00:00
GENERATE_MAN = NO
(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)
2005-07-11 09:00:49 +00:00
MAN_OUTPUT = man
MAN_EXTENSION = .3
Update: Doxyfile
2018-10-27 17:39:15 +00:00
MAN_SUBDIR =
(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)
2005-07-11 09:00:49 +00:00
MAN_LINKS = NO
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the XML output
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK = NO
DOCBOOK_OUTPUT = docbook
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to the Perl module output
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
(svn r11084) -Documentation [FS#1219]: of command.*. Patch by Progman.
2007-09-10 15:21:14 +00:00
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
(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)
2005-07-11 09:00:49 +00:00
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
Remove: ENABLE_NETWORK switch This switch has been a pain for years. Often disabling broke compilation, as no developer compiles OpenTTD without, neither do any of our official binaries. Additionaly, it has grown so hugely in our codebase, that it clearly shows that the current solution was a poor one. 350+ instances of "#ifdef ENABLE_NETWORK" were in the code, of which only ~30 in the networking code itself. The rest were all around the code to do the right thing, from GUI to NewGRF. A more proper solution would be to stub all the functions, and make sure the rest of the code can simply assume network is available. This was also partially done, and most variables were correct if networking was disabled. Despite that, often the #ifdefs were still used. With the recent removal of DOS, there is also no platform anymore which we support where networking isn't working out-of-the-box. All in all, it is time to remove the ENABLE_NETWORK switch. No replacement is planned, but if you feel we really need this option, we welcome any Pull Request which implements this in a way that doesn't crawl through the code like this diff shows we used to.
2019-03-20 16:01:13 +00:00
PREDEFINED = WITH_ZLIB \
Update: Doxyfile
2018-10-27 17:39:15 +00:00
WITH_LZO \
Codechange: liblzma is called liblzma, how ever strange that might be It is the only library we use that calls itself with 'lib' in the name. This might be confusing, but with the arrival of cmake a lot of these things are automated. And detection will find 'liblzma', not 'lzma', like with 'lzo', 'zlib', ..
2019-03-10 15:41:01 +00:00
WITH_LIBLZMA \
Update: Doxyfile
2018-10-27 17:39:15 +00:00
WITH_SDL \
WITH_PNG \
WITH_FONTCONFIG \
WITH_FREETYPE \
Codechange: ICU_SORT is in reality ICU_I18N (according to their CMake files) By naming it in a different way, things get a bit confusing. Especially if we are switching to CMake, which autodetects these things, we need to use the name the authors of ICU gave it; not our interpertation of that name.
2019-03-10 15:46:19 +00:00
WITH_ICU_I18N \
Codechange: ICU_LAYOUT is in reality ICU_LX (according to their CMake files) By naming it in a different way, things get a bit confusing. Especially if we are switching to CMake, which autodetects these things, we need to use the name the authors of ICU gave it; not our interpertation of that name.
2019-03-10 15:43:59 +00:00
WITH_ICU_LX \
Update: Doxyfile
2018-10-27 17:39:15 +00:00
UNICODE \
_UNICODE \
_GNU_SOURCE \
FINAL=
(svn r19102) -Codechange; let doxygen parse as much code as possible
2010-02-12 12:11:03 +00:00
EXPAND_AS_DEFINED =
(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)
2005-07-11 09:00:49 +00:00
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
Update: Doxyfile
2018-10-27 17:39:15 +00:00
# Configuration options related to external references
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
TAGFILES =
Add: [CMake] targets to generate documentation
2020-12-10 22:57:27 +00:00
GENERATE_TAGFILE = ${CPACK_BINARY_DIR}/docs/openttd.tag
(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)
2005-07-11 09:00:49 +00:00
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
EXTERNAL_PAGES = YES
(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)
2005-07-11 09:00:49 +00:00
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
Update: Doxyfile
2018-10-27 17:39:15 +00:00
DIA_PATH =
(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)
2005-07-11 09:00:49 +00:00
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
DOT_NUM_THREADS = 0
DOT_FONTNAME = Helvetica
DOT_FONTSIZE = 10
DOT_FONTPATH =
(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)
2005-07-11 09:00:49 +00:00
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
UML_LIMIT_NUM_FIELDS = 10
(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)
2005-07-11 09:00:49 +00:00
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
Update: Doxyfile
2018-10-27 17:39:15 +00:00
CALLER_GRAPH = NO
(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)
2005-07-11 09:00:49 +00:00
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
Update: Doxyfile
2018-10-27 17:39:15 +00:00
INTERACTIVE_SVG = NO
(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)
2005-07-11 09:00:49 +00:00
DOT_PATH =
DOTFILE_DIRS =
Update: Doxyfile
2018-10-27 17:39:15 +00:00
MSCFILE_DIRS =
DIAFILE_DIRS =
PLANTUML_JAR_PATH =
PLANTUML_CFG_FILE =
PLANTUML_INCLUDE_PATH =
DOT_GRAPH_MAX_NODES = 50
(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)
2005-07-11 09:00:49 +00:00
MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
Reference in New Issue Copy Permalink