-
-
Notifications
You must be signed in to change notification settings - Fork 56.5k
Closed
Labels
category: documentationDocumentation fix or updateDocumentation fix or update
Milestone
Description
Describe the doc issue
Basically, C API has been deprecated/excluded at OpenCV4. ( https://github.com/opencv/opencv/wiki/Opencv4 )
It seems that there are some C API links and these linked C API pages are blank.
I suggests to remove them.
Some modules has been fixed at 5.x branch. What style of pull request is appropriate?
- 2 pull requests
- For 4.x ( calib3d, core, imgproc, imgcodecs, photo, video and videoio )
- For 5.x ( calib, core, imgcodecs, photo, video and videoio)
- 3 pull requests
- For common (core, imgcodecs, photo, video and videoio)
- For additional 4.x (calib3d, imgproc and highgui)
- For additional 5.x ( calib )
- 1 pull request ( do not fix to 4.x branch)
- For 5.x ( calib, core, imgcodecs, photo, video and videoio)
| module | 4.x branch | 5.x branch |
|---|---|---|
| calib | Needs | |
| calib3d | Needs | |
| core | Needs | Needs |
| imgproc | Needs | |
| imgcodecs | Needs | Needs |
| highgui | Needs | |
| photo | Needs | Needs |
| video | Needs | Needs |
| videoio | Needs | Needs |
Fix suggestion
I think we can remove these links and pages.
- https://docs.opencv.org/4.x/d0/de1/group__core.html ->
C structures and operations - https://docs.opencv.org/4.x/d7/dbd/group__imgproc.html ->
C API - https://docs.opencv.org/4.x/d4/da8/group__imgcodecs.html ->
C API - https://docs.opencv.org/4.x/d7/dfc/group__highgui.html ->
C API - https://docs.opencv.org/4.x/dd/de7/group__videoio.html ->
C API for video I/O - https://docs.opencv.org/4.x/d7/de9/group__video.html ->
C API - https://docs.opencv.org/4.x/d9/d0c/group__calib3d.html ->
C API - https://docs.opencv.org/4.x/d1/d0d/group__photo.html ->
C API
kmtr@kmtr-None:~/work/opencv$ git reset --hard
HEAD is now at 500c55a808 Merge pull request #25122 from unnonouno:pqueue
kmtr@kmtr-None:~/work/opencv$ git grep "C API" | grep "\@defgroup"
modules/calib3d/include/opencv2/calib3d.hpp: @defgroup calib3d_c C API
modules/highgui/include/opencv2/highgui.hpp: @defgroup highgui_c C API
modules/imgcodecs/include/opencv2/imgcodecs.hpp: @defgroup imgcodecs_c C API
modules/imgproc/include/opencv2/imgproc.hpp: @defgroup imgproc_c C API
modules/photo/include/opencv2/photo.hpp: @defgroup photo_c C API
modules/video/include/opencv2/video.hpp: @defgroup video_c C API
modules/videoio/include/opencv2/videoio.hpp: @defgroup videoio_c C API for video I/O
kmtr@kmtr-None:~/work/opencv$ git grep "C structure" | grep "\@defgroup"
modules/core/include/opencv2/core.hpp: @defgroup core_c C structures and operations
kmtr@kmtr-None:~/work/opencv5$ git reset --hard
HEAD is now at 1d1faaabef Merge pull request #24411 from alexlyulkov:al/dnn-type-inference
kmtr@kmtr-None:~/work/opencv5$ git grep "C API" | grep "\@defgroup"
modules/calib/include/opencv2/calib.hpp: @defgroup calib3d_c C API
modules/imgcodecs/include/opencv2/imgcodecs.hpp: @defgroup imgcodecs_c C API
modules/photo/include/opencv2/photo.hpp: @defgroup photo_c C API
modules/video/include/opencv2/video.hpp: @defgroup video_c C API
modules/videoio/include/opencv2/videoio.hpp: @defgroup videoio_c C API for video I/O
kmtr@kmtr-None:~/work/opencv5$ git grep "C structure" | grep "\@defgroup"
modules/core/include/opencv2/core.hpp: @defgroup core_c C structures and operations
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
category: documentationDocumentation fix or updateDocumentation fix or update