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