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@/shuttle   \
  75                          @top_srcdir@/sim
  76
  77 FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx *.C
  78 RECURSIVE              = YES
  79 EXCLUDE                = @top_srcdir@/TPCLib/gui
  80
  81 EXCLUDE_SYMLINKS       = NO
  82 EXCLUDE_PATTERNS       =
  83 EXAMPLE_PATH           =
  84 EXAMPLE_PATTERNS       =
  85 EXAMPLE_RECURSIVE      = NO
  86 IMAGE_PATH             = @srcdir@/pics
  87 INPUT_FILTER           =
  88 FILTER_SOURCE_FILES    = NO
  89 #---------------------------------------------------------------------------
  90 # configuration options related to source browsing
  91 #---------------------------------------------------------------------------
  92 SOURCE_BROWSER         = YES
  93 INLINE_SOURCES         = NO
  94 STRIP_CODE_COMMENTS    = YES
  95 REFERENCED_BY_RELATION = YES
  96 REFERENCES_RELATION    = YES
  97 VERBATIM_HEADERS       = NO
  98 #---------------------------------------------------------------------------
  99 # configuration options related to the alphabetical class index
 100 #---------------------------------------------------------------------------
 101 ALPHABETICAL_INDEX     = YES
 102 COLS_IN_ALPHA_INDEX    = 5
 103 IGNORE_PREFIX          =
 104 #---------------------------------------------------------------------------
 105 # configuration options related to the HTML output
 106 #---------------------------------------------------------------------------
 107 GENERATE_HTML          = YES
 108 HTML_OUTPUT            = html
 109 HTML_FILE_EXTENSION    = .html
 110 HTML_HEADER            =
 111 HTML_FOOTER            =
 112 HTML_STYLESHEET        =
 113 HTML_ALIGN_MEMBERS     = YES
 114 GENERATE_HTMLHELP      = NO
 115 CHM_FILE               =
 116 HHC_LOCATION           =
 117 GENERATE_CHI           = NO
 118 BINARY_TOC             = NO
 119 TOC_EXPAND             = NO
 120 DISABLE_INDEX          = NO
 121 ENUM_VALUES_PER_LINE   = 4
 122 GENERATE_TREEVIEW      = NO
 123 TREEVIEW_WIDTH         = 150
 124 #---------------------------------------------------------------------------
 125 # configuration options related to the LaTeX output
 126 #---------------------------------------------------------------------------
 127 GENERATE_LATEX         = NO
 128 LATEX_OUTPUT           = latex
 129 LATEX_CMD_NAME         = latex
 130 MAKEINDEX_CMD_NAME     = makeindex
 131 COMPACT_LATEX          = YES
 132 PAPER_TYPE             = a4wide
 133 EXTRA_PACKAGES         =
 134 LATEX_HEADER           =
 135 PDF_HYPERLINKS         = YES
 136 USE_PDFLATEX           = YES
 137 LATEX_BATCHMODE        = NO
 138 LATEX_HIDE_INDICES     = YES
 139 #---------------------------------------------------------------------------
 140 # configuration options related to the RTF output
 141 #---------------------------------------------------------------------------
 142 GENERATE_RTF           = NO
 143 RTF_OUTPUT             = rtf
 144 COMPACT_RTF            = NO
 145 RTF_HYPERLINKS         = NO
 146 RTF_STYLESHEET_FILE    =
 147 RTF_EXTENSIONS_FILE    =
 148 #---------------------------------------------------------------------------
 149 # configuration options related to the man page output
 150 #---------------------------------------------------------------------------
 151 GENERATE_MAN           = NO
 152 MAN_OUTPUT             = man
 153 MAN_EXTENSION          = .3
 154 MAN_LINKS              = NO
 155 #---------------------------------------------------------------------------
 156 # configuration options related to the XML output
 157 #---------------------------------------------------------------------------
 158 GENERATE_XML           = NO
 159 XML_OUTPUT             = xml
 160 XML_SCHEMA             =
 161 XML_DTD                =
 162 #---------------------------------------------------------------------------
 163 # configuration options for the AutoGen Definitions output
 164 #---------------------------------------------------------------------------
 165 GENERATE_AUTOGEN_DEF   = NO
 166 #---------------------------------------------------------------------------
 167 # configuration options related to the Perl module output
 168 #---------------------------------------------------------------------------
 169 GENERATE_PERLMOD       = NO
 170 PERLMOD_LATEX          = NO
 171 PERLMOD_PRETTY         = YES
 172 PERLMOD_MAKEVAR_PREFIX =
 173 #---------------------------------------------------------------------------
 174 # Configuration options related to the preprocessor
 175 #---------------------------------------------------------------------------
 176 ENABLE_PREPROCESSING   = YES
 177 MACRO_EXPANSION        = YES
 178 EXPAND_ONLY_PREDEF     = NO
 179 SEARCH_INCLUDES        = YES
 180 INCLUDE_PATH           =
 181 INCLUDE_FILE_PATTERNS  =
 182 PREDEFINED             = "DOXYGEN_INPUT"
 183 EXPAND_AS_DEFINED      =
 184 SKIP_FUNCTION_MACROS   = YES
 185 #---------------------------------------------------------------------------
 186 # Configuration::addtions related to external references
 187 #---------------------------------------------------------------------------
 188 TAGFILES               =
 189 GENERATE_TAGFILE       = @PACKAGE@.tags
 190 ALLEXTERNALS           = NO
 191 EXTERNAL_GROUPS        = YES
 192 PERL_PATH              = @PERL@
 193 #---------------------------------------------------------------------------
 194 # Configuration options related to the dot tool
 195 #---------------------------------------------------------------------------
 196 CLASS_DIAGRAMS         = YES
 197 HIDE_UNDOC_RELATIONS   = NO
 198 HAVE_DOT               = @HAVE_DOT@
 199 CLASS_GRAPH            = YES
 200 COLLABORATION_GRAPH    = YES
 201 UML_LOOK               = YES
 202 TEMPLATE_RELATIONS     = YES
 203 INCLUDE_GRAPH          = YES
 204 INCLUDED_BY_GRAPH      = YES
 205 CALL_GRAPH             = YES
 206 GRAPHICAL_HIERARCHY    = YES
 207 DOT_IMAGE_FORMAT       = png
 208 DOT_PATH               = @DOT_PATH@
 209 DOTFILE_DIRS           =
 210 MAX_DOT_GRAPH_WIDTH    = 640
 211 MAX_DOT_GRAPH_HEIGHT   = 640
 212 MAX_DOT_GRAPH_DEPTH    = 0
 213 GENERATE_LEGEND        = YES
 214 DOT_CLEANUP            = YES
 215 #---------------------------------------------------------------------------
 216 # Configuration::addtions related to the search engine
 217 #---------------------------------------------------------------------------
 218 SEARCHENGINE           = NO