add more info to the error code.

csukuangfj · web-flow · commit da94d8578916 · 2017-03-23T14:40:34.000+01:00
diff --git a/modules/core/include/opencv2/core/types_c.h b/modules/core/include/opencv2/core/types_c.h
@@ -130,24 +130,24 @@ enum {
  CV_BadImageSize=              -10,  /**< image size is invalid           */
  CV_BadOffset=                 -11,  /**< offset is invalid               */
  CV_BadDataPtr=                -12,  /**/
- CV_BadStep=                   -13,  /**< image step is wrong             */
+ CV_BadStep=                   -13,  /**< image step is wrong, this may happen for a non-continuous matrix */
  CV_BadModelOrChSeq=           -14,  /**/
- CV_BadNumChannels=            -15,  /**< bad number of channels          */
+ CV_BadNumChannels=            -15,  /**< bad number of channels, for example, some functions accept only single channel matrices */
  CV_BadNumChannel1U=           -16,  /**/
- CV_BadDepth=                  -17,  /**< input image depth is not supported by function */
+ CV_BadDepth=                  -17,  /**< input image depth is not supported by the function */
  CV_BadAlphaChannel=           -18,  /**/
- CV_BadOrder=                  -19,  /**/
- CV_BadOrigin=                 -20,  /**/
- CV_BadAlign=                  -21,  /**/
+ CV_BadOrder=                  -19,  /**< number of dimensions is out of range */
+ CV_BadOrigin=                 -20,  /**< incorrect input origin               */
+ CV_BadAlign=                  -21,  /**< incorrect input align                */
  CV_BadCallBack=               -22,  /**/
  CV_BadTileSize=               -23,  /**/
- CV_BadCOI=                    -24,  /**< input COI is not supported     */
- CV_BadROISize=                -25,  /**/
+ CV_BadCOI=                    -24,  /**< input COI is not supported           */
+ CV_BadROISize=                -25,  /**< incorrect input roi                  */
  CV_MaskIsTiled=               -26,  /**/
  CV_StsNullPtr=                -27,  /**< null pointer */
  CV_StsVecLengthErr=           -28,  /**< incorrect vector length */
- CV_StsFilterStructContentErr= -29,  /**< incorr. filter structure content */
- CV_StsKernelStructContentErr= -30,  /**< incorr. transform kernel content */
+ CV_StsFilterStructContentErr= -29,  /**< incorrect filter structure content */
+ CV_StsKernelStructContentErr= -30,  /**< incorrect transform kernel content */
  CV_StsFilterOffsetErr=        -31,  /**< incorrect filter offset value */
  CV_StsBadSize=                -201, /**< the input/output structure size is incorrect  */
  CV_StsDivByZero=              -202, /**< division by zero */
@@ -163,14 +163,14 @@ enum {
  CV_StsParseError=             -212, /**< invalid syntax/structure of the parsed file */
  CV_StsNotImplemented=         -213, /**< the requested function/feature is not implemented */
  CV_StsBadMemBlock=            -214, /**< an allocated block has been corrupted */
- CV_StsAssert=                 -215, /**< assertion failed */
- CV_GpuNotSupported=           -216,
- CV_GpuApiCallError=           -217,
- CV_OpenGlNotSupported=        -218,
- CV_OpenGlApiCallError=        -219,
- CV_OpenCLApiCallError=        -220,
+ CV_StsAssert=                 -215, /**< assertion failed   */
+ CV_GpuNotSupported=           -216, /**< no CUDA support    */
+ CV_GpuApiCallError=           -217, /**< GPU API call error */
+ CV_OpenGlNotSupported=        -218, /**< no OpenGL support  */
+ CV_OpenGlApiCallError=        -219, /**< OpenGL API call error */
+ CV_OpenCLApiCallError=        -220, /**< OpenCL API call error */
  CV_OpenCLDoubleNotSupported=  -221,
- CV_OpenCLInitError=           -222,
+ CV_OpenCLInitError=           -222, /**< OpenCL initialization error */
  CV_OpenCLNoAMDBlasFft=        -223
 };
 
