Doxyfile.in 17.3 KB
Newer Older
1
2
# Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and
# Development Laboratory (LRDE)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
#
# This file is part of Olena.
#
# Olena is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, version 2 of the License.
#
# Olena is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Olena.  If not, see <http://www.gnu.org/licenses/>.
#
18
# Doxyfile 1.5.1
19
20
21
22

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
23
24
25
PROJECT_NAME           = "Milena"
PROJECT_NUMBER         = "@PACKAGE_VERSION@"
PROJECT_BRIEF	       = "An Image Processing Platform"
Guillaume Lazzara's avatar
Guillaume Lazzara committed
26
PROJECT_LOGO 	       = @top_srcdir@/doc/images/logo.jpg
27
OUTPUT_DIRECTORY       = @builddir@/user-refman.tmp
28
CREATE_SUBDIRS         = YES
29
30
31
OUTPUT_LANGUAGE        = English
BRIEF_MEMBER_DESC      = YES
REPEAT_BRIEF           = YES
32
ABBREVIATE_BRIEF       =
33
34
ALWAYS_DETAILED_SEC    = YES
INLINE_INHERITED_MEMB  = YES
35
FULL_PATH_NAMES        = NO
36
STRIP_FROM_PATH        = @top_srcdir@/milena
37
STRIP_FROM_INC_PATH    =
38
SHORT_NAMES            = YES
Guillaume Lazzara's avatar
Guillaume Lazzara committed
39
JAVADOC_AUTOBRIEF      = YES
40
41
42
43
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 8
44
ALIASES                =
45
46
47
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
BUILTIN_STL_SUPPORT    = YES
48
IDL_PROPERTY_SUPPORT   = NO
49
50
51
52
53
DISTRIBUTE_GROUP_DOC   = NO
SUBGROUPING            = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
54
55
56
57
EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO
EXTRACT_LOCAL_CLASSES  = NO
58
EXTRACT_LOCAL_METHODS  = NO
59
60
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
61
62
63
HIDE_FRIEND_COMPOUNDS  = YES
HIDE_IN_BODY_DOCS      = YES
INTERNAL_DOCS          = NO
64
65
66
67
68
CASE_SENSE_NAMES       = YES
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
69
70
SORT_BRIEF_DOCS        = YES
SORT_BY_SCOPE_NAME     = YES
71
GENERATE_TODOLIST      = NO
72
73
74
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
75
ENABLED_SECTIONS       =
76
MAX_INITIALIZER_LINES  = 30
77
78
79
80
SHOW_USED_FILES        = NO # Disabled for light doc
SHOW_DIRECTORIES       = NO # Disabled for light doc
SHOW_FILES	       = NO # Disabled for light doc
SHOW_NAMESPACES	       = YES
81
FILE_VERSION_FILTER    =
82
83
84
85
86
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET                  = YES
WARNINGS               = YES
87
WARN_IF_UNDOCUMENTED   = NO
88
89
90
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO
WARN_FORMAT            = "$file:$line: $text"
91
WARN_LOGFILE           =
92
93
94
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
95
INPUT                  = @top_srcdir@/milena
Guillaume Lazzara's avatar
Guillaume Lazzara committed
96
97
98
FILE_PATTERNS          = *.cc	\
                         *.hh	\
                         *.hxx	\
99
100
                         *.hcc	\
			 *.dox
101
RECURSIVE              = YES
Guillaume Lazzara's avatar
Guillaume Lazzara committed
102
EXCLUDE                = @top_srcdir@/milena/sandbox			\
103
                         @top_srcdir@/milena/trash			\
104
105
                         @top_srcdir@/milena/mln/core/concept/proxy.hxx \
                         @top_srcdir@/milena/doc/examples/trash		\
Guillaume Lazzara's avatar
Guillaume Lazzara committed
106
107
                         @top_srcdir@/milena/doc/user-refman 		\
                         @top_srcdir@/milena/doc/devel-refman		\
108
                         @top_srcdir@/milena/tests/unit_test
109
EXCLUDE_SYMLINKS       = YES
110
EXCLUDE_PATTERNS       = *spe.hh
111
EXCLUDE_SYMBOLS	       = *::internal* *_ mln::trait::*
Guillaume Lazzara's avatar
Guillaume Lazzara committed
112
EXAMPLE_PATH           = @top_srcdir@/milena/doc/examples	    \
113
114
115
			 @top_srcdir@/milena/doc/outputs	    \
			 @top_srcdir@/milena/doc/examples/split	    \
			 @top_srcdir@/milena/doc/outputs/split
116
EXAMPLE_PATTERNS       = *.cc \
117
118
		       	 *.cc.raw \
			 *.txt
119
EXAMPLE_RECURSIVE      = NO
Guillaume Lazzara's avatar
Guillaume Lazzara committed
120
IMAGE_PATH             = @top_srcdir@/milena/doc/img	       \
121
			 @top_srcdir@/milena/doc/figures
122
123
INPUT_FILTER           =
FILTER_PATTERNS        =
124
FILTER_SOURCE_FILES    = NO
125
INPUT_ENCODING         = ISO-8859-1
Guillaume Lazzara's avatar
Guillaume Lazzara committed
126
CITE_BIB_FILES 	       = @abs_top_srcdir@/doc/doc.bib
127
128
129
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
Guillaume Lazzara's avatar
Guillaume Lazzara committed
130
SOURCE_BROWSER         = YES
131
132
133
134
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
135
REFERENCES_LINK_SOURCE = NO
136
137
138
139
140
141
142
USE_HTAGS              = NO
VERBATIM_HEADERS       = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX     = YES
COLS_IN_ALPHA_INDEX    = 5
Guillaume Lazzara's avatar
Guillaume Lazzara committed
143
IGNORE_PREFIX          = mln::
144
145
146
147
148
149
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
150
151
152
HTML_HEADER            = @top_srcdir@/doc/header.html
HTML_FOOTER            = @top_srcdir@/doc/subdoc_footer.html
HTML_STYLESHEET        = @top_srcdir@/doc/doxygen.css
153
LAYOUT_FILE            = @top_srcdir@/milena/doc/DoxygenLayout.xml
154
155
HTML_ALIGN_MEMBERS     = YES
GENERATE_HTMLHELP      = NO
156
157
CHM_FILE               =
HHC_LOCATION           =
158
159
160
161
162
163
164
165
166
167
GENERATE_CHI           = NO
BINARY_TOC             = NO
TOC_EXPAND             = NO
DISABLE_INDEX          = NO
ENUM_VALUES_PER_LINE   = 4
GENERATE_TREEVIEW      = YES
TREEVIEW_WIDTH         = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
168
GENERATE_LATEX         = YES
169
170
171
172
173
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
COMPACT_LATEX          = NO
PAPER_TYPE             = a4wide
174
175
EXTRA_PACKAGES         =
LATEX_HEADER           =
176
177
178
179
180
181
182
183
184
185
186
PDF_HYPERLINKS         = YES
USE_PDFLATEX           = YES
LATEX_BATCHMODE        = YES
LATEX_HIDE_INDICES     = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF           = NO
RTF_OUTPUT             = rtf
COMPACT_RTF            = NO
RTF_HYPERLINKS         = NO
187
188
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
189
190
191
192
193
194
195
196
197
198
199
200
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN           = NO
MAN_OUTPUT             = man
MAN_EXTENSION          = .3
MAN_LINKS              = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML           = NO
XML_OUTPUT             = xml
201
202
XML_SCHEMA             =
XML_DTD                =
203
204
205
206
207
208
209
210
211
212
213
XML_PROGRAMLISTING     = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF   = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD       = NO
PERLMOD_LATEX          = NO
PERLMOD_PRETTY         = YES
214
PERLMOD_MAKEVAR_PREFIX =
215
#---------------------------------------------------------------------------
216
# Configuration options related to the preprocessor
217
218
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
Thierry Geraud's avatar
Thierry Geraud committed
219
220
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
221
SEARCH_INCLUDES        = YES
222
223
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  =
224
225
226
227
228
229
PREDEFINED             = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \
			 "for_all_2(x1, x2)=for(x1.start(), x2.start();	x1.is_valid(); x1.next(), x2.next())" \
			 "for_all_3(x1, x2, x3)=for(x1.start(), x2.start(), x3.start();	x1.is_valid(); x1.next(), x2.next(), x3.next())" \
			 "for_all_remaining(x)=if (! x.is_valid()) {} else while (x.next(), x.is_valid())" \
			 "mlc_unqualif(T)=typename mln::metal::unqualif<T>::ret" \
			 "mlc_equal(T1,T2)=mln::metal::equal<T1,T2>" \
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
                         "mln_piter(T)=typename T::piter" \
                         "mln_fwd_piter(T)=typename T::fwd_piter" \
                         "mln_bkd_piter(T)=typename T::bkd_piter" \
                         "mln_qiter(T)=typename T::qiter" \
                         "mln_fwd_qiter(T)=typename T::fwd_qiter" \
                         "mln_bkd_qiter(T)=typename T::bkd_qiter" \
                         "mln_niter(T)=typename T::niter" \
                         "mln_fwd_niter(T)=typename T::fwd_niter" \
                         "mln_bkd_niter(T)=typename T::bkd_niter" \
                         "mln_viter(T)=typename T::viter" \
                         "mln_fwd_viter(T)=typename T::fwd_viter" \
                         "mln_bkd_viter(T)=typename T::bkd_viter" \
                         "mln_result(T)=typename T::result" \
                         "mln_enc(T)=typename T::enc" \
                         "mln_value(T)=typename T::value" \
                         "mln_qlf_value(T)=typename T::qlf_value" \
Guillaume Lazzara's avatar
Guillaume Lazzara committed
246
                         "mln_domain(T)=typename T::domain_t" \
247
248
249
250
251
252
                         "mln_sum(T)=typename mln::value::props<T>::sum" \
                         "mln_vset(T)=typename T::vset" \
                         "mln_rvalue(T)=typename T::rvalue" \
                         "mln_lvalue(T)=typename T::lvalue" \
                         "mln_mesh(T)=typename T::mesh" \
                         "mln_coord(T)=typename T::coord" \
253
254
255
                         "mln_site(T)=typename T::site" \
                         "mln_psite(T)=typename T::psite" \
                         "mln_dpsite(T)=typename T::dpsite" \
256
257
                         "mln_accu_with(A, T)=typename A::template with< T >::ret" \
                         "mln_trait_op_div(L, R)=typename mln::trait::op::div< L , R >::ret" \
258
259
                         "mln_trait_op_less(L, R)=typename mln::trait::op::less< L , R >::ret" \
                         "mln_trait_op_minus(L, R)=typename mln::trait::op::minus< L , R >::ret" \
260
                         "mln_trait_op_mod(L, R)=typename mln::trait::op::mod< L , R >::ret" \
261
262
                         "mln_trait_op_plus(L, R)=typename mln::trait::op::plus< L , R >::ret" \
                         "mln_trait_op_times(L, R)=typename mln::trait::op::times< L , R >::ret" \
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
                         "mln_trait_op_uminus(T)=typename mln::trait::op::uminus< T >::ret" \
			 "mln_ch_value(I, V)=typename mln::trait::ch_value< I, V >::ret" \
			 "mlc_unqualif_(T)=mln::metal::unqualif<T>::ret" \
                         "mln_piter_(T)=T::piter" \
                         "mln_fwd_piter_(T)=T::fwd_piter" \
                         "mln_bkd_piter_(T)=T::bkd_piter" \
                         "mln_qiter_(T)=T::qiter" \
                         "mln_fwd_qiter_(T)=T::fwd_qiter" \
                         "mln_bkd_qiter_(T)=T::bkd_qiter" \
                         "mln_niter_(T)=T::niter" \
                         "mln_fwd_niter_(T)=T::fwd_niter" \
                         "mln_bkd_niter_(T)=T::bkd_niter" \
                         "mln_viter_(T)=T::viter" \
                         "mln_fwd_viter_(T)=T::fwd_viter" \
                         "mln_bkd_viter_(T)=T::bkd_viter" \
                         "mln_result_(T)=T::result" \
                         "mln_enc_(T)=T::enc" \
                         "mln_value_(T)=T::value" \
                         "mln_qlf_value_(T)=T::qlf_value" \
Guillaume Lazzara's avatar
Guillaume Lazzara committed
282
                         "mln_domain_(T)=T::domain_t" \
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
                         "mln_sum_(T)=mln::value::props<T>::sum" \
                         "mln_vset_(T)=T::vset" \
                         "mln_rvalue_(T)=T::rvalue" \
                         "mln_lvalue_(T)=T::lvalue" \
                         "mln_mesh_(T)=T::mesh" \
                         "mln_coord_(T)=T::coord" \
                         "mln_site_(T)=T::site" \
                         "mln_psite_(T)=T::psite" \
                         "mln_dpsite_(T)=T::dpsite" \
                         "mln_accu_with_(A, T)=A::template with< T >::ret" \
                         "mln_trait_op_plus_(L, R)=mln::trait::op::plus< L , R >::ret" \
                         "mln_trait_op_minus_(L, R)=mln::trait::op::minus< L , R >::ret" \
                         "mln_trait_op_times_(L, R)=mln::trait::op::times< L , R >::ret" \
                         "mln_trait_op_div_(L, R)=mln::trait::op::div< L , R >::ret" \
                         "mln_trait_op_mod_(L, R)=mln::trait::op::mod< L , R >::ret" \
                         "mln_trait_op_uminus_(T)=mln::trait::op::uminus< T >::ret" \
			 "mln_ch_value_(I, V)=typename mln::trait::ch_value< I, V >::ret" \
300
			 "mln_ch_value(I, V)_=mln::trait::ch_value< I, V >::ret" \
301
302
303
304
305
306
307
308
309
310
311
312
313
314
			 "mln_morpher_lvalue(I)=typename internal::morpher_lvalue_<I>::ret" \
			 "mln_concrete(I)=typename mln::trait::concrete< I >::ret" \
			 "mln_concrete_ch_value(I, V)=typename mln::trait::ch_value< typename mln::trait::concrete< I >::ret, V >::ret" \
			 "mlc_const(T)=typename mln::metal::const_< T >::ret" \
			 "mlc_const_return(T)=typename mln::metal::const_return_< T >::ret" \
			 "mln_element(T)=typename T::element" \
			 "mln_element_(T)=T::element" \
			 "mln_delta(T)=typename T::delta" \
			 "mln_delta_(T)=T::delta" \
			 "mln_dpoint(T)=typename T::dpoint" \
			 "mln_dpoint_(T)=T::dpoint" \
			 "mln_point(T)=typename T::point" \
			 "mln_point_(T)=T::point" \
			 "mln_gradient_component(I)=typename mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret" \
Guillaume Lazzara's avatar
Guillaume Lazzara committed
315
316
			 "mln_gradient(I)=mln::value::stack_image< I::point::dim, mln::trait::ch_value< I, mln::value::props< typename I::value >::sum >::ret >" \
			 "mln_trait_value_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \
Guillaume Lazzara's avatar
Guillaume Lazzara committed
317
			 "mln_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \
Guillaume Lazzara's avatar
Guillaume Lazzara committed
318
319
			 "mln_deduce(T, A1, A2)=typename T::A1::A2" \
			 "mln_graph_element(T)=typename T::graph_element" \
Guillaume Lazzara's avatar
Guillaume Lazzara committed
320
			 "mln_graph_element_(T)=T::graph_element" \
Guillaume Lazzara's avatar
Guillaume Lazzara committed
321
322
323
			 "mln_fun_vv2v(F, L, R)=mln::fun::vv2v::F< mln_value(L), mln_value(R) >" \
			 "mln_fun_vv2v_result(F, L, R)=typename mln_fun_vv2v(F, L, R)::result" \
			 "mln_ch_fun_vv2v(F, L, R)=typename mln::trait::ch_value< L, typename mln_fun_vv2v(F, L, R)::result >::ret"
324
325
326



327

328
EXPAND_AS_DEFINED      =
329
330
SKIP_FUNCTION_MACROS   = YES
#---------------------------------------------------------------------------
331
# Configuration::additions related to external references
332
#---------------------------------------------------------------------------
333
TAGFILES               =
334
GENERATE_TAGFILE       = milena.tag
335
336
337
338
ALLEXTERNALS           = NO
EXTERNAL_GROUPS        = YES
PERL_PATH              = /usr/bin/perl
#---------------------------------------------------------------------------
339
# Configuration options related to the dot tool
340
#---------------------------------------------------------------------------
341
342
CLASS_DIAGRAMS         = NO
HIDE_UNDOC_RELATIONS   = NO
343
HAVE_DOT               = YES
344
CLASS_GRAPH            = NO
345
346
COLLABORATION_GRAPH    = NO # Disabled for light doc
GROUP_GRAPHS           = NO # Disabled for light doc
347
UML_LOOK               = NO
348
TEMPLATE_RELATIONS     = NO
349
350
INCLUDE_GRAPH          = NO # Disabled for light doc
INCLUDED_BY_GRAPH      = NO # Disabled for light doc
351
352
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
353
GRAPHICAL_HIERARCHY    = NO
354
DIRECTORY_GRAPH        = NO # Disabled for light doc
355
DOT_IMAGE_FORMAT       = png
356
357
DOT_PATH               =
DOTFILE_DIRS           =
358
MAX_DOT_GRAPH_DEPTH    = 1000
359
360
DOT_TRANSPARENT        = NO
DOT_MULTI_TARGETS      = NO
361
GENERATE_LEGEND        = NO # Disabled for light doc
362
363
DOT_CLEANUP            = YES
#---------------------------------------------------------------------------
364
# Configuration::additions related to the search engine
365
#---------------------------------------------------------------------------
366
SEARCHENGINE           = YES
367
368
369
370
371
372
373
374
375
#---------------------------------------------------------------------------
# Configuration::additions related to the Qt help engine
#---------------------------------------------------------------------------
GENERATE_QHP       = yes
QHP_NAMESPACE      = "fr.epita.lrde.olena.scribo"
QHP_VIRTUAL_FOLDER = "scribo-2.0"
QCH_FILE 	   = "@builddir@/scribo.qch"
QHG_LOCATION       = "qhelpgenerator"

376
377
378
379

# Local Variables:
# mode: Makefile
# End: