Skip to content

doxygen: Fix ImwriteFlags documentation misalignment#23967

Merged
asmorkalov merged 1 commit intoopencv:4.xfrom
YusukeKameda:4.x
Jul 11, 2023
Merged

doxygen: Fix ImwriteFlags documentation misalignment#23967
asmorkalov merged 1 commit intoopencv:4.xfrom
YusukeKameda:4.x

Conversation

@YusukeKameda
Copy link
Copy Markdown
Contributor

@YusukeKameda YusukeKameda commented Jul 11, 2023

Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

  • I agree to contribute to the project under Apache 2 License.
  • 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
  • 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

The generated document is misaligned because the comment preceded the "//!<".
https://docs.opencv.org/4.x/d8/d6a/group__imgcodecs__flags.html#ga292d81be8d76901bff7988d18d2b42ac

I think a reasonable solution would be to write the comment before the comma.
Is there another good solution?

@asmorkalov asmorkalov self-requested a review July 11, 2023 11:54
@asmorkalov asmorkalov added the category: documentation Documentation fix or update label Jul 11, 2023
@asmorkalov asmorkalov added this to the 4.9.0 milestone Jul 11, 2023
@asmorkalov asmorkalov self-assigned this Jul 11, 2023
Copy link
Copy Markdown
Contributor

@asmorkalov asmorkalov left a comment

Choose a reason for hiding this comment

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

👍

@asmorkalov asmorkalov merged commit 37aa823 into opencv:4.x Jul 11, 2023
@asmorkalov asmorkalov mentioned this pull request Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category: documentation Documentation fix or update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants