Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
O
opencv
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
opencv
Commits
ddd9a99c
Commit
ddd9a99c
authored
May 28, 2012
by
Andrey Kamaev
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added check for documented but missing functions
parent
78329b0d
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
5 deletions
+8
-5
check_docs2.py
doc/check_docs2.py
+8
-5
No files found.
doc/check_docs2.py
View file @
ddd9a99c
...
...
@@ -30,12 +30,12 @@ doc_signatures_whitelist = [
# templates
"Matx"
,
"Vec"
,
"SparseMat_"
,
"Scalar_"
,
"Mat_"
,
"Ptr"
,
"Size_"
,
"Point_"
,
"Rect_"
,
"Point3_"
,
"DataType"
,
"detail::RotationWarperBase"
,
"flann::Index_"
,
"CalonderDescriptorExtractor"
,
# the following classes reside in core bu documented in gpu. It's no good
# black boxes
"CvArr"
,
"CvFileStorage"
,
# the following classes reside in core but documented in gpu. It's no good
"gpu::DevMem2D_"
,
"gpu::PtrStep_"
,
"gpu::PtrElemStep_"
,
# these are even non-template
"gpu::DeviceInfo"
,
"gpu::GpuMat"
,
"gpu::TargetArchs"
,
"gpu::FeatureSet"
,
# black boxes
"CvArr"
,
"CvFileStorage"
]
"gpu::DeviceInfo"
,
"gpu::GpuMat"
,
"gpu::TargetArchs"
,
"gpu::FeatureSet"
]
synonims
=
{
"StarDetector"
:
[
"StarFeatureDetector"
],
...
...
@@ -431,7 +431,10 @@ def process_module(module, path):
if
name
in
doc_signatures_whitelist
:
continue
logerror
(
ERROR_010_UNKNOWNCLASS
,
"class/struct "
+
name
+
" is mentioned in documentation but is not found in OpenCV headers"
,
doc
)
#for signature in decls:
for
d
in
doc
.
get
(
"decls"
,
[]):
if
d
[
-
1
]
!=
DOCUMENTED_MARKER
:
if
d
[
0
]
==
"C"
or
d
[
0
]
==
"C++"
or
(
do_python_crosscheck
and
d
[
0
]
.
startswith
(
"Python"
)):
logerror
(
ERROR_011_UNKNOWNFUNC
,
d
[
0
]
+
" function is documented but is not found in OpenCV headers. It is documented as:
\n\t
"
+
d
[
1
],
doc
)
# end of process_module
if
__name__
==
"__main__"
:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment