Changeset 163 for trunk/SRC/ToBeReviewed/PLOTS/DIVERS/placedessin.pro

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)

File:

• trunk/SRC/ToBeReviewed/PLOTS/DIVERS/placedessin.pro (modified) (6 diffs)

trunk/SRC/ToBeReviewed/PLOTS/DIVERS/placedessin.pro

@@ -10 +10 @@
 ; Utilities
 ;
-; @param TYPEDESSIN
-; It is a chain or characteres specifying what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt'
+; @param TYPEDESSIN {type=string}
+; It specify what procedure is called by PLACEDESSIN: 'plt', 'pltz' or 'pltt'
 ;
 ; @keyword LANDSCAPE 
-; Force the page or the window on the screen to be in lenthened position.
-;
-; @keyword LCT 
-; Is an integer designating the number of the palette of color we want to use for the plot. 
+; Force the page or the window on the screen to be in lengthened position.
+;
+; @keyword LCT {type=integer}
+; It designate the number of the palette of color we want to use for the plot. 
 ;       
 ; @keyword MAP 
 ; We use it when we want to do a projection.
 ; This keyword can be of two types:
-;     MAP=[P0lat,P0lon,Rot]. For the descrption of these 3 values (see the online help of MAP_SET).
-;     /MAP: In this case, map is automatically caculated have the value: 
+;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of MAP_SET).
+;     /MAP: In this case, map is automatically calculated have the value: 
 ;          map = [0, (lon1+lon2)/2., 0]
 ; Comment: A good way to choose the type of the projection we want to do is to have a look at IDL demo:
 ; IDL> demo
 ; Then choose earth sciences and  mapping.
-; Comment2: By default it  is a cindrical projection which is effectuated (with or without the keyword map). 
+; Comment2: By default it is a cylindrical projection which is effectuated (with or without the keyword map). 
 ; If we want an other projection, MAP must be activated and we have to add the keyword: /nom_projection.
 ; For example, for a polar projection centered on the south pole:
@@ -44 +44 @@
 ;
 ; @keyword SMALL 
-; Vector composed of 3 or 4 elements, applyed to make a drawing on a 
+; Vector composed of 3 or 4 elements, applied to make a drawing on a 
 ; small portion of a page or screen. It delimit the zone where the drawing will be done.
 ;     If there is 4 elements:
-; then is constituated of coordinates (expressed in cm located from the up and 
-; left corner of the page or the window (in portrait like in lanscape)) of the bottom 
+; then is constituted of coordinates (expressed in cm located from the up and 
+; left corner of the page or the window (in portrait like in landscape)) of the bottom 
 ; and left corner and of the up and right corner of the drawing zone.
 ;     If there is 3 elements:
@@ -55 +55 @@
 ; the number 1 and then, following the writing direction.
 ; By default, we make the largest drawing we can do, conserving the aspect rapport 
-; (exept when REMPLI is activated).
+; (except when REMPLI is activated).
 ; 
 ; @keyword PORTRAIT 
@@ -67 +67 @@
 ; Force the drawing to occupy the whole space defined by small.
 ;
-; @keyword WINDOW
+; @keyword WINDOW 
 ; Number of the window on which we want to do the graph (Allow to open several windows). 
 ; By default, we open 'IDL0'
@@ -76 +76 @@
 ; @keyword CONTOUR 
 ; If we want to trace contours of a different field than the one 
-; whose we have the colored drawing (by examlpe E-P in color and QSR in contours). 
-; It must be a field respecting same caracteristics than the argument number one of plt.
+; whose we have the colored drawing (by example E-P in color and QSR in contours). 
+; It must be a field respecting same characteristics than the argument number one of plt.
 ;
 ; @keyword ENDPOINTS 
-; keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities 
-; of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
+; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities 
+; of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are 
 ; coordinates. 
 ;
-; @keyword VECTEUR
+; @keyword VECTEUR {type=vector}
 ; It is a structure composed by 2 elements containing the 2 fields U
 ; and V of values of the zonal and meridian component of the vector of the fields
 ; to draw. These fields can be an array or a structure.
 ;       For example: vecteur={matriceu:lec('unsurface'),matricev:lec('vnsurface')}
-;       Comment: name of elements of vectors are inconsenquential.
+;       Comment: name of elements of vectors are inconsequential.
 ;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated.
 ;
@@ -103 +103 @@
 ; with filling in color 
 ;
-; @param POSFENETRE {out}
+; @param POSFENETRE {out}{type=vector}
 ; It is a vector composed by 4 elements containing the position of the frame 
-; containing captions and the graph in normalized coorinates. 
+; containing captions and the graph in normalized coordinates. 
 ; Comment: To position the drawing; we have to do !p.position=posfenetre 
 ; after the call of the caliber
 ;
-; @param POSBAR {out}
+; @param POSBAR {out}{type=vector}
 ; Like POSFENETRE but for the color bar. 
 ; Same comment to position the color bar, !p.position=posbar