From 1e4a6bead66e0af234afa5f9c31a95ea6d062581 Mon Sep 17 00:00:00 2001
From: John Cupitt <jcupitt@gmail.com>
Date: Mon, 1 Feb 2010 17:46:37 +0000
Subject: [PATCH] im_scale() gtkdoc

---
 libvips/conversion/im_scale.c | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/libvips/conversion/im_scale.c b/libvips/conversion/im_scale.c
index cce6068c..a10ad799 100644
--- a/libvips/conversion/im_scale.c
+++ b/libvips/conversion/im_scale.c
@@ -1,12 +1,4 @@
-/* @(#) Scale an image so that min(im) maps to 0 and max(im) maps to 255. If
- * @(#) min(im)==max(im), then we return black. Any non-complex type.
- * @(#)
- * @(#) int 
- * @(#) im_scale( in, out )
- * @(#) IMAGE *in, *out;
- * @(#)
- * @(#) Returns 0 on success and -1 on error
- * @(#)
+/* im_scale
  *
  * Author: John Cupitt
  * Written on: 22/4/93
@@ -21,6 +13,8 @@
  * 16/10/06
  * 	- what? no, don't set Type, useful to be able to scale histograms, for
  * 	  example
+ * 1/2/10
+ * 	- gtkdoc
  */
 
 /*
@@ -63,7 +57,18 @@
 #include <dmalloc.h>
 #endif /*WITH_DMALLOC*/
 
-/* Scale, as noted above.
+/**
+ * im_scale:
+ * @in: input image
+ * @out: output image
+ *
+ * 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
+ * minimum is zero.
+ *
+ * See also: im_clip2fmt().
+ *
+ * Returns: 0 on success, -1 on error
  */
 int 
 im_scale( IMAGE *in, IMAGE *out )