Skip to content

Commit dd81c29

Browse files
vpisarevvpisarev
committed
Merge pull request opencv#8359 from csukuangfj:patch-fix-error-code-documentation
2 parents dea5eac + da94d85 commit dd81c29

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

‎modules/core/include/opencv2/core/base.hpp

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -73,30 +73,30 @@ enum Code {
7373
StsNoMem= -4, //!< insufficient memory
7474
StsBadArg= -5, //!< function arg/param is bad
7575
StsBadFunc= -6, //!< unsupported function
76-
StsNoConv= -7, //!< iter. didn't converge
76+
StsNoConv= -7, //!< iteration didn't converge
7777
StsAutoTrace= -8, //!< tracing
7878
HeaderIsNull= -9, //!< image header is NULL
7979
BadImageSize= -10, //!< image size is invalid
8080
BadOffset= -11, //!< offset is invalid
8181
BadDataPtr= -12, //!<
82-
BadStep= -13, //!<
82+
BadStep= -13, //!< image step is wrong, this may happen for a non-continuous matrix.
8383
BadModelOrChSeq= -14, //!<
84-
BadNumChannels= -15, //!<
84+
BadNumChannels= -15, //!< bad number of channels, for example, some functions accept only single channel matrices.
8585
BadNumChannel1U= -16, //!<
86-
BadDepth= -17, //!<
86+
BadDepth= -17, //!< input image depth is not supported by the function
8787
BadAlphaChannel= -18, //!<
88-
BadOrder= -19, //!<
89-
BadOrigin= -20, //!<
90-
BadAlign= -21, //!<
88+
BadOrder= -19, //!< number of dimensions is out of range
89+
BadOrigin= -20, //!< incorrect input origin
90+
BadAlign= -21, //!< incorrect input align
9191
BadCallBack= -22, //!<
9292
BadTileSize= -23, //!<
93-
BadCOI= -24, //!<
94-
BadROISize= -25, //!<
93+
BadCOI= -24, //!< input COI is not supported
94+
BadROISize= -25, //!< incorrect input roi
9595
MaskIsTiled= -26, //!<
9696
StsNullPtr= -27, //!< null pointer
9797
StsVecLengthErr= -28, //!< incorrect vector length
98-
StsFilterStructContentErr= -29, //!< incorr. filter structure content
99-
StsKernelStructContentErr= -30, //!< incorr. transform kernel content
98+
StsFilterStructContentErr= -29, //!< incorrect filter structure content
99+
StsKernelStructContentErr= -30, //!< incorrect transform kernel content
100100
StsFilterOffsetErr= -31, //!< incorrect filter offset value
101101
StsBadSize= -201, //!< the input/output structure size is incorrect
102102
StsDivByZero= -202, //!< division by zero
@@ -113,13 +113,13 @@ enum Code {
113113
StsNotImplemented= -213, //!< the requested function/feature is not implemented
114114
StsBadMemBlock= -214, //!< an allocated block has been corrupted
115115
StsAssert= -215, //!< assertion failed
116-
GpuNotSupported= -216,
117-
GpuApiCallError= -217,
118-
OpenGlNotSupported= -218,
119-
OpenGlApiCallError= -219,
120-
OpenCLApiCallError= -220,
116+
GpuNotSupported= -216, //!< no CUDA support
117+
GpuApiCallError= -217, //!< GPU API call error
118+
OpenGlNotSupported= -218, //!< no OpenGL support
119+
OpenGlApiCallError= -219, //!< OpenGL API call error
120+
OpenCLApiCallError= -220, //!< OpenCL API call error
121121
OpenCLDoubleNotSupported= -221,
122-
OpenCLInitError= -222,
122+
OpenCLInitError= -222, //!< OpenCL initialization error
123123
OpenCLNoAMDBlasFft= -223
124124
};
125125
} //Error

‎modules/core/include/opencv2/core/types_c.h

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -130,24 +130,24 @@ enum {
130130
CV_BadImageSize= -10, /**< image size is invalid */
131131
CV_BadOffset= -11, /**< offset is invalid */
132132
CV_BadDataPtr= -12, /**/
133-
CV_BadStep= -13, /**/
133+
CV_BadStep= -13, /**< image step is wrong, this may happen for a non-continuous matrix */
134134
CV_BadModelOrChSeq= -14, /**/
135-
CV_BadNumChannels= -15, /**/
135+
CV_BadNumChannels= -15, /**< bad number of channels, for example, some functions accept only single channel matrices */
136136
CV_BadNumChannel1U= -16, /**/
137-
CV_BadDepth= -17, /**/
137+
CV_BadDepth= -17, /**< input image depth is not supported by the function */
138138
CV_BadAlphaChannel= -18, /**/
139-
CV_BadOrder= -19, /**/
140-
CV_BadOrigin= -20, /**/
141-
CV_BadAlign= -21, /**/
139+
CV_BadOrder= -19, /**< number of dimensions is out of range */
140+
CV_BadOrigin= -20, /**< incorrect input origin */
141+
CV_BadAlign= -21, /**< incorrect input align */
142142
CV_BadCallBack= -22, /**/
143143
CV_BadTileSize= -23, /**/
144-
CV_BadCOI= -24, /**/
145-
CV_BadROISize= -25, /**/
144+
CV_BadCOI= -24, /**< input COI is not supported */
145+
CV_BadROISize= -25, /**< incorrect input roi */
146146
CV_MaskIsTiled= -26, /**/
147147
CV_StsNullPtr= -27, /**< null pointer */
148148
CV_StsVecLengthErr= -28, /**< incorrect vector length */
149-
CV_StsFilterStructContentErr= -29, /**< incorr. filter structure content */
150-
CV_StsKernelStructContentErr= -30, /**< incorr. transform kernel content */
149+
CV_StsFilterStructContentErr= -29, /**< incorrect filter structure content */
150+
CV_StsKernelStructContentErr= -30, /**< incorrect transform kernel content */
151151
CV_StsFilterOffsetErr= -31, /**< incorrect filter offset value */
152152
CV_StsBadSize= -201, /**< the input/output structure size is incorrect */
153153
CV_StsDivByZero= -202, /**< division by zero */
@@ -163,14 +163,14 @@ enum {
163163
CV_StsParseError= -212, /**< invalid syntax/structure of the parsed file */
164164
CV_StsNotImplemented= -213, /**< the requested function/feature is not implemented */
165165
CV_StsBadMemBlock= -214, /**< an allocated block has been corrupted */
166-
CV_StsAssert= -215, /**< assertion failed */
167-
CV_GpuNotSupported= -216,
168-
CV_GpuApiCallError= -217,
169-
CV_OpenGlNotSupported= -218,
170-
CV_OpenGlApiCallError= -219,
171-
CV_OpenCLApiCallError= -220,
166+
CV_StsAssert= -215, /**< assertion failed */
167+
CV_GpuNotSupported= -216, /**< no CUDA support */
168+
CV_GpuApiCallError= -217, /**< GPU API call error */
169+
CV_OpenGlNotSupported= -218, /**< no OpenGL support */
170+
CV_OpenGlApiCallError= -219, /**< OpenGL API call error */
171+
CV_OpenCLApiCallError= -220, /**< OpenCL API call error */
172172
CV_OpenCLDoubleNotSupported= -221,
173-
CV_OpenCLInitError= -222,
173+
CV_OpenCLInitError= -222, /**< OpenCL initialization error */
174174
CV_OpenCLNoAMDBlasFft= -223
175175
};
176176

0 commit comments

Comments
 (0)