Doxyfile.in 17.3 KB
Newer Older
1
2
# Copyright (C) 2011, 2012, 2013 EPITA Research and Development
# Laboratory (LRDE)
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#
# 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/>.
#
# Doxyfile 1.5.1

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
PROJECT_NAME           = "Scribo"
PROJECT_NUMBER         = "User documentation @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
28
29
OUTPUT_DIRECTORY       = @builddir@/user-refman.tmp
CREATE_SUBDIRS         = YES
OUTPUT_LANGUAGE        = English
30
BRIEF_MEMBER_DESC      = NO
31
32
33
34
REPEAT_BRIEF           = YES
ABBREVIATE_BRIEF       =
ALWAYS_DETAILED_SEC    = YES
INLINE_INHERITED_MEMB  = YES
35
FULL_PATH_NAMES        = YES
36
STRIP_FROM_PATH        =
37
STRIP_FROM_INC_PATH    = @top_srcdir@/scribo
38
SHORT_NAMES            = NO
39
40
41
42
43
44
45
46
47
48
JAVADOC_AUTOBRIEF      = YES
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS           = YES
SEPARATE_MEMBER_PAGES  = NO
TAB_SIZE               = 8
ALIASES                =
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
BUILTIN_STL_SUPPORT    = YES
IDL_PROPERTY_SUPPORT   = NO
49
DISTRIBUTE_GROUP_DOC   = YES
50
SUBGROUPING            = YES
51
52
INLINE_GROUPED_CLASSES = NO
SORT_GROUP_NAMES       = YES
53
TYPEDEF_HIDES_STRUCT   = YES
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO
EXTRACT_LOCAL_CLASSES  = NO
EXTRACT_LOCAL_METHODS  = NO
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = YES
HIDE_IN_BODY_DOCS      = YES
INTERNAL_DOCS          = NO
CASE_SENSE_NAMES       = YES
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = YES
SORT_BY_SCOPE_NAME     = YES
74
SORT_MEMBERS_CTORS_1ST = YES
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
GENERATE_TODOLIST      = NO
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS       =
MAX_INITIALIZER_LINES  = 30
SHOW_USED_FILES        = NO # Disabled for light doc
SHOW_FILES	       = NO # Disabled for light doc
SHOW_NAMESPACES	       = YES
FILE_VERSION_FILTER    =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET                  = YES
WARNINGS               = YES
90
WARN_IF_UNDOCUMENTED   = NO
91
92
93
94
95
96
97
98
99
100
101
WARN_IF_DOC_ERROR      = YES
WARN_NO_PARAMDOC       = NO
WARN_FORMAT            = "$file:$line: $text"
WARN_LOGFILE           =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT                  = @top_srcdir@/scribo
FILE_PATTERNS          = *.cc	\
                         *.hh	\
                         *.hxx	\
102
103
                         *.hcc	\
			 *.dox
104
105
106
107
108
RECURSIVE              = YES
EXCLUDE                = @top_srcdir@/scribo/demo			\
                         @top_srcdir@/scribo/sandbox 			\
                         @top_srcdir@/scribo/doc/user-refman 		\
                         @top_srcdir@/scribo/doc/devel-refman		\
109
110
                         @top_srcdir@/scribo/tests/unit_test		\
                         @top_srcdir@/scribo/+*
111
EXCLUDE_SYMLINKS       = YES
112
EXCLUDE_PATTERNS       = *.spe.hh *.moc.cc
113
114
EXCLUDE_SYMBOLS	       = mln::trait::* \
			 scribo::*::internal::*_data
115
116
117
EXAMPLE_PATH           = @top_srcdir@/scribo/doc/examples	    \
			 @top_srcdir@/scribo/doc/outputs	    \
			 @top_srcdir@/scribo/doc/examples/split	    \
118
119
			 @top_srcdir@/scribo/doc/outputs/split	    \
			 @top_srcdir@/scribo/src
120
121
122
123
EXAMPLE_PATTERNS       = *.cc \
		       	 *.cc.raw \
			 *.txt
EXAMPLE_RECURSIVE      = NO
124
IMAGE_PATH             = @top_srcdir@/scribo/doc/images	       \
125
126
127
128
129
			 @top_srcdir@/scribo/doc/figures
INPUT_FILTER           =
FILTER_PATTERNS        =
FILTER_SOURCE_FILES    = NO
INPUT_ENCODING         = ISO-8859-1
130
131
CITE_BIB_FILES 	       = @abs_top_srcdir@/doc/doc.bib \
		       	 @abs_top_srcdir@/doc/olena.bib
132
LATEX_BIB_STYLE	       = plain
133
134
135
136
137
138
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER         = YES
INLINE_SOURCES         = NO
STRIP_CODE_COMMENTS    = YES
139
140
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION    = NO
141
142
143
144
145
146
147
148
REFERENCES_LINK_SOURCE = NO
USE_HTAGS              = NO
VERBATIM_HEADERS       = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX     = YES
COLS_IN_ALPHA_INDEX    = 5
149
IGNORE_PREFIX          = scribo::
150
151
152
153
154
155
156
157
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
HTML_HEADER            = @top_srcdir@/doc/header.html
HTML_FOOTER            = @top_srcdir@/doc/subdoc_footer.html
158
159
HTML_STYLESHEET        =
HTML_EXTRA_STYLESHEET  = @top_srcdir@/doc/doc.css
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
LAYOUT_FILE            = @top_srcdir@/scribo/doc/DoxygenLayout.xml
GENERATE_HTMLHELP      = NO
CHM_FILE               =
HHC_LOCATION           =
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
#---------------------------------------------------------------------------
GENERATE_LATEX         = YES
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = latex
MAKEINDEX_CMD_NAME     = makeindex
COMPACT_LATEX          = NO
PAPER_TYPE             = a4wide
EXTRA_PACKAGES         =
LATEX_HEADER           =
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
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
#---------------------------------------------------------------------------
# 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
XML_SCHEMA             =
XML_DTD                =
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
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
SEARCH_INCLUDES        = YES
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  =
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>" \
                         "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" \
                         "mln_domain(T)=typename T::domain_t" \
                         "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" \
                         "mln_site(T)=typename T::site" \
                         "mln_psite(T)=typename T::psite" \
                         "mln_dpsite(T)=typename T::dpsite" \
                         "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" \
                         "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" \
                         "mln_trait_op_mod(L, R)=typename mln::trait::op::mod< L , R >::ret" \
                         "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" \
                         "mln_trait_op_uminus(T)=typename mln::trait::op::uminus< T >::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" \
                         "mln_domain_(T)=T::domain_t" \
                         "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" \
304
305
			 "mln_ch_value_(I, V)=mln::trait::ch_value< I, V >::ret" \
			 "mln_ch_value(I, V)=typename mln::trait::ch_value< I, V >::ret" \
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
			 "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" \
			 "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" \
			 "mln_sum_product(T, U)=typename mln::trait::value_< mln_trait_op_times(T,U) >::sum" \
			 "mln_deduce(T, A1, A2)=typename T::A1::A2" \
			 "mln_graph_element(T)=typename T::graph_element" \
			 "mln_graph_element_(T)=T::graph_element" \
			 "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"




EXPAND_AS_DEFINED      =
SKIP_FUNCTION_MACROS   = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
338
TAGFILES               = @builddir@/../../milena/doc/milena.tag=../../../../milena/doc/user-refman/html
339
340
GENERATE_TAGFILE       = scribo.tag
ALLEXTERNALS           = NO
341
EXTERNAL_GROUPS        = NO
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
PERL_PATH              = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS         = NO
HIDE_UNDOC_RELATIONS   = YES
HAVE_DOT               = YES
CLASS_GRAPH            = NO
COLLABORATION_GRAPH    = NO # Disabled for light doc
GROUP_GRAPHS           = NO # Disabled for light doc
UML_LOOK               = NO
TEMPLATE_RELATIONS     = NO
INCLUDE_GRAPH          = NO # Disabled for light doc
INCLUDED_BY_GRAPH      = NO # Disabled for light doc
CALL_GRAPH             = NO
CALLER_GRAPH           = NO
GRAPHICAL_HIERARCHY    = NO
DIRECTORY_GRAPH        = NO # Disabled for light doc
DOT_IMAGE_FORMAT       = png
DOT_PATH               =
DOTFILE_DIRS           =
MAX_DOT_GRAPH_DEPTH    = 1000
DOT_TRANSPARENT        = NO
DOT_MULTI_TARGETS      = NO
GENERATE_LEGEND        = NO # Disabled for light doc
DOT_CLEANUP            = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE           = YES

GENERATE_QHP       = yes
QHP_NAMESPACE      = "fr.epita.lrde.olena.scribo"
QHP_VIRTUAL_FOLDER = "scribo-2.0"
QCH_FILE 	   = "@builddir@/scribo.qch"
QHG_LOCATION       = "qhelpgenerator"


# Local Variables:
# mode: Makefile
# End: