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