docs(features2d): document getBlobContours and collectContours in SimpleBlobDetector#28275
Merged
asmorkalov merged 2 commits intoopencv:4.xfrom Dec 23, 2025
Merged
Conversation
Contributor
|
CI warnings: |
Contributor
Author
|
I have removed the trailing whitespaces as requested and verified the file locally using git diff --check. Ready for a final review once the CI checks pass. Thank you! |
asmorkalov
approved these changes
Dec 23, 2025
FoxHelms
pushed a commit
to FoxHelms/opencv
that referenced
this pull request
Dec 23, 2025
…ctor-api docs(features2d): document getBlobContours and collectContours in SimpleBlobDetector opencv#28275 Description: This PR adds missing Doxygen documentation for the getBlobContours() method and the collectContours parameter in SimpleBlobDetector. These features were previously undocumented, making the contour collection functionality difficult for users to discover and use correctly. Changes: Added a @brief and detailed note for SimpleBlobDetector::Params::collectContours. Added documentation for SimpleBlobDetector::getBlobContours(), including a @note regarding the required parameter setup. Testing: Verified the documentation build locally on macOS using ninja opencv_docs. Confirmed the generated HTML displays the descriptions and cross-references accurately. Partially fixes: opencv#25904 Related PR that adds method: opencv#21942 ### Pull Request Readiness Checklist See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request - [x] I agree to contribute to the project under Apache 2 License. - [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV - [x] The PR is proposed to the proper branch - [x] There is a reference to the original bug report and related work. - [ ] There is accuracy test, performance test and test data in opencv_extra repository, if applicable Patch to opencv_extra has the same branch name. - [x] The feature is well documented and sample code can be built with the project CMake
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description: This PR adds missing Doxygen documentation for the getBlobContours() method and the collectContours parameter in SimpleBlobDetector. These features were previously undocumented, making the contour collection functionality difficult for users to discover and use correctly.
Changes:
Added a @brief and detailed note for SimpleBlobDetector::Params::collectContours.
Added documentation for SimpleBlobDetector::getBlobContours(), including a @note regarding the required parameter setup.
Testing:
Verified the documentation build locally on macOS using ninja opencv_docs.
Confirmed the generated HTML displays the descriptions and cross-references accurately.
Partially fixes: #25904
Related PR that adds method: #21942
Pull Request Readiness Checklist
See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request
Patch to opencv_extra has the same branch name.