Skip to content

Update documentation#22176

Merged
opencv-pushbot merged 1 commit intoopencv:4.xfrom
danopdev:doc-update-1
Jul 1, 2022
Merged

Update documentation#22176
opencv-pushbot merged 1 commit intoopencv:4.xfrom
danopdev:doc-update-1

Conversation

@danopdev
Copy link
Copy Markdown
Contributor

Just a small public method documentation.
The method does not exists on 3.x so I propose it for 4.x only.

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
  • 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.
  • The feature is well documented and sample code can be built with the project CMake

Copy link
Copy Markdown
Member

@alalek alalek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for contribution!

Comment on lines +306 to +309
/** @brief Return the mask of the panorama as 8U UMat: 0xFF (white) for pixels filled by the input images,
0 (black) for unused pixels. It can be used as the mask for inpaint.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brief section very short. Please use one simple sentence only. "Return the mask of the panorama" is enough.

Details should go below (separate by empty line).

"Preview" documentation is available here: https://pullrequest.opencv.org/buildbot/export/pr/22176/docs/d2/d8d/classcv_1_1Stitcher.html

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's done.
Please let me know if I'm missing something.

Copy link
Copy Markdown
Member

@alalek alalek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@opencv-pushbot opencv-pushbot merged commit d2f5a10 into opencv:4.x Jul 1, 2022
@alalek alalek mentioned this pull request Aug 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants