Skip to content

Commit 0dfc5d4

Browse files
asmorkalovasmorkalov
authored
Merge pull request opencv#26598 from mshabunin:fix-doc-footer
doc: upgraded for compatibility with doxygen 1.12
2 parents 0a2669d + 4ade793 commit 0dfc5d4

File tree

7 files changed

+2376
-59
lines changed

7 files changed

+2376
-59
lines changed

‎doc/CMakeLists.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ endif()
1616

1717
find_package(Doxygen)
1818
if(DOXYGEN_FOUND)
19-
if (DOXYGEN_VERSION VERSION_LESS 1.9.8)
20-
message(WARNING "Found doxygen ${DOXYGEN_VERSION}, version 1.9.8 is used for testing, there is "
19+
if (DOXYGEN_VERSION VERSION_LESS 1.12)
20+
message(WARNING "Found doxygen ${DOXYGEN_VERSION}, version 1.12 is used for testing, there is "
2121
"a chance your documentation will look different or have some limitations.")
2222
endif()
2323
add_custom_target(doxygen)

‎doc/Doxyfile.in‎

Lines changed: 67 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1+
# Doxyfile 1.12.0
2+
3+
#---------------------------------------------------------------------------
4+
# Project related configuration options
5+
#---------------------------------------------------------------------------
16
DOXYFILE_ENCODING = UTF-8
27
PROJECT_NAME = OpenCV
38
PROJECT_NUMBER = @OPENCV_VERSION@
49
PROJECT_BRIEF = "Open Source Computer Vision"
510
PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/opencv-logo-small.png
6-
#PROJECT_ICON =
11+
PROJECT_ICON = @CMAKE_CURRENT_SOURCE_DIR@/opencv.ico
712
OUTPUT_DIRECTORY = @CMAKE_DOXYGEN_OUTPUT_PATH@
813
CREATE_SUBDIRS = YES
914
CREATE_SUBDIRS_LEVEL = 8
@@ -25,7 +30,8 @@ ABBREVIATE_BRIEF = "The $name class" \
2530
ALWAYS_DETAILED_SEC = NO
2631
INLINE_INHERITED_MEMB = NO
2732
FULL_PATH_NAMES = YES
28-
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/modules @CMAKE_DOXYGEN_INCLUDE_ROOTS@
33+
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/modules \
34+
@CMAKE_DOXYGEN_INCLUDE_ROOTS@
2935
STRIP_FROM_INC_PATH = @CMAKE_DOXYGEN_INCLUDE_ROOTS@
3036
SHORT_NAMES = NO
3137
JAVADOC_AUTOBRIEF = NO
@@ -67,6 +73,9 @@ TYPEDEF_HIDES_STRUCT = YES
6773
LOOKUP_CACHE_SIZE = 0
6874
NUM_PROC_THREADS = 1
6975
TIMESTAMP = YES
76+
#---------------------------------------------------------------------------
77+
# Build related configuration options
78+
#---------------------------------------------------------------------------
7079
EXTRACT_ALL = YES
7180
EXTRACT_PRIVATE = NO
7281
EXTRACT_PRIV_VIRTUAL = NO
@@ -107,6 +116,10 @@ SHOW_NAMESPACES = YES
107116
FILE_VERSION_FILTER =
108117
LAYOUT_FILE = @CMAKE_DOXYGEN_LAYOUT@
109118
CITE_BIB_FILES = @CMAKE_EXTRA_BIB_FILES@
119+
EXTERNAL_TOOL_PATH =
120+
#---------------------------------------------------------------------------
121+
# Configuration options related to warning and progress messages
122+
#---------------------------------------------------------------------------
110123
QUIET = YES
111124
WARNINGS = YES
112125
WARN_IF_UNDOCUMENTED = YES
@@ -118,6 +131,9 @@ WARN_AS_ERROR = NO
118131
WARN_FORMAT = "$file:$line: $text"
119132
WARN_LINE_FORMAT = "at line $line of file $file"
120133
WARN_LOGFILE =
134+
#---------------------------------------------------------------------------
135+
# Configuration options related to the input files
136+
#---------------------------------------------------------------------------
121137
INPUT = @CMAKE_DOXYGEN_INPUT_LIST@
122138
INPUT_ENCODING = UTF-8
123139
INPUT_FILE_ENCODING =
@@ -136,6 +152,10 @@ FILTER_PATTERNS =
136152
FILTER_SOURCE_FILES = NO
137153
FILTER_SOURCE_PATTERNS =
138154
USE_MDFILE_AS_MAINPAGE =
155+
FORTRAN_COMMENT_AFTER = 72
156+
#---------------------------------------------------------------------------
157+
# Configuration options related to source browsing
158+
#---------------------------------------------------------------------------
139159
SOURCE_BROWSER = NO
140160
INLINE_SOURCES = NO
141161
STRIP_CODE_COMMENTS = YES
@@ -149,8 +169,14 @@ CLANG_ASSISTED_PARSING = NO
149169
CLANG_ADD_INC_PATHS = YES
150170
CLANG_OPTIONS =
151171
CLANG_DATABASE_PATH =
172+
#---------------------------------------------------------------------------
173+
# Configuration options related to the alphabetical class index
174+
#---------------------------------------------------------------------------
152175
ALPHABETICAL_INDEX = YES
153176
IGNORE_PREFIX =
177+
#---------------------------------------------------------------------------
178+
# Configuration options related to the HTML output
179+
#---------------------------------------------------------------------------
154180
GENERATE_HTML = YES
155181
HTML_OUTPUT = html
156182
HTML_FILE_EXTENSION = .html
@@ -166,8 +192,8 @@ HTML_COLORSTYLE_GAMMA = 80
166192
HTML_DYNAMIC_MENUS = YES
167193
HTML_DYNAMIC_SECTIONS = NO
168194
HTML_CODE_FOLDING = YES
169-
#HTML_COPY_CLIPBOARD = YES
170-
#HTML_PROJECT_COOKIE =
195+
HTML_COPY_CLIPBOARD = YES
196+
HTML_PROJECT_COOKIE =
171197
HTML_INDEX_NUM_ENTRIES = 100
172198
GENERATE_DOCSET = NO
173199
DOCSET_FEEDNAME = "Doxygen generated docs"
@@ -197,6 +223,7 @@ DISABLE_INDEX = NO
197223
GENERATE_TREEVIEW = NO
198224
FULL_SIDEBAR = NO
199225
ENUM_VALUES_PER_LINE = 1
226+
SHOW_ENUM_VALUES = NO
200227
TREEVIEW_WIDTH = 250
201228
EXT_LINKS_IN_WINDOW = YES
202229
OBFUSCATE_EMAILS = YES
@@ -216,6 +243,9 @@ SEARCHENGINE_URL =
216243
SEARCHDATA_FILE = searchdata.xml
217244
EXTERNAL_SEARCH_ID =
218245
EXTRA_SEARCH_MAPPINGS =
246+
#---------------------------------------------------------------------------
247+
# Configuration options related to the LaTeX output
248+
#---------------------------------------------------------------------------
219249
GENERATE_LATEX = NO
220250
LATEX_OUTPUT = latex
221251
LATEX_CMD_NAME = latex
@@ -234,31 +264,56 @@ LATEX_BATCHMODE = NO
234264
LATEX_HIDE_INDICES = NO
235265
LATEX_BIB_STYLE = plain
236266
LATEX_EMOJI_DIRECTORY =
267+
#---------------------------------------------------------------------------
268+
# Configuration options related to the RTF output
269+
#---------------------------------------------------------------------------
237270
GENERATE_RTF = NO
238271
RTF_OUTPUT = rtf
239272
COMPACT_RTF = NO
240273
RTF_HYPERLINKS = NO
241274
RTF_STYLESHEET_FILE =
242275
RTF_EXTENSIONS_FILE =
276+
RTF_EXTRA_FILES =
277+
#---------------------------------------------------------------------------
278+
# Configuration options related to the man page output
279+
#---------------------------------------------------------------------------
243280
GENERATE_MAN = NO
244281
MAN_OUTPUT = man
245282
MAN_EXTENSION = .3
246283
MAN_SUBDIR =
247284
MAN_LINKS = NO
285+
#---------------------------------------------------------------------------
286+
# Configuration options related to the XML output
287+
#---------------------------------------------------------------------------
248288
GENERATE_XML = NO
249289
XML_OUTPUT = xml
250290
XML_PROGRAMLISTING = YES
251291
XML_NS_MEMB_FILE_SCOPE = NO
292+
#---------------------------------------------------------------------------
293+
# Configuration options related to the DOCBOOK output
294+
#---------------------------------------------------------------------------
252295
GENERATE_DOCBOOK = NO
253296
DOCBOOK_OUTPUT = docbook
297+
#---------------------------------------------------------------------------
298+
# Configuration options for the AutoGen Definitions output
299+
#---------------------------------------------------------------------------
254300
GENERATE_AUTOGEN_DEF = NO
301+
#---------------------------------------------------------------------------
302+
# Configuration options related to Sqlite3 output
303+
#---------------------------------------------------------------------------
255304
GENERATE_SQLITE3 = NO
256305
SQLITE3_OUTPUT = sqlite3
257306
SQLITE3_RECREATE_DB = YES
307+
#---------------------------------------------------------------------------
308+
# Configuration options related to the Perl module output
309+
#---------------------------------------------------------------------------
258310
GENERATE_PERLMOD = NO
259311
PERLMOD_LATEX = NO
260312
PERLMOD_PRETTY = YES
261313
PERLMOD_MAKEVAR_PREFIX =
314+
#---------------------------------------------------------------------------
315+
# Configuration options related to the preprocessor
316+
#---------------------------------------------------------------------------
262317
ENABLE_PREPROCESSING = YES
263318
MACRO_EXPANSION = YES
264319
EXPAND_ONLY_PREDEF = NO
@@ -307,18 +362,24 @@ PREDEFINED = __cplusplus=1 \
307362
CV_DEPRECATED=
308363
EXPAND_AS_DEFINED =
309364
SKIP_FUNCTION_MACROS = YES
365+
#---------------------------------------------------------------------------
366+
# Configuration options related to external references
367+
#---------------------------------------------------------------------------
310368
TAGFILES =
311369
GENERATE_TAGFILE = @CMAKE_DOXYGEN_OUTPUT_PATH@/html/opencv.tag
312370
ALLEXTERNALS = NO
313371
EXTERNAL_GROUPS = YES
314372
EXTERNAL_PAGES = YES
373+
#---------------------------------------------------------------------------
374+
# Configuration options related to diagram generator tools
375+
#---------------------------------------------------------------------------
315376
HIDE_UNDOC_RELATIONS = NO
316377
HAVE_DOT = @CMAKECONFIG_HAVE_DOT@
317378
DOT_NUM_THREADS = 0
318-
DOT_FONTPATH =
319379
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
320380
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
321381
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
382+
DOT_FONTPATH =
322383
CLASS_GRAPH = NO
323384
COLLABORATION_GRAPH = YES
324385
GROUP_GRAPHS = NO
@@ -338,6 +399,7 @@ DOT_IMAGE_FORMAT = @CMAKECONFIG_DOT_IMAGE_FORMAT@
338399
INTERACTIVE_SVG = @CMAKECONFIG_INTERACTIVE_SVG@
339400
DOT_PATH = @CMAKECONFIG_DOT_PATH@
340401
DOTFILE_DIRS =
402+
DIA_PATH =
341403
DIAFILE_DIRS =
342404
PLANTUML_JAR_PATH =
343405
PLANTUML_CFG_FILE =

‎doc/footer.html‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
1-
<!-- HTML footer for doxygen 1.8.6-->
1+
<!-- HTML footer for doxygen 1.12.0-->
22
<!-- start footer part -->
33
<!--BEGIN GENERATE_TREEVIEW-->
44
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
55
<ul>
66
$navpath
7-
<li class="footer">$generatedby
8-
<a href="http://www.doxygen.org/index.html">
9-
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
7+
<li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
108
</ul>
119
</div>
1210
<!--END GENERATE_TREEVIEW-->
1311
<!--BEGIN !GENERATE_TREEVIEW-->
1412
<hr class="footer"/><address class="footer"><small>
15-
$generatedby &#160;<a href="http://www.doxygen.org/index.html">
16-
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
17-
</a> $doxygenversion
13+
$generatedby&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
1814
</small></address>
15+
</div><!-- doc-content -->
1916
<!--END !GENERATE_TREEVIEW-->
2017
<script type="text/javascript">
2118
//<![CDATA[

‎doc/header.html‎

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,80 @@
1-
<!-- HTML header for doxygen 1.8.6-->
2-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3-
<html xmlns="http://www.w3.org/1999/xhtml">
1+
<!-- HTML header for doxygen 1.12.0-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
44
<head>
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6-
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
77
<meta name="generator" content="Doxygen $doxygenversion"/>
8+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
89
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
910
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
10-
<link href="$relpath^opencv.ico" rel="shortcut icon" type="image/x-icon" />
11+
<!--BEGIN PROJECT_ICON-->
12+
<link rel="icon" href="$relpath^$projecticon" type="image/x-icon" />
13+
<!--END PROJECT_ICON-->
1114
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
15+
<!--BEGIN DISABLE_INDEX-->
16+
<!--BEGIN FULL_SIDEBAR-->
17+
<script type="text/javascript">var page_layout=1;</script>
18+
<!--END FULL_SIDEBAR-->
19+
<!--END DISABLE_INDEX-->
1220
<script type="text/javascript" src="$relpath^jquery.js"></script>
1321
<script type="text/javascript" src="$relpath^dynsections.js"></script>
1422
<script type="text/javascript" src="$relpath^tutorial-utils.js"></script>
23+
<!--BEGIN COPY_CLIPBOARD-->
24+
<script type="text/javascript" src="$relpath^clipboard.js"></script>
25+
<!--END COPY_CLIPBOARD-->
1526
$treeview
1627
$search
1728
$mathjax
29+
$darkmode
1830
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
1931
$extrastylesheet
2032
</head>
2133
<body>
34+
<!--BEGIN DISABLE_INDEX-->
35+
<!--BEGIN FULL_SIDEBAR-->
36+
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
37+
<!--END FULL_SIDEBAR-->
38+
<!--END DISABLE_INDEX-->
39+
2240
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
2341

2442
<!--BEGIN TITLEAREA-->
2543
<div id="titlearea">
2644
<!--#include virtual="/google-search.html"-->
2745
<table cellspacing="0" cellpadding="0">
2846
<tbody>
29-
<tr style="height: 56px;">
47+
<tr id="projectrow">
3048
<!--BEGIN PROJECT_LOGO-->
31-
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
49+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"$logosize/></td>
3250
<!--END PROJECT_LOGO-->
3351
<!--BEGIN PROJECT_NAME-->
34-
<td style="padding-left: 0.5em;">
35-
<div id="projectname">$projectname
36-
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
52+
<td id="projectalign">
53+
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
3754
</div>
3855
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
3956
</td>
4057
<!--END PROJECT_NAME-->
4158
<!--BEGIN !PROJECT_NAME-->
4259
<!--BEGIN PROJECT_BRIEF-->
43-
<td style="padding-left: 0.5em;">
60+
<td>
4461
<div id="projectbrief">$projectbrief</div>
4562
</td>
4663
<!--END PROJECT_BRIEF-->
4764
<!--END !PROJECT_NAME-->
4865
<!--BEGIN DISABLE_INDEX-->
4966
<!--BEGIN SEARCHENGINE-->
50-
<td>$searchbox</td>
67+
<!--BEGIN !FULL_SIDEBAR-->
68+
<td>$searchbox</td>
69+
<!--END !FULL_SIDEBAR-->
5170
<!--END SEARCHENGINE-->
5271
<!--END DISABLE_INDEX-->
5372
</tr>
73+
<!--BEGIN SEARCHENGINE-->
74+
<!--BEGIN FULL_SIDEBAR-->
75+
<tr><td colspan="2">$searchbox</td></tr>
76+
<!--END FULL_SIDEBAR-->
77+
<!--END SEARCHENGINE-->
5478
</tbody>
5579
</table>
5680
</div>

0 commit comments

Comments
 (0)