Changeset 231 for trunk/SRC/Colors/getcolor.pro

Timestamp:

03/19/07 18:15:51 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

• trunk/SRC/Colors/getcolor.pro (modified) (10 diffs)

trunk/SRC/Colors/getcolor.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; The original purpose of this function was to enable the
 ; user to specify one of the 16 colors supported by the
@@ -15 +15 @@
 ; table offered on the IDL newsgroup by Liam Gumley.)
 ;
-; @categories Graphics, Color
-;
-; @param thisColor {in}{optional} 
+; @categories
+; Graphics, Color
+;
+; @param thisColor {in}{optional}
 ; A string with the "name" of the color. Valid names are:
 ;           black
@@ -39 +40 @@
 ; Case is unimportant.
 ;
-;
-; @param index {in}{optional} 
+; @param index {in}{optional}
 ; The color table index where the specified color should be loaded.
 ;
@@ -68 +68 @@
 ;
 ;
-; @keyword NAMES 
+; @keyword NAMES
 ; If this keyword is set, the return value of the function is
 ; a 16-element string array containing the names of the colors.
@@ -77 +77 @@
 ; listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
 ;
-; @keyword LOAD  
+; @keyword LOAD
 ; If this keyword is set, all 16 colors are automatically loaded
 ; starting at the color index specified by the START keyword.
@@ -96 +96 @@
 ; IDL 5.2 and higher.
 ;
-; @keyword TRUE  
+; @keyword TRUE
 ; If this keyword is set, the specified color triple is returned
 ; as a 24-bit integer equivalent. The lowest 8 bits correspond to
@@ -104 +104 @@
 ; were set.
 ;
-; @restrictions 
+; @restrictions
 ; The TRUE keyword causes the START keyword to be ignored.
-; The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be 
+; The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be
 ; ignored.
 ; The COLOR parameter is ignored if the LOAD keyword is used.
@@ -113 +113 @@
 ; returned if color decomposition is ON.
 ;
-; @examples 
+; @examples
 ; To load a yellow color in color index 100 and plot in yellow, type:
 ;
@@ -177 +177 @@
 ;      IDL> PLOT, data, Color=colors.yellow
 ;
-; @history 
+; @history
 ; Written by: David Fanning, 10 February 96.
 ; Fixed a bug in which N_ELEMENTS was spelled wrong. 7 Dec 96. DWF
@@ -187 +187 @@
 ; Added LOAD AND START keywords. 7 June 99. DWF.
 ;
-; @version $Id$
+; @version
+; $Id$
 ;-
-
+;
 FUNCTION getcolor, thisColor, index, TRUE=truecolor, $
    NAMES=colornames, LOAD=load, START=start