Porting HLT doxygen documentation to cmake
[u/mrichter/AliRoot.git] / 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           = "ALICE HLT"
15 PROJECT_NUMBER         = @ALIROOT_BRANCH@
16 OUTPUT_DIRECTORY       = @HLT_doxy_output_root@
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                  = @HLT_doxy_input@
98
99 INPUT_ENCODING         = UTF-8
100
101 FILE_PATTERNS          = *.h *.c *.cpp *.hpp *.cxx
102 RECURSIVE              = YES
103 EXCLUDE                = @HLT_doxy_source_exclude_paths@
104
105 EXCLUDE_SYMLINKS       = NO
106 EXCLUDE_PATTERNS       = 
107 EXCLUDE_SYMBOLS        = 
108 EXAMPLE_PATH           = 
109 EXAMPLE_PATTERNS       = 
110 EXAMPLE_RECURSIVE      = NO
111 IMAGE_PATH             = @HLT_doxy_image_path@
112 INPUT_FILTER           = 
113 FILTER_PATTERNS        = 
114 FILTER_SOURCE_FILES    = NO
115 #---------------------------------------------------------------------------
116 # configuration options related to source browsing
117 #---------------------------------------------------------------------------
118 SOURCE_BROWSER         = YES
119 INLINE_SOURCES         = NO
120 STRIP_CODE_COMMENTS    = YES
121 REFERENCED_BY_RELATION = YES
122 REFERENCES_RELATION    = YES
123 REFERENCES_LINK_SOURCE = YES
124 USE_HTAGS              = NO
125 VERBATIM_HEADERS       = NO
126 #---------------------------------------------------------------------------
127 # configuration options related to the alphabetical class index
128 #---------------------------------------------------------------------------
129 ALPHABETICAL_INDEX     = YES
130 COLS_IN_ALPHA_INDEX    = 5
131 IGNORE_PREFIX          = 
132 #---------------------------------------------------------------------------
133 # configuration options related to the HTML output
134 #---------------------------------------------------------------------------
135 GENERATE_HTML          = YES
136 HTML_OUTPUT            = html
137 HTML_FILE_EXTENSION    = .html
138 HTML_HEADER            = 
139 HTML_FOOTER            = 
140 HTML_STYLESHEET        = 
141 #HTML_ALIGN_MEMBERS     = YES
142 HTML_DYNAMIC_SECTIONS  = NO
143 GENERATE_DOCSET        = NO
144 DOCSET_FEEDNAME        = 
145 DOCSET_BUNDLE_ID       = 
146 GENERATE_HTMLHELP      = NO
147 CHM_FILE               =
148 HHC_LOCATION           =
149 GENERATE_CHI           = NO
150 CHM_INDEX_ENCODING     = 
151 BINARY_TOC             = NO
152 TOC_EXPAND             = NO
153 GENERATE_QHP           = NO
154 QCH_FILE               = 
155 QHP_NAMESPACE          = 
156 QHP_VIRTUAL_FOLDER     = doc
157 QHG_LOCATION           = 
158 DISABLE_INDEX          = NO
159 ENUM_VALUES_PER_LINE   = 4
160 GENERATE_TREEVIEW      = NO
161 TREEVIEW_WIDTH         = 150
162 FORMULA_FONTSIZE       = 10
163 #---------------------------------------------------------------------------
164 # configuration options related to the LaTeX output
165 #---------------------------------------------------------------------------
166 GENERATE_LATEX         = NO
167 LATEX_OUTPUT           = latex
168 LATEX_CMD_NAME         = latex
169 MAKEINDEX_CMD_NAME     = makeindex
170 COMPACT_LATEX          = YES
171 PAPER_TYPE             = a4wide
172 EXTRA_PACKAGES         = 
173 LATEX_HEADER           = 
174 PDF_HYPERLINKS         = YES
175 USE_PDFLATEX           = YES
176 LATEX_BATCHMODE        = NO
177 LATEX_HIDE_INDICES     = YES
178 #---------------------------------------------------------------------------
179 # configuration options related to the RTF output
180 #---------------------------------------------------------------------------
181 GENERATE_RTF           = NO
182 RTF_OUTPUT             = rtf
183 COMPACT_RTF            = NO
184 RTF_HYPERLINKS         = NO
185 RTF_STYLESHEET_FILE    = 
186 RTF_EXTENSIONS_FILE    = 
187 #---------------------------------------------------------------------------
188 # configuration options related to the man page output
189 #---------------------------------------------------------------------------
190 GENERATE_MAN           = NO
191 MAN_OUTPUT             = man
192 MAN_EXTENSION          = .3
193 MAN_LINKS              = NO
194 #---------------------------------------------------------------------------
195 # configuration options related to the XML output
196 #---------------------------------------------------------------------------
197 GENERATE_XML           = NO
198 XML_OUTPUT             = xml
199 XML_SCHEMA             =
200 XML_DTD                =
201 #---------------------------------------------------------------------------
202 # configuration options for the AutoGen Definitions output
203 #---------------------------------------------------------------------------
204 GENERATE_AUTOGEN_DEF   = NO
205 #---------------------------------------------------------------------------
206 # configuration options related to the Perl module output
207 #---------------------------------------------------------------------------
208 GENERATE_PERLMOD       = NO
209 PERLMOD_LATEX          = NO
210 PERLMOD_PRETTY         = YES
211 PERLMOD_MAKEVAR_PREFIX =
212 #---------------------------------------------------------------------------
213 # Configuration options related to the preprocessor   
214 #---------------------------------------------------------------------------
215 ENABLE_PREPROCESSING   = YES
216 MACRO_EXPANSION        = YES
217 EXPAND_ONLY_PREDEF     = NO
218 SEARCH_INCLUDES        = YES
219 INCLUDE_PATH           = 
220 INCLUDE_FILE_PATTERNS  = 
221 PREDEFINED             = ClassImp()= \
222                        GPUd()=
223 EXPAND_AS_DEFINED      = 
224 SKIP_FUNCTION_MACROS   = YES
225 #---------------------------------------------------------------------------
226 # Configuration::addtions related to external references   
227 #---------------------------------------------------------------------------
228 TAGFILES               = 
229 GENERATE_TAGFILE       = 
230 ALLEXTERNALS           = NO
231 EXTERNAL_GROUPS        = YES
232 PERL_PATH              = 
233 #---------------------------------------------------------------------------
234 # Configuration options related to the dot tool   
235 #---------------------------------------------------------------------------
236 CLASS_DIAGRAMS         = YES
237 HIDE_UNDOC_RELATIONS   = NO
238 HAVE_DOT               = @DOXYGEN_DOT_FOUND@
239 DOT_FONTNAME           = Sans
240 DOT_FONTSIZE           = 10
241 CLASS_GRAPH            = YES
242 COLLABORATION_GRAPH    = NO
243 GROUP_GRAPHS           = YES
244 UML_LOOK               = YES
245 TEMPLATE_RELATIONS     = YES
246 INCLUDE_GRAPH          = YES
247 INCLUDED_BY_GRAPH      = NO
248 CALL_GRAPH             = YES
249 CALLER_GRAPH           = NO
250 GRAPHICAL_HIERARCHY    = YES
251 DIRECTORY_GRAPH        = YES
252 DOT_IMAGE_FORMAT       = png
253 DOT_PATH               = @DOXYGEN_DOT_PATH@
254 #DOT_GRAPH_MAX_NODES    = 100
255 DOTFILE_DIRS           = 
256 MAX_DOT_GRAPH_DEPTH    = 0
257 GENERATE_LEGEND        = YES
258 DOT_CLEANUP            = YES
259 #---------------------------------------------------------------------------
260 # Configuration::additions related to the search engine   
261 #---------------------------------------------------------------------------
262 SEARCHENGINE           = NO