From: Alexander Alekhin <alexander.a.alekhin@gmail.com>
Date: Wed, 16 Jun 2021 15:06:04 +0000 (+0000)
Subject: Merge pull request #20238 from dmatveev:dm/gframe_docs
X-Git-Tag: submit/tizen/20220120.021815~1^2~28
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b3db37b99de4d2dcb8c4d8c7568029b3e06893b2;p=platform%2Fupstream%2Fopencv.git

Merge pull request #20238 from dmatveev:dm/gframe_docs
---

b3db37b99de4d2dcb8c4d8c7568029b3e06893b2
diff --cc modules/gapi/include/opencv2/gapi/stereo.hpp
index 278ae34950,b573dbf0db..dcf8f4d260
--- a/modules/gapi/include/opencv2/gapi/stereo.hpp
+++ b/modules/gapi/include/opencv2/gapi/stereo.hpp
@@@ -14,30 -14,18 +14,35 @@@
  namespace cv {
  namespace gapi {
  
 +/**
 + * The enum specified format of result that you get from @ref cv::gapi::stereo.
 + */
  enum class StereoOutputFormat {
 -    DEPTH_FLOAT16,
 -    DEPTH_FLOAT32,
 -    DISPARITY_FIXED16_11_5,
 -    DISPARITY_FIXED16_12_4
 +    DEPTH_FLOAT16, ///< Floating point 16 bit value, CV_16FC1.
 +                   ///< This identifier is deprecated, use DEPTH_16F instead.
 +    DEPTH_FLOAT32, ///< Floating point 32 bit value, CV_32FC1
 +                   ///< This identifier is deprecated, use DEPTH_16F instead.
 +    DISPARITY_FIXED16_11_5, ///< 16 bit signed: first bit for sign,
 +                            ///< 10 bits for integer part,
 +                            ///< 5 bits for fractional part.
 +                            ///< This identifier is deprecated,
 +                            ///< use DISPARITY_16Q_10_5 instead.
 +    DISPARITY_FIXED16_12_4, ///< 16 bit signed: first bit for sign,
 +                            ///< 11 bits for integer part,
 +                            ///< 4 bits for fractional part.
 +                            ///< This identifier is deprecated,
 +                            ///< use DISPARITY_16Q_11_4 instead.
 +    DEPTH_16F = DEPTH_FLOAT16, ///< Same as DEPTH_FLOAT16
 +    DEPTH_32F = DEPTH_FLOAT32, ///< Same as DEPTH_FLOAT32
 +    DISPARITY_16Q_10_5 = DISPARITY_FIXED16_11_5, ///< Same as DISPARITY_FIXED16_11_5
 +    DISPARITY_16Q_11_4 = DISPARITY_FIXED16_12_4 ///< Same as DISPARITY_FIXED16_12_4
  };
  
+ 
+ /**
+  * @brief This namespace contains G-API Operation Types for Stereo and
+  * related functionality.
+  */
  namespace calib3d {
  
  G_TYPED_KERNEL(GStereo, <GMat(GMat, GMat, const StereoOutputFormat)>, "org.opencv.stereo") {