HLT/doc/doxygen.conf.in

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