Fix cv::FileStorage::Mode::Memory doxygen layout#21582
Fix cv::FileStorage::Mode::Memory doxygen layout#21582opencv-pushbot merged 1 commit intoopencv:3.4from
Conversation
| MEMORY = 4, //!< flag, read data from source or write data to the internal buffer (which is | ||
| //!< returned by FileStorage::release) | ||
| //!< |
There was a problem hiding this comment.
I believe it makes sense merge these lines into one instead.
3.4 version is not broken.
4.x version is broken.
Patch "live" changes: enum cv::FileStorage::Mode
There was a problem hiding this comment.
I'm happy to make it single-line, however this creates a 139 character long line that appears to go against the coding style guide. Please advise if this is an allowed exception.
No issue changing the target branch if necessary. That should be a clean patch.
There was a problem hiding this comment.
It is OK to exceed lines length with comments.
There was a problem hiding this comment.
Okay, I've made this correction. Marking comment as resolved.
There was a problem hiding this comment.
Could you please revert target branch change and target to 3.4?
There is similar problem on 3.4 branch. But due to some reason it doesn't trigger buggy doxygen behavior.
There was a problem hiding this comment.
BTW, It makes sense to put multi-line doc string as multi-line C++ comment:
MEMORY = 4, /**< flag, read data from source or write data to the internal buffer
(which is returned by FileStorage::release) */
There was a problem hiding this comment.
Switch back to 3.4. Made this multiline C++ comment, retaining the original line break location.
|
Retargeted 4.x branch with force push and PR edit. |
|
Re-targeting 3.4, per assigned milestone. |
Multiline post-variable doxygen comments need a terminator. Without this PR, the previous comments appear as two separate comments in the generated HTML documentation in reverse order.
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.