sergiotarxz/libvips
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

make optional args into bullets

Browse Source 
make docs easier to read
This commit is contained in:
John Cupitt 2016-05-02 10:12:37 +01:00
parent 48ef215479
commit 1ae92bb15f
91 changed files with 362 additions and 364 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
libvips/arithmetic/hist_find.c
View File

@ -475,7 +475,7 @@ vips_hist_find_init( VipsHistFind *hist_find )
*
* Optional arguments:
*
* @band: band to equalise
* * @band: band to equalise
*
* Find the histogram of @in. Find the histogram for band @band (producing a
* one-band histogram), or for all bands (producing an n-band histogram) if

2
libvips/arithmetic/hist_find_ndim.c
View File

@ -323,7 +323,7 @@ vips_hist_find_ndim_init( VipsHistFindNDim *ndim )
*
* Optional arguments:
*
* @bins: number of bins to make on each axis
* * @bins: number of bins to make on each axis
*
* Make a one, two or three dimensional histogram of a 1, 2 or
* 3 band image. Divide each axis into @bins bins .. ie.

6
libvips/arithmetic/hough_circle.c
View File

@ -275,9 +275,9 @@ vips_hough_circle_init( VipsHoughCircle *hough_circle )
*
* Optional arguments:
*
* @scale: scale down dimensions by this much
* @min_radius: smallest radius to search for
* @max_radius: largest radius to search for
* * @scale: scale down dimensions by this much
* * @min_radius: smallest radius to search for
* * @max_radius: largest radius to search for
*
* Find the circular Hough transform of an image. @in must be one band, with
* non-zero pixels for image edges. @out is three-band, with the third channel

4
libvips/arithmetic/hough_line.c
View File

@ -169,8 +169,8 @@ vips_hough_line_init( VipsHoughLine *hough_line )
*
* Optional arguments:
*
* @width: horizontal size of parameter space
* @height: vertical size of parameter space
* * @width: horizontal size of parameter space
* * @height: vertical size of parameter space
*
* Find the line Hough transform for @in. @in must have one band. @out has one
* band, with pixels being the number of votes for that line. The X dimension

4
libvips/arithmetic/linear.c
View File

@ -448,7 +448,7 @@ vips_linearv( VipsImage *in, VipsImage **out,
*
* Optional arguments:
*
* @uchar: output uchar pixels
* * @uchar: output uchar pixels
*
* Pass an image through a linear transform, ie. (@out = @in * @a + @b). Output
* is float for integer input, double for double input, complex for
@ -489,7 +489,7 @@ vips_linear( VipsImage *in, VipsImage **out, double *a, double *b, int n, ... )
*
* Optional arguments:
*
* @uchar: output uchar pixels
* * @uchar: output uchar pixels
*
* Run vips_linear() with a single constant.
*

12
libvips/arithmetic/max.c
View File

@ -486,12 +486,12 @@ vips_max_init( VipsMax *max )
*
* Optional arguments:
*
* @x: horizontal position of maximum
* @y: vertical position of maximum
* @size: number of maxima to find
* @out_array: return array of maximum values
* @x_array: corresponding horizontal positions
* @y_array: corresponding vertical positions
* * @x: horizontal position of maximum
* * @y: vertical position of maximum
* * @size: number of maxima to find
* * @out_array: return array of maximum values
* * @x_array: corresponding horizontal positions
* * @y_array: corresponding vertical positions
*
* This operation finds the maximum value in an image.
*

8
libvips/arithmetic/measure.c
View File

@ -269,10 +269,10 @@ vips_measure_init( VipsMeasure *measure )
*
* Optional arguments:
*
* @left: area of image containing chart
* @top: area of image containing chart
* @width: area of image containing chart
* @height: area of image containing chart
* * @left: area of image containing chart
* * @top: area of image containing chart
* * @width: area of image containing chart
* * @height: area of image containing chart
*
* Analyse a grid of colour patches, producing an array of patch averages.
* The mask has a row for each measured patch and a column for each image

12
libvips/arithmetic/min.c
View File

@ -489,12 +489,12 @@ vips_min_init( VipsMin *min )
*
* Optional arguments:
*
* @x: horizontal position of minimum
* @y: vertical position of minimum
* @size: number of minima to find
* @out_array: return array of minimum values
* @x_array: corresponding horizontal positions
* @y_array: corresponding vertical positions
* * @x: horizontal position of minimum
* * @y: vertical position of minimum
* * @size: number of minima to find
* * @out_array: return array of minimum values
* * @x_array: corresponding horizontal positions
* * @y_array: corresponding vertical positions
*
* This operation finds the minimum value in an image.
*

2
libvips/colour/colourspace.c
View File

@ -625,7 +625,7 @@ vips_colourspace_init( VipsColourspace *colourspace )
*
* Optional arguments:
*
* @source_space: input colour space
* * @source_space: input colour space
*
* This operation looks at the interpretation field of @in (or uses
* @source_space, if set) and runs

24
libvips/colour/icc_transform.c
View File

@ -1255,10 +1255,10 @@ vips_icc_ac2rc( VipsImage *in, VipsImage **out, const char *profile_filename )
*
* Optional arguments:
*
* @input_profile: get the input profile from here
* @intent: transform with this intent
* @embedded: use profile embedded in input image
* @pcs: use XYZ or LAB PCS
* * @input_profile: get the input profile from here
* * @intent: transform with this intent
* * @embedded: use profile embedded in input image
* * @pcs: use XYZ or LAB PCS
*
* Import an image from device space to D65 LAB with an ICC profile. If @pcs is
* set to #VIPS_PCS_XYZ, use CIE XYZ PCS instead.
@ -1294,10 +1294,10 @@ vips_icc_import( VipsImage *in, VipsImage **out, ... )
*
* Optional arguments:
*
* @intent: transform with this intent
* @depth: depth of output image in bits
* @output_profile: get the output profile from here
* @pcs: use XYZ or LAB PCS
* * @intent: transform with this intent
* * @depth: depth of output image in bits
* * @output_profile: get the output profile from here
* * @pcs: use XYZ or LAB PCS
*
* Export an image from D65 LAB to device space with an ICC profile.
* If @pcs is
@ -1330,10 +1330,10 @@ vips_icc_export( VipsImage *in, VipsImage **out, ... )
*
* Optional arguments:
*
* @input_profile: get the input profile from here
* @intent: transform with this intent
* @depth: depth of output image in bits
* @embedded: use profile embedded in input image
* * @input_profile: get the input profile from here
* * @intent: transform with this intent
* * @depth: depth of output image in bits
* * @embedded: use profile embedded in input image
*
* Transform an image with a pair of ICC profiles. The input image is moved to
* profile-connection space with the input profile and then to the output

2
libvips/colour/scRGB2BW.c
View File

@ -268,7 +268,7 @@ vips_scRGB2BW_init( VipsscRGB2BW *scRGB2BW )
*
* Optional arguments:
*
* @depth: depth of output image in bits
* * @depth: depth of output image in bits
*
* Convert an scRGB image to greyscale. Set @depth to 16 to get 16-bit output.
*

2
libvips/colour/scRGB2sRGB.c
View File

@ -296,7 +296,7 @@ vips_scRGB2sRGB_init( VipsscRGB2sRGB *scRGB2sRGB )
*
* Optional arguments:
*
* @depth: depth of output image in bits
* * @depth: depth of output image in bits
*
* Convert an scRGB image to sRGB. Set @depth to 16 to get 16-bit output.
*

14
libvips/conversion/arrayjoin.c
View File

@ -397,13 +397,13 @@ vips_arrayjoinv( VipsImage **in, VipsImage **out, int n, va_list ap )
*
* Optional arguments:
*
* @across: number of images per row
* @shim: space between images, in pixels
* @background: background ink colour
* @halign: low, centre or high alignment
* @valign: low, centre or high alignment
* @hspacing: horizontal distance between images
* @vspacing: vertical distance between images
* * @across: number of images per row
* * @shim: space between images, in pixels
* * @background: background ink colour
* * @halign: low, centre or high alignment
* * @valign: low, centre or high alignment
* * @hspacing: horizontal distance between images
* * @vspacing: vertical distance between images
*
* Lay out the images in @in in a grid. The grid is @across images across and
* however high is necessary to use up all of @in. Images are set down

2
libvips/conversion/autorot.c
View File

@ -214,7 +214,7 @@ vips_autorot_init( VipsAutorot *autorot )
*
* Optional arguments:
*
* @angle: output #VipsAngle the image was rotated by
* * @angle: output #VipsAngle the image was rotated by
*
* Look at the exif tags and rotate the image to make it upright. The
* orientation tag is removed from @out to prevent accidental double rotation.

2
libvips/conversion/bandfold.c
View File

@ -186,7 +186,7 @@ vips_bandfold_init( VipsBandfold *bandfold )
*
* Optional arguments:
*
* @factor: fold by this factor
* * @factor: fold by this factor
*
* Fold up an image horizontally: width is collapsed into bands.
* Use @factor to set how much to fold by: @factor 3, for example, will make

2
libvips/conversion/bandrank.c
View File

@ -286,7 +286,7 @@ vips_bandrankv( VipsImage **in, VipsImage **out, int n, va_list ap )
*
* Optional arguments:
*
* @index: pick this index from list of sorted values
* * @index: pick this index from list of sorted values
*
* Sorts the images @in band-element-wise, then outputs an
* image in which each band element is selected from the sorted list by the

2
libvips/conversion/bandunfold.c
View File

@ -189,7 +189,7 @@ vips_bandunfold_init( VipsBandunfold *bandunfold )
*
* Optional arguments:
*
* @factor: unfold by this factor
* * @factor: unfold by this factor
*
* Unfold image bands into x axis.
* Use @factor to set how much to unfold by: @factor 3, for example, will make

6
libvips/conversion/cache.c
View File

@ -144,9 +144,9 @@ vips_cache_init( VipsCache *cache )
*
* Optional arguments:
*
* @tile_width: width of tiles in cache
* @tile_height: height of tiles in cache
* @max_tiles: maximum number of tiles to cache
* * @tile_width: width of tiles in cache
* * @tile_height: height of tiles in cache
* * @max_tiles: maximum number of tiles to cache
*
* This operation behaves rather like vips_copy() between images
* @in and @out, except that it keeps a cache of computed pixels.

2
libvips/conversion/cast.c
View File

@ -587,7 +587,7 @@ vips_castv( VipsImage *in, VipsImage **out, VipsBandFormat format, va_list ap )
*
* Optional arguments:
*
* @shift: integer values are shifted
* * @shift: integer values are shifted
*
* Convert @in to @format. You can convert between any pair of formats.
* Floats are truncated (not rounded). Out of range values are clipped.

20
libvips/conversion/copy.c
View File

@ -366,16 +366,16 @@ vips_copy_init( VipsCopy *copy )
*
* Optional arguments:
*
* @width: set image width
* @height: set image height
* @bands: set image bands
* @format: set image format
* @coding: set image coding
* @interpretation: set image interpretation
* @xres: set image xres
* @yres: set image yres
* @xoffset: set image xoffset
* @yoffset: set image yoffset
* * @width: set image width
* * @height: set image height
* * @bands: set image bands
* * @format: set image format
* * @coding: set image coding
* * @interpretation: set image interpretation
* * @xres: set image xres
* * @yres: set image yres
* * @xoffset: set image xoffset
* * @yoffset: set image yoffset
*
* Copy an image, optionally modifying the header. VIPS copies images by
* copying pointers, so this operation is instant, even for very large images.

4
libvips/conversion/embed.c
View File

@ -627,8 +627,8 @@ vips_embed_init( VipsEmbed *embed )
*
* Optional arguments:
*
* @extend: #VipsExtend to generate the edge pixels (default: black)
* @background: #VipsArrayDouble colour for edge pixels
* * @extend: #VipsExtend to generate the edge pixels (default: black)
* * @background: #VipsArrayDouble colour for edge pixels
*
* The opposite of vips_extract_area(): embed @in within an image of size
* @width by @height at position @x, @y.

2
libvips/conversion/extract.c
View File

@ -455,7 +455,7 @@ vips_extract_band_init( VipsExtractBand *extract )
*
* Optional arguments:
*
* @n: number of bands to extract
* * @n: number of bands to extract
*
* Extract a band or bands from an image. Extracting out of range is an error.
*

4
libvips/conversion/flatten.c
View File

@ -409,8 +409,8 @@ vips_flatten_init( VipsFlatten *flatten )
*
* Optional arguments:
*
* @background: #VipsArrayDouble colour for new pixels
* @max_alpha: %gdouble, maximum value for alpha
* * @background: #VipsArrayDouble colour for new pixels
* * @max_alpha: %gdouble, maximum value for alpha
*
* Take the last band of @in as an alpha and use it to blend the
* remaining channels with @background.

2
libvips/conversion/gamma.c
View File

@ -168,7 +168,7 @@ vips_gamma_init( VipsGamma *gamma )
*
* Optional arguments:
*
* @exponent: gamma, default 1.0 / 2.4
* * @exponent: gamma, default 1.0 / 2.4
*
* Calculate @in ** (1 / @exponent), normalising to the maximum range of the
* input type. For float types use 1.0 as the maximum.

2
libvips/conversion/ifthenelse.c
View File

@ -517,7 +517,7 @@ vips_ifthenelse_init( VipsIfthenelse *ifthenelse )
*
* Optional arguments:
*
* @blend: blend smoothly between @in1 and @in2
* * @blend: blend smoothly between @in1 and @in2
*
* This operation scans the condition image @cond
* and uses it to select pixels from either the then image @in1 or the else

4
libvips/conversion/insert.c
View File

@ -573,8 +573,8 @@ vips_insert_init( VipsInsert *insert )
*
* Optional arguments:
*
* @expand: expand output to hold whole of both images
* @background: colour for new pixels
* * @expand: expand output to hold whole of both images
* * @background: colour for new pixels
*
* Insert @sub into @main at position @x, @y.
*

8
libvips/conversion/join.c
View File

@ -296,10 +296,10 @@ vips_join_init( VipsJoin *join )
*
* Optional arguments:
*
* @expand: %TRUE to expand the output image to hold all of the input pixels
* @shim: space between images, in pixels
* @background: background ink colour
* @align: low, centre or high alignment
* * @expand: %TRUE to expand the output image to hold all of the input pixels
* * @shim: space between images, in pixels
* * @background: background ink colour
* * @align: low, centre or high alignment
*
* Join @in1 and @in2 together, left-right or up-down depending on the value
* of @direction.

2
libvips/conversion/msb.c
View File

@ -269,7 +269,7 @@ vips_msb_init( VipsMsb *msb )
*
* Optional arguments:
*
* @band: msb just this band
* * @band: msb just this band
*
* Turn any integer image to 8-bit unsigned char by discarding all but the most
* significant byte. Signed values are converted to unsigned by adding 128.

2
libvips/conversion/premultiply.c
View File

@ -273,7 +273,7 @@ vips_premultiply_init( VipsPremultiply *premultiply )
*
* Optional arguments:
*
* @max_alpha: %gdouble, maximum value for alpha
* * @max_alpha: %gdouble, maximum value for alpha
*
* Premultiplies any alpha channel.
* The final band is taken to be the alpha

2
libvips/conversion/rot45.c
View File

@ -291,7 +291,7 @@ vips_rot45_init( VipsRot45 *rot45 )
*
* Optional arguments:
*
* @angle: rotation angle
* * @angle: rotation angle
*
* Rotate @in by a multiple of 45 degrees. Odd-length sides and square images
* only.

4
libvips/conversion/scale.c
View File

@ -183,8 +183,8 @@ vips_scale_init( VipsScale *scale )
*
* Optional arguments:
*
* @log: log scale pixels
* @exp: exponent for log scale
* * @log: log scale pixels
* * @exp: exponent for log scale
*
* Search the image for the maximum and minimum value, then return the image
* as unsigned 8-bit, scaled so that the maximum value is 255 and the

6
libvips/conversion/sequential.c
View File

@ -364,9 +364,9 @@ vips_sequential_init( VipsSequential *sequential )
*
* Optional arguments:
*
* @trace: trace requests
* @strip_height: height of cache strips
* @access: access pattern
* * @trace: trace requests
* * @strip_height: height of cache strips
* * @access: access pattern
*
* This operation behaves rather like vips_copy() between images
* @in and @out, except that it checks that pixels are only requested

2
libvips/conversion/subsample.c
View File

@ -314,7 +314,7 @@ vips_subsample_init( VipsSubsample *subsample )
*
* Optional arguments:
*
* @point: turn on point sample mode
* * @point: turn on point sample mode
*
* Subsample an image by an integer fraction. This is fast, nearest-neighbour
* shrink.

18
libvips/conversion/tilecache.c
View File

@ -824,12 +824,12 @@ vips_tile_cache_init( VipsTileCache *cache )
*
* Optional arguments:
*
* @tile_width: width of tiles in cache
* @tile_height: height of tiles in cache
* @max_tiles: maximum number of tiles to cache
* @access: hint expected access pattern #VipsAccess
* @threaded: allow many threads
* @persistent: don't drop cache at end of computation
* * @tile_width: width of tiles in cache
* * @tile_height: height of tiles in cache
* * @max_tiles: maximum number of tiles to cache
* * @access: hint expected access pattern #VipsAccess
* * @threaded: allow many threads
* * @persistent: don't drop cache at end of computation
*
* This operation behaves rather like vips_copy() between images
* @in and @out, except that it keeps a cache of computed pixels.
@ -1018,9 +1018,9 @@ vips_line_cache_init( VipsLineCache *cache )
*
* Optional arguments:
*
* @access: hint expected access pattern #VipsAccess
* @tile_height: height of tiles in cache
* @threaded: allow many threads
* * @access: hint expected access pattern #VipsAccess
* * @tile_height: height of tiles in cache
* * @threaded: allow many threads
*
* This operation behaves rather like vips_copy() between images
* @in and @out, except that it keeps a cache of computed scanlines.

2
libvips/conversion/unpremultiply.c
View File

@ -283,7 +283,7 @@ vips_unpremultiply_init( VipsUnpremultiply *unpremultiply )
*
* Optional arguments:
*
* @max_alpha: %gdouble, maximum value for alpha
* * @max_alpha: %gdouble, maximum value for alpha
*
* Unpremultiplies any alpha channel.
* The final band is taken to be the alpha

4
libvips/conversion/wrap.c
View File

@ -150,8 +150,8 @@ vips_wrap_init( VipsWrap *wrap )
*
* Optional arguments:
*
* @x: horizontal displacement
* @y: vertical displacement
* * @x: horizontal displacement
* * @y: vertical displacement
*
* Slice an image up and move the segments about so that the pixel that was
* at 0, 0 is now at @x, @y. If @x and @y are not set, they default to the

6
libvips/convolution/conv.c
View File

@ -175,9 +175,9 @@ vips_conv_init( VipsConv *conv )
*
* Optional arguments:
*
* @precision: calculation accuracy
* @layers: number of layers for approximation
* @cluster: cluster lines closer than this distance
* * @precision: calculation accuracy
* * @layers: number of layers for approximation
* * @cluster: cluster lines closer than this distance
*
* Convolution.
*

6
libvips/convolution/convsep.c
View File

@ -143,9 +143,9 @@ vips_convsep_init( VipsConvsep *convsep )
*
* Optional arguments:
*
* @precision: calculation accuracy
* @layers: number of layers for approximation
* @cluster: cluster lines closer than this distance
* * @precision: calculation accuracy
* * @layers: number of layers for approximation
* * @cluster: cluster lines closer than this distance
*
* Perform a separable convolution of @in with @mask.
* See vips_conv() for a detailed description.

4
libvips/convolution/gaussblur.c
View File

@ -168,8 +168,8 @@ vips_gaussblur_init( VipsGaussblur *gaussblur )
*
* Optional arguments:
*
* @precision: #VipsPrecision for blur, default VIPS_PRECISION_INTEGER
* @min_ampl: minimum amplitude, default 0.2
* * @precision: #VipsPrecision for blur, default VIPS_PRECISION_INTEGER
* * @min_ampl: minimum amplitude, default 0.2
*
* This operator runs vips_gaussmat() and vips_convsep() for you on an image.
* Set @min_ampl smaller to generate a larger, more accurate mask. Set @sigma

12
libvips/convolution/sharpen.c
View File

@ -394,12 +394,12 @@ vips_sharpen_init( VipsSharpen *sharpen )
*
* Optional arguments:
*
* @sigma: sigma of gaussian
* @x1: flat/jaggy threshold
* @y2: maximum amount of brightening
* @y3: maximum amount of darkening
* @m1: slope for flat areas
* @m2: slope for jaggy areas
* * @sigma: sigma of gaussian
* * @x1: flat/jaggy threshold
* * @y2: maximum amount of brightening
* * @y3: maximum amount of darkening
* * @m1: slope for flat areas
* * @m2: slope for jaggy areas
*
* Selectively sharpen the L channel of a LAB image. The input image is
* transformed to #VIPS_INTERPRETATION_LABS.

2
libvips/create/black.c
View File

@ -162,7 +162,7 @@ vips_black_init( VipsBlack *black )
*
* Optional arguments:
*
* @bands: output bands
* * @bands: output bands
*
* Make a black unsigned char image of a specified size.
*

4
libvips/create/eye.c
View File

@ -123,8 +123,8 @@ vips_eye_init( VipsEye *eye )
*
* Optional arguments:
*
* @factor: maximum spatial frequency
* @uchar: output a uchar image
* * @factor: maximum spatial frequency
* * @uchar: output a uchar image
*
* Create a test pattern with increasing spatial frequence in X and
* amplitude in Y. @factor should be between 0 and 1 and determines the

4
libvips/create/gaussmat.c
View File

@ -234,8 +234,8 @@ vips_gaussmat_init( VipsGaussmat *gaussmat )
*
* Optional arguments:
*
* @separable: generate a separable gaussian
* @precision: #VipsPrecision for @out
* * @separable: generate a separable gaussian
* * @precision: #VipsPrecision for @out
*
* Creates a circularly symmetric Gaussian image of radius
* @sigma. The size of the mask is determined by the variable @min_ampl;

4
libvips/create/gaussnoise.c
View File

@ -195,8 +195,8 @@ vips_gaussnoise_init( VipsGaussnoise *gaussnoise )
*
* Optional arguments:
*
* @mean: mean of generated pixels
* @sigma: standard deviation of generated pixels
* * @mean: mean of generated pixels
* * @sigma: standard deviation of generated pixels
*
* Make a one band float image of gaussian noise with the specified
* distribution. The noise distribution is created by averaging 12 random

2
libvips/create/grey.c
View File

@ -107,7 +107,7 @@ vips_grey_init( VipsGrey *grey )
*
* Optional arguments:
*
* @uchar: output a uchar image
* * @uchar: output a uchar image
*
* Create a one-band float image with the left-most column zero and the
* right-most 1. Intermediate pixels are a linear ramp.

6
libvips/create/identity.c
View File

@ -178,9 +178,9 @@ vips_identity_init( VipsIdentity *identity )
*
* Optional arguments:
*
* @bands: number of bands to create
* @ushort: %TRUE for an unsigned short identity
* @size: number of LUT elements for a ushort image
* * @bands: number of bands to create
* * @ushort: %TRUE for an unsigned short identity
* * @size: number of LUT elements for a ushort image
*
* Creates an identity lookup table, ie. one which will leave an image
* unchanged when applied with vips_maplut(). Each entry in the table has a

2
libvips/create/invertlut.c
View File

@ -314,7 +314,7 @@ vips_invertlut_init( VipsInvertlut *lut )
*
* Optional arguments:
*
* @size: generate this much
* * @size: generate this much
*
* Given a mask of target values and real values, generate a LUT which
* will map reals to targets. Handy for linearising images from

4
libvips/create/logmat.c
View File

@ -251,8 +251,8 @@ vips_logmat_init( VipsLogmat *logmat )
*
* Optional arguments:
*
* @separable: generate a separable mask
* @precision: #VipsPrecision for @out
* * @separable: generate a separable mask
* * @precision: #VipsPrecision for @out
*
* Creates a circularly symmetric Laplacian of Gaussian mask
* of radius

8
libvips/create/mask_butterworth.c
View File

@ -127,10 +127,10 @@ vips_mask_butterworth_init( VipsMaskButterworth *butterworth )
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make an butterworth high- or low-pass filter, that is, one with a variable,
* smooth transition

8
libvips/create/mask_butterworth_band.c
View File

@ -171,10 +171,10 @@ vips_mask_butterworth_band_init(
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make an butterworth band-pass or band-reject filter, that is, one with a
* variable, smooth transition positioned at @frequency_cutoff_x,

8
libvips/create/mask_butterworth_ring.c
View File

@ -131,10 +131,10 @@ vips_mask_butterworth_ring_init(
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make a butterworth ring-pass or ring-reject filter, that is, one with a
* variable,

8
libvips/create/mask_fractal.c
View File

@ -114,10 +114,10 @@ vips_mask_fractal_init( VipsMaskFractal *fractal )
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* This operation should be used to create fractal images by filtering the
* power spectrum of Gaussian white noise. See vips_gaussnoise().

8
libvips/create/mask_gaussian.c
View File

@ -116,10 +116,10 @@ vips_mask_gaussian_init( VipsMaskGaussian *gaussian )
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make a gaussian high- or low-pass filter, that is, one with a variable,
* smooth transition positioned at @frequency_cutoff.

8
libvips/create/mask_gaussian_band.c
View File

@ -155,10 +155,10 @@ vips_mask_gaussian_band_init( VipsMaskGaussianBand *gaussian_band )
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make a gaussian band-pass or band-reject filter, that is, one with a
* variable, smooth transition positioned at @frequency_cutoff_x,

8
libvips/create/mask_gaussian_ring.c
View File

@ -124,10 +124,10 @@ vips_mask_gaussian_ring_init( VipsMaskGaussianRing *gaussian_ring )
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make a gaussian ring-pass or ring-reject filter, that is, one with a
* variable, smooth transition positioned at @frequency_cutoff of width

8
libvips/create/mask_ideal.c
View File

@ -105,10 +105,10 @@ vips_mask_ideal_init( VipsMaskIdeal *ideal )
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make an ideal high- or low-pass filter, that is, one with a sharp cutoff
* positioned at @frequency_cutoff, where @frequency_cutoff is in

8
libvips/create/mask_ideal_band.c
View File

@ -137,10 +137,10 @@ vips_mask_ideal_band_init( VipsMaskIdealBand *ideal_band )
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make an ideal band-pass or band-reject filter, that is, one with a
* sharp cutoff around the point @frequency_cutoff_x, @frequency_cutoff_y,

8
libvips/create/mask_ideal_ring.c
View File

@ -120,10 +120,10 @@ vips_mask_ideal_ring_init( VipsMaskIdealRing *ideal_ring )
*
* Optional arguments:
*
* @nodc: don't set the DC pixel
* @reject: invert the filter sense
* @optical: coordinates in optical space
* @uchar: output a uchar image
* * @nodc: don't set the DC pixel
* * @reject: invert the filter sense
* * @optical: coordinates in optical space
* * @uchar: output a uchar image
*
* Make an ideal ring-pass or ring-reject filter, that is, one with a sharp
* ring positioned at @frequency_cutoff of width @width, where

6
libvips/create/sines.c
View File

@ -154,9 +154,9 @@ vips_sines_init( VipsSines *sines )
*
* Optional arguments:
*
* @hfreq: horizontal frequency
* @vreq: vertical frequency
* @uchar: output a uchar image
* * @hfreq: horizontal frequency
* * @vreq: vertical frequency
* * @uchar: output a uchar image
*
* Creates a float one band image of the a sine waveform in two
* dimensions.

10
libvips/create/text.c
View File

@ -341,11 +341,11 @@ vips_text_init( VipsText *text )
*
* Optional arguments:
*
* @font: font to render with
* @width: render within this many pixels across
* @alignment: left/centre/right alignment
* @dpi: render at this resolution
* @spacing: space lines by this in points
* * @font: font to render with
* * @width: render within this many pixels across
* * @alignment: left/centre/right alignment
* * @dpi: render at this resolution
* * @spacing: space lines by this in points
*
* Draw the string @text to an image. @out is a one-band 8-bit
* unsigned char image, with 0 for no text and 255 for text. Values inbetween

20
libvips/create/tonelut.c
View File

@ -315,16 +315,16 @@ vips_tonelut_init( VipsTonelut *lut )
*
* Optional arguments:
*
* @in_max: input range
* @out_max: output range
* @Lb: black-point [0-100]
* @Lw: white-point [0-100]
* @Ps: shadow point (eg. 0.2)
* @Pm: mid-tone point (eg. 0.5)
* @Ph: highlight point (eg. 0.8)
* @S: shadow adjustment (+/- 30)
* @M: mid-tone adjustment (+/- 30)
* @H: highlight adjustment (+/- 30)
* * @in_max: input range
* * @out_max: output range
* * @Lb: black-point [0-100]
* * @Lw: white-point [0-100]
* * @Ps: shadow point (eg. 0.2)
* * @Pm: mid-tone point (eg. 0.5)
* * @Ph: highlight point (eg. 0.8)
* * @S: shadow adjustment (+/- 30)
* * @M: mid-tone adjustment (+/- 30)
* * @H: highlight adjustment (+/- 30)
*
* vips_tonelut() generates a tone curve for the adjustment of image
* levels. It is mostly designed for adjusting the L* part of a LAB image in

6
libvips/create/xyz.c
View File

@ -246,9 +246,9 @@ vips_xyz_init( VipsXyz *xyz )
*
* Optional arguments:
*
* @csize: size for third dimension
* @dsize: size for fourth dimension
* @esize: size for fifth dimension
* * @csize: size for third dimension
* * @dsize: size for fourth dimension
* * @esize: size for fifth dimension
*
* Create a two-band uint32 image where the elements in the first band have the
* value of their x coordinate and elements in the second band have their y

2
libvips/create/zone.c
View File

@ -106,7 +106,7 @@ vips_zone_init( VipsZone *zone )
*
* Optional arguments:
*
* @uchar: output a uchar image
* * @uchar: output a uchar image
*
* Create a one-band image of a zone plate.
*

4
libvips/draw/draw_circle.c
View File

@ -294,7 +294,7 @@ vips_draw_circlev( VipsImage *image,
*
* Optional arguments:
*
* @fill: fill the draw_circle
* * @fill: fill the draw_circle
*
* Draws a circle on @image. If @fill is %TRUE then the circle is filled,
* otherwise a 1-pixel-wide perimeter is drawn.
@ -330,7 +330,7 @@ vips_draw_circle( VipsImage *image,
*
* Optional arguments:
*
* @fill: fill the draw_circle
* * @fill: fill the draw_circle
*
* As vips_draw_circle(), but just takes a single double for @ink.
*

24
libvips/draw/draw_flood.c
View File

@ -685,12 +685,12 @@ vips_draw_floodv( VipsImage *image,
*
* Optional arguments:
*
* @test: test this image
* @equal: fill while equal to edge
* @left: output left edge of bounding box of modified area
* @top: output top edge of bounding box of modified area
* @width: output width of bounding box of modified area
* @height: output height of bounding box of modified area
* * @test: test this image
* * @equal: fill while equal to edge
* * @left: output left edge of bounding box of modified area
* * @top: output top edge of bounding box of modified area
* * @width: output width of bounding box of modified area
* * @height: output height of bounding box of modified area
*
* Flood-fill @image with @ink, starting at position @x, @y. The filled area is
* bounded by pixels that are equal to the ink colour, in other words, it
@ -736,12 +736,12 @@ vips_draw_flood( VipsImage *image,
*
* Optional arguments:
*
* @test: test this image
* @equal: fill while equal to edge
* @left: output left edge of bounding box of modified area
* @top: output top edge of bounding box of modified area
* @width: output width of bounding box of modified area
* @height: output height of bounding box of modified area
* * @test: test this image
* * @equal: fill while equal to edge
* * @left: output left edge of bounding box of modified area
* * @top: output top edge of bounding box of modified area
* * @width: output width of bounding box of modified area
* * @height: output height of bounding box of modified area
*
* As vips_draw_flood(), but just takes a single double for @ink.
*

2
libvips/draw/draw_image.c
View File

@ -300,7 +300,7 @@ vips_draw_image_init( VipsDrawImage *draw_image )
*
* Optional arguments:
*
* @mode: how to combine pixels
* * @mode: how to combine pixels
*
* Draw @sub on top of @image at position @x, @y. The two images must have the
* same Coding. If @sub has 1 band, the bands will be duplicated to match the

4
libvips/draw/draw_rect.c
View File

@ -240,7 +240,7 @@ vips_draw_rectv( VipsImage *image,
*
* Optional arguments:
*
* @fill: fill the rect
* * @fill: fill the rect
*
* Paint pixels within @left, @top, @width, @height in @image with @ink. If
* @fill is zero, just paint a 1-pixel-wide outline.
@ -276,7 +276,7 @@ vips_draw_rect( VipsImage *image,
*
* Optional arguments:
*
* @fill: fill the rect
* * @fill: fill the rect
*
* As vips_draw_rect(), but just take a single double for @ink.
*

8
libvips/foreign/csvload.c
View File

@ -187,10 +187,10 @@ vips_foreign_load_csv_init( VipsForeignLoadCsv *csv )
*
* Optional arguments:
*
* @skip: skip this many lines at start of file
* @lines: read this many lines from file
* @whitespace: set of whitespace characters
* @separator: set of separator characters
* * @skip: skip this many lines at start of file
* * @lines: read this many lines from file
* * @whitespace: set of whitespace characters
* * @separator: set of separator characters
*
* Load a CSV (comma-separated values) file. The output image is always 1
* band (monochrome), #VIPS_FORMAT_DOUBLE. Use vips_bandfold() to turn

2
libvips/foreign/csvsave.c
View File

@ -128,7 +128,7 @@ vips_foreign_save_csv_init( VipsForeignSaveCsv *csv )
*
* Optional arguments:
*
* @separator: separator string
* * @separator: separator string
*
* Writes the pixels in @in to the @filename as CSV (comma-separated values).
* The image is written

20
libvips/foreign/dzsave.c
View File

@ -2047,16 +2047,16 @@ vips_foreign_save_dz_init( VipsForeignSaveDz *dz )
*
* Optional arguments:
*
* @layout; directory layout convention
* @suffix: suffix for tile tiles
* @overlap; set tile overlap
* @tile_size; set tile size
* @background: background colour
* @depth: how deep to make the pyramid
* @centre: centre the tiles
* @angle: rotate the image by this much
* @container: set container type
* @properties: write a properties file
* * @layout; directory layout convention
* * @suffix: suffix for tile tiles
* * @overlap; set tile overlap
* * @tile_size; set tile size
* * @background: background colour
* * @depth: how deep to make the pyramid
* * @centre: centre the tiles
* * @angle: rotate the image by this much
* * @container: set container type
* * @properties: write a properties file
*
* Save an image as a set of tiles at various resolutions. By default dzsave
* uses DeepZoom layout -- use @layout to pick other conventions.

178
libvips/foreign/foreign.c
View File

@ -1823,8 +1823,8 @@ vips_vipssave( VipsImage *in, const char *filename, ... )
*
* Optional arguments:
*
* @all_frames: %gboolean, load all frames in sequence
* @density: string, canvas resolution for rendering vector formats like SVG
* * @all_frames: %gboolean, load all frames in sequence
* * @density: string, canvas resolution for rendering vector formats like SVG
*
* Read in an image using libMagick, the ImageMagick library. This library can
* read more than 80 file formats, including SVG, BMP, EPS, DICOM and many
@ -1870,8 +1870,8 @@ vips_magickload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @all_frames: %gboolean, load all frames in sequence
* @density: string, canvas resolution for rendering vector formats like SVG
* * @all_frames: %gboolean, load all frames in sequence
* * @density: string, canvas resolution for rendering vector formats like SVG
*
* Read an image memory block using libMagick into a VIPS image. Exactly as
* vips_magickload(), but read from a memory source.
@ -1911,7 +1911,7 @@ vips_magickload_buffer( void *buf, size_t len, VipsImage **out, ... )
*
* Optional arguments:
*
* @page: int, load this page
* * @page: int, load this page
*
* Read a TIFF file into a VIPS image. It is a full baseline TIFF 6 reader,
* with extensions for tiled images, multipage images, LAB colour space,
@ -1949,7 +1949,7 @@ vips_tiffload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @page: %gint, load this page
* * @page: %gint, load this page
*
* Read a TIFF-formatted memory block into a VIPS image. Exactly as
* vips_tiffload(), but read from a memory source.
@ -1989,20 +1989,20 @@ vips_tiffload_buffer( void *buf, size_t len, VipsImage **out, ... )
*
* Optional arguments:
*
* @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
* @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
* @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
* * @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
* * @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
* * @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
*
* Write a VIPS image to a file as TIFF.
*
@ -2089,9 +2089,9 @@ vips_tiffsave( VipsImage *in, const char *filename, ... )
*
* Optional arguments:
*
* @shrink: %gint, shrink by this much on load
* @fail: %gboolean, fail on warnings
* @autorotate: %gboolean, use exif Orientation tag to rotate the image during load
* * @shrink: %gint, shrink by this much on load
* * @fail: %gboolean, fail on warnings
* * @autorotate: %gboolean, use exif Orientation tag to rotate the image during load
*
* Read a JPEG file into a VIPS image. It can read most 8-bit JPEG images,
* including CMYK and YCbCr.
@ -2167,8 +2167,8 @@ vips_jpegload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @shrink: %gint, shrink by this much on load
* @fail: %gboolean, fail on warnings
* * @shrink: %gint, shrink by this much on load
* * @fail: %gboolean, fail on warnings
*
* Read a JPEG-formatted memory block into a VIPS image. Exactly as
* vips_jpegload(), but read from a memory buffer.
@ -2208,15 +2208,15 @@ vips_jpegload_buffer( void *buf, size_t len, VipsImage **out, ... )
*
* Optional arguments:
*
* @Q: %gint, quality factor
* @profile: filename of ICC profile to attach
* @optimize_coding: %gboolean, compute optimal Huffman coding tables
* @interlace: %gboolean, write an interlaced (progressive) jpeg
* @strip: %gboolean, remove all metadata from image
* @no-subsample: %gboolean, disable chroma subsampling
* @trellis_quant: %gboolean, apply trellis quantisation to each 8x8 block
* @overshoot_deringing: %gboolean, overshoot samples with extreme values
* @optimize_scans: %gboolean, split DCT coefficients into separate scans
* * @Q: %gint, quality factor
* * @profile: filename of ICC profile to attach
* * @optimize_coding: %gboolean, compute optimal Huffman coding tables
* * @interlace: %gboolean, write an interlaced (progressive) jpeg
* * @strip: %gboolean, remove all metadata from image
* * @no-subsample: %gboolean, disable chroma subsampling
* * @trellis_quant: %gboolean, apply trellis quantisation to each 8x8 block
* * @overshoot_deringing: %gboolean, overshoot samples with extreme values
* * @optimize_scans: %gboolean, split DCT coefficients into separate scans
*
* Write a VIPS image to a file as JPEG.
*
@ -2294,15 +2294,15 @@ vips_jpegsave( VipsImage *in, const char *filename, ... )
*
* Optional arguments:
*
* @Q: JPEG quality factor
* @profile: attach this ICC profile
* @optimize_coding: compute optimal Huffman coding tables
* @interlace: write an interlaced (progressive) jpeg
* @strip: remove all metadata from image
* @no-subsample: disable chroma subsampling
* @trellis_quant: %gboolean, apply trellis quantisation to each 8x8 block
* @overshoot_deringing: %gboolean, overshoot samples with extreme values
* @optimize_scans: %gboolean, split DCT coefficients into separate scans
* * @Q: JPEG quality factor
* * @profile: attach this ICC profile
* * @optimize_coding: compute optimal Huffman coding tables
* * @interlace: write an interlaced (progressive) jpeg
* * @strip: remove all metadata from image
* * @no-subsample: disable chroma subsampling
* * @trellis_quant: %gboolean, apply trellis quantisation to each 8x8 block
* * @overshoot_deringing: %gboolean, overshoot samples with extreme values
* * @optimize_scans: %gboolean, split DCT coefficients into separate scans
*
* As vips_jpegsave(), but save to a memory buffer.
*
@ -2349,14 +2349,14 @@ vips_jpegsave_buffer( VipsImage *in, void **buf, size_t *len, ... )
*
* Optional arguments:
*
* @Q: JPEG quality factor
* @profile: attach this ICC profile
* @optimize_coding: compute optimal Huffman coding tables
* @strip: remove all metadata from image
* @no-subsample: disable chroma subsampling
* @trellis_quant: %gboolean, apply trellis quantisation to each 8x8 block
* @overshoot_deringing: %gboolean, overshoot samples with extreme values
* @optimize_scans: %gboolean, split DCT coefficients into separate scans
* * @Q: JPEG quality factor
* * @profile: attach this ICC profile
* * @optimize_coding: compute optimal Huffman coding tables
* * @strip: remove all metadata from image
* * @no-subsample: disable chroma subsampling
* * @trellis_quant: %gboolean, apply trellis quantisation to each 8x8 block
* * @overshoot_deringing: %gboolean, overshoot samples with extreme values
* * @optimize_scans: %gboolean, split DCT coefficients into separate scans
*
* As vips_jpegsave(), but save as a mime jpeg on stdout.
*
@ -2385,7 +2385,7 @@ vips_jpegsave_mime( VipsImage *in, ... )
*
* Optional arguments:
*
* @shrink: %gint, shrink by this much on load
* * @shrink: %gint, shrink by this much on load
*
* Read a WebP file into a VIPS image.
*
@ -2417,7 +2417,7 @@ vips_webpload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @shrink: %gint, shrink by this much on load
* * @shrink: %gint, shrink by this much on load
*
* Read a WebP-formatted memory block into a VIPS image. Exactly as
* vips_webpload(), but read from a memory buffer.
@ -2505,12 +2505,12 @@ vips_webpsave( VipsImage *in, const char *filename, ... )
*
* Optional arguments:
*
* @Q: %gint quality factor
* @lossless: %gboolean enables lossless compression
* @preset: #VipsForeignWebpPreset choose lossy compression preset
* @smart_subsample: %gboolean enables high quality chroma subsampling
* @near_lossless: %gboolean use preprocessing in lossless mode (controlled by Q)
* @alpha_q: %gint set alpha quality in lossless mode
* * @Q: %gint quality factor
* * @lossless: %gboolean enables lossless compression
* * @preset: #VipsForeignWebpPreset choose lossy compression preset
* * @smart_subsample: %gboolean enables high quality chroma subsampling
* * @near_lossless: %gboolean use preprocessing in lossless mode (controlled by Q)
* * @alpha_q: %gint set alpha quality in lossless mode
*
* As vips_webpsave(), but save to a memory buffer.
*
@ -2557,12 +2557,12 @@ vips_webpsave_buffer( VipsImage *in, void **buf, size_t *len, ... )
*
* Optional arguments:
*
* @Q: %gint quality factor
* @lossless: %gboolean enables lossless compression
* @preset: #VipsForeignWebpPreset choose lossy compression preset
* @smart_subsample: %gboolean enables high quality chroma subsampling
* @near_lossless: %gboolean use preprocessing in lossless mode (controlled by Q)
* @alpha_q: %gint set alpha quality in lossless mode
* * @Q: %gint quality factor
* * @lossless: %gboolean enables lossless compression
* * @preset: #VipsForeignWebpPreset choose lossy compression preset
* * @smart_subsample: %gboolean enables high quality chroma subsampling
* * @near_lossless: %gboolean use preprocessing in lossless mode (controlled by Q)
* * @alpha_q: %gint set alpha quality in lossless mode
*
* As vips_webpsave(), but save as a mime webp on stdout.
*
@ -2623,9 +2623,9 @@ vips_openexrload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @level: load this level
* @associated: load this associated image
* @autocrop: crop to image bounds
* * @level: load this level
* * @associated: load this associated image
* * @autocrop: crop to image bounds
*
* Read a virtual slide supported by the OpenSlide library into a VIPS image.
* OpenSlide supports images in Aperio, Hamamatsu, MIRAX, Sakura, Trestle,
@ -2726,8 +2726,6 @@ vips_fitssave( VipsImage *in, const char *filename, ... )
* @out: decompressed image
* @...: %NULL-terminated list of optional named arguments
*
* Optional arguments:
*
* Read a PNG file into a VIPS image. It can read all png images, including 8-
* and 16-bit images, 1 and 3 channel, with and without an alpha channel.
*
@ -2798,10 +2796,10 @@ vips_pngload_buffer( void *buf, size_t len, VipsImage **out, ... )
*
* Optional arguments:
*
* @compression: compression level
* @interlace: interlace image
* @profile: ICC profile to embed
* @filter: #VipsForeignPngFilter row filter flag(s)
* * @compression: compression level
* * @interlace: interlace image
* * @profile: ICC profile to embed
* * @filter: #VipsForeignPngFilter row filter flag(s)
*
* Write a VIPS image to a file as PNG.
*
@ -2854,10 +2852,10 @@ 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)
* * @compression: compression level
* * @interlace: interlace image
* * @profile: ICC profile to embed
* * @filter: libpng row filter flag(s)
*
* As vips_pngsave(), but save to a memory buffer.
*
@ -2935,9 +2933,9 @@ vips_matload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @page: %gint, load this page, numbered from zero
* @dpi: %gdouble, render at this DPI
* @scale: %gdouble, scale render by this factor
* * @page: %gint, load this page, numbered from zero
* * @dpi: %gdouble, render at this DPI
* * @scale: %gdouble, scale render by this factor
*
* Render a PDF file into a VIPS image. Rendering uses the libpoppler library
* and should be fast.
@ -2996,9 +2994,9 @@ vips_pdfload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @page: %gint, load this page, numbered from zero
* @dpi: %gdouble, render at this DPI
* @scale: %gdouble, scale render by this factor
* * @page: %gint, load this page, numbered from zero
* * @dpi: %gdouble, render at this DPI
* * @scale: %gdouble, scale render by this factor
*
* Read a PDF-formatted memory block into a VIPS image. Exactly as
* vips_pdfload(), but read from a memory buffer.
@ -3038,8 +3036,8 @@ vips_pdfload_buffer( void *buf, size_t len, VipsImage **out, ... )
*
* Optional arguments:
*
* @dpi: %gdouble, render at this DPI
* @scale: %gdouble, scale render by this factor
* * @dpi: %gdouble, render at this DPI
* * @scale: %gdouble, scale render by this factor
*
* Render a SVG file into a VIPS image. Rendering uses the librsvg library
* and should be fast.
@ -3076,8 +3074,8 @@ vips_svgload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @dpi: %gdouble, render at this DPI
* @scale: %gdouble, scale render by this factor
* * @dpi: %gdouble, render at this DPI
* * @scale: %gdouble, scale render by this factor
*
* Read a SVG-formatted memory block into a VIPS image. Exactly as
* vips_svgload(), but read from a memory buffer.
@ -3117,7 +3115,7 @@ vips_svgload_buffer( void *buf, size_t len, VipsImage **out, ... )
*
* Optional arguments:
*
* @page: %ginit, page (frame) to read
* * @page: %ginit, page (frame) to read
*
* Read a GIF file into a VIPS image. Rendering uses the giflib library.
*
@ -3152,7 +3150,7 @@ vips_gifload( const char *filename, VipsImage **out, ... )
*
* Optional arguments:
*
* @page: %ginit, page (frame) to read
* * @page: %ginit, page (frame) to read
*
* Read a GIF-formatted memory block into a VIPS image. Exactly as
* vips_gifload(), but read from a memory buffer.

4
libvips/foreign/ppmsave.c
View File

@ -156,8 +156,8 @@ vips_foreign_save_ppm_init( VipsForeignSavePpm *ppm )
*
* Optional arguments:
*
* @ascii: save as ASCII rather than binary
* @squash: squash 8-bit images down to one bit
* * @ascii: save as ASCII rather than binary
* * @squash: squash 8-bit images down to one bit
*
* Write a VIPS image to a file as PPM. It can write 1, 8, 16 or
* 32 bit unsigned integer images, float images, colour or monochrome,

2
libvips/foreign/rawload.c
View File

@ -165,7 +165,7 @@ vips_foreign_load_raw_init( VipsForeignLoadRaw *raw )
*
* Optional arguments:
*
* @offset: offset in bytes from start of file
* * @offset: offset in bytes from start of file
*
* This operation mmaps the file, setting @out so that access to that
* image will read from the file.

2
libvips/freqfilt/invfft.c
View File

@ -276,7 +276,7 @@ vips_invfft_init( VipsInvfft *invfft )
*
* Optional arguments:
*
* @real: only output the real part
* * @real: only output the real part
*
* Transform an image from Fourier space to real space. The result is complex.
* If you are OK with a real result, set @real, it's quicker.

2
libvips/histogram/hist_equal.c
View File

@ -138,7 +138,7 @@ vips_hist_equal_init( VipsHistEqual *equal )
*
* Optional arguments:
*
* @band: band to equalise
* * @band: band to equalise
*
* Histogram-equalise @in. Equalise using band @bandno, or if @bandno is -1,
* equalise bands independently.

2
libvips/histogram/maplut.c
View File

@ -735,7 +735,7 @@ vips_maplut_init( VipsMaplut *maplut )
*
* Optional arguments:
*
* @band: apply one-band @lut to this band of @in
* * @band: apply one-band @lut to this band of @in
*
* Map an image through another image acting as a LUT (Look Up Table).
* The lut may have any type and the output image will be that type.

8
libvips/histogram/stdif.c
View File

@ -367,10 +367,10 @@ vips_stdif_init( VipsStdif *stdif )
*
* Optional arguments:
*
* @a: weight of new mean
* @m0: target mean
* @b: weight of new deviation
* @s0: target deviation
* * @a: weight of new mean
* * @m0: target mean
* * @b: weight of new deviation
* * @s0: target deviation
*
* vips_stdif() preforms statistical differencing according to the formula
* given in page 45 of the book "An Introduction to Digital Image

4
libvips/iofuncs/image.c
View File

@ -1837,8 +1837,8 @@ vips_filename_get_options( const char *vips_filename )
*
* Optional arguments:
*
* @access: hint #VipsAccess mode to loader
* @disc: load via a temporary disc file
* * @access: hint #VipsAccess mode to loader
* * @disc: load via a temporary disc file
*
* vips_image_new_from_file() opens @name for reading. It can load files
* in many image formats, including VIPS, TIFF, PNG, JPEG, FITS, Matlab,

10
libvips/iofuncs/system.c
View File

@ -329,11 +329,11 @@ vips_system_init( VipsSystem *system )
*
* Optional arguments:
*
* @in: array of input images
* @out: output image
* @in_format: write input files like this
* @out_format: write output filename like this
* @log: stdout of command is returned here
* * @in: array of input images
* * @out: output image
* * @in_format: write input files like this
* * @out_format: write output filename like this
* * @log: stdout of command is returned here
*
* vips_system() runs a command, optionally passing a set of images in and
* optionally getting an image back. The command's stdout is returned in @log.

2
libvips/morphology/labelregions.c
View File

@ -149,7 +149,7 @@ vips_labelregions_init( VipsLabelregions *labelregions )
*
* Optional arguments:
*
* @segments: return number of regions found here
* * @segments: return number of regions found here
*
* Repeatedly scans @in for regions of 4-connected pixels
* with the same pixel value. Every time a region is discovered, those

4
libvips/mosaicing/global_balance.c
View File

@ -1809,8 +1809,8 @@ vips_globalbalance_init( VipsGlobalbalance *globalbalance )
*
* Optional arguments:
*
* @gamma: gamma of source images
* @int_output: %TRUE for integer image output
* * @gamma: gamma of source images
* * @int_output: %TRUE for integer image output
*
* vips_globalbalance() can be used to remove contrast differences in
* an assembled mosaic.

8
libvips/mosaicing/match.c
View File

@ -328,10 +328,10 @@ vips_match_init( VipsMatch *match )
*
* Optional arguments:
*
* @search: search to improve tie-points
* @hwindow: half window size
* @harea: half search size
* @interpolate: interpolate pixels with this
* * @search: search to improve tie-points
* * @hwindow: half window size
* * @harea: half search size
* * @interpolate: interpolate pixels with this
*
* Scale, rotate and translate @sec so that the tie-points line up.
*

2
libvips/mosaicing/merge.c
View File

@ -171,7 +171,7 @@ vips_merge_init( VipsMerge *merge )
*
* Optional arguments:
*
* @mblend: maximum blend size
* * @mblend: maximum blend size
*
* This operation joins two images left-right (with @ref on the left) or
* up-down (with @ref above) with a smooth seam.

8
libvips/mosaicing/mosaic.c
View File

@ -324,10 +324,10 @@ vips_mosaic_init( VipsMosaic *mosaic )
*
* Optional arguments:
*
* @bandno: band to search for features
* @hwindow: half window size
* @harea: half search size
* @mblend: maximum blend size
* * @bandno: band to search for features
* * @hwindow: half window size
* * @harea: half search size
* * @mblend: maximum blend size
*
* This operation joins two images left-right (with @ref on the left) or
* top-bottom (with @ref above) given an approximate overlap.

12
libvips/mosaicing/mosaic1.c
View File

@ -635,12 +635,12 @@ vips_mosaic1_init( VipsMosaic1 *mosaic1 )
*
* Optional arguments:
*
* @search: search to improve tie-points
* @hwindow: half window size
* @harea: half search size
* @interpolate: interpolate pixels with this
* @mblend: maximum blend size
* @bandno: band to search for features
* * @search: search to improve tie-points
* * @hwindow: half window size
* * @harea: half search size
* * @interpolate: interpolate pixels with this
* * @mblend: maximum blend size
* * @bandno: band to search for features
*
* This operation joins two images top-bottom (with @sec on the right)
* or left-right (with @sec at the bottom)

12
libvips/resample/affine.c
View File

@ -623,12 +623,12 @@ vips_affine_init( VipsAffine *affine )
*
* Optional arguments:
*
* @interpolate: interpolate pixels with this
* @oarea: output rectangle
* @idx: input horizontal offset
* @idy: input vertical offset
* @odx: output horizontal offset
* @ody: output vertical offset
* * @interpolate: interpolate pixels with this
* * @oarea: output rectangle
* * @idx: input horizontal offset
* * @idy: input vertical offset
* * @odx: output horizontal offset
* * @ody: output vertical offset
*
* This operator performs an affine transform on an image using @interpolate.
*

2
libvips/resample/mapim.c
View File

@ -415,7 +415,7 @@ vips_mapim_init( VipsMapim *mapim )
*
* Optional arguments:
*
* @interpolate: interpolate pixels with this
* * @interpolate: interpolate pixels with this
*
* This operator resamples @in using @index to look up pixels. @out is
* the same size as @index, with each pixel being fetched from that position in

2
libvips/resample/quadratic.c
View File

@ -371,7 +371,7 @@ vips_quadratic_init( VipsQuadratic *quadratic )
*
* Optional arguments:
*
* @interpolate: use this interpolator (default bilinear)
* * @interpolate: use this interpolator (default bilinear)
*
* This operation is unfinished and unusable, sorry.
*

2
libvips/resample/reduce.c
View File

@ -146,7 +146,7 @@ vips_reduce_init( VipsReduce *reduce )
*
* Optional arguments:
*
* @kernel: #VipsKernel to use to interpolate (default: lanczos3)
* * @kernel: #VipsKernel to use to interpolate (default: lanczos3)
*
* Reduce @in by a pair of factors with a pair of 1D interpolators. This
* will not work well for shrink factors greater than two.

4
libvips/resample/resize.c
View File

@ -336,8 +336,8 @@ vips_resize_init( VipsResize *resize )
*
* Optional arguments:
*
* @vscale: vertical scale factor
* @kernel: #VipsKernel to reduce with
* * @vscale: vertical scale factor
* * @kernel: #VipsKernel to reduce with
*
* Resize an image. When upsizing (@scale > 1), the image is simply block
* upsized. When downsizing, the

14
libvips/resample/similarity.c
View File

@ -236,13 +236,13 @@ vips_similarity_init( VipsSimilarity *similarity )
*
* Optional arguments:
*
* @scale: scale by this factor
* @angle: rotate by this many degrees anticlockwise
* @interpolate: interpolate pixels with this
* @idx: input horizontal offset
* @idy: input vertical offset
* @odx: output horizontal offset
* @ody: output vertical offset
* * @scale: scale by this factor
* * @angle: rotate by this many degrees anticlockwise
* * @interpolate: interpolate pixels with this
* * @idx: input horizontal offset
* * @idy: input vertical offset
* * @odx: output horizontal offset
* * @ody: output vertical offset
*
* This operator calls vips_affine() for you, calculating the matrix for the
* affine transform from @scale and @angle. Other parameters are passed on to