Merge remote-tracking branch 'upstream/3.4' into merge-3.4
[platform/upstream/opencv.git] / doc / Doxyfile.in
1 DOXYFILE_ENCODING      = UTF-8
2 PROJECT_NAME           = OpenCV
3 PROJECT_NUMBER         = @OPENCV_VERSION@
4 PROJECT_BRIEF          = "Open Source Computer Vision"
5 PROJECT_LOGO           = @CMAKE_CURRENT_SOURCE_DIR@/opencv-logo-small.png
6 OUTPUT_DIRECTORY       = @CMAKE_DOXYGEN_OUTPUT_PATH@
7 CREATE_SUBDIRS         = YES
8 OUTPUT_LANGUAGE        = English
9 BRIEF_MEMBER_DESC      = YES
10 REPEAT_BRIEF           = YES
11 ABBREVIATE_BRIEF       = "The $name class" \
12                          "The $name widget" \
13                          "The $name file" \
14                          is \
15                          provides \
16                          specifies \
17                          contains \
18                          represents \
19                          a \
20                          an \
21                          the
22 ALWAYS_DETAILED_SEC    = NO
23 INLINE_INHERITED_MEMB  = NO
24 FULL_PATH_NAMES        = YES
25 STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@/modules @CMAKE_DOXYGEN_INCLUDE_ROOTS@
26 STRIP_FROM_INC_PATH    = @CMAKE_DOXYGEN_INCLUDE_ROOTS@
27 SHORT_NAMES            = NO
28 JAVADOC_AUTOBRIEF      = NO
29 QT_AUTOBRIEF           = NO
30 MULTILINE_CPP_IS_BRIEF = NO
31 INHERIT_DOCS           = YES
32 SEPARATE_MEMBER_PAGES  = NO
33 TAB_SIZE               = 4
34 ALIASES               += add_toggle{1}="@htmlonly[block] <div class='newInnerHTML'>\1</div><div> <script type="text/javascript"> addToggle(); </script>@endhtmlonly"
35 ALIASES               += add_toggle_cpp="@htmlonly[block] <div class='newInnerHTML' title='cpp' style='display: none;'>C++</div><div class='toggleable_div label_cpp' style='display: none;'>@endhtmlonly"
36 ALIASES               += add_toggle_java="@htmlonly[block] <div class='newInnerHTML' title='java' style='display: none;'>Java</div><div class='toggleable_div label_java' style='display: none;'>@endhtmlonly"
37 ALIASES               += add_toggle_python="@htmlonly[block] <div class='newInnerHTML' title='python' style='display: none;'>Python</div><div class='toggleable_div label_python' style='display: none;'>@endhtmlonly"
38 ALIASES               += end_toggle="@htmlonly[block] </div> @endhtmlonly"
39 ALIASES               += prev_tutorial{1}="**Prev  Tutorial:** \ref \1 \n"
40 ALIASES               += next_tutorial{1}="**Next  Tutorial:** \ref \1 \n"
41 ALIASES               += youtube{1}="@htmlonly[block]<div align='center'><iframe title='Video' width='560' height='349' src='https://www.youtube.com/embed/\1?rel=0' frameborder='0' align='middle' allowfullscreen></iframe></div>@endhtmlonly"
42 TCL_SUBST              =
43 OPTIMIZE_OUTPUT_FOR_C  = NO
44 OPTIMIZE_OUTPUT_JAVA   = NO
45 OPTIMIZE_FOR_FORTRAN   = NO
46 OPTIMIZE_OUTPUT_VHDL   = NO
47 EXTENSION_MAPPING      =
48 MARKDOWN_SUPPORT       = YES
49 AUTOLINK_SUPPORT       = YES
50 BUILTIN_STL_SUPPORT    = YES
51 CPP_CLI_SUPPORT        = NO
52 SIP_SUPPORT            = NO
53 IDL_PROPERTY_SUPPORT   = YES
54 DISTRIBUTE_GROUP_DOC   = NO
55 SUBGROUPING            = YES
56 INLINE_GROUPED_CLASSES = NO
57 INLINE_SIMPLE_STRUCTS  = NO
58 TYPEDEF_HIDES_STRUCT   = YES
59 LOOKUP_CACHE_SIZE      = 0
60 EXTRACT_ALL            = YES
61 EXTRACT_PRIVATE        = NO
62 EXTRACT_PACKAGE        = NO
63 EXTRACT_STATIC         = YES
64 EXTRACT_LOCAL_CLASSES  = NO
65 EXTRACT_LOCAL_METHODS  = NO
66 EXTRACT_ANON_NSPACES   = NO
67 HIDE_UNDOC_MEMBERS     = NO
68 HIDE_UNDOC_CLASSES     = NO
69 HIDE_FRIEND_COMPOUNDS  = NO
70 HIDE_IN_BODY_DOCS      = NO
71 INTERNAL_DOCS          = NO
72 CASE_SENSE_NAMES       = YES
73 HIDE_SCOPE_NAMES       = NO
74 SHOW_INCLUDE_FILES     = YES
75 SHOW_GROUPED_MEMB_INC  = YES
76 FORCE_LOCAL_INCLUDES   = NO
77 INLINE_INFO            = YES
78 SORT_MEMBER_DOCS       = YES
79 SORT_BRIEF_DOCS        = YES
80 SORT_MEMBERS_CTORS_1ST = YES
81 SORT_GROUP_NAMES       = NO
82 SORT_BY_SCOPE_NAME     = NO
83 STRICT_PROTO_MATCHING  = NO
84 GENERATE_TODOLIST      = YES
85 GENERATE_TESTLIST      = YES
86 GENERATE_BUGLIST       = YES
87 GENERATE_DEPRECATEDLIST= YES
88 ENABLED_SECTIONS       = @CMAKE_DOXYGEN_ENABLED_SECTIONS@
89 MAX_INITIALIZER_LINES  = 30
90 SHOW_USED_FILES        = YES
91 SHOW_FILES             = YES
92 SHOW_NAMESPACES        = YES
93 FILE_VERSION_FILTER    =
94 LAYOUT_FILE            = @CMAKE_DOXYGEN_LAYOUT@
95 CITE_BIB_FILES         = @CMAKE_EXTRA_BIB_FILES@
96 QUIET                  = YES
97 WARNINGS               = YES
98 WARN_IF_UNDOCUMENTED   = YES
99 WARN_IF_DOC_ERROR      = YES
100 WARN_NO_PARAMDOC       = NO
101 WARN_FORMAT            = "$file:$line: $text"
102 WARN_LOGFILE           =
103 INPUT                  = @CMAKE_DOXYGEN_INPUT_LIST@
104 INPUT_ENCODING         = UTF-8
105 FILE_PATTERNS          =
106 RECURSIVE              = YES
107 EXCLUDE                = @CMAKE_DOXYGEN_EXCLUDE_LIST@
108 EXCLUDE_SYMLINKS       = NO
109 EXCLUDE_PATTERNS       = *.inl.hpp *.impl.hpp *_detail.hpp */cudev/**/detail/*.hpp *.m */opencl/runtime/* */legacy/* *_c.h @DOXYGEN_EXCLUDE_PATTERNS@
110 EXCLUDE_SYMBOLS        = cv::DataType<*> cv::traits::* int void CV__* T __CV*
111 EXAMPLE_PATH           = @CMAKE_DOXYGEN_EXAMPLE_PATH@
112 EXAMPLE_PATTERNS       = *
113 EXAMPLE_RECURSIVE      = YES
114 IMAGE_PATH             = @CMAKE_DOXYGEN_IMAGE_PATH@
115 INPUT_FILTER           =
116 FILTER_PATTERNS        =
117 FILTER_SOURCE_FILES    = NO
118 FILTER_SOURCE_PATTERNS =
119 USE_MDFILE_AS_MAINPAGE =
120 SOURCE_BROWSER         = NO
121 INLINE_SOURCES         = NO
122 STRIP_CODE_COMMENTS    = YES
123 REFERENCED_BY_RELATION = NO
124 REFERENCES_RELATION    = NO
125 REFERENCES_LINK_SOURCE = YES
126 SOURCE_TOOLTIPS        = YES
127 USE_HTAGS              = NO
128 VERBATIM_HEADERS       = NO
129 ALPHABETICAL_INDEX     = YES
130 COLS_IN_ALPHA_INDEX    = 5
131 IGNORE_PREFIX          =
132 GENERATE_HTML          = YES
133 HTML_OUTPUT            = html
134 HTML_FILE_EXTENSION    = .html
135 HTML_HEADER            = @CMAKE_CURRENT_SOURCE_DIR@/header.html
136 HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/footer.html
137 HTML_STYLESHEET        =
138 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/stylesheet.css
139 HTML_EXTRA_FILES       = @CMAKE_DOXYGEN_HTML_FILES@
140 HTML_COLORSTYLE_HUE    = 220
141 HTML_COLORSTYLE_SAT    = 100
142 HTML_COLORSTYLE_GAMMA  = 80
143 HTML_TIMESTAMP         = YES
144 HTML_DYNAMIC_SECTIONS  = NO
145 HTML_INDEX_NUM_ENTRIES = 100
146 GENERATE_DOCSET        = NO
147 DOCSET_FEEDNAME        = "Doxygen generated docs"
148 DOCSET_BUNDLE_ID       = org.doxygen.Project
149 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
150 DOCSET_PUBLISHER_NAME  = Publisher
151 GENERATE_HTMLHELP      = NO
152 CHM_FILE               =
153 HHC_LOCATION           =
154 GENERATE_CHI           = NO
155 CHM_INDEX_ENCODING     =
156 BINARY_TOC             = NO
157 TOC_EXPAND             = NO
158 GENERATE_QHP           = @CMAKE_DOXYGEN_GENERATE_QHP@
159 QCH_FILE               = ../opencv-@OPENCV_VERSION@.qch
160 QHP_NAMESPACE          = org.opencv.@OPENCV_VERSION@
161 QHP_VIRTUAL_FOLDER     = opencv
162 QHP_CUST_FILTER_NAME   =
163 QHP_CUST_FILTER_ATTRS  =
164 QHP_SECT_FILTER_ATTRS  =
165 QHG_LOCATION           =
166 GENERATE_ECLIPSEHELP   = NO
167 ECLIPSE_DOC_ID         = org.doxygen.Project
168 DISABLE_INDEX          = NO
169 GENERATE_TREEVIEW      = NO
170 ENUM_VALUES_PER_LINE   = 1
171 TREEVIEW_WIDTH         = 250
172 EXT_LINKS_IN_WINDOW    = YES
173 FORMULA_FONTSIZE       = 14
174 FORMULA_TRANSPARENT    = YES
175 USE_MATHJAX            = YES
176 MATHJAX_FORMAT         = HTML-CSS
177 MATHJAX_RELPATH        = @OPENCV_MATHJAX_RELPATH@
178 MATHJAX_EXTENSIONS     = TeX/AMSmath TeX/AMSsymbols
179 MATHJAX_CODEFILE       = @CMAKE_CURRENT_SOURCE_DIR@/mymath.js
180 SEARCHENGINE           = YES
181 SERVER_BASED_SEARCH    = NO
182 EXTERNAL_SEARCH        = NO
183 SEARCHENGINE_URL       =
184 SEARCHDATA_FILE        = searchdata.xml
185 EXTERNAL_SEARCH_ID     =
186 EXTRA_SEARCH_MAPPINGS  =
187 GENERATE_LATEX         = NO
188 LATEX_OUTPUT           = latex
189 LATEX_CMD_NAME         = latex
190 MAKEINDEX_CMD_NAME     = makeindex
191 COMPACT_LATEX          = NO
192 PAPER_TYPE             = a4
193 EXTRA_PACKAGES         = mymath
194 LATEX_HEADER           =
195 LATEX_FOOTER           =
196 LATEX_EXTRA_FILES      =
197 PDF_HYPERLINKS         = YES
198 USE_PDFLATEX           = YES
199 LATEX_BATCHMODE        = NO
200 LATEX_HIDE_INDICES     = NO
201 LATEX_SOURCE_CODE      = NO
202 LATEX_BIB_STYLE        = plain
203 GENERATE_RTF           = NO
204 RTF_OUTPUT             = rtf
205 COMPACT_RTF            = NO
206 RTF_HYPERLINKS         = NO
207 RTF_STYLESHEET_FILE    =
208 RTF_EXTENSIONS_FILE    =
209 GENERATE_MAN           = NO
210 MAN_OUTPUT             = man
211 MAN_EXTENSION          = .3
212 MAN_LINKS              = NO
213 GENERATE_XML           = NO
214 XML_OUTPUT             = xml
215 XML_PROGRAMLISTING     = YES
216 GENERATE_DOCBOOK       = NO
217 DOCBOOK_OUTPUT         = docbook
218 GENERATE_AUTOGEN_DEF   = NO
219 GENERATE_PERLMOD       = NO
220 PERLMOD_LATEX          = NO
221 PERLMOD_PRETTY         = YES
222 PERLMOD_MAKEVAR_PREFIX =
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             = __cplusplus=1 \
230                          CVAPI(x)=x \
231                          CV_DOXYGEN= \
232                          CV_EXPORTS= \
233                          CV_EXPORTS_W= \
234                          CV_EXPORTS_W_SIMPLE= \
235                          CV_EXPORTS_AS(x)= \
236                          CV_EXPORTS_W_MAP= \
237                          GAPI_EXPORTS= \
238                          GAPI_EXPORTS_W= \
239                          CV_IN_OUT= \
240                          CV_OUT= \
241                          CV_PROP= \
242                          CV_PROP_RW= \
243                          CV_WRAP= \
244                          CV_WRAP_AS(x)= \
245                          CV_WRAP_MAPPABLE(x)= \
246                          CV_WRAP_PHANTOM(x)= \
247                          CV_WRAP_DEFAULT(x)= \
248                          CV_CDECL= \
249                          CV_Func = \
250                          CV_DO_PRAGMA(x)= \
251                          CV_SUPPRESS_DEPRECATED_START= \
252                          CV_SUPPRESS_DEPRECATED_END= \
253                          CV_INLINE= \
254                          CV_NORETURN= \
255                          CV_DEFAULT(x)=" = x" \
256                          CV_NEON=1 \
257                          CV_SSE2=1 \
258                          CV__DEBUG_NS_BEGIN= \
259                          CV__DEBUG_NS_END= \
260                          CV_DEPRECATED_EXTERNAL= \
261                          CV_DEPRECATED=
262 EXPAND_AS_DEFINED      =
263 SKIP_FUNCTION_MACROS   = YES
264 TAGFILES               =
265 GENERATE_TAGFILE       = @CMAKE_DOXYGEN_OUTPUT_PATH@/html/opencv.tag
266 ALLEXTERNALS           = NO
267 EXTERNAL_GROUPS        = YES
268 EXTERNAL_PAGES         = YES
269 CLASS_DIAGRAMS         = YES
270 DIA_PATH               =
271 HIDE_UNDOC_RELATIONS   = NO
272 HAVE_DOT               = @CMAKECONFIG_HAVE_DOT@
273 DOT_NUM_THREADS        = 0
274 DOT_FONTNAME           = Helvetica
275 DOT_FONTSIZE           = 10
276 DOT_FONTPATH           =
277 CLASS_GRAPH            = YES
278 COLLABORATION_GRAPH    = YES
279 GROUP_GRAPHS           = YES
280 UML_LOOK               = YES
281 UML_LIMIT_NUM_FIELDS   = 10
282 TEMPLATE_RELATIONS     = YES
283 INCLUDE_GRAPH          = YES
284 INCLUDED_BY_GRAPH      = YES
285 CALL_GRAPH             = YES
286 CALLER_GRAPH           = NO
287 GRAPHICAL_HIERARCHY    = YES
288 DIRECTORY_GRAPH        = YES
289 DOT_IMAGE_FORMAT       = @CMAKECONFIG_DOT_IMAGE_FORMAT@
290 INTERACTIVE_SVG        = @CMAKECONFIG_INTERACTIVE_SVG@
291 DOT_PATH               = @CMAKECONFIG_DOT_PATH@
292 DOTFILE_DIRS           =
293 MSCFILE_DIRS           =
294 DIAFILE_DIRS           =
295 DOT_GRAPH_MAX_NODES    = 50
296 MAX_DOT_GRAPH_DEPTH    = 0
297 DOT_TRANSPARENT        = NO
298 DOT_MULTI_TARGETS      = NO
299 GENERATE_LEGEND        = YES
300 DOT_CLEANUP            = YES