Doxyfile.in 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  1. # Doxyfile 1.12.0
  2. #---------------------------------------------------------------------------
  3. # Project related configuration options
  4. #---------------------------------------------------------------------------
  5. DOXYFILE_ENCODING = UTF-8
  6. PROJECT_NAME = OpenCV
  7. PROJECT_NUMBER = @OPENCV_VERSION@
  8. PROJECT_BRIEF = "Open Source Computer Vision"
  9. PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/opencv-logo-small.png
  10. PROJECT_ICON = @CMAKE_CURRENT_SOURCE_DIR@/opencv.ico
  11. OUTPUT_DIRECTORY = @CMAKE_DOXYGEN_OUTPUT_PATH@
  12. CREATE_SUBDIRS = YES
  13. CREATE_SUBDIRS_LEVEL = 8
  14. ALLOW_UNICODE_NAMES = NO
  15. OUTPUT_LANGUAGE = English
  16. BRIEF_MEMBER_DESC = YES
  17. REPEAT_BRIEF = YES
  18. ABBREVIATE_BRIEF = "The $name class" \
  19. "The $name widget" \
  20. "The $name file" \
  21. is \
  22. provides \
  23. specifies \
  24. contains \
  25. represents \
  26. a \
  27. an \
  28. the
  29. ALWAYS_DETAILED_SEC = NO
  30. INLINE_INHERITED_MEMB = NO
  31. FULL_PATH_NAMES = YES
  32. STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/modules \
  33. @CMAKE_DOXYGEN_INCLUDE_ROOTS@
  34. STRIP_FROM_INC_PATH = @CMAKE_DOXYGEN_INCLUDE_ROOTS@
  35. SHORT_NAMES = NO
  36. JAVADOC_AUTOBRIEF = NO
  37. JAVADOC_BANNER = NO
  38. QT_AUTOBRIEF = NO
  39. MULTILINE_CPP_IS_BRIEF = NO
  40. PYTHON_DOCSTRING = YES
  41. INHERIT_DOCS = YES
  42. SEPARATE_MEMBER_PAGES = NO
  43. TAB_SIZE = 4
  44. ALIASES += add_toggle{1}="@htmlonly[block] <div class='newInnerHTML'>\1</div><div> <script type='text/javascript'> addToggle(); </script>@endhtmlonly"
  45. 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"
  46. 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"
  47. 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"
  48. ALIASES += end_toggle="@htmlonly[block] </div> @endhtmlonly"
  49. ALIASES += prev_tutorial{1}="**Prev Tutorial:** \ref \1 \n"
  50. ALIASES += next_tutorial{1}="**Next Tutorial:** \ref \1 \n"
  51. 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"
  52. OPTIMIZE_OUTPUT_FOR_C = NO
  53. OPTIMIZE_OUTPUT_JAVA = NO
  54. OPTIMIZE_FOR_FORTRAN = NO
  55. OPTIMIZE_OUTPUT_VHDL = NO
  56. OPTIMIZE_OUTPUT_SLICE = NO
  57. EXTENSION_MAPPING =
  58. MARKDOWN_SUPPORT = YES
  59. TOC_INCLUDE_HEADINGS = 5
  60. MARKDOWN_ID_STYLE = DOXYGEN
  61. AUTOLINK_SUPPORT = YES
  62. BUILTIN_STL_SUPPORT = YES
  63. CPP_CLI_SUPPORT = NO
  64. SIP_SUPPORT = NO
  65. IDL_PROPERTY_SUPPORT = YES
  66. DISTRIBUTE_GROUP_DOC = NO
  67. GROUP_NESTED_COMPOUNDS = NO
  68. SUBGROUPING = YES
  69. INLINE_GROUPED_CLASSES = NO
  70. INLINE_SIMPLE_STRUCTS = NO
  71. TYPEDEF_HIDES_STRUCT = YES
  72. LOOKUP_CACHE_SIZE = 0
  73. NUM_PROC_THREADS = 1
  74. TIMESTAMP = YES
  75. #---------------------------------------------------------------------------
  76. # Build related configuration options
  77. #---------------------------------------------------------------------------
  78. EXTRACT_ALL = YES
  79. EXTRACT_PRIVATE = NO
  80. EXTRACT_PRIV_VIRTUAL = NO
  81. EXTRACT_PACKAGE = NO
  82. EXTRACT_STATIC = YES
  83. EXTRACT_LOCAL_CLASSES = NO
  84. EXTRACT_LOCAL_METHODS = NO
  85. EXTRACT_ANON_NSPACES = NO
  86. RESOLVE_UNNAMED_PARAMS = YES
  87. HIDE_UNDOC_MEMBERS = NO
  88. HIDE_UNDOC_CLASSES = NO
  89. HIDE_FRIEND_COMPOUNDS = NO
  90. HIDE_IN_BODY_DOCS = NO
  91. INTERNAL_DOCS = NO
  92. CASE_SENSE_NAMES = YES
  93. HIDE_SCOPE_NAMES = NO
  94. HIDE_COMPOUND_REFERENCE= NO
  95. SHOW_HEADERFILE = YES
  96. SHOW_INCLUDE_FILES = YES
  97. SHOW_GROUPED_MEMB_INC = YES
  98. FORCE_LOCAL_INCLUDES = NO
  99. INLINE_INFO = YES
  100. SORT_MEMBER_DOCS = YES
  101. SORT_BRIEF_DOCS = YES
  102. SORT_MEMBERS_CTORS_1ST = YES
  103. SORT_GROUP_NAMES = NO
  104. SORT_BY_SCOPE_NAME = NO
  105. STRICT_PROTO_MATCHING = NO
  106. GENERATE_TODOLIST = YES
  107. GENERATE_TESTLIST = YES
  108. GENERATE_BUGLIST = YES
  109. GENERATE_DEPRECATEDLIST= YES
  110. ENABLED_SECTIONS = @CMAKE_DOXYGEN_ENABLED_SECTIONS@
  111. MAX_INITIALIZER_LINES = 30
  112. SHOW_USED_FILES = YES
  113. SHOW_FILES = YES
  114. SHOW_NAMESPACES = YES
  115. FILE_VERSION_FILTER =
  116. LAYOUT_FILE = @CMAKE_DOXYGEN_LAYOUT@
  117. CITE_BIB_FILES = @CMAKE_EXTRA_BIB_FILES@
  118. EXTERNAL_TOOL_PATH =
  119. #---------------------------------------------------------------------------
  120. # Configuration options related to warning and progress messages
  121. #---------------------------------------------------------------------------
  122. QUIET = YES
  123. WARNINGS = YES
  124. WARN_IF_UNDOCUMENTED = YES
  125. WARN_IF_DOC_ERROR = YES
  126. WARN_IF_INCOMPLETE_DOC = YES
  127. WARN_NO_PARAMDOC = NO
  128. WARN_IF_UNDOC_ENUM_VAL = NO
  129. WARN_AS_ERROR = NO
  130. WARN_FORMAT = "$file:$line: $text"
  131. WARN_LINE_FORMAT = "at line $line of file $file"
  132. WARN_LOGFILE =
  133. #---------------------------------------------------------------------------
  134. # Configuration options related to the input files
  135. #---------------------------------------------------------------------------
  136. INPUT = @CMAKE_DOXYGEN_INPUT_LIST@
  137. INPUT_ENCODING = UTF-8
  138. INPUT_FILE_ENCODING =
  139. FILE_PATTERNS =
  140. RECURSIVE = YES
  141. EXCLUDE = @CMAKE_DOXYGEN_EXCLUDE_LIST@
  142. EXCLUDE_SYMLINKS = NO
  143. EXCLUDE_PATTERNS = *.inl.hpp *.impl.hpp *_detail.hpp */cudev/**/detail/*.hpp *.m */opencl/runtime/* */legacy/* *_c.h @DOXYGEN_EXCLUDE_PATTERNS@
  144. EXCLUDE_SYMBOLS = cv::DataType<*> cv::traits::* int void CV__* T __CV* cv::gapi::detail*
  145. EXAMPLE_PATH = @CMAKE_DOXYGEN_EXAMPLE_PATH@
  146. EXAMPLE_PATTERNS = *
  147. EXAMPLE_RECURSIVE = YES
  148. IMAGE_PATH = @CMAKE_DOXYGEN_IMAGE_PATH@
  149. INPUT_FILTER =
  150. FILTER_PATTERNS =
  151. FILTER_SOURCE_FILES = NO
  152. FILTER_SOURCE_PATTERNS =
  153. USE_MDFILE_AS_MAINPAGE =
  154. FORTRAN_COMMENT_AFTER = 72
  155. #---------------------------------------------------------------------------
  156. # Configuration options related to source browsing
  157. #---------------------------------------------------------------------------
  158. SOURCE_BROWSER = NO
  159. INLINE_SOURCES = NO
  160. STRIP_CODE_COMMENTS = YES
  161. REFERENCED_BY_RELATION = NO
  162. REFERENCES_RELATION = NO
  163. REFERENCES_LINK_SOURCE = YES
  164. SOURCE_TOOLTIPS = YES
  165. USE_HTAGS = NO
  166. VERBATIM_HEADERS = NO
  167. CLANG_ASSISTED_PARSING = NO
  168. CLANG_ADD_INC_PATHS = YES
  169. CLANG_OPTIONS =
  170. CLANG_DATABASE_PATH =
  171. #---------------------------------------------------------------------------
  172. # Configuration options related to the alphabetical class index
  173. #---------------------------------------------------------------------------
  174. ALPHABETICAL_INDEX = YES
  175. IGNORE_PREFIX =
  176. #---------------------------------------------------------------------------
  177. # Configuration options related to the HTML output
  178. #---------------------------------------------------------------------------
  179. GENERATE_HTML = YES
  180. HTML_OUTPUT = html
  181. HTML_FILE_EXTENSION = .html
  182. HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/header.html
  183. HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/footer.html
  184. HTML_STYLESHEET =
  185. HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/stylesheet.css
  186. HTML_EXTRA_FILES = @CMAKE_DOXYGEN_HTML_FILES@
  187. HTML_COLORSTYLE = LIGHT
  188. HTML_COLORSTYLE_HUE = 220
  189. HTML_COLORSTYLE_SAT = 100
  190. HTML_COLORSTYLE_GAMMA = 80
  191. HTML_DYNAMIC_MENUS = YES
  192. HTML_DYNAMIC_SECTIONS = NO
  193. HTML_CODE_FOLDING = YES
  194. HTML_COPY_CLIPBOARD = YES
  195. HTML_PROJECT_COOKIE =
  196. HTML_INDEX_NUM_ENTRIES = 100
  197. GENERATE_DOCSET = NO
  198. DOCSET_FEEDNAME = "Doxygen generated docs"
  199. DOCSET_FEEDURL =
  200. DOCSET_BUNDLE_ID = org.doxygen.Project
  201. DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  202. DOCSET_PUBLISHER_NAME = Publisher
  203. GENERATE_HTMLHELP = NO
  204. CHM_FILE =
  205. HHC_LOCATION =
  206. GENERATE_CHI = NO
  207. CHM_INDEX_ENCODING =
  208. BINARY_TOC = NO
  209. TOC_EXPAND = NO
  210. SITEMAP_URL =
  211. GENERATE_QHP = @CMAKE_DOXYGEN_GENERATE_QHP@
  212. QCH_FILE = ../opencv-@OPENCV_VERSION@.qch
  213. QHP_NAMESPACE = org.opencv.@OPENCV_VERSION@
  214. QHP_VIRTUAL_FOLDER = opencv
  215. QHP_CUST_FILTER_NAME =
  216. QHP_CUST_FILTER_ATTRS =
  217. QHP_SECT_FILTER_ATTRS =
  218. QHG_LOCATION =
  219. GENERATE_ECLIPSEHELP = NO
  220. ECLIPSE_DOC_ID = org.doxygen.Project
  221. DISABLE_INDEX = NO
  222. GENERATE_TREEVIEW = NO
  223. FULL_SIDEBAR = NO
  224. ENUM_VALUES_PER_LINE = 1
  225. SHOW_ENUM_VALUES = NO
  226. TREEVIEW_WIDTH = 250
  227. EXT_LINKS_IN_WINDOW = YES
  228. OBFUSCATE_EMAILS = YES
  229. HTML_FORMULA_FORMAT = svg
  230. FORMULA_FONTSIZE = 14
  231. FORMULA_MACROFILE =
  232. USE_MATHJAX = YES
  233. MATHJAX_VERSION = MathJax_3
  234. MATHJAX_FORMAT = chtml
  235. MATHJAX_RELPATH = @OPENCV_MATHJAX_RELPATH@
  236. MATHJAX_EXTENSIONS = ams
  237. MATHJAX_CODEFILE = @CMAKE_CURRENT_SOURCE_DIR@/mymath.js
  238. SEARCHENGINE = YES
  239. SERVER_BASED_SEARCH = NO
  240. EXTERNAL_SEARCH = NO
  241. SEARCHENGINE_URL =
  242. SEARCHDATA_FILE = searchdata.xml
  243. EXTERNAL_SEARCH_ID =
  244. EXTRA_SEARCH_MAPPINGS =
  245. #---------------------------------------------------------------------------
  246. # Configuration options related to the LaTeX output
  247. #---------------------------------------------------------------------------
  248. GENERATE_LATEX = NO
  249. LATEX_OUTPUT = latex
  250. LATEX_CMD_NAME = latex
  251. MAKEINDEX_CMD_NAME = makeindex
  252. LATEX_MAKEINDEX_CMD = makeindex
  253. COMPACT_LATEX = NO
  254. PAPER_TYPE = a4
  255. EXTRA_PACKAGES = mymath
  256. LATEX_HEADER =
  257. LATEX_FOOTER =
  258. LATEX_EXTRA_STYLESHEET =
  259. LATEX_EXTRA_FILES =
  260. PDF_HYPERLINKS = YES
  261. USE_PDFLATEX = YES
  262. LATEX_BATCHMODE = NO
  263. LATEX_HIDE_INDICES = NO
  264. LATEX_BIB_STYLE = plain
  265. LATEX_EMOJI_DIRECTORY =
  266. #---------------------------------------------------------------------------
  267. # Configuration options related to the RTF output
  268. #---------------------------------------------------------------------------
  269. GENERATE_RTF = NO
  270. RTF_OUTPUT = rtf
  271. COMPACT_RTF = NO
  272. RTF_HYPERLINKS = NO
  273. RTF_STYLESHEET_FILE =
  274. RTF_EXTENSIONS_FILE =
  275. RTF_EXTRA_FILES =
  276. #---------------------------------------------------------------------------
  277. # Configuration options related to the man page output
  278. #---------------------------------------------------------------------------
  279. GENERATE_MAN = NO
  280. MAN_OUTPUT = man
  281. MAN_EXTENSION = .3
  282. MAN_SUBDIR =
  283. MAN_LINKS = NO
  284. #---------------------------------------------------------------------------
  285. # Configuration options related to the XML output
  286. #---------------------------------------------------------------------------
  287. GENERATE_XML = NO
  288. XML_OUTPUT = xml
  289. XML_PROGRAMLISTING = YES
  290. XML_NS_MEMB_FILE_SCOPE = NO
  291. #---------------------------------------------------------------------------
  292. # Configuration options related to the DOCBOOK output
  293. #---------------------------------------------------------------------------
  294. GENERATE_DOCBOOK = NO
  295. DOCBOOK_OUTPUT = docbook
  296. #---------------------------------------------------------------------------
  297. # Configuration options for the AutoGen Definitions output
  298. #---------------------------------------------------------------------------
  299. GENERATE_AUTOGEN_DEF = NO
  300. #---------------------------------------------------------------------------
  301. # Configuration options related to Sqlite3 output
  302. #---------------------------------------------------------------------------
  303. GENERATE_SQLITE3 = NO
  304. SQLITE3_OUTPUT = sqlite3
  305. SQLITE3_RECREATE_DB = YES
  306. #---------------------------------------------------------------------------
  307. # Configuration options related to the Perl module output
  308. #---------------------------------------------------------------------------
  309. GENERATE_PERLMOD = NO
  310. PERLMOD_LATEX = NO
  311. PERLMOD_PRETTY = YES
  312. PERLMOD_MAKEVAR_PREFIX =
  313. #---------------------------------------------------------------------------
  314. # Configuration options related to the preprocessor
  315. #---------------------------------------------------------------------------
  316. ENABLE_PREPROCESSING = YES
  317. MACRO_EXPANSION = YES
  318. EXPAND_ONLY_PREDEF = NO
  319. SEARCH_INCLUDES = YES
  320. INCLUDE_PATH =
  321. INCLUDE_FILE_PATTERNS =
  322. PREDEFINED = __cplusplus=1 \
  323. CVAPI(x)=x \
  324. CV_API_CALL= \
  325. CV_DOXYGEN= \
  326. CV_EXPORTS= \
  327. CV_EXPORTS_W= \
  328. CV_EXPORTS_W_SIMPLE= \
  329. CV_EXPORTS_AS(x)= \
  330. CV_EXPORTS_W_MAP= \
  331. GAPI_EXPORTS= \
  332. GAPI_EXPORTS_W= \
  333. CV_IN_OUT= \
  334. CV_OUT= \
  335. CV_PROP= \
  336. CV_PROP_RW= \
  337. CV_WRAP= \
  338. CV_WRAP_AS(x)= \
  339. CV_WRAP_MAPPABLE(x)= \
  340. CV_WRAP_PHANTOM(x)= \
  341. CV_WRAP_DEFAULT(x)= \
  342. CV_CDECL= \
  343. CV_Func= \
  344. CV_DO_PRAGMA(x)= \
  345. CV_SUPPRESS_DEPRECATED_START= \
  346. CV_SUPPRESS_DEPRECATED_END= \
  347. CV_INLINE= \
  348. CV_NORETURN= \
  349. CV_DEFAULT(x)=" = x" \
  350. CV_NEON=1 \
  351. CV_SSE2=1 \
  352. CV_SIMD128=1 \
  353. CV_SIMD256=1 \
  354. CV_SIMD512=1 \
  355. CV_SIMD128_64F=1 \
  356. CV_SIMD256_64F=1 \
  357. CV_SIMD512_64F=1 \
  358. CV__DEBUG_NS_BEGIN= \
  359. CV__DEBUG_NS_END= \
  360. CV_DEPRECATED_EXTERNAL= \
  361. CV_DEPRECATED=
  362. EXPAND_AS_DEFINED =
  363. SKIP_FUNCTION_MACROS = YES
  364. #---------------------------------------------------------------------------
  365. # Configuration options related to external references
  366. #---------------------------------------------------------------------------
  367. TAGFILES =
  368. GENERATE_TAGFILE = @CMAKE_DOXYGEN_OUTPUT_PATH@/html/opencv.tag
  369. ALLEXTERNALS = NO
  370. EXTERNAL_GROUPS = YES
  371. EXTERNAL_PAGES = YES
  372. #---------------------------------------------------------------------------
  373. # Configuration options related to diagram generator tools
  374. #---------------------------------------------------------------------------
  375. HIDE_UNDOC_RELATIONS = NO
  376. HAVE_DOT = @CMAKECONFIG_HAVE_DOT@
  377. DOT_NUM_THREADS = 0
  378. DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
  379. DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
  380. DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
  381. DOT_FONTPATH =
  382. CLASS_GRAPH = NO
  383. COLLABORATION_GRAPH = YES
  384. GROUP_GRAPHS = NO
  385. UML_LOOK = YES
  386. UML_LIMIT_NUM_FIELDS = 10
  387. DOT_UML_DETAILS = NO
  388. DOT_WRAP_THRESHOLD = 17
  389. TEMPLATE_RELATIONS = YES
  390. INCLUDE_GRAPH = YES
  391. INCLUDED_BY_GRAPH = YES
  392. CALL_GRAPH = YES
  393. CALLER_GRAPH = NO
  394. GRAPHICAL_HIERARCHY = YES
  395. DIRECTORY_GRAPH = YES
  396. DIR_GRAPH_MAX_DEPTH = 1
  397. DOT_IMAGE_FORMAT = @CMAKECONFIG_DOT_IMAGE_FORMAT@
  398. INTERACTIVE_SVG = @CMAKECONFIG_INTERACTIVE_SVG@
  399. DOT_PATH = @CMAKECONFIG_DOT_PATH@
  400. DOTFILE_DIRS =
  401. DIA_PATH =
  402. DIAFILE_DIRS =
  403. PLANTUML_JAR_PATH =
  404. PLANTUML_CFG_FILE =
  405. PLANTUML_INCLUDE_PATH =
  406. DOT_GRAPH_MAX_NODES = 250
  407. MAX_DOT_GRAPH_DEPTH = 0
  408. DOT_MULTI_TARGETS = NO
  409. GENERATE_LEGEND = YES
  410. DOT_CLEANUP = YES
  411. MSCGEN_TOOL =
  412. MSCFILE_DIRS =