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           = "@PACKAGE_NAME@"
  15 PROJECT_NUMBER         = @PACKAGE_VERSION@
  16 OUTPUT_DIRECTORY       = .
  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 SYMBOL_CACHE_SIZE      = 0
  49
  50 #---------------------------------------------------------------------------
  51 # Build related configuration options
  52 #---------------------------------------------------------------------------
  53 EXTRACT_ALL            = YES
  54 EXTRACT_PRIVATE        = YES
  55 EXTRACT_STATIC         = YES
  56 EXTRACT_LOCAL_CLASSES  = YES
  57 EXTRACT_LOCAL_METHODS  = NO
  58 EXTRACT_ANON_NSPACES   = NO
  59 HIDE_UNDOC_MEMBERS     = NO
  60 HIDE_UNDOC_CLASSES     = NO
  61 HIDE_FRIEND_COMPOUNDS  = NO
  62 HIDE_IN_BODY_DOCS      = YES
  63 INTERNAL_DOCS          = NO
  64 CASE_SENSE_NAMES       = YES
  65 HIDE_SCOPE_NAMES       = NO
  66 SHOW_INCLUDE_FILES     = YES
  67 INLINE_INFO            = YES
  68 SORT_MEMBER_DOCS       = YES
  69 SORT_BRIEF_DOCS        = NO
  70 SORT_GROUP_NAMES       = NO
  71 SORT_BY_SCOPE_NAME     = NO
  72 GENERATE_TODOLIST      = YES
  73 GENERATE_TESTLIST      = YES
  74 GENERATE_BUGLIST       = YES
  75 GENERATE_DEPRECATEDLIST= YES
  76 ENABLED_SECTIONS       =
  77 MAX_INITIALIZER_LINES  = 30
  78 SHOW_USED_FILES        = YES
  79 SHOW_DIRECTORIES       = NO
  80 SHOW_FILES             = YES
  81 SHOW_NAMESPACES        = YES
  82 FILE_VERSION_FILTER    =
  83 LAYOUT_FILE            =
  84 #---------------------------------------------------------------------------
  85 # configuration options related to warning and progress messages
  86 #---------------------------------------------------------------------------
  87 QUIET                  = YES
  88 WARNINGS               = YES
  89 WARN_IF_UNDOCUMENTED   = YES
  90 WARN_IF_DOC_ERROR      = NO
  91 WARN_NO_PARAMDOC       = NO
  92 WARN_FORMAT            = "$file:$line: $text"
  93 WARN_LOGFILE           =
  94 #---------------------------------------------------------------------------
  95 # configuration options related to the input files
  96 #---------------------------------------------------------------------------
  97 INPUT                  = @top_srcdir@/doc       \
  98                          readme.c               \
  99                          sample_readme.c        \
 100                          module_group.c         \
 101                          @top_srcdir@/BASE      \
 102                          @top_srcdir@/SampleLib \
 103                          @top_srcdir@/rec       \
 104                          @top_srcdir@/exa       \
 105                          @top_srcdir@/shuttle   \
 106                          @top_srcdir@/sim
 107 INPUT_ENCODING         = UTF-8
 108
 109 FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx *.C
 110 RECURSIVE              = YES
 111 EXCLUDE                = @top_srcdir@/TPCLib/gui
 112
 113 EXCLUDE_SYMLINKS       = NO
 114 EXCLUDE_PATTERNS       =
 115 EXCLUDE_SYMBOLS        =
 116 EXAMPLE_PATH           =
 117 EXAMPLE_PATTERNS       =
 118 EXAMPLE_RECURSIVE      = NO
 119 IMAGE_PATH             = @srcdir@/pics
 120 INPUT_FILTER           =
 121 FILTER_PATTERNS        =
 122 FILTER_SOURCE_FILES    = NO
 123 #---------------------------------------------------------------------------
 124 # configuration options related to source browsing
 125 #---------------------------------------------------------------------------
 126 SOURCE_BROWSER         = YES
 127 INLINE_SOURCES         = NO
 128 STRIP_CODE_COMMENTS    = YES
 129 REFERENCED_BY_RELATION = YES
 130 REFERENCES_RELATION    = YES
 131 REFERENCES_LINK_SOURCE = YES
 132 USE_HTAGS              = NO
 133 VERBATIM_HEADERS       = NO
 134 #---------------------------------------------------------------------------
 135 # configuration options related to the alphabetical class index
 136 #---------------------------------------------------------------------------
 137 ALPHABETICAL_INDEX     = YES
 138 COLS_IN_ALPHA_INDEX    = 5
 139 IGNORE_PREFIX          =
 140 #---------------------------------------------------------------------------
 141 # configuration options related to the HTML output
 142 #---------------------------------------------------------------------------
 143 GENERATE_HTML          = YES
 144 HTML_OUTPUT            = html
 145 HTML_FILE_EXTENSION    = .html
 146 HTML_HEADER            =
 147 HTML_FOOTER            =
 148 HTML_STYLESHEET        =
 149 HTML_ALIGN_MEMBERS     = YES
 150 HTML_DYNAMIC_SECTIONS  = NO
 151 GENERATE_DOCSET        = NO
 152 DOCSET_FEEDNAME        =
 153 DOCSET_BUNDLE_ID       =
 154 GENERATE_HTMLHELP      = NO
 155 CHM_FILE               =
 156 HHC_LOCATION           =
 157 GENERATE_CHI           = NO
 158 CHM_INDEX_ENCODING     =
 159 BINARY_TOC             = NO
 160 TOC_EXPAND             = NO
 161 GENERATE_QHP           = NO
 162 QCH_FILE               =
 163 QHP_NAMESPACE          =
 164 QHP_VIRTUAL_FOLDER     = doc
 165 QHG_LOCATION           =
 166 DISABLE_INDEX          = NO
 167 ENUM_VALUES_PER_LINE   = 4
 168 GENERATE_TREEVIEW      = NO
 169 TREEVIEW_WIDTH         = 150
 170 FORMULA_FONTSIZE       = 10
 171 #---------------------------------------------------------------------------
 172 # configuration options related to the LaTeX output
 173 #---------------------------------------------------------------------------
 174 GENERATE_LATEX         = NO
 175 LATEX_OUTPUT           = latex
 176 LATEX_CMD_NAME         = latex
 177 MAKEINDEX_CMD_NAME     = makeindex
 178 COMPACT_LATEX          = YES
 179 PAPER_TYPE             = a4wide
 180 EXTRA_PACKAGES         =
 181 LATEX_HEADER           =
 182 PDF_HYPERLINKS         = YES
 183 USE_PDFLATEX           = YES
 184 LATEX_BATCHMODE        = NO
 185 LATEX_HIDE_INDICES     = YES
 186 #---------------------------------------------------------------------------
 187 # configuration options related to the RTF output
 188 #---------------------------------------------------------------------------
 189 GENERATE_RTF           = NO
 190 RTF_OUTPUT             = rtf
 191 COMPACT_RTF            = NO
 192 RTF_HYPERLINKS         = NO
 193 RTF_STYLESHEET_FILE    =
 194 RTF_EXTENSIONS_FILE    =
 195 #---------------------------------------------------------------------------
 196 # configuration options related to the man page output
 197 #---------------------------------------------------------------------------
 198 GENERATE_MAN           = NO
 199 MAN_OUTPUT             = man
 200 MAN_EXTENSION          = .3
 201 MAN_LINKS              = NO
 202 #---------------------------------------------------------------------------
 203 # configuration options related to the XML output
 204 #---------------------------------------------------------------------------
 205 GENERATE_XML           = NO
 206 XML_OUTPUT             = xml
 207 XML_SCHEMA             =
 208 XML_DTD                =
 209 #---------------------------------------------------------------------------
 210 # configuration options for the AutoGen Definitions output
 211 #---------------------------------------------------------------------------
 212 GENERATE_AUTOGEN_DEF   = NO
 213 #---------------------------------------------------------------------------
 214 # configuration options related to the Perl module output
 215 #---------------------------------------------------------------------------
 216 GENERATE_PERLMOD       = NO
 217 PERLMOD_LATEX          = NO
 218 PERLMOD_PRETTY         = YES
 219 PERLMOD_MAKEVAR_PREFIX =
 220 #---------------------------------------------------------------------------
 221 # Configuration options related to the preprocessor
 222 #---------------------------------------------------------------------------
 223 ENABLE_PREPROCESSING   = YES
 224 MACRO_EXPANSION        = YES
 225 EXPAND_ONLY_PREDEF     = NO
 226 SEARCH_INCLUDES        = YES
 227 INCLUDE_PATH           =
 228 INCLUDE_FILE_PATTERNS  =
 229 PREDEFINED             = "DOXYGEN_INPUT"
 230 EXPAND_AS_DEFINED      =
 231 SKIP_FUNCTION_MACROS   = YES
 232 #---------------------------------------------------------------------------
 233 # Configuration::addtions related to external references
 234 #---------------------------------------------------------------------------
 235 TAGFILES               =
 236 GENERATE_TAGFILE       = @PACKAGE@.tags
 237 ALLEXTERNALS           = NO
 238 EXTERNAL_GROUPS        = YES
 239 PERL_PATH              = @PERL@
 240 #---------------------------------------------------------------------------
 241 # Configuration options related to the dot tool
 242 #---------------------------------------------------------------------------
 243 CLASS_DIAGRAMS         = YES
 244 HIDE_UNDOC_RELATIONS   = NO
 245 HAVE_DOT               = @HAVE_DOT@
 246 DOT_FONTNAME           = FreeSans
 247 DOT_FONTSIZE           = 10
 248 CLASS_GRAPH            = YES
 249 COLLABORATION_GRAPH    = YES
 250 GROUP_GRAPHS           = YES
 251 UML_LOOK               = YES
 252 TEMPLATE_RELATIONS     = YES
 253 INCLUDE_GRAPH          = YES
 254 INCLUDED_BY_GRAPH      = YES
 255 CALL_GRAPH             = YES
 256 CALLER_GRAPH           = NO
 257 GRAPHICAL_HIERARCHY    = YES
 258 DIRECTORY_GRAPH        = YES
 259 DOT_IMAGE_FORMAT       = png
 260 DOT_PATH               = @DOT_PATH@
 261 DOTFILE_DIRS           =
 262 MAX_DOT_GRAPH_DEPTH    = 0
 263 GENERATE_LEGEND        = YES
 264 DOT_CLEANUP            = YES
 265 #---------------------------------------------------------------------------
 266 # Configuration::additions related to the search engine
 267 #---------------------------------------------------------------------------
 268 SEARCHENGINE           = NO