Changeset 163 for trunk/SRC/Picture/saveimage.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Picture/saveimage.pro (modified) (3 diffs)

trunk/SRC/Picture/saveimage.pro

@@ -17 +17 @@
 ; @categories Input/Output.
 ;
-; @param FILE {in}{required}
-; Name of the output file (GIF format by default).
+; @param FILE {in}{required}{default=format GIF}
+; Name of the output file
 ;
 ; @keyword BMP
@@ -35 +35 @@
 ; Set this keyword to create TIFF format (24-bit true color).
 ;
-; @keyword QUALITY
+; @keyword QUALITY {default=75}
 ; If set to a named variable, specifies the quality for
-; JPEG output (default 75). Ranges from 0 ("terrible") to
+; JPEG output. Ranges from 0 ("terrible") to
 ; 100 ("excellent"). Smaller quality values yield higher
 ; compression ratios and smaller output files.
 ;
-; @keyword DITHER
+; @keyword DITHER {default=no dithering}
 ; If set, dither the output image when creating 8-bit output
-; which is read from a 24-bit display (default is no dithering).
-;
-; @keyword CUBE
+; which is read from a 24-bit display.
+;
+; @keyword CUBE {default=to use statistical method)
 ; If set, use the color cube method to quantize colors when
-; creating 8-bit output which is read from a 24-bit display
-; (default is to use the statistical method). This may improve
-; the accuracy of colors in the output image, especially white.
-;
-; @keyword QUIET
-; Set this keyword to suppress the information message
-; (default is to print an information message).
+; creating 8-bit output which is read from a 24-bit display.
+; This may improve the accuracy of colors in the output image, 
+; especially white.
+;
+; @keyword QUIET {default=to print an information message}
+; Set this keyword to suppress the information message.
 ;
 ; @restrictions
@@ -91 +90 @@
 ;
 ;-
-PRO SAVEIMAGE, FILE, BMP=BMP, PNG=PNG, PICT=PICT, JPEG=JPEG, TIFF=TIFF, $
+PRO saveimage, FILE, BMP=BMP, PNG=PNG, PICT=PICT, JPEG=JPEG, TIFF=TIFF, $
   QUALITY=QUALITY, DITHER=DITHER, CUBE=CUBE, QUIET=QUIET, MULTIPLE = multiple
 ;