Changeset 133 for trunk/SRC/Picture/showimage.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Picture

Files:

• . (added)
• showimage.pro (moved) (moved from trunk/SRC/ToBeReviewed/IMAGE/showimage.pro) (3 diffs)

trunk/SRC/Picture/showimage.pro

@@ -1 @@
-PRO SHOWIMAGE, FILE, DITHER=DITHER, CURRENT=CURRENT
-;
-  compile_opt idl2, strictarrsubs
-;
-
 ;+
-; NAME:
-;    SHOWIMAGE
-;
-; PURPOSE:
-;    Show the contents of a graphics file in the current window.
+;
+; @file_comments 
+; Show the contents of a graphics file in the current window.
 ;
 ;    The input formats supported are:
@@ -21 +14 @@
 ;    to 8-bit or 24-bit images on-screen are done automatically.
 ;
-; CATEGORY:
-;    Input/Output.
-;
-; CALLING SEQUENCE:
-;    SHOWIMAGE, FILE
-;
-; INPUTS:
-;    FILE     Name of the output file (format is identified automatically).
-;
-; OPTIONAL INPUTS:
-;    None.
-;
-; KEYWORD PARAMETERS:
-;    DITHER   Set this keyword to dither the input image when displaying
+; @categories Input/Output.
+;
+; @param FILE {in}{required} Name of the output file (format is identified automatically).
+;
+; @keyword DITHER Set this keyword to dither the input image when displaying
 ;             24-bit images on an 8-bit display (default is no dithering).
-;    CURRENT  Set this keyword to display the image in the current window
+; @keyword CURRENT Set this keyword to display the image in the current window
 ;             (default is to create a new window sized to fit the image).
 ;
-; OUTPUTS:
-;    None.
-;
-; OPTIONAL OUTPUTS:
-;    None
-;
-; COMMON BLOCKS:
-;    None
-;
-; SIDE EFFECTS:
-;    The color table is modified.
-;
-; RESTRICTIONS:
-;    Requires IDL 5.2 or higher (image QUERY functions).
-;
-; EXAMPLE:
-;
-;showimage, filepath('rose.jpg', subdir='examples/data')
-;
-; MODIFICATION HISTORY:
-; Liam.Gumley@ssec.wisc.edu
+; @restrictions The color table is modified.
+;
+; @restrictions Requires IDL 5.2 or higher (image QUERY functions).
+;
+; @examples showimage, filepath('rose.jpg', subdir='examples/data')
+;
+; @history Liam.Gumley@ssec.wisc.edu
 ; http://cimss.ssec.wisc.edu/~gumley
-; $Id$
-;
-; Copyright (C) 1999 Liam E. Gumley
 ;
 ; This program is free software; you can redistribute it and/or
@@ -78 +45 @@
 ; along with this program; if not, write to the Free Software
 ; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+;
+; @version $Id$ 
+;
 ;-
-
+PRO SHOWIMAGE, FILE, DITHER=DITHER, CURRENT=CURRENT
+;
+  compile_opt idl2, strictarrsubs
+;
 rcs_id = '$Id$'