Changeset 150 for trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildreadcmd.pro

Timestamp:

08/09/06 12:12:54 (18 years ago)

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildreadcmd.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/WIDGET/AUTOUR_de_XXX/buildreadcmd.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
-; NAME:buildreadcmd
+; 
+; @param BASE {in}{required} 
+; The id of the widget where apply the drawing.
 ;
-; PURPOSE:
+; @param SNAMEEXP {in}{required}
 ;
-; CATEGORY:
 ;
-; CALLING SEQUENCE:
+; @param PROCEDURE {in}{required}
+;
+;
+; @param TYPE {in}{required}
+;
 ; 
-; INPUTS:
+; @keyword BOXZOOM
+; Vector indicating the geographic zone on which we want to cut the map. 
+; If BOXZOOM has : 
+;   1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]]
+;   2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]]
+;   4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])]
+;   5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]]
+;   6 elements: The extraction is made on Boxzoom 
+; Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!
 ;
-; KEYWORD PARAMETERS:
+; @keyword COMPLETE
 ;
-; OUTPUTS:
+;  
+; @keyword NAMEFIELD
 ;
-; COMMON BLOCKS:common.pro
 ;
-; SIDE EFFECTS:
+; @uses
+; common.pro
+; 
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+; 
+; @version 
+; $Id$
 ;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @todo
+; seb: documenter les param et les keyword qui ne le sont pas.
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 FUNCTION buildreadcmd, base, snameexp, procedure, type, BOXZOOM = boxzoom $
                        , COMPLETE = complete, NAMEFIELD = namefield
@@ -135 +146 @@
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-; on va definir le string qui contiendra la commande a executer pour
-; la lecture
+; We will define the string which will contain the command to be executed for the reading.
 ;------------------------------------------------------------
     Cmd = ['; Definition of extra structure:', 'extra = '+sextra $