HLT/doc/doxygen.conf.in

   1 # $Id$
   2 #
   3
   4 #---------------------------------------------------------------------------
   5 # Project related configuration options
   6 #---------------------------------------------------------------------------
   7 # This tag specifies the encoding used for all characters in the config file
   8 # that follow. The default is UTF-8 which is also the encoding used for all
   9 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
  10 # iconv built into libc) for the transcoding. See
  11 # http://www.gnu.org/software/libiconv for the list of possible encodings.
  12
  13 DOXYFILE_ENCODING      = UTF-8
  14 PROJECT_NAME           = "ALICE HLT"
  15 PROJECT_NUMBER         = @ALIROOT_BRANCH@
  16 OUTPUT_DIRECTORY       = @HLT_doxy_output_root@
  17 CREATE_SUBDIRS         = NO
  18 OUTPUT_LANGUAGE        = English
  19 BRIEF_MEMBER_DESC      = NO
  20 REPEAT_BRIEF           = YES
  21 ABBREVIATE_BRIEF       =
  22 ALWAYS_DETAILED_SEC    = YES
  23 INLINE_INHERITED_MEMB  = NO
  24 FULL_PATH_NAMES        = NO
  25 STRIP_FROM_PATH        =
  26 STRIP_FROM_INC_PATH    =
  27 SHORT_NAMES            = NO
  28 JAVADOC_AUTOBRIEF      = YES
  29 QT_AUTOBRIEF           = NO
  30 MULTILINE_CPP_IS_BRIEF = NO
  31 INHERIT_DOCS           = YES
  32 SEPARATE_MEMBER_PAGES  = NO
  33 TAB_SIZE               = 8
  34 GENERATE_TESTLIST      = YES
  35 GENERATE_BUGLIST       = YES
  36 ALIASES                =
  37 OPTIMIZE_OUTPUT_FOR_C  = YES
  38 OPTIMIZE_OUTPUT_JAVA   = NO
  39 OPTIMIZE_FOR_FORTRAN   = NO
  40 OPTIMIZE_OUTPUT_VHDL   = NO
  41 BUILTIN_STL_SUPPORT    = NO
  42 CPP_CLI_SUPPORT        = NO
  43 SIP_SUPPORT            = NO
  44 IDL_PROPERTY_SUPPORT   = YES
  45 DISTRIBUTE_GROUP_DOC   = NO
  46 SUBGROUPING            = YES
  47 TYPEDEF_HIDES_STRUCT   = NO
  48
  49 #---------------------------------------------------------------------------
  50 # Build related configuration options
  51 #---------------------------------------------------------------------------
  52 EXTRACT_ALL            = YES
  53 EXTRACT_PRIVATE        = YES
  54 EXTRACT_STATIC         = YES
  55 EXTRACT_LOCAL_CLASSES  = YES
  56 EXTRACT_LOCAL_METHODS  = NO
  57 EXTRACT_ANON_NSPACES   = NO
  58 HIDE_UNDOC_MEMBERS     = NO
  59 HIDE_UNDOC_CLASSES     = NO
  60 HIDE_FRIEND_COMPOUNDS  = NO
  61 HIDE_IN_BODY_DOCS      = YES
  62 INTERNAL_DOCS          = NO
  63 CASE_SENSE_NAMES       = YES
  64 HIDE_SCOPE_NAMES       = NO
  65 SHOW_INCLUDE_FILES     = YES
  66 INLINE_INFO            = YES
  67 SORT_MEMBER_DOCS       = YES
  68 SORT_BRIEF_DOCS        = NO
  69 SORT_GROUP_NAMES       = NO
  70 SORT_BY_SCOPE_NAME     = NO
  71 GENERATE_TODOLIST      = YES
  72 GENERATE_TESTLIST      = YES
  73 GENERATE_BUGLIST       = YES
  74 GENERATE_DEPRECATEDLIST= YES
  75 ENABLED_SECTIONS       =
  76 MAX_INITIALIZER_LINES  = 30
  77 SHOW_USED_FILES        = YES
  78 #SHOW_DIRECTORIES       = NO
  79 SHOW_FILES             = YES
  80 SHOW_NAMESPACES        = YES
  81 FILE_VERSION_FILTER    =
  82 LAYOUT_FILE            =
  83 #---------------------------------------------------------------------------
  84 # configuration options related to warning and progress messages
  85 #---------------------------------------------------------------------------
  86 QUIET                  = YES
  87 WARNINGS               = YES
  88 WARN_IF_UNDOCUMENTED   = YES
  89 WARN_IF_DOC_ERROR      = NO
  90 WARN_NO_PARAMDOC       = NO
  91 WARN_FORMAT            = "$file:$line: $text"
  92 WARN_LOGFILE           =
  93 #---------------------------------------------------------------------------
  94 # configuration options related to the input files
  95 #---------------------------------------------------------------------------
  96 INPUT                  = @HLT_doxy_input@
  97
  98 INPUT_ENCODING         = UTF-8
  99
 100 FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx
 101 RECURSIVE              = YES
 102 EXCLUDE                = @HLT_doxy_source_exclude_paths@
 103
 104 EXCLUDE_SYMLINKS       = NO
 105 EXCLUDE_PATTERNS       =
 106 EXCLUDE_SYMBOLS        =
 107 EXAMPLE_PATH           =
 108 EXAMPLE_PATTERNS       =
 109 EXAMPLE_RECURSIVE      = NO
 110 IMAGE_PATH             = @HLT_doxy_image_path@
 111 INPUT_FILTER           =
 112 FILTER_PATTERNS        =
 113 FILTER_SOURCE_FILES    = NO
 114 #---------------------------------------------------------------------------
 115 # configuration options related to source browsing
 116 #---------------------------------------------------------------------------
 117 SOURCE_BROWSER         = YES
 118 INLINE_SOURCES         = NO
 119 STRIP_CODE_COMMENTS    = YES
 120 REFERENCED_BY_RELATION = YES
 121 REFERENCES_RELATION    = YES
 122 REFERENCES_LINK_SOURCE = YES
 123 USE_HTAGS              = NO
 124 VERBATIM_HEADERS       = NO
 125 #---------------------------------------------------------------------------
 126 # configuration options related to the alphabetical class index
 127 #---------------------------------------------------------------------------
 128 ALPHABETICAL_INDEX     = YES
 129 COLS_IN_ALPHA_INDEX    = 5
 130 IGNORE_PREFIX          =
 131 #---------------------------------------------------------------------------
 132 # configuration options related to the HTML output
 133 #---------------------------------------------------------------------------
 134 GENERATE_HTML          = YES
 135 HTML_OUTPUT            = html
 136 HTML_FILE_EXTENSION    = .html
 137 HTML_HEADER            =
 138 HTML_FOOTER            =
 139 HTML_STYLESHEET        =
 140 #HTML_ALIGN_MEMBERS     = YES
 141 HTML_DYNAMIC_SECTIONS  = NO
 142 GENERATE_DOCSET        = NO
 143 DOCSET_FEEDNAME        =
 144 DOCSET_BUNDLE_ID       =
 145 GENERATE_HTMLHELP      = NO
 146 CHM_FILE               =
 147 HHC_LOCATION           =
 148 GENERATE_CHI           = NO
 149 CHM_INDEX_ENCODING     =
 150 BINARY_TOC             = NO
 151 TOC_EXPAND             = NO
 152 GENERATE_QHP           = NO
 153 QCH_FILE               =
 154 QHP_NAMESPACE          =
 155 QHP_VIRTUAL_FOLDER     = doc
 156 QHG_LOCATION           =
 157 DISABLE_INDEX          = NO
 158 ENUM_VALUES_PER_LINE   = 4
 159 GENERATE_TREEVIEW      = NO
 160 TREEVIEW_WIDTH         = 150
 161 FORMULA_FONTSIZE       = 10
 162 #---------------------------------------------------------------------------
 163 # configuration options related to the LaTeX output
 164 #---------------------------------------------------------------------------
 165 GENERATE_LATEX         = NO
 166 LATEX_OUTPUT           = latex
 167 LATEX_CMD_NAME         = latex
 168 MAKEINDEX_CMD_NAME     = makeindex
 169 COMPACT_LATEX          = YES
 170 PAPER_TYPE             = a4wide
 171 EXTRA_PACKAGES         =
 172 LATEX_HEADER           =
 173 PDF_HYPERLINKS         = YES
 174 USE_PDFLATEX           = YES
 175 LATEX_BATCHMODE        = NO
 176 LATEX_HIDE_INDICES     = YES
 177 #---------------------------------------------------------------------------
 178 # configuration options related to the RTF output
 179 #---------------------------------------------------------------------------
 180 GENERATE_RTF           = NO
 181 RTF_OUTPUT             = rtf
 182 COMPACT_RTF            = NO
 183 RTF_HYPERLINKS         = NO
 184 RTF_STYLESHEET_FILE    =
 185 RTF_EXTENSIONS_FILE    =
 186 #---------------------------------------------------------------------------
 187 # configuration options related to the man page output
 188 #---------------------------------------------------------------------------
 189 GENERATE_MAN           = NO
 190 MAN_OUTPUT             = man
 191 MAN_EXTENSION          = .3
 192 MAN_LINKS              = NO
 193 #---------------------------------------------------------------------------
 194 # configuration options related to the XML output
 195 #---------------------------------------------------------------------------
 196 GENERATE_XML           = NO
 197 XML_OUTPUT             = xml
 198 XML_SCHEMA             =
 199 XML_DTD                =
 200 #---------------------------------------------------------------------------
 201 # configuration options for the AutoGen Definitions output
 202 #---------------------------------------------------------------------------
 203 GENERATE_AUTOGEN_DEF   = NO
 204 #---------------------------------------------------------------------------
 205 # configuration options related to the Perl module output
 206 #---------------------------------------------------------------------------
 207 GENERATE_PERLMOD       = NO
 208 PERLMOD_LATEX          = NO
 209 PERLMOD_PRETTY         = YES
 210 PERLMOD_MAKEVAR_PREFIX =
 211 #---------------------------------------------------------------------------
 212 # Configuration options related to the preprocessor
 213 #---------------------------------------------------------------------------
 214 ENABLE_PREPROCESSING   = YES
 215 MACRO_EXPANSION        = YES
 216 EXPAND_ONLY_PREDEF     = NO
 217 SEARCH_INCLUDES        = YES
 218 INCLUDE_PATH           =
 219 INCLUDE_FILE_PATTERNS  =
 220 PREDEFINED             = ClassImp()= \
 221                        GPUd()=
 222 EXPAND_AS_DEFINED      =
 223 SKIP_FUNCTION_MACROS   = YES
 224 #---------------------------------------------------------------------------
 225 # Configuration::addtions related to external references
 226 #---------------------------------------------------------------------------
 227 TAGFILES               =
 228 GENERATE_TAGFILE       =
 229 ALLEXTERNALS           = NO
 230 EXTERNAL_GROUPS        = YES
 231 PERL_PATH              =
 232 #---------------------------------------------------------------------------
 233 # Configuration options related to the dot tool
 234 #---------------------------------------------------------------------------
 235 CLASS_DIAGRAMS         = YES
 236 HIDE_UNDOC_RELATIONS   = NO
 237 HAVE_DOT               = @DOXYGEN_DOT_FOUND@
 238 DOT_FONTNAME           = Sans
 239 DOT_FONTSIZE           = 10
 240 CLASS_GRAPH            = YES
 241 COLLABORATION_GRAPH    = NO
 242 GROUP_GRAPHS           = YES
 243 UML_LOOK               = YES
 244 TEMPLATE_RELATIONS     = YES
 245 INCLUDE_GRAPH          = YES
 246 INCLUDED_BY_GRAPH      = NO
 247 CALL_GRAPH             = YES
 248 CALLER_GRAPH           = NO
 249 GRAPHICAL_HIERARCHY    = YES
 250 DIRECTORY_GRAPH        = YES
 251 DOT_IMAGE_FORMAT       = png
 252 DOT_PATH               = @DOXYGEN_DOT_PATH@
 253 #DOT_GRAPH_MAX_NODES    = 100
 254 DOTFILE_DIRS           =
 255 MAX_DOT_GRAPH_DEPTH    = 0
 256 GENERATE_LEGEND        = YES
 257 DOT_CLEANUP            = YES
 258 #---------------------------------------------------------------------------
 259 # Configuration::additions related to the search engine
 260 #---------------------------------------------------------------------------
 261 SEARCHENGINE           = NO