doc improvements

configure.ac

@@ -112,6 +112,7 @@ headers="\
 	draw.h \
 	morphology.h \
 	type.h \
+	rect.h \
 	memory.h \
 	region.h"
 

libvips/Makefile.am

@@ -98,10 +98,8 @@ Vips_8_0_gir_LIBS = libvips.la
 Vips_8_0_gir_FILES = $(introspection_sources)
 INTROSPECTION_GIRS += Vips-8.0.gir
 
-# don't use --warn-all --verbose 
-# we have an unusual markup with optional args and we don't want to see all
-# those warnings
 Vips_8_0_gir_SCANNERFLAGS = \
+			--warn-all --verbose  \
 			    --program=./introspect \
 			    --identifier-prefix=Vips \
 			    --identifier-prefix=vips \

libvips/colour/Lab2XYZ.c

@@ -197,9 +197,9 @@ vips_Lab2XYZ_init( VipsLab2XYZ *Lab2XYZ )
  * @out: output image
  * @...: %NULL-terminated list of optional named arguments
  *
- * optional arguments:
+ * Optional arguments:
  *
- * @temp: colour temperature
+ * * @temp: #VipsArrayDouble, colour temperature
  *
  * Turn Lab to XYZ. The colour temperature defaults to D65, but can be 
  * specified with @temp.

libvips/colour/XYZ2Lab.c

@@ -250,9 +250,9 @@ vips_XYZ2Lab_init( VipsXYZ2Lab *XYZ2Lab )
  * @out: output image
  * @...: %NULL-terminated list of optional named arguments
  *
- * optional arguments:
+ * Optional arguments:
  *
- * @temp: colour temperature
+ * * @temp: #VipsArrayDouble, colour temperature
  *
  * Turn XYZ to Lab, optionally specifying the colour temperature. @temp
  * defaults to D65. 

libvips/conversion/arrayjoin.c

@@ -394,16 +394,17 @@ vips_arrayjoinv( VipsImage **in, VipsImage **out, int n, va_list ap )
  * @in: (array length=n) (transfer none): array of input images
  * @out: output image
  * @n: number of input images
+ * @...: %NULL-terminated list of optional named arguments
  *
  * 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: %gint, number of images per row
+ * * @shim: %gint, space between images, in pixels
+ * * @background: #VipsArrayDouble, background ink colour
+ * * @halign: #VipsAlign, low, centre or high alignment
+ * * @valign: #VipsAlign, low, centre or high alignment
+ * * @hspacing: %gint, horizontal distance between images
+ * * @vspacing: %gint, 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

libvips/conversion/autorot.c

@@ -126,9 +126,9 @@ vips_autorot_remove_angle_sub( VipsImage *image,
 
 /**
  * vips_autorot_remove_angle:
- * @im: image to remove orientation from
+ * @image: image to remove orientation from
  *
- * Remove the orientation tag on @im. Also remove any exif orientation tags. 
+ * Remove the orientation tag on @image. Also remove any exif orientation tags. 
  *
  * See also: vips_autorot_get_angle(). 
  */

libvips/iofuncs/image.c

@@ -2997,6 +2997,8 @@ vips_image_rewind_output( VipsImage *image )
  * have made it yourself), use vips_image_wio_input() instead.
  *
  * See also: vips_image_wio_input().
+ *
+ * Returns: (transfer full): the new #VipsImage, or %NULL on error.
  */
 VipsImage *
 vips_image_copy_memory( VipsImage *image )

libvips/resample/reduce.c

@@ -50,6 +50,19 @@
 
 #include "presample.h"
 
+/**
+ * VipsKernel: 
+ * @VIPS_KERNEL_NEAREST: The nearest pixel to the point.
+ * @VIPS_KERNEL_LINEAR: Calculate a pixel value using linear interpolation.
+ * @VIPS_KERNEL_CUBIC: Calculate using a 4-element cubic kernel.
+ * @VIPS_KERNEL_LANCZOS2: Calculate with a two-lobe Lanczos kernel.
+ * @VIPS_KERNEL_LANCZOS3: Calculate with a three-lobe Lanczos kernel.
+ *
+ * The resampling kernels vips supports. See vips_reduce(), for example.  
+ *
+ * The Lanczos kernels vary in size with the downsampling ratio. 
+ */
+
 typedef struct _VipsReduce {
 	VipsResample parent_instance;
 
@@ -141,15 +154,15 @@ vips_reduce_init( VipsReduce *reduce )
  * @in: input image
  * @out: output image
  * @xshrink: horizontal shrink
- * @shrinke: vertical shrink
+ * @yshrink: vertical shrink
  * @...: %NULL-terminated list of optional named arguments
  *
  * Optional arguments:
  *
  * * @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.
+ * Reduce @in by a pair of factors with a pair of 1D kernels. This 
+ * will not work well for shrink factors greater than three.
  *
  * This is a very low-level operation: see vips_resize() for a more
  * convenient way to resize images.