kotovalexarian-likes-github/ruby-opencv
1
0
Fork 0
mirror of https://github.com/ruby-opencv/ruby-opencv synced 2023-03-27 23:22:12 -04:00
Code Releases Activity

fix documentation warnings

Browse source
This commit is contained in:
ser1zw 2016-05-02 03:39:01 +09:00
parent c2f7aa3766
commit 9650602eef
5 changed files with 67 additions and 67 deletions
Download patch file Download diff file Expand all files Collapse all files

26
ext/opencv/mat.cpp
View file

@ -878,9 +878,9 @@ namespace rubyopencv {
* Scales, computes absolute values, and converts the result to 8-bit. * Scales, computes absolute values, and converts the result to 8-bit.
* *
* @overload convert_scale_abs(alpha = 1, beta = 0) * @overload convert_scale_abs(alpha = 1, beta = 0)
* @param alpha [Number] Optional scale factor. * @param alpha [Number] Optional scale factor.
* @param beta [Number] Optional delta added to the scaled values. * @param beta [Number] Optional delta added to the scaled values.
* @return [Mat] Output array * @return [Mat] Output array
* @opencv_func cv::convertScaleAbs * @opencv_func cv::convertScaleAbs
*/ */
VALUE rb_convert_scale_abs(int argc, VALUE *argv, VALUE self) { VALUE rb_convert_scale_abs(int argc, VALUE *argv, VALUE self) {
@ -906,12 +906,12 @@ namespace rubyopencv {
* Converts an array to another data type with optional scaling. * Converts an array to another data type with optional scaling.
* *
* @overload convert_to(rtype, alpha = 1, beta = 0) * @overload convert_to(rtype, alpha = 1, beta = 0)
* @param rtype [Integer] Desired output matrix type or, rather, the depth * @param rtype [Integer] Desired output matrix type or, rather, the depth
* since the number of channels are the same as the input has; * since the number of channels are the same as the input has;
* if rtype is negative, the output matrix will have the same type as the input. * if rtype is negative, the output matrix will have the same type as the input.
* @param alpha [Number] Optional scale factor. * @param alpha [Number] Optional scale factor.
* @param beta [Number] Optional delta added to the scaled values. * @param beta [Number] Optional delta added to the scaled values.
* @return [Mat] Output array * @return [Mat] Output array
* @opencv_func cv::convertTo * @opencv_func cv::convertTo
*/ */
VALUE rb_convert_to(int argc, VALUE *argv, VALUE self) { VALUE rb_convert_to(int argc, VALUE *argv, VALUE self) {
@ -937,8 +937,8 @@ namespace rubyopencv {
* Initializes a scaled identity matrix. * Initializes a scaled identity matrix.
* *
* @overload set_identity(s = Scalar.new(1)) * @overload set_identity(s = Scalar.new(1))
* @param s [Scalar] Value to assign to diagonal elements. * @param s [Scalar] Value to assign to diagonal elements.
* @return [Mat] +self+ * @return [Mat] +self+
* @opencv_func cv::setIdentity * @opencv_func cv::setIdentity
*/ */
VALUE rb_set_identity(int argc, VALUE *argv, VALUE self) { VALUE rb_set_identity(int argc, VALUE *argv, VALUE self) {
@ -988,8 +988,8 @@ namespace rubyopencv {
* The function merge merges several arrays to make a single multi-channel array. * The function merge merges several arrays to make a single multi-channel array.
* *
* @overload merge(mv) * @overload merge(mv)
* @param mv [Array<Mat>] Input array of matrices to be merged; all the matrices in mv must have the same size and the same depth. * @param mv [Array<Mat>] Input array of matrices to be merged; all the matrices in mv must have the same size and the same depth.
* @return [Mat] Output array of the same size and the same depth as mv[0]; The number of channels will be equal to the parameter count. * @return [Mat] Output array of the same size and the same depth as mv[0]; The number of channels will be equal to the parameter count.
* @!scope class * @!scope class
* @opencv_func cv::merge * @opencv_func cv::merge
*/ */

8
ext/opencv/rect.cpp
View file

@ -130,8 +130,8 @@ namespace rubyopencv {
* Set width * Set width
* *
* @overload width=(value) * @overload width=(value)
* @param value [Integer] Width * @param value [Integer] Width
* @return [Rect] +self+ * @return [Rect] +self+
*/ */
VALUE rb_set_width(VALUE self, VALUE width) { VALUE rb_set_width(VALUE self, VALUE width) {
obj2rect(self)->width = NUM2INT(width); obj2rect(self)->width = NUM2INT(width);
@ -152,8 +152,8 @@ namespace rubyopencv {
* Set height * Set height
* *
* @overload height=(value) * @overload height=(value)
* @param value [Integer] Height * @param value [Integer] Height
* @return [Rect] +self+ * @return [Rect] +self+
*/ */
VALUE rb_set_height(VALUE self, VALUE height) { VALUE rb_set_height(VALUE self, VALUE height) {
obj2rect(self)->height = NUM2INT(height); obj2rect(self)->height = NUM2INT(height);

10
ext/opencv/scalar.cpp
View file

@ -48,11 +48,11 @@ namespace rubyopencv {
* Creates a new Scalar. * Creates a new Scalar.
* *
* @overload new(v0 = 0, v1 = 0, v2 = 0, v3 = 0) * @overload new(v0 = 0, v1 = 0, v2 = 0, v3 = 0)
* @param v0 [Number] Value 0 * @param v0 [Number] Value 0
* @param v1 [Number] Value 1 * @param v1 [Number] Value 1
* @param v2 [Number] Value 2 * @param v2 [Number] Value 2
* @param v3 [Number] Value 3 * @param v3 [Number] Value 3
* @return [Scalar] +self+ * @return [Scalar] +self+
*/ */
VALUE rb_initialize(int argc, VALUE *argv, VALUE self) { VALUE rb_initialize(int argc, VALUE *argv, VALUE self) {
const int SIZE = 4; const int SIZE = 4;

8
ext/opencv/size.cpp
View file

@ -56,8 +56,8 @@ namespace rubyopencv {
* Set width * Set width
* *
* @overload width=(value) * @overload width=(value)
* @param value [Integer] Width * @param value [Integer] Width
* @return [Mat] +self+ * @return [Mat] +self+
*/ */
VALUE rb_set_width(VALUE self, VALUE width) { VALUE rb_set_width(VALUE self, VALUE width) {
obj2size(self)->width = NUM2INT(width); obj2size(self)->width = NUM2INT(width);
@ -78,8 +78,8 @@ namespace rubyopencv {
* Set height * Set height
* *
* @overload height=(value) * @overload height=(value)
* @param value [Integer] Height * @param value [Integer] Height
* @return [Mat] +self+ * @return [Mat] +self+
*/ */
VALUE rb_set_height(VALUE self, VALUE height) { VALUE rb_set_height(VALUE self, VALUE height) {
obj2size(self)->height = NUM2INT(height); obj2size(self)->height = NUM2INT(height);

82
ext/opencv/videocapture.cpp
View file

@ -147,26 +147,26 @@ namespace rubyopencv {
* Returns the specified VideoCapture property. * Returns the specified VideoCapture property.
* *
* @overload get(prop_id) * @overload get(prop_id)
* @param prop_id [Integer] Property identifier. It can be one of the following: * @param prop_id [Integer] Property identifier. It can be one of the following:
* - CAP_PROP_POS_MSEC - Current position of the video file in milliseconds. * - CAP_PROP_POS_MSEC - Current position of the video file in milliseconds.
* - CAP_PROP_POS_FRAMES - 0-based index of the frame to be decoded/captured next. * - CAP_PROP_POS_FRAMES - 0-based index of the frame to be decoded/captured next.
* - CAP_PROP_POS_AVI_RATIO - Relative position of the video file: 0 - start of the film, 1 - end of the film. * - CAP_PROP_POS_AVI_RATIO - Relative position of the video file: 0 - start of the film, 1 - end of the film.
* - CAP_PROP_FRAME_WIDTH - Width of the frames in the video stream. * - CAP_PROP_FRAME_WIDTH - Width of the frames in the video stream.
* - CAP_PROP_FRAME_HEIGHT - Height of the frames in the video stream. * - CAP_PROP_FRAME_HEIGHT - Height of the frames in the video stream.
* - CAP_PROP_FPS - Frame rate. * - CAP_PROP_FPS - Frame rate.
* - CAP_PROP_FOURCC - 4-character code of codec. * - CAP_PROP_FOURCC - 4-character code of codec.
* - CAP_PROP_FRAME_COUNT - Number of frames in the video file. * - CAP_PROP_FRAME_COUNT - Number of frames in the video file.
* - CAP_PROP_FORMAT - Format of the Mat objects returned by retrieve() . * - CAP_PROP_FORMAT - Format of the Mat objects returned by retrieve() .
* - CAP_PROP_MODE - Backend-specific value indicating the current capture mode. * - CAP_PROP_MODE - Backend-specific value indicating the current capture mode.
* - CAP_PROP_BRIGHTNESS - Brightness of the image (only for cameras). * - CAP_PROP_BRIGHTNESS - Brightness of the image (only for cameras).
* - CAP_PROP_CONTRAST - Contrast of the image (only for cameras). * - CAP_PROP_CONTRAST - Contrast of the image (only for cameras).
* - CAP_PROP_SATURATION - Saturation of the image (only for cameras). * - CAP_PROP_SATURATION - Saturation of the image (only for cameras).
* - CAP_PROP_HUE - Hue of the image (only for cameras). * - CAP_PROP_HUE - Hue of the image (only for cameras).
* - CAP_PROP_GAIN - Gain of the image (only for cameras). * - CAP_PROP_GAIN - Gain of the image (only for cameras).
* - CAP_PROP_EXPOSURE - Exposure (only for cameras). * - CAP_PROP_EXPOSURE - Exposure (only for cameras).
* - CAP_PROP_CONVERT_RGB - Boolean flags indicating whether images should be converted to RGB. * - CAP_PROP_CONVERT_RGB - Boolean flags indicating whether images should be converted to RGB.
* - CAP_PROP_WHITE_BALANCE - Currently unsupported * - CAP_PROP_WHITE_BALANCE - Currently unsupported
* - CAP_PROP_RECTIFICATION - Rectification flag for stereo cameras (note: only supported by DC1394 v 2.x backend currently) * - CAP_PROP_RECTIFICATION - Rectification flag for stereo cameras (note: only supported by DC1394 v 2.x backend currently)
* @return [Number] VideoCapture property * @return [Number] VideoCapture property
* @opencv_func cv::VideoCapture::get * @opencv_func cv::VideoCapture::get
*/ */
@ -178,27 +178,27 @@ namespace rubyopencv {
* Sets a property in the VideoCapture. * Sets a property in the VideoCapture.
* *
* @overload set(prop_id, value) * @overload set(prop_id, value)
* @param prop_id [Integer] Property identifier. It can be one of the following: * @param prop_id [Integer] Property identifier. It can be one of the following:
* - CAP_PROP_POS_MSEC - Current position of the video file in milliseconds. * - CAP_PROP_POS_MSEC - Current position of the video file in milliseconds.
* - CAP_PROP_POS_FRAMES - 0-based index of the frame to be decoded/captured next. * - CAP_PROP_POS_FRAMES - 0-based index of the frame to be decoded/captured next.
* - CAP_PROP_POS_AVI_RATIO - Relative position of the video file: 0 - start of the film, 1 - end of the film. * - CAP_PROP_POS_AVI_RATIO - Relative position of the video file: 0 - start of the film, 1 - end of the film.
* - CAP_PROP_FRAME_WIDTH - Width of the frames in the video stream. * - CAP_PROP_FRAME_WIDTH - Width of the frames in the video stream.
* - CAP_PROP_FRAME_HEIGHT - Height of the frames in the video stream. * - CAP_PROP_FRAME_HEIGHT - Height of the frames in the video stream.
* - CAP_PROP_FPS - Frame rate. * - CAP_PROP_FPS - Frame rate.
* - CAP_PROP_FOURCC - 4-character code of codec. * - CAP_PROP_FOURCC - 4-character code of codec.
* - CAP_PROP_FRAME_COUNT - Number of frames in the video file. * - CAP_PROP_FRAME_COUNT - Number of frames in the video file.
* - CAP_PROP_FORMAT - Format of the Mat objects returned by retrieve() . * - CAP_PROP_FORMAT - Format of the Mat objects returned by retrieve() .
* - CAP_PROP_MODE - Backend-specific value indicating the current capture mode. * - CAP_PROP_MODE - Backend-specific value indicating the current capture mode.
* - CAP_PROP_BRIGHTNESS - Brightness of the image (only for cameras). * - CAP_PROP_BRIGHTNESS - Brightness of the image (only for cameras).
* - CAP_PROP_CONTRAST - Contrast of the image (only for cameras). * - CAP_PROP_CONTRAST - Contrast of the image (only for cameras).
* - CAP_PROP_SATURATION - Saturation of the image (only for cameras). * - CAP_PROP_SATURATION - Saturation of the image (only for cameras).
* - CAP_PROP_HUE - Hue of the image (only for cameras). * - CAP_PROP_HUE - Hue of the image (only for cameras).
* - CAP_PROP_GAIN - Gain of the image (only for cameras). * - CAP_PROP_GAIN - Gain of the image (only for cameras).
* - CAP_PROP_EXPOSURE - Exposure (only for cameras). * - CAP_PROP_EXPOSURE - Exposure (only for cameras).
* - CAP_PROP_CONVERT_RGB - Boolean flags indicating whether images should be converted to RGB. * - CAP_PROP_CONVERT_RGB - Boolean flags indicating whether images should be converted to RGB.
* - CAP_PROP_WHITE_BALANCE - Currently unsupported * - CAP_PROP_WHITE_BALANCE - Currently unsupported
* - CAP_PROP_RECTIFICATION - Rectification flag for stereo cameras (note: only supported by DC1394 v 2.x backend currently) * - CAP_PROP_RECTIFICATION - Rectification flag for stereo cameras (note: only supported by DC1394 v 2.x backend currently)
* @param value [Number] Value of the property * @param value [Number] Value of the property
* @return [Boolean] Result * @return [Boolean] Result
* @opencv_func cv::VideoCapture::set * @opencv_func cv::VideoCapture::set
*/ */