-
-
Notifications
You must be signed in to change notification settings - Fork 56.4k
Documentation transition to fresh Doxygen #25042
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
504ccd9
doc: Upgrade doxygen support to 1.10
mshabunin a409b7a
doc: fix warning in cvstd.hpp
mshabunin 503dcca
doc: extract template implementations from matx.hpp
mshabunin d20ef18
doc: temporary fixes in persistence.hpp
mshabunin 422abdb
doc: fixed issues in features2d root
mshabunin 41ab8d1
doc: fix issues in G-API module
mshabunin 2f9d2c3
doc: upgrade MathJax, warn when using old doxygen
mshabunin 25313ab
doc: various fixes for modern doxygen 1.10
mshabunin f0bcfbe
doc: fixed ambiguous image in tutorial
mshabunin 5c267b4
doc: disable collaboration graphs
mshabunin 0687436
doc: reformat group definitions, disable group graph
mshabunin 870cb34
doc: move back to Doxygen 1.9.8
mshabunin f42b21e
doc: fixed doxygen version check in cmake, minor formatting fix
mshabunin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,6 +16,10 @@ endif() | |
|
|
||
| find_package(Doxygen) | ||
| if(DOXYGEN_FOUND) | ||
| if (DOXYGEN_VERSION VERSION_LESS 1.9.8) | ||
| message(WARNING "Found doxygen ${DOXYGEN_VERSION}, version 1.9.8 is used for testing, there is | ||
| a chance your documentation will look different or have some limitations.") | ||
| endif() | ||
| add_custom_target(doxygen) | ||
|
|
||
| # not documented modules list | ||
|
|
@@ -191,6 +195,8 @@ if(DOXYGEN_FOUND) | |
| list(APPEND CMAKE_DOXYGEN_HTML_FILES "${CMAKE_CURRENT_SOURCE_DIR}/tutorial-utils.js") | ||
| string(REPLACE ";" " \\\n" CMAKE_DOXYGEN_HTML_FILES "${CMAKE_DOXYGEN_HTML_FILES}") | ||
|
|
||
| set(OPENCV_MATHJAX_RELPATH "https://cdn.jsdelivr.net/npm/[email protected]" CACHE STRING "URI to a MathJax installation") | ||
|
|
||
| set(OPENCV_DOCS_DOT_PATH "" CACHE PATH "Doxygen/DOT_PATH value") | ||
| set(CMAKECONFIG_DOT_PATH "${OPENCV_DOCS_DOT_PATH}") | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,8 +3,11 @@ PROJECT_NAME = OpenCV | |
| PROJECT_NUMBER = @OPENCV_VERSION@ | ||
| PROJECT_BRIEF = "Open Source Computer Vision" | ||
| PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/opencv-logo-small.png | ||
| #PROJECT_ICON = | ||
| OUTPUT_DIRECTORY = @CMAKE_DOXYGEN_OUTPUT_PATH@ | ||
| CREATE_SUBDIRS = YES | ||
| CREATE_SUBDIRS_LEVEL = 8 | ||
| ALLOW_UNICODE_NAMES = NO | ||
| OUTPUT_LANGUAGE = English | ||
| BRIEF_MEMBER_DESC = YES | ||
| REPEAT_BRIEF = YES | ||
|
|
@@ -26,8 +29,10 @@ STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/modules @CMAKE_DOXYGEN_INCLUDE_ROOTS | |
| STRIP_FROM_INC_PATH = @CMAKE_DOXYGEN_INCLUDE_ROOTS@ | ||
| SHORT_NAMES = NO | ||
| JAVADOC_AUTOBRIEF = NO | ||
| JAVADOC_BANNER = NO | ||
| QT_AUTOBRIEF = NO | ||
| MULTILINE_CPP_IS_BRIEF = NO | ||
| PYTHON_DOCSTRING = YES | ||
| INHERIT_DOCS = YES | ||
| SEPARATE_MEMBER_PAGES = NO | ||
| TAB_SIZE = 4 | ||
|
|
@@ -43,33 +48,43 @@ OPTIMIZE_OUTPUT_FOR_C = NO | |
| OPTIMIZE_OUTPUT_JAVA = NO | ||
| OPTIMIZE_FOR_FORTRAN = NO | ||
| OPTIMIZE_OUTPUT_VHDL = NO | ||
| OPTIMIZE_OUTPUT_SLICE = NO | ||
| EXTENSION_MAPPING = | ||
| MARKDOWN_SUPPORT = YES | ||
| TOC_INCLUDE_HEADINGS = 5 | ||
| MARKDOWN_ID_STYLE = DOXYGEN | ||
| AUTOLINK_SUPPORT = YES | ||
| BUILTIN_STL_SUPPORT = YES | ||
| CPP_CLI_SUPPORT = NO | ||
| SIP_SUPPORT = NO | ||
| IDL_PROPERTY_SUPPORT = YES | ||
| DISTRIBUTE_GROUP_DOC = NO | ||
| GROUP_NESTED_COMPOUNDS = NO | ||
| SUBGROUPING = YES | ||
| INLINE_GROUPED_CLASSES = NO | ||
| INLINE_SIMPLE_STRUCTS = NO | ||
| TYPEDEF_HIDES_STRUCT = YES | ||
| LOOKUP_CACHE_SIZE = 0 | ||
| NUM_PROC_THREADS = 1 | ||
| TIMESTAMP = YES | ||
| EXTRACT_ALL = YES | ||
| EXTRACT_PRIVATE = NO | ||
| EXTRACT_PRIV_VIRTUAL = NO | ||
| EXTRACT_PACKAGE = NO | ||
| EXTRACT_STATIC = YES | ||
| EXTRACT_LOCAL_CLASSES = NO | ||
| EXTRACT_LOCAL_METHODS = NO | ||
| EXTRACT_ANON_NSPACES = NO | ||
| RESOLVE_UNNAMED_PARAMS = YES | ||
| HIDE_UNDOC_MEMBERS = NO | ||
| HIDE_UNDOC_CLASSES = NO | ||
| HIDE_FRIEND_COMPOUNDS = NO | ||
| HIDE_IN_BODY_DOCS = NO | ||
| INTERNAL_DOCS = NO | ||
| CASE_SENSE_NAMES = YES | ||
| HIDE_SCOPE_NAMES = NO | ||
| HIDE_COMPOUND_REFERENCE= NO | ||
| SHOW_HEADERFILE = YES | ||
| SHOW_INCLUDE_FILES = YES | ||
| SHOW_GROUPED_MEMB_INC = YES | ||
| FORCE_LOCAL_INCLUDES = NO | ||
|
|
@@ -96,11 +111,16 @@ QUIET = YES | |
| WARNINGS = YES | ||
| WARN_IF_UNDOCUMENTED = YES | ||
| WARN_IF_DOC_ERROR = YES | ||
| WARN_IF_INCOMPLETE_DOC = YES | ||
| WARN_NO_PARAMDOC = NO | ||
| WARN_IF_UNDOC_ENUM_VAL = NO | ||
| WARN_AS_ERROR = NO | ||
| WARN_FORMAT = "$file:$line: $text" | ||
| WARN_LINE_FORMAT = "at line $line of file $file" | ||
| WARN_LOGFILE = | ||
| INPUT = @CMAKE_DOXYGEN_INPUT_LIST@ | ||
| INPUT_ENCODING = UTF-8 | ||
| INPUT_FILE_ENCODING = | ||
| FILE_PATTERNS = | ||
| RECURSIVE = YES | ||
| EXCLUDE = @CMAKE_DOXYGEN_EXCLUDE_LIST@ | ||
|
|
@@ -125,8 +145,11 @@ REFERENCES_LINK_SOURCE = YES | |
| SOURCE_TOOLTIPS = YES | ||
| USE_HTAGS = NO | ||
| VERBATIM_HEADERS = NO | ||
| CLANG_ASSISTED_PARSING = NO | ||
| CLANG_ADD_INC_PATHS = YES | ||
| CLANG_OPTIONS = | ||
| CLANG_DATABASE_PATH = | ||
| ALPHABETICAL_INDEX = YES | ||
| COLS_IN_ALPHA_INDEX = 5 | ||
| IGNORE_PREFIX = | ||
| GENERATE_HTML = YES | ||
| HTML_OUTPUT = html | ||
|
|
@@ -136,14 +159,19 @@ HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/footer.html | |
| HTML_STYLESHEET = | ||
| HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/stylesheet.css | ||
| HTML_EXTRA_FILES = @CMAKE_DOXYGEN_HTML_FILES@ | ||
| HTML_COLORSTYLE = LIGHT | ||
| HTML_COLORSTYLE_HUE = 220 | ||
| HTML_COLORSTYLE_SAT = 100 | ||
| HTML_COLORSTYLE_GAMMA = 80 | ||
| HTML_TIMESTAMP = YES | ||
| HTML_DYNAMIC_MENUS = YES | ||
| HTML_DYNAMIC_SECTIONS = NO | ||
| HTML_CODE_FOLDING = YES | ||
| #HTML_COPY_CLIPBOARD = YES | ||
| #HTML_PROJECT_COOKIE = | ||
| HTML_INDEX_NUM_ENTRIES = 100 | ||
| GENERATE_DOCSET = NO | ||
| DOCSET_FEEDNAME = "Doxygen generated docs" | ||
| DOCSET_FEEDURL = | ||
| DOCSET_BUNDLE_ID = org.doxygen.Project | ||
| DOCSET_PUBLISHER_ID = org.doxygen.Publisher | ||
| DOCSET_PUBLISHER_NAME = Publisher | ||
|
|
@@ -154,6 +182,7 @@ GENERATE_CHI = NO | |
| CHM_INDEX_ENCODING = | ||
| BINARY_TOC = NO | ||
| TOC_EXPAND = NO | ||
| SITEMAP_URL = | ||
| GENERATE_QHP = @CMAKE_DOXYGEN_GENERATE_QHP@ | ||
| QCH_FILE = ../opencv-@[email protected] | ||
| QHP_NAMESPACE = org.opencv.@OPENCV_VERSION@ | ||
|
|
@@ -166,15 +195,19 @@ GENERATE_ECLIPSEHELP = NO | |
| ECLIPSE_DOC_ID = org.doxygen.Project | ||
| DISABLE_INDEX = NO | ||
| GENERATE_TREEVIEW = NO | ||
| FULL_SIDEBAR = NO | ||
| ENUM_VALUES_PER_LINE = 1 | ||
| TREEVIEW_WIDTH = 250 | ||
| EXT_LINKS_IN_WINDOW = YES | ||
| OBFUSCATE_EMAILS = YES | ||
| HTML_FORMULA_FORMAT = svg | ||
| FORMULA_FONTSIZE = 14 | ||
| FORMULA_TRANSPARENT = YES | ||
| FORMULA_MACROFILE = | ||
| USE_MATHJAX = YES | ||
| MATHJAX_FORMAT = HTML-CSS | ||
| MATHJAX_VERSION = MathJax_3 | ||
| MATHJAX_FORMAT = chtml | ||
| MATHJAX_RELPATH = @OPENCV_MATHJAX_RELPATH@ | ||
| MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols | ||
| MATHJAX_EXTENSIONS = ams | ||
| MATHJAX_CODEFILE = @CMAKE_CURRENT_SOURCE_DIR@/mymath.js | ||
| SEARCHENGINE = YES | ||
| SERVER_BASED_SEARCH = NO | ||
|
|
@@ -187,18 +220,20 @@ GENERATE_LATEX = NO | |
| LATEX_OUTPUT = latex | ||
| LATEX_CMD_NAME = latex | ||
| MAKEINDEX_CMD_NAME = makeindex | ||
| LATEX_MAKEINDEX_CMD = makeindex | ||
| COMPACT_LATEX = NO | ||
| PAPER_TYPE = a4 | ||
| EXTRA_PACKAGES = mymath | ||
| LATEX_HEADER = | ||
| LATEX_FOOTER = | ||
| LATEX_EXTRA_STYLESHEET = | ||
| LATEX_EXTRA_FILES = | ||
| PDF_HYPERLINKS = YES | ||
| USE_PDFLATEX = YES | ||
| LATEX_BATCHMODE = NO | ||
| LATEX_HIDE_INDICES = NO | ||
| LATEX_SOURCE_CODE = NO | ||
| LATEX_BIB_STYLE = plain | ||
| LATEX_EMOJI_DIRECTORY = | ||
| GENERATE_RTF = NO | ||
| RTF_OUTPUT = rtf | ||
| COMPACT_RTF = NO | ||
|
|
@@ -208,13 +243,18 @@ RTF_EXTENSIONS_FILE = | |
| GENERATE_MAN = NO | ||
| MAN_OUTPUT = man | ||
| MAN_EXTENSION = .3 | ||
| MAN_SUBDIR = | ||
| MAN_LINKS = NO | ||
| GENERATE_XML = NO | ||
| XML_OUTPUT = xml | ||
| XML_PROGRAMLISTING = YES | ||
| XML_NS_MEMB_FILE_SCOPE = NO | ||
| GENERATE_DOCBOOK = NO | ||
| DOCBOOK_OUTPUT = docbook | ||
| GENERATE_AUTOGEN_DEF = NO | ||
| GENERATE_SQLITE3 = NO | ||
| SQLITE3_OUTPUT = sqlite3 | ||
| SQLITE3_RECREATE_DB = YES | ||
| GENERATE_PERLMOD = NO | ||
| PERLMOD_LATEX = NO | ||
| PERLMOD_PRETTY = YES | ||
|
|
@@ -272,35 +312,40 @@ GENERATE_TAGFILE = @CMAKE_DOXYGEN_OUTPUT_PATH@/html/opencv.tag | |
| ALLEXTERNALS = NO | ||
| EXTERNAL_GROUPS = YES | ||
| EXTERNAL_PAGES = YES | ||
| CLASS_DIAGRAMS = YES | ||
| DIA_PATH = | ||
| HIDE_UNDOC_RELATIONS = NO | ||
| HAVE_DOT = @CMAKECONFIG_HAVE_DOT@ | ||
| DOT_NUM_THREADS = 0 | ||
| DOT_FONTNAME = Helvetica | ||
| DOT_FONTSIZE = 10 | ||
| DOT_FONTPATH = | ||
| DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" | ||
| DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" | ||
| DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" | ||
| CLASS_GRAPH = YES | ||
| COLLABORATION_GRAPH = YES | ||
| GROUP_GRAPHS = YES | ||
| GROUP_GRAPHS = NO | ||
| UML_LOOK = YES | ||
| UML_LIMIT_NUM_FIELDS = 10 | ||
| DOT_UML_DETAILS = NO | ||
| DOT_WRAP_THRESHOLD = 17 | ||
| TEMPLATE_RELATIONS = YES | ||
| INCLUDE_GRAPH = YES | ||
| INCLUDED_BY_GRAPH = YES | ||
| CALL_GRAPH = YES | ||
| CALLER_GRAPH = NO | ||
| GRAPHICAL_HIERARCHY = YES | ||
| DIRECTORY_GRAPH = YES | ||
| DIR_GRAPH_MAX_DEPTH = 1 | ||
| DOT_IMAGE_FORMAT = @CMAKECONFIG_DOT_IMAGE_FORMAT@ | ||
| INTERACTIVE_SVG = @CMAKECONFIG_INTERACTIVE_SVG@ | ||
| DOT_PATH = @CMAKECONFIG_DOT_PATH@ | ||
| DOTFILE_DIRS = | ||
| MSCFILE_DIRS = | ||
| DIAFILE_DIRS = | ||
| DOT_GRAPH_MAX_NODES = 50 | ||
| PLANTUML_JAR_PATH = | ||
| PLANTUML_CFG_FILE = | ||
| PLANTUML_INCLUDE_PATH = | ||
| DOT_GRAPH_MAX_NODES = 250 | ||
| MAX_DOT_GRAPH_DEPTH = 0 | ||
| DOT_TRANSPARENT = NO | ||
| DOT_MULTI_TARGETS = NO | ||
| GENERATE_LEGEND = YES | ||
| DOT_CLEANUP = YES | ||
| MSCGEN_TOOL = | ||
| MSCFILE_DIRS = | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,20 @@ | ||
| //<![CDATA[ | ||
| MathJax.Hub.Config( | ||
| { | ||
| TeX: { | ||
| Macros: { | ||
| matTT: [ "\\[ \\left|\\begin{array}{ccc} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{array}\\right| \\]", 9], | ||
| fork: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ \\end{array} \\right.", 4], | ||
| forkthree: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ \\end{array} \\right.", 6], | ||
| forkfour: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ #7 & \\mbox{#8}\\\\ \\end{array} \\right.", 8], | ||
| vecthree: ["\\begin{bmatrix} #1\\\\ #2\\\\ #3 \\end{bmatrix}", 3], | ||
| vecthreethree: ["\\begin{bmatrix} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{bmatrix}", 9], | ||
| cameramatrix: ["#1 = \\begin{bmatrix} f_x & 0 & c_x\\\\ 0 & f_y & c_y\\\\ 0 & 0 & 1 \\end{bmatrix}", 1], | ||
| distcoeffs: ["(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]]) \\text{ of 4, 5, 8, 12 or 14 elements}"], | ||
| distcoeffsfisheye: ["(k_1, k_2, k_3, k_4)"], | ||
| hdotsfor: ["\\dots", 1], | ||
| mathbbm: ["\\mathbb{#1}", 1], | ||
| bordermatrix: ["\\matrix{#1}", 1] | ||
| } | ||
| } | ||
| } | ||
| ); | ||
| window.MathJax = { | ||
| tex: { | ||
| macros: { | ||
| matTT: [ "\\[ \\left|\\begin{array}{ccc} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{array}\\right| \\]", 9], | ||
| fork: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ \\end{array} \\right.", 4], | ||
| forkthree: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ \\end{array} \\right.", 6], | ||
| forkfour: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ #7 & \\mbox{#8}\\\\ \\end{array} \\right.", 8], | ||
| vecthree: ["\\begin{bmatrix} #1\\\\ #2\\\\ #3 \\end{bmatrix}", 3], | ||
| vecthreethree: ["\\begin{bmatrix} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{bmatrix}", 9], | ||
| cameramatrix: ["#1 = \\begin{bmatrix} f_x & 0 & c_x\\\\ 0 & f_y & c_y\\\\ 0 & 0 & 1 \\end{bmatrix}", 1], | ||
| distcoeffs: ["(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]]) \\text{ of 4, 5, 8, 12 or 14 elements}"], | ||
| distcoeffsfisheye: ["(k_1, k_2, k_3, k_4)"], | ||
| hdotsfor: ["\\dots", 1], | ||
| mathbbm: ["\\mathbb{#1}", 1], | ||
| bordermatrix: ["\\matrix{#1}", 1] | ||
| } | ||
| } | ||
| }; | ||
| //]]> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This variable is used in Javadoc too which could be build without Doxygen.
Moving from the root CMake script is wrong.
P.S. History is broken due to removal.