Changeset 231 for trunk/SRC/ToBeReviewed/PLOTS/VECTEUR/velovect.pro

Timestamp:

03/19/07 18:15:51 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

• trunk/SRC/ToBeReviewed/PLOTS/VECTEUR/velovect.pro (modified) (7 diffs)

trunk/SRC/ToBeReviewed/PLOTS/VECTEUR/velovect.pro

@@ -1 @@
-;
-;+ 
+;+
 ;
 ; @file_comments
 ; Produce a two-dimensional velocity field plot.
 ;
-; A directed arrow is drawn at each point showing the direction and 
+; A directed arrow is drawn at each point showing the direction and
 ; magnitude of the field.
-;               
+;
 ; @categories
 ; Plotting, two-dimensional.
 ;
-;
 ; @param U {in}{required}
-; The X component of the two-dimensional field.  
+; The X component of the two-dimensional field.
 ; U must be a two-dimensional array.
 ;
 ; @param V {in}{required}
 ; The Y component of the two dimensional field.  Y must have
-; the same dimensions as X.  The vector at point [i,j] has a 
+; the same dimensions as X.  The vector at point [i,j] has a
 ; magnitude of:
 ;
@@ -28 +26 @@
 ;
 ; @param X {in}{optional}{type=vector}
-; Optional abscissa values.  X must be a vector with a length 
+; Optional abscissa values.  X must be a vector with a length
 ; equal to the first dimension of U and V.
 ;
@@ -39 +37 @@
 ;
 ; @keyword DOTS
-; Set this keyword to 1 to place a dot at each missing point. 
+; Set this keyword to 1 to place a dot at each missing point.
 ; Set this keyword to 0 or omit it to draw nothing for missing
 ; points.  Has effect only if MISSING is specified.
@@ -55 +53 @@
 ; current graphics screen is not erased, no axes are drawn, and
 ; the previously established scaling remains in effect.
-; 
+;
 ; @keyword CLIP
-; 
+;
 ; @keyword NOCLIP
 ;
 ; @keyword _EXTRA
-; Used to pass your keywords.
+; Used to pass keywords
 ;
-; @restrictions 
+; @restrictions
 ; Plotting on the selected device is performed.  System
 ; variables concerning plotting are changed.
 ; Note:   All other keywords are passed directly to the PLOT procedure
-;       and may be used to set option such as TITLE, POSITION, 
+;       and may be used to set option such as TITLE, POSITION,
 ;       NOERASE, etc.
 ;
@@ -83 +81 @@
 ;       June, 1995, MWR. Removed _EXTRA inheritance for PLOTS and changed
 ;                        OPLOT to PLOTS.
-;       September, 1996, GGS. Changed denominator of x_step and y_step vars. 
+;       September, 1996, GGS. Changed denominator of x_step and y_step vars.
 ;       February, 1998, DLD.  Add support for CLIP and NO_CLIP keywords.
 ;       June, 1998, DLD.  Add support for OVERPLOT keyword.
@@ -103 +101 @@
         s = size(u)
         t = size(v)
-        if s[0] ne 2 then begin 
+        if s[0] ne 2 then begin
 baduv:   message, 'U and V parameters must be 2D and same size.'
                 endif
@@ -122 +120 @@
         nbad = 0                        ;# of missing points
         if n_elements(missing) gt 0 then begin
-                good = where(mag lt missing) 
+                good = where(mag lt missing)
                 if keyword_set(dots) then bad = where(mag ge missing, nbad)
         endif else begin