HLT/doc/doxymodule.conf.in

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