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