truebrain@9840: # Doxyfile 1.5.4 truebrain@9840: truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # Project related configuration options truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: DOXYFILE_ENCODING = UTF-8 truebrain@9840: PROJECT_NAME = "OpenTTD AI API " truebrain@9840: PROJECT_NUMBER = truebrain@9840: OUTPUT_DIRECTORY = ../../../docs/aidocs/ truebrain@9840: CREATE_SUBDIRS = NO truebrain@9840: OUTPUT_LANGUAGE = English truebrain@9840: BRIEF_MEMBER_DESC = YES truebrain@9840: REPEAT_BRIEF = YES truebrain@9840: ABBREVIATE_BRIEF = "The $name class " \ truebrain@9840: "The $name widget " \ truebrain@9840: "The $name file " \ truebrain@9840: is \ truebrain@9840: provides \ truebrain@9840: specifies \ truebrain@9840: contains \ truebrain@9840: represents \ truebrain@9840: a \ truebrain@9840: an \ truebrain@9840: the truebrain@9840: ALWAYS_DETAILED_SEC = NO truebrain@9840: INLINE_INHERITED_MEMB = NO truebrain@9840: FULL_PATH_NAMES = YES truebrain@9840: STRIP_FROM_PATH = ./ truebrain@9840: STRIP_FROM_INC_PATH = truebrain@9840: SHORT_NAMES = NO truebrain@9840: JAVADOC_AUTOBRIEF = YES truebrain@9840: QT_AUTOBRIEF = NO truebrain@9840: MULTILINE_CPP_IS_BRIEF = NO truebrain@9840: DETAILS_AT_TOP = NO truebrain@9840: INHERIT_DOCS = YES truebrain@9840: SEPARATE_MEMBER_PAGES = NO truebrain@9840: TAB_SIZE = 2 truebrain@9840: ALIASES = truebrain@9840: OPTIMIZE_OUTPUT_FOR_C = YES truebrain@9840: OPTIMIZE_OUTPUT_JAVA = NO truebrain@9840: BUILTIN_STL_SUPPORT = NO truebrain@9840: CPP_CLI_SUPPORT = NO truebrain@9840: SIP_SUPPORT = NO truebrain@9840: DISTRIBUTE_GROUP_DOC = NO truebrain@9840: SUBGROUPING = YES truebrain@9840: TYPEDEF_HIDES_STRUCT = NO truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # Build related configuration options truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: EXTRACT_ALL = NO truebrain@9840: EXTRACT_PRIVATE = NO truebrain@9840: EXTRACT_STATIC = YES truebrain@9840: EXTRACT_LOCAL_CLASSES = YES truebrain@9840: EXTRACT_LOCAL_METHODS = YES truebrain@9840: EXTRACT_ANON_NSPACES = NO truebrain@9840: HIDE_UNDOC_MEMBERS = NO truebrain@9840: HIDE_UNDOC_CLASSES = NO truebrain@9840: HIDE_FRIEND_COMPOUNDS = NO truebrain@9840: HIDE_IN_BODY_DOCS = YES truebrain@9840: INTERNAL_DOCS = YES truebrain@9840: CASE_SENSE_NAMES = YES truebrain@9840: HIDE_SCOPE_NAMES = NO truebrain@9840: SHOW_INCLUDE_FILES = NO truebrain@9840: INLINE_INFO = YES truebrain@9840: SORT_MEMBER_DOCS = YES truebrain@9840: SORT_BRIEF_DOCS = NO truebrain@9840: SORT_BY_SCOPE_NAME = NO truebrain@9840: GENERATE_TODOLIST = NO truebrain@9840: GENERATE_TESTLIST = NO truebrain@9840: GENERATE_BUGLIST = NO truebrain@9840: GENERATE_DEPRECATEDLIST= NO truebrain@9840: ENABLED_SECTIONS = truebrain@9840: MAX_INITIALIZER_LINES = 30 truebrain@9840: SHOW_USED_FILES = NO truebrain@9840: SHOW_DIRECTORIES = NO truebrain@9840: FILE_VERSION_FILTER = truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to warning and progress messages truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: QUIET = NO truebrain@9840: WARNINGS = YES truebrain@9840: WARN_IF_UNDOCUMENTED = YES truebrain@9840: WARN_IF_DOC_ERROR = YES truebrain@9841: WARN_NO_PARAMDOC = YES truebrain@9840: WARN_FORMAT = "$file:$line: $text " truebrain@9840: WARN_LOGFILE = truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to the input files truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: INPUT = . truebrain@9840: INPUT_ENCODING = UTF-8 truebrain@9840: FILE_PATTERNS = *.h \ truebrain@9840: *.hpp truebrain@9840: RECURSIVE = YES truebrain@9840: EXCLUDE = truebrain@9840: EXCLUDE_SYMLINKS = NO truebrain@9840: EXCLUDE_PATTERNS = truebrain@9840: EXCLUDE_SYMBOLS = GetClassName DECLARE_ENUM_AS_BIT_SET DECLARE_POSTFIX_INCREMENT truebrain@9840: EXAMPLE_PATH = truebrain@9840: EXAMPLE_PATTERNS = * truebrain@9840: EXAMPLE_RECURSIVE = NO truebrain@9840: IMAGE_PATH = truebrain@9840: INPUT_FILTER = truebrain@9840: FILTER_PATTERNS = truebrain@9840: FILTER_SOURCE_FILES = NO truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to source browsing truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: SOURCE_BROWSER = NO truebrain@9840: INLINE_SOURCES = NO truebrain@9840: STRIP_CODE_COMMENTS = YES truebrain@9840: REFERENCED_BY_RELATION = NO truebrain@9840: REFERENCES_RELATION = NO truebrain@9840: REFERENCES_LINK_SOURCE = YES truebrain@9840: USE_HTAGS = NO truebrain@9840: VERBATIM_HEADERS = NO truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to the alphabetical class index truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: ALPHABETICAL_INDEX = NO truebrain@9840: COLS_IN_ALPHA_INDEX = 5 truebrain@9840: IGNORE_PREFIX = truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to the HTML output truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: GENERATE_HTML = YES truebrain@9840: HTML_OUTPUT = html truebrain@9840: HTML_FILE_EXTENSION = .html truebrain@9840: HTML_HEADER = truebrain@9840: HTML_FOOTER = truebrain@9840: HTML_STYLESHEET = truebrain@9840: HTML_ALIGN_MEMBERS = YES truebrain@9840: GENERATE_HTMLHELP = NO truebrain@9840: HTML_DYNAMIC_SECTIONS = NO truebrain@9840: CHM_FILE = truebrain@9840: HHC_LOCATION = truebrain@9840: GENERATE_CHI = NO truebrain@9840: BINARY_TOC = NO truebrain@9840: TOC_EXPAND = NO truebrain@9840: DISABLE_INDEX = NO truebrain@9840: ENUM_VALUES_PER_LINE = 1 truebrain@9840: GENERATE_TREEVIEW = NO truebrain@9840: TREEVIEW_WIDTH = 250 truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to the LaTeX output truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: GENERATE_LATEX = NO truebrain@9840: LATEX_OUTPUT = latex truebrain@9840: LATEX_CMD_NAME = latex truebrain@9840: MAKEINDEX_CMD_NAME = makeindex truebrain@9840: COMPACT_LATEX = NO truebrain@9840: PAPER_TYPE = a4wide truebrain@9840: EXTRA_PACKAGES = truebrain@9840: LATEX_HEADER = truebrain@9840: PDF_HYPERLINKS = NO truebrain@9840: USE_PDFLATEX = NO truebrain@9840: LATEX_BATCHMODE = NO truebrain@9840: LATEX_HIDE_INDICES = NO truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to the RTF output truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: GENERATE_RTF = NO truebrain@9840: RTF_OUTPUT = rtf truebrain@9840: COMPACT_RTF = NO truebrain@9840: RTF_HYPERLINKS = NO truebrain@9840: RTF_STYLESHEET_FILE = truebrain@9840: RTF_EXTENSIONS_FILE = truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to the man page output truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: GENERATE_MAN = NO truebrain@9840: MAN_OUTPUT = man truebrain@9840: MAN_EXTENSION = .3 truebrain@9840: MAN_LINKS = NO truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to the XML output truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: GENERATE_XML = NO truebrain@9840: XML_OUTPUT = xml truebrain@9840: XML_SCHEMA = truebrain@9840: XML_DTD = truebrain@9840: XML_PROGRAMLISTING = YES truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options for the AutoGen Definitions output truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: GENERATE_AUTOGEN_DEF = NO truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # configuration options related to the Perl module output truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: GENERATE_PERLMOD = NO truebrain@9840: PERLMOD_LATEX = NO truebrain@9840: PERLMOD_PRETTY = YES truebrain@9840: PERLMOD_MAKEVAR_PREFIX = truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # Configuration options related to the preprocessor truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: ENABLE_PREPROCESSING = YES truebrain@9840: MACRO_EXPANSION = YES truebrain@9840: EXPAND_ONLY_PREDEF = YES truebrain@9840: SEARCH_INCLUDES = YES truebrain@9840: INCLUDE_PATH = truebrain@9840: INCLUDE_FILE_PATTERNS = truebrain@9840: PREDEFINED = truebrain@9840: EXPAND_AS_DEFINED = DEF_COMMAND truebrain@9840: SKIP_FUNCTION_MACROS = YES truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # Configuration::additions related to external references truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: TAGFILES = truebrain@9840: GENERATE_TAGFILE = openttd.tag truebrain@9840: ALLEXTERNALS = NO truebrain@9840: EXTERNAL_GROUPS = YES truebrain@9840: PERL_PATH = /usr/bin/perl truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # Configuration options related to the dot tool truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: CLASS_DIAGRAMS = YES truebrain@9840: MSCGEN_PATH = truebrain@9840: HIDE_UNDOC_RELATIONS = YES truebrain@9840: HAVE_DOT = NO truebrain@9840: CLASS_GRAPH = YES truebrain@9840: COLLABORATION_GRAPH = YES truebrain@9840: GROUP_GRAPHS = YES truebrain@9840: UML_LOOK = NO truebrain@9840: TEMPLATE_RELATIONS = NO truebrain@9840: INCLUDE_GRAPH = YES truebrain@9840: INCLUDED_BY_GRAPH = YES truebrain@9840: CALL_GRAPH = NO truebrain@9840: CALLER_GRAPH = NO truebrain@9840: GRAPHICAL_HIERARCHY = YES truebrain@9840: DIRECTORY_GRAPH = YES truebrain@9840: DOT_IMAGE_FORMAT = png truebrain@9840: DOT_PATH = truebrain@9840: DOTFILE_DIRS = truebrain@9840: DOT_GRAPH_MAX_NODES = 50 truebrain@9840: MAX_DOT_GRAPH_DEPTH = 1000 truebrain@9840: DOT_TRANSPARENT = NO truebrain@9840: DOT_MULTI_TARGETS = NO truebrain@9840: GENERATE_LEGEND = NO truebrain@9840: DOT_CLEANUP = YES truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: # Configuration::additions related to the search engine truebrain@9840: #--------------------------------------------------------------------------- truebrain@9840: SEARCHENGINE = NO