diff --git a/TODO b/TODO index f2a0a90f..09878425 100644 --- a/TODO +++ b/TODO @@ -1,4 +1,4 @@ -- vips_compass() needs docs +- fix gtk-doc, again - cpp bandjoin should use bandjoin_const() where possible ... currently uses new_from_image diff --git a/libvips/convolution/compass.c b/libvips/convolution/compass.c index bc140a76..2b9d3861 100644 --- a/libvips/convolution/compass.c +++ b/libvips/convolution/compass.c @@ -204,6 +204,30 @@ vips_compass_init( VipsCompass *compass ) compass->cluster = 1; } +/** + * vips_compass: + * @in: input image + * @out: output image + * @mask: convolve with this mask + * @...: %NULL-terminated list of optional named arguments + * + * Optional arguments: + * + * * @times: %gint, how many times to rotate and convolve + * * @angle: #VipsAngle45, rotate mask by this much between colvolutions + * * @combine: #VipsCombine, combine results like this + * * @precision: #VipsPrecision, precision for blur, default float + * * @layers: %gint, number of layers for approximation + * * @cluster: %gint, cluster lines closer than this distance + * + * This convolves @in with @mask @times times, rotating @mask by @angle + * each time. By default, it comvolves twice, rotating by 90 degrees, taking + * the maximum result. + * + * See also: vips_conv(). + * + * Returns: 0 on success, -1 on error. + */ int vips_compass( VipsImage *in, VipsImage **out, VipsImage *mask, ... ) { diff --git a/libvips/convolution/gaussblur.c b/libvips/convolution/gaussblur.c index d5bfc29a..c64833a4 100644 --- a/libvips/convolution/gaussblur.c +++ b/libvips/convolution/gaussblur.c @@ -167,7 +167,7 @@ vips_gaussblur_init( VipsGaussblur *gaussblur ) * * Optional arguments: * - * * @precision: #VipsPrecision for blur, default VIPS_PRECISION_INTEGER + * * @precision: #VipsPrecision, precision for blur, default int * * @min_ampl: minimum amplitude, default 0.2 * * This operator runs vips_gaussmat() and vips_convsep() for you on an image.