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