G-API: Documentation updates
authorDmitry Matveev <dmitry.matveev@intel.com>
Mon, 31 May 2021 19:02:05 +0000 (22:02 +0300)
committerDmitry Matveev <dmitry.matveev@intel.com>
Tue, 15 Jun 2021 22:01:55 +0000 (01:01 +0300)
commit415668ecf04561959aca6a020e4f5c1390120225
treeb5b94d65f60974d6c77186e93476d4ca89e57e15
parent76e9da3fe9389000cd3800f455686152c93b06d7
G-API: Documentation updates

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
28 files changed:
doc/Doxyfile.in
modules/gapi/include/opencv2/gapi/core.hpp
modules/gapi/include/opencv2/gapi/cpu/gcpukernel.hpp
modules/gapi/include/opencv2/gapi/fluid/gfluidkernel.hpp
modules/gapi/include/opencv2/gapi/garray.hpp
modules/gapi/include/opencv2/gapi/gasync_context.hpp
modules/gapi/include/opencv2/gapi/gframe.hpp
modules/gapi/include/opencv2/gapi/gkernel.hpp
modules/gapi/include/opencv2/gapi/gmat.hpp
modules/gapi/include/opencv2/gapi/gopaque.hpp
modules/gapi/include/opencv2/gapi/gscalar.hpp
modules/gapi/include/opencv2/gapi/gstreaming.hpp
modules/gapi/include/opencv2/gapi/imgproc.hpp
modules/gapi/include/opencv2/gapi/infer.hpp
modules/gapi/include/opencv2/gapi/infer/ie.hpp
modules/gapi/include/opencv2/gapi/infer/onnx.hpp
modules/gapi/include/opencv2/gapi/media.hpp
modules/gapi/include/opencv2/gapi/ocl/goclkernel.hpp
modules/gapi/include/opencv2/gapi/own/types.hpp
modules/gapi/include/opencv2/gapi/plaidml/plaidml.hpp
modules/gapi/include/opencv2/gapi/python/python.hpp
modules/gapi/include/opencv2/gapi/render/render.hpp
modules/gapi/include/opencv2/gapi/rmat.hpp
modules/gapi/include/opencv2/gapi/s11n/base.hpp
modules/gapi/include/opencv2/gapi/stereo.hpp
modules/gapi/include/opencv2/gapi/video.hpp
modules/gapi/samples/api_ref_snippets.cpp
modules/gapi/samples/gaze_estimation.cpp