Description
Detailed description
In the last chapter of the contrib repo README.md is described how module should be included with documentation.
Update the repository documentation
In order to keep a clean overview containing all contributed modules the following files need to be created/adapted.
Update the README.md file under the modules folder. Here you add your model with a single line description.
Add a README.md inside your own module folder. This README explains which functionality (separate functions) is available, links to the corresponding samples and explains in somewhat more detail what the module is expected to do. If any extra requirements are needed to build the module without problems, add them here also.
I count a total of 57 Modules of which 35 are listed in mdoule/README.md and 40 with a README.md inside the modules themself. The following table shows the incomplete Modules:
| Module | In Readme | Readme |
|---|---|---|
| alphamat | alphamat | ✔️ |
| aruco | aruco | ✔️ |
| bgsegm | bgsegm | ✔️ |
| bioinspired | bioinspired | ✔️ |
| ccalib | ccalib | ✔️ |
| cnn_3dobj | cnn_3dobj | ✔️ |
| cudaarithm | ||
| cudabgsegm | ||
| cudacodec | ||
| cudafeatures2d | ||
| cudafilters | ||
| cudaimgproc | ||
| cudalegacy | ||
| cudaobjdetect | ||
| cudaoptflow | ||
| cudastereo | ||
| cudawarping | ||
| cudev | ||
| cvv | cvv | ✔️ |
| datasets | datasets | ✔️ |
| dnn_objdetect | dnn_objdetect | ✔️ |
| dnn_superres | dnn_superres | ✔️ |
| dnns_easily_fooled | dnns_easily_fooled | ✔️ |
| dpm | dpm | ✔️ |
| face | face | ✔️ |
| freetype | freetype | ✔️ |
| fuzzy | fuzzy | ✔️ |
| hdf | hdf | ✔️ |
| hfs | ✔️ | |
| img_hash | ✔️ | |
| intensity_transform | ✔️ | |
| julia | julia | ✔️ |
| line_descriptor | line_descriptor | ✔️ |
| matlab | matlab | ✔️ |
| optflow | optflow | ✔️ |
| ovis | ovis | ✔️ |
| phase_unwrapping | ✔️ | |
| plot | plot | ✔️ |
| quality | ✔️ | |
| rapid | ||
| reg | reg | ✔️ |
| rgbd | rgbd | ✔️ |
| saliency | saliency | ✔️ |
| sfm | sfm | ✔️ |
| shape | ||
| stereo | stereo | ✔️ |
| structured_light | structured_light | ✔️ |
| superres | ||
| surface_matching | surface_matching | ✔️ |
| text | text | ✔️ |
| tracking | tracking | ✔️ |
| videostab | ||
| viz | ||
| xfeatures2d | xfeatures2d | ✔️ |
| ximgproc | ximgproc | ✔️ |
| xobjdetect | xobjdetect | ✔️ |
| xphoto | xphoto | ✔️ |
| 57 | 35 | 40 |
Steps to reproduce
- Open
https://github.com/opencv/opencv_contrib/tree/master/modules/README.md - Count the total number of packages listed
- Compare with total number module folder in
https://github.com/opencv/opencv_contrib/tree/master/modules/ - Check for every module folder if
https://github.com/opencv/opencv_contrib/tree/master/modules/<module-name>/README.mdexists
Issue submission checklist
- I report the issue, it's not a question
- I checked the problem with documentation, FAQ, open issues,
answers.opencv.org, Stack Overflow, etc and have not found solution - I updated to latest OpenCV version and the issue is still there
- There is reproducer code and related data files: videos, images, onnx, etc