Add documentation on G-types, cv::MediaFrame, and G-API namespaces#20238
Merged
opencv-pushbot merged 1 commit intoopencv:masterfrom Jun 16, 2021
Merged
Add documentation on G-types, cv::MediaFrame, and G-API namespaces#20238opencv-pushbot merged 1 commit intoopencv:masterfrom
opencv-pushbot merged 1 commit intoopencv:masterfrom
Conversation
Contributor
Author
|
@TolyaTalamanov @mpashchenkov please have a look |
Contributor
Author
|
as @mpashchenkov is on vacation, kindly asking @rgarnov to review. |
Contributor
Author
|
@TolyaTalamanov @rgarnov any comments here? |
rgarnov
reviewed
Jun 11, 2021
Contributor
rgarnov
left a comment
There was a problem hiding this comment.
Just a minor misprint catch from my side, and a small sample code clean-up suggestion
| */ | ||
|
|
||
| /** | ||
| * @brief `cv::GArray<T>` template class represents an list of objects |
| * at the graph construction or compile time. Examples include: corner | ||
| * and feature detectors (`cv::GArray<cv::Point>`), object detection | ||
| * and tracking results (`cv::GArray<cv::Rect>`). Programmers can use | ||
| * their own types in with `cv::GArray<T>` in the custom operations. |
| * other `cv::GArray<T>` to the object using `operator=` -- on the | ||
| * assigment, the old association or value is discarded. | ||
| * | ||
| * @param v a std::vector<T> to assiciate with this |
| * @overload | ||
| * @brief Constructs a value-initialized `cv::GArray<T>` | ||
| * | ||
| * @param v a std::vector<T> to assiciate with this |
1) Document GFrame/MediaFrame (and also other G-API types) - Added doxygen comments for GMat, GScalar, GArray<T>, GOpaque classes; - Documented GFrame and its host-side counterpart MediaFrame; - Added some more notes to the data type classes. 2) Give @brief descriptions to most of the cv::gapi::* namespaces 3) Make some symbols private - These structures are mainly internal and shouldn't be used directly
Contributor
Author
|
@rgarnov @TolyaTalamanov I've pushed the updates (had to do this earlier but could do it just now). Please, have a look |
rgarnov
approved these changes
Jun 16, 2021
Contributor
Author
|
Cool, thanks! |
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
4 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.
There is also some pending changes on Inference but those parts will be pushed in a separate PR after #20169 is merged.
Patch to opencv_extra has the same branch name.