From 2eed3ea45f3291c88746dfe983de28607763afdd Mon Sep 17 00:00:00 2001 From: John Cupitt Date: Mon, 21 Oct 2019 20:58:59 +0100 Subject: [PATCH] add more types to optional args thanks augustocdias see https://github.com/libvips/libvips/issues/1449#issue-509081179 --- libvips/foreign/foreign.c | 2 +- libvips/foreign/pngsave.c | 30 ++++++++++++++--------------- libvips/foreign/tiffsave.c | 39 ++++++++++++++++++-------------------- 3 files changed, 34 insertions(+), 37 deletions(-) diff --git a/libvips/foreign/foreign.c b/libvips/foreign/foreign.c index a48591ad..540a2ffa 100644 --- a/libvips/foreign/foreign.c +++ b/libvips/foreign/foreign.c @@ -1628,7 +1628,7 @@ vips_foreign_save_class_init( VipsForeignSaveClass *class ) G_STRUCT_OFFSET( VipsForeignSave, background ), VIPS_TYPE_ARRAY_DOUBLE ); - VIPS_ARG_INT( class, "page_height", 8, + VIPS_ARG_INT( class, "page_height", 102, _( "Page height" ), _( "Set page height for multipage save" ), VIPS_ARGUMENT_OPTIONAL_INPUT, diff --git a/libvips/foreign/pngsave.c b/libvips/foreign/pngsave.c index ab576248..a193d485 100644 --- a/libvips/foreign/pngsave.c +++ b/libvips/foreign/pngsave.c @@ -312,14 +312,14 @@ vips_foreign_save_png_buffer_init( VipsForeignSavePngBuffer *buffer ) * * Optional arguments: * - * * @compression: compression level - * * @interlace: interlace image - * * @profile: ICC profile to embed + * * @compression: %gint, compression level + * * @interlace: %gboolean, interlace image + * * @profile: %gchararray, ICC profile to embed * * @filter: #VipsForeignPngFilter row filter flag(s) - * * @palette: enable quantisation to 8bpp palette - * * @colours: max number of palette colours for quantisation - * * @Q: quality for 8bpp quantisation (does not exceed @colours) - * * @dither: amount of dithering for 8bpp quantization + * * @palette: %gboolean, enable quantisation to 8bpp palette + * * @colours: %gint, max number of palette colours for quantisation + * * @Q: %gint, quality for 8bpp quantisation (does not exceed @colours) + * * @dither: %gdouble, amount of dithering for 8bpp quantization * * Write a VIPS image to a file as PNG. * @@ -381,14 +381,14 @@ vips_pngsave( VipsImage *in, const char *filename, ... ) * * Optional arguments: * - * * @compression: compression level - * * @interlace: interlace image - * * @profile: ICC profile to embed - * * @filter: libpng row filter flag(s) - * * @palette: enable quantisation to 8bpp palette - * * @colours: max number of palette colours for quantisation - * * @Q: quality for 8bpp quantisation (does not exceed @colours) - * * @dither: amount of dithering for 8bpp quantization + * * @compression: %gint, compression level + * * @interlace: %gboolean, interlace image + * * @profile: %gchararray, ICC profile to embed + * * @filter: #VipsForeignPngFilter row filter flag(s) + * * @palette: %gboolean, enable quantisation to 8bpp palette + * * @colours: %gint, max number of palette colours for quantisation + * * @Q: %gint, quality for 8bpp quantisation (does not exceed @colours) + * * @dither: %gdouble, amount of dithering for 8bpp quantization * * As vips_pngsave(), but save to a memory buffer. * diff --git a/libvips/foreign/tiffsave.c b/libvips/foreign/tiffsave.c index 341193cc..cf6ec9bc 100644 --- a/libvips/foreign/tiffsave.c +++ b/libvips/foreign/tiffsave.c @@ -469,7 +469,8 @@ vips_foreign_save_tiff_buffer_build( VipsObject *object ) } static void -vips_foreign_save_tiff_buffer_class_init( VipsForeignSaveTiffBufferClass *class ) +vips_foreign_save_tiff_buffer_class_init( + VipsForeignSaveTiffBufferClass *class ) { GObjectClass *gobject_class = G_OBJECT_CLASS( class ); VipsObjectClass *object_class = (VipsObjectClass *) class; @@ -507,23 +508,21 @@ vips_foreign_save_tiff_buffer_init( VipsForeignSaveTiffBuffer *buffer ) * * @compression: use this #VipsForeignTiffCompression * * @Q: %gint quality factor * * @predictor: use this #VipsForeignTiffPredictor - * * @profile: filename of ICC profile to attach - * * @tile: set %TRUE to write a tiled tiff + * * @profile: %gchararray, filename of ICC profile to attach + * * @tile: %gboolean, set %TRUE to write a tiled tiff * * @tile_width: %gint for tile size * * @tile_height: %gint for tile size - * * @pyramid: set %TRUE to write an image pyramid - * * @squash: set %TRUE to squash 8-bit images down to 1 bit - * * @miniswhite: set %TRUE to write 1-bit images as MINISWHITE + * * @pyramid: %gboolean, write an image pyramid + * * @squash: %gboolean, squash 8-bit images down to 1 bit + * * @miniswhite: %gboolean, write 1-bit images as MINISWHITE * * @resunit: #VipsForeignTiffResunit for resolution unit * * @xres: %gdouble horizontal resolution in pixels/mm * * @yres: %gdouble vertical resolution in pixels/mm - * * @bigtiff: set %TRUE to write a BigTiff file - * * @properties: set %TRUE to write an IMAGEDESCRIPTION tag - * * @strip: set %TRUE to block metadata save - * * @page_height: %gint for page height for multi-page save + * * @bigtiff: %gboolean, write a BigTiff file + * * @properties: %gboolean, set %TRUE to write an IMAGEDESCRIPTION tag * * @region_shrink: #VipsRegionShrink How to shrink each 2x2 region. * * @level: %gint, Zstd compression level - * * @lossless: set %TRUE for WebP losssless mode + * * @lossless: %gboolean, WebP losssless mode * * Write a VIPS image to a file as TIFF. * @@ -626,23 +625,21 @@ vips_tiffsave( VipsImage *in, const char *filename, ... ) * * @compression: use this #VipsForeignTiffCompression * * @Q: %gint quality factor * * @predictor: use this #VipsForeignTiffPredictor - * * @profile: filename of ICC profile to attach - * * @tile: set %TRUE to write a tiled tiff + * * @profile: %gchararray, filename of ICC profile to attach + * * @tile: %gboolean, set %TRUE to write a tiled tiff * * @tile_width: %gint for tile size * * @tile_height: %gint for tile size - * * @pyramid: set %TRUE to write an image pyramid - * * @squash: set %TRUE to squash 8-bit images down to 1 bit - * * @miniswhite: set %TRUE to write 1-bit images as MINISWHITE + * * @pyramid: %gboolean, write an image pyramid + * * @squash: %gboolean, squash 8-bit images down to 1 bit + * * @miniswhite: %gboolean, write 1-bit images as MINISWHITE * * @resunit: #VipsForeignTiffResunit for resolution unit * * @xres: %gdouble horizontal resolution in pixels/mm * * @yres: %gdouble vertical resolution in pixels/mm - * * @bigtiff: set %TRUE to write a BigTiff file - * * @properties: set %TRUE to write an IMAGEDESCRIPTION tag - * * @strip: set %TRUE to block metadata save - * * @page_height: %gint for page height for multi-page save + * * @bigtiff: %gboolean, write a BigTiff file + * * @properties: %gboolean, set %TRUE to write an IMAGEDESCRIPTION tag * * @region_shrink: #VipsRegionShrink How to shrink each 2x2 region. * * @level: %gint, Zstd compression level - * * @lossless: set %TRUE for WebP losssless mode + * * @lossless: %gboolean, WebP losssless mode * * As vips_tiffsave(), but save to a memory buffer. *