1# This file is part of OpenTTD. 2# 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. 3# 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. 4# 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/>. 5 6# Doxyfile 1.5.4 7 8#--------------------------------------------------------------------------- 9# Project related configuration options 10#--------------------------------------------------------------------------- 11DOXYFILE_ENCODING = UTF-8 12PROJECT_NAME = "OpenTTD AI API" 13PROJECT_NUMBER = ${REV_VERSION} 14OUTPUT_DIRECTORY = ${CPACK_BINARY_DIR}/docs/ai-api/ 15CREATE_SUBDIRS = NO 16OUTPUT_LANGUAGE = English 17BRIEF_MEMBER_DESC = YES 18REPEAT_BRIEF = YES 19ABBREVIATE_BRIEF = "The $name class " \ 20 "The $name widget " \ 21 "The $name file " \ 22 is \ 23 provides \ 24 specifies \ 25 contains \ 26 represents \ 27 a \ 28 an \ 29 the 30ALWAYS_DETAILED_SEC = NO 31INLINE_INHERITED_MEMB = NO 32FULL_PATH_NAMES = YES 33STRIP_FROM_PATH = ./ 34STRIP_FROM_INC_PATH = 35SHORT_NAMES = NO 36JAVADOC_AUTOBRIEF = YES 37QT_AUTOBRIEF = NO 38MULTILINE_CPP_IS_BRIEF = NO 39INHERIT_DOCS = YES 40SEPARATE_MEMBER_PAGES = NO 41TAB_SIZE = 2 42ALIASES = 43OPTIMIZE_OUTPUT_FOR_C = YES 44OPTIMIZE_OUTPUT_JAVA = NO 45BUILTIN_STL_SUPPORT = NO 46CPP_CLI_SUPPORT = NO 47SIP_SUPPORT = NO 48DISTRIBUTE_GROUP_DOC = NO 49SUBGROUPING = YES 50TYPEDEF_HIDES_STRUCT = NO 51#--------------------------------------------------------------------------- 52# Build related configuration options 53#--------------------------------------------------------------------------- 54EXTRACT_ALL = NO 55EXTRACT_PRIVATE = NO 56EXTRACT_STATIC = YES 57EXTRACT_LOCAL_CLASSES = YES 58EXTRACT_LOCAL_METHODS = YES 59EXTRACT_ANON_NSPACES = NO 60HIDE_UNDOC_MEMBERS = NO 61HIDE_UNDOC_CLASSES = NO 62HIDE_FRIEND_COMPOUNDS = NO 63HIDE_IN_BODY_DOCS = YES 64INTERNAL_DOCS = YES 65CASE_SENSE_NAMES = YES 66HIDE_SCOPE_NAMES = NO 67SHOW_INCLUDE_FILES = NO 68INLINE_INFO = YES 69SORT_MEMBER_DOCS = YES 70SORT_BRIEF_DOCS = NO 71SORT_BY_SCOPE_NAME = NO 72GENERATE_TODOLIST = NO 73GENERATE_TESTLIST = NO 74GENERATE_BUGLIST = NO 75GENERATE_DEPRECATEDLIST= NO 76ENABLED_SECTIONS = 77MAX_INITIALIZER_LINES = 30 78SHOW_USED_FILES = NO 79FILE_VERSION_FILTER = 80#--------------------------------------------------------------------------- 81# configuration options related to warning and progress messages 82#--------------------------------------------------------------------------- 83QUIET = NO 84WARNINGS = YES 85WARN_IF_UNDOCUMENTED = YES 86WARN_IF_DOC_ERROR = YES 87WARN_NO_PARAMDOC = YES 88WARN_FORMAT = "$file:$line: $text " 89WARN_LOGFILE = 90#--------------------------------------------------------------------------- 91# configuration options related to the input files 92#--------------------------------------------------------------------------- 93INPUT = . ${FIND_VERSION_BINARY_DIR}/script/api 94INPUT_ENCODING = UTF-8 95FILE_PATTERNS = script_*.hpp \ 96 ai_*.hpp 97RECURSIVE = YES 98EXCLUDE = 99EXCLUDE_SYMLINKS = NO 100EXCLUDE_PATTERNS = ai_includes.hpp 101EXCLUDE_SYMBOLS = GetClassName DECLARE_ENUM_AS_BIT_SET DECLARE_POSTFIX_INCREMENT 102EXAMPLE_PATH = 103EXAMPLE_PATTERNS = * 104EXAMPLE_RECURSIVE = NO 105IMAGE_PATH = 106INPUT_FILTER = "./doxygen_filter.sh AI" 107FILTER_PATTERNS = 108FILTER_SOURCE_FILES = NO 109#--------------------------------------------------------------------------- 110# configuration options related to source browsing 111#--------------------------------------------------------------------------- 112SOURCE_BROWSER = NO 113INLINE_SOURCES = NO 114STRIP_CODE_COMMENTS = YES 115REFERENCED_BY_RELATION = NO 116REFERENCES_RELATION = NO 117REFERENCES_LINK_SOURCE = YES 118USE_HTAGS = NO 119VERBATIM_HEADERS = NO 120#--------------------------------------------------------------------------- 121# configuration options related to the alphabetical class index 122#--------------------------------------------------------------------------- 123ALPHABETICAL_INDEX = NO 124COLS_IN_ALPHA_INDEX = 5 125IGNORE_PREFIX = 126#--------------------------------------------------------------------------- 127# configuration options related to the HTML output 128#--------------------------------------------------------------------------- 129GENERATE_HTML = YES 130HTML_OUTPUT = html 131HTML_FILE_EXTENSION = .html 132HTML_HEADER = 133HTML_FOOTER = 134HTML_STYLESHEET = 135GENERATE_HTMLHELP = NO 136HTML_DYNAMIC_SECTIONS = NO 137CHM_FILE = 138HHC_LOCATION = 139GENERATE_CHI = NO 140BINARY_TOC = NO 141TOC_EXPAND = NO 142DISABLE_INDEX = NO 143ENUM_VALUES_PER_LINE = 1 144GENERATE_TREEVIEW = NO 145TREEVIEW_WIDTH = 250 146#--------------------------------------------------------------------------- 147# configuration options related to the LaTeX output 148#--------------------------------------------------------------------------- 149GENERATE_LATEX = NO 150LATEX_OUTPUT = latex 151LATEX_CMD_NAME = latex 152MAKEINDEX_CMD_NAME = makeindex 153COMPACT_LATEX = NO 154PAPER_TYPE = a4wide 155EXTRA_PACKAGES = 156LATEX_HEADER = 157PDF_HYPERLINKS = NO 158USE_PDFLATEX = NO 159LATEX_BATCHMODE = NO 160LATEX_HIDE_INDICES = NO 161#--------------------------------------------------------------------------- 162# configuration options related to the RTF output 163#--------------------------------------------------------------------------- 164GENERATE_RTF = NO 165RTF_OUTPUT = rtf 166COMPACT_RTF = NO 167RTF_HYPERLINKS = NO 168RTF_STYLESHEET_FILE = 169RTF_EXTENSIONS_FILE = 170#--------------------------------------------------------------------------- 171# configuration options related to the man page output 172#--------------------------------------------------------------------------- 173GENERATE_MAN = NO 174MAN_OUTPUT = man 175MAN_EXTENSION = .3 176MAN_LINKS = NO 177#--------------------------------------------------------------------------- 178# configuration options related to the XML output 179#--------------------------------------------------------------------------- 180GENERATE_XML = NO 181XML_OUTPUT = xml 182XML_PROGRAMLISTING = YES 183#--------------------------------------------------------------------------- 184# configuration options for the AutoGen Definitions output 185#--------------------------------------------------------------------------- 186GENERATE_AUTOGEN_DEF = NO 187#--------------------------------------------------------------------------- 188# configuration options related to the Perl module output 189#--------------------------------------------------------------------------- 190GENERATE_PERLMOD = NO 191PERLMOD_LATEX = NO 192PERLMOD_PRETTY = YES 193PERLMOD_MAKEVAR_PREFIX = 194#--------------------------------------------------------------------------- 195# Configuration options related to the preprocessor 196#--------------------------------------------------------------------------- 197ENABLE_PREPROCESSING = YES 198MACRO_EXPANSION = YES 199EXPAND_ONLY_PREDEF = YES 200SEARCH_INCLUDES = YES 201INCLUDE_PATH = 202INCLUDE_FILE_PATTERNS = 203PREDEFINED = DOXYGEN_API 204EXPAND_AS_DEFINED = DEF_COMMAND 205SKIP_FUNCTION_MACROS = YES 206#--------------------------------------------------------------------------- 207# Configuration::additions related to external references 208#--------------------------------------------------------------------------- 209TAGFILES = 210GENERATE_TAGFILE = ${CPACK_BINARY_DIR}/docs/openttd_ai_api.tag 211ALLEXTERNALS = NO 212EXTERNAL_GROUPS = YES 213#--------------------------------------------------------------------------- 214# Configuration options related to the dot tool 215#--------------------------------------------------------------------------- 216CLASS_DIAGRAMS = YES 217HIDE_UNDOC_RELATIONS = YES 218HAVE_DOT = NO 219CLASS_GRAPH = YES 220COLLABORATION_GRAPH = YES 221GROUP_GRAPHS = YES 222UML_LOOK = NO 223TEMPLATE_RELATIONS = NO 224INCLUDE_GRAPH = YES 225INCLUDED_BY_GRAPH = YES 226CALL_GRAPH = NO 227CALLER_GRAPH = NO 228GRAPHICAL_HIERARCHY = YES 229DIRECTORY_GRAPH = YES 230DOT_IMAGE_FORMAT = png 231DOT_PATH = 232DOTFILE_DIRS = 233DOT_GRAPH_MAX_NODES = 50 234MAX_DOT_GRAPH_DEPTH = 1000 235DOT_TRANSPARENT = NO 236DOT_MULTI_TARGETS = NO 237GENERATE_LEGEND = NO 238DOT_CLEANUP = YES 239#--------------------------------------------------------------------------- 240# Configuration::additions related to the search engine 241#--------------------------------------------------------------------------- 242SEARCHENGINE = NO 243