Changeset 163 for trunk/SRC/Colors

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)

Location:

trunk/SRC/Colors

Files:

• color24.pro (modified) (1 diff)
• colorbar.pro (modified) (2 diffs)
• getcolor.pro (modified) (3 diffs)
• lct.pro (modified) (2 diffs)
• newpalette.pro (modified) (2 diffs)
• xlct.pro (modified) (3 diffs)
• xpal.pro (modified) (11 diffs)

trunk/SRC/Colors/color24.pro

@@ -33 +33 @@
 ;
 ;-
-FUNCTION COLOR24, rgb_triple
+FUNCTION color24, rgb_triple
 ;
   compile_opt idl2, strictarrsubs

trunk/SRC/Colors/colorbar.pro

@@ -37 +37 @@
 ; The format of the bar annotations.
 ;
-; @keyword CB_LABEL 
-; A vector to specify sticks values of the color bar. It allowes,
+; @keyword CB_LABEL {type=vector}
+; A vector to specify sticks values of the color bar. It allows,
 ; when we use DISCRETE, to have colors that don't increase by
 ; increments in a regular way.
@@ -115 +115 @@
 ;
 ;-
-PRO COLORBAR, BOTTOM=bottom, CB_CHARSIZE=cb_charsize, CB_CHARTHICK=cb_charthick $
+PRO colorbar, BOTTOM=bottom, CB_CHARSIZE=cb_charsize, CB_CHARTHICK=cb_charthick $
               , CB_COLOR=cb_color, DIVISIONS=divisions, DISCRETE=discrete $
               , CB_LABEL = cb_label, FORMAT=format, POSITION=position $

trunk/SRC/Colors/getcolor.pro

@@ -94 +94 @@
 ; value is ignored unless the LOAD keyword is also set. The keyword is also
 ; ignored if the TRUE keyword is set or if color decomposition in on in
-; IDL 5.2 and higher. The default value for the START keyword is
+; IDL 5.2 and higher.
 ;
 ; @keyword TRUE  
@@ -183 +183 @@
 ; Added the INDEX parameter to the program 8 Mar 99. DWF
 ; Added the NAMES keyword at insistence of Martin Schultz. 10 Mar 99. DWF
-; Reorderd the colors so black is first and white is last. 7 June 99. DWF
+; Reordered the colors so black is first and white is last. 7 June 99. DWF
 ; Added automatic recognition of DECOMPOSED=1 state. 7 June 99. DWF
 ; Added LOAD AND START keywords. 7 June 99. DWF.
@@ -190 +190 @@
 ;-
 
-FUNCTION GETCOLOR, thisColor, index, TRUE=truecolor, $
+FUNCTION getcolor, thisColor, index, TRUE=truecolor, $
    NAMES=colornames, LOAD=load, START=start
 ;

trunk/SRC/Colors/lct.pro

@@ -13 +13 @@
 ; @keyword LIGHTNESS 
 ; a scalar used to change the Lightness of the color
-; palette to be abble to adjust according to the printer we use,
+; palette to be able to adjust according to the printer we use,
 ; the media (paper or slide)... 
 ;               lightness < 1 to get lighter colors
@@ -23 +23 @@
 ; @keyword GET_NAME
 ; Set this keyword to a named variable in which the names of the color tables
-; are reurned as a string array. No changes are made to the color table.
+; are returned as a string array. No changes are made to the color table.
 ;
 ; @keyword _EXTRA

trunk/SRC/Colors/newpalette.pro

@@ -4 +4 @@
 ; @file_comments 
 ; Allows to save the palette which is on the screen
-; in a same type file than the one gven by default in IDL
+; in a same type file than the one given by default in IDL
 ; 'colors1.tbl'.
 ;
@@ -10 +10 @@
 ; Color
 ;
-; @param namepal {in}{required} 
+; @param namepal {in}{required}{type=string}
 ; a string containing the name of the new palette we want to write.
 ;

trunk/SRC/Colors/xlct.pro

@@ -2 +2 @@
 ; @hidden
 ;-
-PRO XLCT_PSAVE                  ;Save/Restore our plotting state.
+PRO xlct_psave                  ;Save/Restore our plotting state.
 ;  Swaps our state with the current state each time its called.
 ;
@@ -458 +458 @@
 ; will be undefined.
 ;
-; @history 5/5/1999 copie de xloadct par Sebastien Masson (smasson\@lodyc.jussieu.fr)
+; @history 5/5/1999 copy of xloadct par Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;
 ; @version $Id$
@@ -464 +464 @@
 ;-
 
-PRO XLct, SILENT=silent_f, GROUP=group, FILE=file, $
+PRO xlct, SILENT=silent_f, GROUP=group, FILE=file, $
           USE_CURRENT=use_current, NCOLORS = nc, BOTTOM=bottom, $
           MODAL=modal, BLOCK=block, UPDATECALLBACK=updt_cb_name, $

trunk/SRC/Colors/xpal.pro

@@ -7 +7 @@
 ; @hidden
 ;-
-function XP_NEW_COLORS
+function xp_new_colors
 ;
   compile_opt idl2, strictarrsubs
@@ -32 +32 @@
 ; @hidden
 ;-
-pro XP_ALERT_CALLER
+pro xp_alert_caller
 ;
   compile_opt idl2, strictarrsubs
@@ -61 +61 @@
 ; @hidden
 ;-
-pro XP_XLCTCALLBACK
+pro xp_xlctcallback
 ;
   compile_opt idl2, strictarrsubs
@@ -75 +75 @@
 ; @hidden
 ;-
-pro XP_REDRAW
+pro xp_redraw
 ;
   compile_opt idl2, strictarrsubs
@@ -103 +103 @@
 ; @hidden
 ;-
-pro XP_REPLOT, color_index, type
+pro xp_replot, color_index, type
 ;
   compile_opt idl2, strictarrsubs
@@ -190 +190 @@
 ; @hidden
 ;-
-pro XP_CHANGE_COLOR, type, value
+pro xp_change_color, type, value
 ;
   compile_opt idl2, strictarrsubs
@@ -236 +236 @@
 ; @hidden
 ;-
-pro XP_BUTTON_EVENT, event
+pro xp_button_event, event
 ;
   compile_opt idl2, strictarrsubs
@@ -388 +388 @@
 ;-
 
-pro XP_EVENT, event
+pro xp_event, event
 ;
   compile_opt idl2, strictarrsubs
@@ -542 +542 @@
 ; specified, a death of the caller results in a death of xpal
 ;
-; @keyword BLOCK
+; @keyword BLOCK {default=1}
 ; Set this keyword to have XMANAGER block when this
 ; application is registered.  By default the Xmanager
@@ -568 +568 @@
 ; will be undefined.
 ;
-; @history adaptation de xpalette pour ajouter un bouton save par
-;          Grima Nicolas (nglod\@ipsl.jussieu.fr) et par Masson
+; @history 
+; Adaptation of xpalette to add a save button by
+;          Grima Nicolas (nglod\@ipsl.jussieu.fr) and by Masson
 ;          Sebastien (smlod\@ipsl.jussieu.fr)
 ;
@@ -575 +576 @@
 ;
 ;-
-pro XPAL, GROUP=group, BLOCK=block, UPDATECALLBACK=updt_cb_name, $
+pro xpal, GROUP=group, BLOCK=block, UPDATECALLBACK=updt_cb_name, $
         UPDATECBDATA=updt_cb_data
 ;