ext/RMagick/rmkinfo.c in rmagick-4.1.0.rc2 vs ext/RMagick/rmkinfo.c in rmagick-4.1.0
- old
+ new
@@ -26,30 +26,23 @@
}
/**
* Create a KernelInfo object.
*
- * No Ruby usage (internal function)
- *
- * @param class the Ruby class to use
- * @return a new KernelInfo object
+ * @return [Magick::KernelInfo] a new KernelInfo object
*/
VALUE
KernelInfo_alloc(VALUE class)
{
return Data_Wrap_Struct(class, NULL, rm_kernel_info_destroy, NULL);
}
/**
* KernelInfo object constructor
*
- * Ruby usage:
- * - @verbatim KernelInfo#initialize @endverbatim
- *
- * @param self this object
- * @param kernel_string kernel info string representation to be parsed
- * @return self
+ * @param kernel_string [String] kernel info string representation to be parsed
+ * @return [Magick::KernelInfo] self
*/
VALUE
KernelInfo_initialize(VALUE self, VALUE kernel_string)
{
KernelInfo *kernel;
@@ -64,11 +57,11 @@
kernel = AcquireKernelInfo(StringValueCStr(kernel_string), exception);
if (rm_should_raise_exception(exception, DestroyExceptionRetention))
{
if (kernel != (KernelInfo *) NULL)
{
- (void) DestroyKernelInfo(kernel);
+ DestroyKernelInfo(kernel);
}
rm_raise_exception(exception);
}
#else
kernel = AcquireKernelInfo(StringValueCStr(kernel_string));
@@ -86,47 +79,34 @@
/**
* Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled and normalized Kernel.
*
- * Ruby usage:
- * - @verbatim KernelInfo#unity_add(scale) @endverbatim
- *
- * @param self this object
- * @param scale scale to add
+ * @param scale [Numeric] scale to add
*/
-
-/* UnityAddKernelInfo() was private function until IM 6.9 */
-MagickExport void UnityAddKernelInfo(KernelInfo *kernel, const double scale);
-
VALUE
KernelInfo_unity_add(VALUE self, VALUE scale)
{
if (!FIXNUM_P(scale))
Check_Type(scale, T_FLOAT);
+ /* UnityAddKernelInfo() was private function until IM 6.9 */
+ MagickExport void UnityAddKernelInfo(KernelInfo *kernel, const double scale);
+
UnityAddKernelInfo((KernelInfo*)DATA_PTR(self), NUM2DBL(scale));
return Qnil;
}
/**
* Scales the given kernel list by the given amount, with or without normalization
* of the sum of the kernel values (as per given flags).
*
- * Ruby usage:
- * - @verbatim KernelInfo#scale(scale, flags) @endverbatim
- *
- * @param scale scale to use
- * @param flags one of Magick::NormalizeValue, Magick::CorrelateNormalizeValue,
- * and/or Magick::PercentValue
- * @param self this object
+ * @param scale [Numeric] scale to use
+ * @param flags [Magick::GeometryFlags] one of Magick::NormalizeValue, Magick::CorrelateNormalizeValue,
+ * and/or Magick::PercentValue
*/
-
-/* ScaleKernelInfo() was private function until IM 6.9 */
-MagickExport void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor,const GeometryFlags normalize_flags);
-
VALUE
KernelInfo_scale(VALUE self, VALUE scale, VALUE flags)
{
GeometryFlags geoflags;
@@ -136,23 +116,22 @@
if (rb_obj_is_instance_of(flags, Class_GeometryFlags))
VALUE_TO_ENUM(flags, geoflags, GeometryFlags);
else
rb_raise(rb_eArgError, "expected Integer or Magick::GeometryFlags to specify flags");
+ /* ScaleKernelInfo() was private function until IM 6.9 */
+ MagickExport void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor, const GeometryFlags normalize_flags);
+
ScaleKernelInfo((KernelInfo*)DATA_PTR(self), NUM2DBL(scale), geoflags);
return Qnil;
}
/**
- * Takes a geometry argument string, typically provided as a "-set option:convolve:scale {geometry}" user setting,
+ * Takes a geometry argument string, typically provided as a +-set option:convolve:scale {geometry}+ user setting,
* and modifies the kernel according to the parsed arguments of that setting.
*
- * Ruby usage:
- * - @verbatim KernelInfo#scale_geometry(geometry) @endverbatim
- *
- * @param geometry geometry string to parse and apply
- * @param self this object
+ * @param geometry [String] geometry string to parse and apply
*/
VALUE
KernelInfo_scale_geometry(VALUE self, VALUE geometry)
{
Check_Type(geometry, T_STRING);
@@ -161,15 +140,11 @@
}
/**
* Creates a new clone of the object so that its can be modified without effecting the original.
*
- * Ruby usage:
- * - @verbatim KernelInfo#clone @endverbatim
- *
- * @param self this object
- * @return new KernelInfo instance
+ * @return [Magick::KernelInfo] new KernelInfo object
*/
VALUE
KernelInfo_clone(VALUE self)
{
KernelInfo *kernel = CloneKernelInfo((KernelInfo*)DATA_PTR(self));
@@ -179,54 +154,13 @@
/**
* Create new instance of KernelInfo with one of the 'named' built-in types of
* kernels used for special purposes such as gaussian blurring, skeleton
* pruning, and edge distance determination.
*
- * Ruby usage:
- * - @verbatim KernelInfo.builtin(kernel, geometry = nil) @endverbatim
- *
- * @parms kernel one of Magick::KernelInfoType enums:
- * Magick::UndefinedKernel
- * Magick::UnityKernel
- * Magick::GaussianKernel
- * Magick::DoGKernel
- * Magick::LoGKernel
- * Magick::BlurKernel
- * Magick::CometKernel
- * Magick::LaplacianKernel
- * Magick::SobelKernel
- * Magick::FreiChenKernel
- * Magick::RobertsKernel
- * Magick::PrewittKernel
- * Magick::CompassKernel
- * Magick::KirschKernel
- * Magick::DiamondKernel
- * Magick::SquareKernel
- * Magick::RectangleKernel
- * Magick::OctagonKernel
- * Magick::DiskKernel
- * Magick::PlusKernel
- * Magick::CrossKernel
- * Magick::RingKernel
- * Magick::PeaksKernel
- * Magick::EdgesKernel
- * Magick::CornersKernel
- * Magick::DiagonalsKernel
- * Magick::LineEndsKernel
- * Magick::LineJunctionsKernel
- * Magick::RidgesKernel
- * Magick::ConvexHullKernel
- * Magick::ThinSEKernel
- * Magick::SkeletonKernel
- * Magick::ChebyshevKernel
- * Magick::ManhattanKernel
- * Magick::OctagonalKernel
- * Magick::EuclideanKernel
- * Magick::UserDefinedKernel
- * Magick::BinomialKernel
- * @param geometry geometry to pass to default kernel
- * @return KernelInfo instance
+ * @param what [Magick::KernelInfoType] kernel one of Magick::KernelInfoType enums
+ * @param geometry [String] geometry to pass to default kernel
+ * @return [Magick::KernelInfo] a new KernelInfo object
*/
VALUE
KernelInfo_builtin(VALUE self, VALUE what, VALUE geometry)
{
KernelInfo *kernel;
@@ -245,10 +179,10 @@
kernel = AcquireKernelBuiltIn(kernel_type, &info, exception);
if (rm_should_raise_exception(exception, DestroyExceptionRetention))
{
if (kernel != (KernelInfo *) NULL)
{
- (void) DestroyKernelInfo(kernel);
+ DestroyKernelInfo(kernel);
}
rm_raise_exception(exception);
}
#else
kernel = AcquireKernelBuiltIn(kernel_type, &info);