Changeset 378 for trunk/SRC/ToBeReviewed/PLOTS/DIVERS

Timestamp:

08/12/08 14:35:46 (16 years ago)

Author:

pinsard

Message:

improvements of headers (typo, links, paragraphes, etc)

Location:

trunk/SRC/ToBeReviewed/PLOTS/DIVERS

Files:

• addaxe.pro (modified) (1 diff)
• axis4pltz.pro (modified) (1 diff)
• checkfield.pro (modified) (4 diffs)
• determineminmax.pro (modified) (1 diff)
• placecolor.pro (modified) (1 diff)
• placedessin.pro (modified) (8 diffs)
• restoreatt.pro (modified) (2 diffs)
• saveatt.pro (modified) (1 diff)
• terminedessin.pro (modified) (1 diff)

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

@@ -3 +3 @@
 ; @file_comments
 ; Add an axis when we do an oblique section in <pro>pltz</pro>, 
-; <pro>pltt</pro>
-; or <pro>plt1d</pro>
+; <pro>pltt</pro> or <pro>plt1d</pro>
 ;
 ; @categories

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

@@ -33 +33 @@
 ; Used to pass keywords
 ;
-; Others: see pltz
+; Others: see <pro>pltz</pro>
 ;
 ; @history

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

@@ -15 +15 @@
 ;
 ; @param NAME {in}{optional}{type=string}
-; It gives the name of the file to be opened. If NAME
+; It gives the name of the file to be opened. 
+;
+; If NAME
 ; does not contain the separating character of directories ('/' under
 ; unix for example), the file will be looked for in the current directory.
@@ -142 +144 @@
 ;
 ; @param FIELD {in}{required}{type=field}
-; It respect <pro>litchamp</pro>'s criterions. See IDL>xhelp,'litchamp'
+; It respect <pro>litchamp</pro>'s criterions.
 ;
 ; @param PROCEDURE {in}{required}
@@ -152 +154 @@
 ; @keyword BOXZOOM {type=vector}
 ; 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]]
@@ -168 +171 @@
 ; @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 inconsequential.
-;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated.
+; 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 inconsequential.
+;  vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated.
 ;
 ; @keyword _EXTRA

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

@@ -48 +48 @@
 ; $Id$
 ;
-; @todo seb: manque les param glam et gphi
+; @todo
+; seb: manque les param glam et gphi
 ;
 ;-

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

@@ -3 +3 @@
 ; @file_comments
 ; allows to trace the independently from a graph
+;
 ; By default, trace a color bar of the same type than the one present in 
 ; <pro>plt</pro>
 ; and <pro>pltz</pro>.
+;
 ; If max, min and divisions are not stipulated, then max=sup,min=inf
 ; and divisions=div.

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

@@ -13 +13 @@
 ; @param POSFENETRE {out}{type=vector}
 ; 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
@@ -18 +19 @@
 ; @param POSBAR {out}{type=vector}
 ; Like POSFENETRE but for the color bar.
+;
 ; Same comment to position the color bar, !p.position=posbar
 ;
@@ -32 +34 @@
 ; @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 description of these 3 values (see the online help of <proidl>map_set</proidl>).
+;     MAP=[P0lat,P0lon,Rot]. For the description of these 3 values (see the online help of <proidl>MAP_SET</proidl>).
 ;     /MAP: In this case, map is automatically calculated have the value:
 ;          map = [0, (lon1+lon2)/2., 0]
+;
 ; Comment 1: 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 "Mapping" and "Global Mapping Demo"
+;
 ; Comment 2: 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:
 ;   IDL> domdef,-180,180,-90,-45
@@ -57 +63 @@
 ; 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 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:
-; in this case, we divide the page or the screen in small[0] columns and in small[1] lines
-; the drawing made in the box numbered small[2]. The numerotation starting up and left by
+;
+; If there is 4 elements 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, we divide the page or the screen in small[0] columns 
+; and in small[1] lines, the drawing is made in the box numbered small[2]. 
+;
+; The numerotation starting up and left by
 ; the number 1 and then, following the writing direction.
-; By default, we make the largest drawing we can do, conserving the aspect ratio 
-; (except when REMPLI is activated).
+;
+; By default, we make the largest drawing we can do, conserving the aspect 
+; ratio (except when REMPLI is activated).
 ;
 ; @keyword PORTRAIT
@@ -72 +82 @@
 ;
 ; @keyword POST
-; Make a postscript. Only works if we made one drawing on the page.
+; Make a postscript. 
+;
+; Only works if we made one drawing on the page.
+;
 ; If we make several drawing, use \@<pro>ps</pro>.
 ;
@@ -80 +93 @@
 ; @keyword WINDOW
 ; Number of the window on which we want to do the graph (Allow to open several windows).
+;
 ; By default, we open 'IDL0'
 ;
@@ -88 +102 @@
 ; If we want to trace contours of a different field than the one
 ; 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 <pro>plt</pro>.
 ;
 ; @keyword ENDPOINTS
-; keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
-; of these ones are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
-; coordinates.
+; keyword specifying that we want to make a vertical cut in diagonal. 
+;
+; Then coordinated of extremities of these ones are defined by the 4 elements 
+; of the vector ENDPOINTS: [x1,y1,x2,y2] which are coordinates.
 ;
 ; @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 inconsequential.
+; 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 inconsequential.
 ;       vecteur={u:lec('unsurface'),v:lec('vnsurface')} is also appropriated.
 ;
 ; @keyword DIREC
 ; 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
-;       'xzt' 'yzt' 'xyzt' Direction on which do averages
+; 'xzt' 'yzt' 'xyzt' Direction on which do averages
 ;
 ; @keyword _EXTRA
@@ -112 +132 @@
 ;
 ; @keyword COLOR_C
-; To draw the contour in color instead of in black
-; with filling in color
+; To draw the contour in color instead of in black with filling in color
 ;
 ; @uses

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

@@ -10 +10 @@
 ; @param STRUCT {in}{required}
 ; a structure like the one who read <pro>litchamp</pro>.
-;        See IDL> xhelp,'litchamp'
 ;
 ; @uses
@@ -17 +16 @@
 ; @restrictions
 ; Change the value if global variables attribute of a field: vargrid,
-; varname, varunit, vardate, varexp , valmask and time.
+; varname, varunit, vardate, varexp, valmask and time.
 ;
 ; @history

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

@@ -2 +2 @@
 ;
 ; @file_comments
-; Allows to put in a structure attributes which can be associated with a variable.
+; Allows to put in a structure attributes which can be associated with 
+; a variable.
 ;
 ; @categories

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

@@ -8 +8 @@
 ;
 ; @keyword POST
-; Make a postscript. Only works if we made one drawing on the page.
+; Make a postscript. 
+;
+; Only works if we made one drawing on the page.
 ; If we make several drawing, use \@<pro>ps</pro>.
 ;
 ; @keyword SMALL {type=vector}
 ; 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 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:
-; in this case, we divide the page or the screen in small[0] columns and in small[1] lines
-; the drawing made in the box numbered small[2]. The numerotation starting up and left by
-; the number 1 and then, following the writing direction.
-; By default, we make the largest drawing we can do, conserving the aspect ration 
-; (except when REMPLI is activated).
+; small portion of a page or screen. 
+;
+; It delimit the zone where the drawing will be done.
+;
+; If there is 4 elements 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 we divide the page or the screen in small[0] columns 
+; and in small[1] lines and the drawing is made in the box numbered small[2]. 
+;
+; The numerotation starting up and left by the number 1 and then, following 
+; the writing direction.
+;
+; By default, we make the largest drawing we can do, conserving the aspect 
+; ration (except when REMPLI is activated).
 ;
 ; @keyword _EXTRA