Changeset 133 for trunk/SRC/Colors/color24.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Colors

Files:

• . (added)
• color24.pro (moved) (moved from trunk/SRC/ToBeReviewed/COULEURS/color24.pro) (2 diffs)

trunk/SRC/Colors/color24.pro

@@ -1 +1 @@
 ;+
-; NAME:
-;       COLOR24
 ;
-; PURPOSE:
-;       The purpose of this function is to convert a RGB color triple
-;       into the equivalent 24-big long integer. 
+; @file_comments 
+; The purpose of this function is to convert a RGB color triple
+; into the equivalent 24-big long integer. 
 ;
-; CATEGORY:
-;       Graphics, Color Specification.
+; @categories Graphics, Color Specification.
 ;
-; CALLING SEQUENCE:
-;       color = COLOR24(rgb_triple)
-;
-; INPUTS:
-;       RGB_TRIPLE: A three-element column or row array representing 
+; @param RGB_TRIPLE {in}{required} A three-element column or row array representing 
 ;       a color triple. The values of the elements must be between 
 ;       0 and 255.
 ;
-; KEYWORD PARAMETERS:
-;       None. 
+; @returns a 24-bit long integer that is equivalent the input color. 
+; The color is
+; described in terms of a hexidecimal number (e.g., FF206A)
+; where the left two digits represent the blue color, the 
+; middle two digits represent the green color, and the right 
+; two digits represent the red color.
 ;
-; COMMON BLOCKS:
-;       None.
-;
-; SIDE EFFECTS:
-;       None.
-;
-; RESTRICTIONS:
-;       None.
-;
-; EXAMPLE:
-;       To convert the color triple for the color YELLOW, 
+; @examples To convert the color triple for the color YELLOW, 
 ;       (255, 255, 0), to the hexadecimal value '00FFFF'x 
 ;       or the decimal number 65535, type:
@@ -40 +27 @@
 ;       COLORS or GETCOLOR
 ;
-; MODIFICATION HISTORY:
+; @history
 ;       Written by:     David Fanning, 3 February 96.
+;
+; @version $Id$
+;
 ;-
-
-
 FUNCTION COLOR24, number
 ;
   compile_opt idl2, strictarrsubs
-;
-
-   ; This FUNCTION accepts a [red, green, blue] triple that
-   ; describes a particular color and returns a 24-bit long
-   ; integer that is equivalent to that color. The color is
-   ; described in terms of a hexidecimal number (e.g., FF206A)
-   ; where the left two digits represent the blue color, the 
-   ; middle two digits represent the green color, and the right 
-   ; two digits represent the red color.
-   ;
-   ; The triple can be either a row or column vector of 3 elements.
-   
+;   
 ON_ERROR, 1