Changeset 371 for trunk/SRC/Computation/norm.pro

Timestamp:

08/07/08 11:32:02 (16 years ago)

Author:

pinsard

Message:

improvements of headers (alignments of IDL prompt in examples)

File:

• trunk/SRC/Computation/norm.pro (modified) (3 diffs)

trunk/SRC/Computation/norm.pro

@@ -15 +15 @@
 ; @param VV {in}{required}
 ; Matrix representing the meridional coordinates (at V/U point) of a field of vectors
-; A 2D (xy), 3D (xyz or yt), 4D (xyzt) or a structure readable by
+; A 2D (xy), 3D (xyz or yt), 4D (xyzt) array or a structure readable by
 ; <pro>litchamp</pro> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
 ; Note that the dimension of the array must suit the domain dimension.
@@ -27 +27 @@
 ;
 ; @returns
-; A 2D (xy), 3D (xyz or yt), 4D (xyzt) Array
+; a 2D (xy), 3D (xyz or yt), 4D (xyzt) array
 ;
 ; @uses
-; cm_4mesh
-; cm_4data
-; cm_4cal
+; <pro>cm_4mesh</pro>
+; <pro>cm_4data</pro>
+; <pro>cm_4cal</pro>
 ;
 ; @restrictions
@@ -51 +51 @@
 ;
 ; @examples
+;
 ; To calculate the average of the norm of streams on all the domain
 ; between 0 and 50:
-;      IDL> domdef, 0, 50
-;      IDL> res = norm(un, vn, dir = 'xyz')
+;   IDL> domdef, 0, 50
+;   IDL> res = norm(un, vn, dir = 'xyz')
 ;
 ; @history