doc/Doxyfile.in
author Alpar Juttner <alpar@cs.elte.hu>
Mon, 06 Oct 2008 13:02:13 +0100
changeset 305 069f27927ba9
parent 219 b9c6a47c977b
parent 224 b246072978e8
child 299 907446600ca9
permissions -rw-r--r--
0.x -> 1.x migration script and guide (preliminary version) (#157)
     1 # Doxyfile 1.5.5
     2 
     3 #---------------------------------------------------------------------------
     4 # Project related configuration options
     5 #---------------------------------------------------------------------------
     6 DOXYFILE_ENCODING      = UTF-8
     7 PROJECT_NAME           = @PACKAGE_NAME@
     8 PROJECT_NUMBER         = @PACKAGE_VERSION@
     9 OUTPUT_DIRECTORY       = 
    10 CREATE_SUBDIRS         = NO
    11 OUTPUT_LANGUAGE        = English
    12 BRIEF_MEMBER_DESC      = YES
    13 REPEAT_BRIEF           = NO
    14 ABBREVIATE_BRIEF       = 
    15 ALWAYS_DETAILED_SEC    = NO
    16 INLINE_INHERITED_MEMB  = NO
    17 FULL_PATH_NAMES        = YES
    18 STRIP_FROM_PATH        = "@abs_top_srcdir@"
    19 STRIP_FROM_INC_PATH    = "@abs_top_srcdir@"
    20 SHORT_NAMES            = YES
    21 JAVADOC_AUTOBRIEF      = NO
    22 QT_AUTOBRIEF           = NO
    23 MULTILINE_CPP_IS_BRIEF = NO
    24 DETAILS_AT_TOP         = YES
    25 INHERIT_DOCS           = NO
    26 SEPARATE_MEMBER_PAGES  = NO
    27 TAB_SIZE               = 8
    28 ALIASES                = 
    29 OPTIMIZE_OUTPUT_FOR_C  = NO
    30 OPTIMIZE_OUTPUT_JAVA   = NO
    31 OPTIMIZE_FOR_FORTRAN   = NO
    32 OPTIMIZE_OUTPUT_VHDL   = NO
    33 BUILTIN_STL_SUPPORT    = YES
    34 CPP_CLI_SUPPORT        = NO
    35 SIP_SUPPORT            = NO
    36 DISTRIBUTE_GROUP_DOC   = NO
    37 SUBGROUPING            = YES
    38 TYPEDEF_HIDES_STRUCT   = NO
    39 #---------------------------------------------------------------------------
    40 # Build related configuration options
    41 #---------------------------------------------------------------------------
    42 EXTRACT_ALL            = NO
    43 EXTRACT_PRIVATE        = YES
    44 EXTRACT_STATIC         = YES
    45 EXTRACT_LOCAL_CLASSES  = NO
    46 EXTRACT_LOCAL_METHODS  = NO
    47 EXTRACT_ANON_NSPACES   = NO
    48 HIDE_UNDOC_MEMBERS     = YES
    49 HIDE_UNDOC_CLASSES     = YES
    50 HIDE_FRIEND_COMPOUNDS  = NO
    51 HIDE_IN_BODY_DOCS      = NO
    52 INTERNAL_DOCS          = NO
    53 CASE_SENSE_NAMES       = YES
    54 HIDE_SCOPE_NAMES       = YES
    55 SHOW_INCLUDE_FILES     = YES
    56 INLINE_INFO            = YES
    57 SORT_MEMBER_DOCS       = NO
    58 SORT_BRIEF_DOCS        = NO
    59 SORT_GROUP_NAMES       = NO
    60 SORT_BY_SCOPE_NAME     = NO
    61 GENERATE_TODOLIST      = YES
    62 GENERATE_TESTLIST      = YES
    63 GENERATE_BUGLIST       = YES
    64 GENERATE_DEPRECATEDLIST= YES
    65 ENABLED_SECTIONS       = 
    66 MAX_INITIALIZER_LINES  = 5
    67 SHOW_USED_FILES        = YES
    68 SHOW_DIRECTORIES       = YES
    69 FILE_VERSION_FILTER    = 
    70 #---------------------------------------------------------------------------
    71 # configuration options related to warning and progress messages
    72 #---------------------------------------------------------------------------
    73 QUIET                  = NO
    74 WARNINGS               = YES
    75 WARN_IF_UNDOCUMENTED   = YES
    76 WARN_IF_DOC_ERROR      = YES
    77 WARN_NO_PARAMDOC       = NO
    78 WARN_FORMAT            = "$file:$line: $text  "
    79 WARN_LOGFILE           = doxygen.log
    80 #---------------------------------------------------------------------------
    81 # configuration options related to the input files
    82 #---------------------------------------------------------------------------
    83 INPUT                  = "@abs_top_srcdir@/doc" \
    84                          "@abs_top_srcdir@/lemon" \
    85                          "@abs_top_srcdir@/lemon/bits" \
    86                          "@abs_top_srcdir@/lemon/concepts" \
    87                          "@abs_top_srcdir@/demo" \
    88                          "@abs_top_srcdir@/tools" \
    89                          "@abs_top_srcdir@/test/test_tools.h"
    90 INPUT_ENCODING         = UTF-8
    91 FILE_PATTERNS          = *.h \
    92                          *.cc \
    93                          *.dox
    94 RECURSIVE              = NO
    95 EXCLUDE                = 
    96 EXCLUDE_SYMLINKS       = NO
    97 EXCLUDE_PATTERNS       = 
    98 EXCLUDE_SYMBOLS        = 
    99 EXAMPLE_PATH           = "@abs_top_srcdir@/demo" \
   100                          "@abs_top_srcdir@/LICENSE" \
   101                          "@abs_top_srcdir@/doc"
   102 EXAMPLE_PATTERNS       = 
   103 EXAMPLE_RECURSIVE      = NO
   104 IMAGE_PATH             = "@abs_top_srcdir@/doc/images" \
   105                          "@abs_top_builddir@/doc/gen-images"
   106 INPUT_FILTER           = 
   107 FILTER_PATTERNS        = 
   108 FILTER_SOURCE_FILES    = NO
   109 #---------------------------------------------------------------------------
   110 # configuration options related to source browsing
   111 #---------------------------------------------------------------------------
   112 SOURCE_BROWSER         = NO
   113 INLINE_SOURCES         = NO
   114 STRIP_CODE_COMMENTS    = YES
   115 REFERENCED_BY_RELATION = NO
   116 REFERENCES_RELATION    = NO
   117 REFERENCES_LINK_SOURCE = YES
   118 USE_HTAGS              = NO
   119 VERBATIM_HEADERS       = NO
   120 #---------------------------------------------------------------------------
   121 # configuration options related to the alphabetical class index
   122 #---------------------------------------------------------------------------
   123 ALPHABETICAL_INDEX     = YES
   124 COLS_IN_ALPHA_INDEX    = 2
   125 IGNORE_PREFIX          = 
   126 #---------------------------------------------------------------------------
   127 # configuration options related to the HTML output
   128 #---------------------------------------------------------------------------
   129 GENERATE_HTML          = YES
   130 HTML_OUTPUT            = html
   131 HTML_FILE_EXTENSION    = .html
   132 HTML_HEADER            = 
   133 HTML_FOOTER            = 
   134 HTML_STYLESHEET        = 
   135 HTML_ALIGN_MEMBERS     = YES
   136 GENERATE_HTMLHELP      = NO
   137 GENERATE_DOCSET        = NO
   138 DOCSET_FEEDNAME        = "Doxygen generated docs"
   139 DOCSET_BUNDLE_ID       = org.doxygen.Project
   140 HTML_DYNAMIC_SECTIONS  = NO
   141 CHM_FILE               = 
   142 HHC_LOCATION           = 
   143 GENERATE_CHI           = NO
   144 BINARY_TOC             = NO
   145 TOC_EXPAND             = NO
   146 DISABLE_INDEX          = NO
   147 ENUM_VALUES_PER_LINE   = 4
   148 GENERATE_TREEVIEW      = NO
   149 TREEVIEW_WIDTH         = 250
   150 #---------------------------------------------------------------------------
   151 # configuration options related to the LaTeX output
   152 #---------------------------------------------------------------------------
   153 GENERATE_LATEX         = NO
   154 LATEX_OUTPUT           = latex
   155 LATEX_CMD_NAME         = latex
   156 MAKEINDEX_CMD_NAME     = makeindex
   157 COMPACT_LATEX          = YES
   158 PAPER_TYPE             = a4wide
   159 EXTRA_PACKAGES         = amsmath \
   160                          amssymb
   161 LATEX_HEADER           = 
   162 PDF_HYPERLINKS         = YES
   163 USE_PDFLATEX           = YES
   164 LATEX_BATCHMODE        = NO
   165 LATEX_HIDE_INDICES     = NO
   166 #---------------------------------------------------------------------------
   167 # configuration options related to the RTF output
   168 #---------------------------------------------------------------------------
   169 GENERATE_RTF           = NO
   170 RTF_OUTPUT             = rtf
   171 COMPACT_RTF            = NO
   172 RTF_HYPERLINKS         = NO
   173 RTF_STYLESHEET_FILE    = 
   174 RTF_EXTENSIONS_FILE    = 
   175 #---------------------------------------------------------------------------
   176 # configuration options related to the man page output
   177 #---------------------------------------------------------------------------
   178 GENERATE_MAN           = NO
   179 MAN_OUTPUT             = man
   180 MAN_EXTENSION          = .3
   181 MAN_LINKS              = NO
   182 #---------------------------------------------------------------------------
   183 # configuration options related to the XML output
   184 #---------------------------------------------------------------------------
   185 GENERATE_XML           = NO
   186 XML_OUTPUT             = xml
   187 XML_SCHEMA             = 
   188 XML_DTD                = 
   189 XML_PROGRAMLISTING     = YES
   190 #---------------------------------------------------------------------------
   191 # configuration options for the AutoGen Definitions output
   192 #---------------------------------------------------------------------------
   193 GENERATE_AUTOGEN_DEF   = NO
   194 #---------------------------------------------------------------------------
   195 # configuration options related to the Perl module output
   196 #---------------------------------------------------------------------------
   197 GENERATE_PERLMOD       = NO
   198 PERLMOD_LATEX          = NO
   199 PERLMOD_PRETTY         = YES
   200 PERLMOD_MAKEVAR_PREFIX = 
   201 #---------------------------------------------------------------------------
   202 # Configuration options related to the preprocessor   
   203 #---------------------------------------------------------------------------
   204 ENABLE_PREPROCESSING   = YES
   205 MACRO_EXPANSION        = NO
   206 EXPAND_ONLY_PREDEF     = NO
   207 SEARCH_INCLUDES        = YES
   208 INCLUDE_PATH           = 
   209 INCLUDE_FILE_PATTERNS  = 
   210 PREDEFINED             = DOXYGEN
   211 EXPAND_AS_DEFINED      = 
   212 SKIP_FUNCTION_MACROS   = YES
   213 #---------------------------------------------------------------------------
   214 # Configuration::additions related to external references   
   215 #---------------------------------------------------------------------------
   216 TAGFILES               = "@abs_top_srcdir@/doc/libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/  "
   217 GENERATE_TAGFILE       = html/lemon.tag
   218 ALLEXTERNALS           = NO
   219 EXTERNAL_GROUPS        = NO
   220 PERL_PATH              = /usr/bin/perl
   221 #---------------------------------------------------------------------------
   222 # Configuration options related to the dot tool   
   223 #---------------------------------------------------------------------------
   224 CLASS_DIAGRAMS         = NO
   225 MSCGEN_PATH            = 
   226 HIDE_UNDOC_RELATIONS   = YES
   227 HAVE_DOT               = YES
   228 CLASS_GRAPH            = YES
   229 COLLABORATION_GRAPH    = NO
   230 GROUP_GRAPHS           = NO
   231 UML_LOOK               = NO
   232 TEMPLATE_RELATIONS     = NO
   233 INCLUDE_GRAPH          = NO
   234 INCLUDED_BY_GRAPH      = NO
   235 CALL_GRAPH             = NO
   236 CALLER_GRAPH           = NO
   237 GRAPHICAL_HIERARCHY    = NO
   238 DIRECTORY_GRAPH        = NO
   239 DOT_IMAGE_FORMAT       = png
   240 DOT_PATH               = 
   241 DOTFILE_DIRS           = 
   242 DOT_GRAPH_MAX_NODES    = 50
   243 MAX_DOT_GRAPH_DEPTH    = 0
   244 DOT_TRANSPARENT        = NO
   245 DOT_MULTI_TARGETS      = NO
   246 GENERATE_LEGEND        = YES
   247 DOT_CLEANUP            = YES
   248 #---------------------------------------------------------------------------
   249 # Configuration::additions related to the search engine   
   250 #---------------------------------------------------------------------------
   251 SEARCHENGINE           = NO