Changeset 101 for trunk/SRC/Interpolation/angle.pro

Timestamp:

06/12/06 10:29:56 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Interpolation *.pro files for better idldoc output

File:

• trunk/SRC/Interpolation/angle.pro (modified) (4 diffs)

trunk/SRC/Interpolation/angle.pro

@@ -1 +1 @@
 ;---------
 ;+
-; NAME:angle.pro (fom angle.F,v 2.2 in OPA8.2)
+; @file_comments north stereographic polar projection
 ;
-; PURPOSE:Compute angles between grid lines and direction of the North
+; @keyword    /DOUBLE use double precision (default is float)
 ;
-; CALLING SEQUENCE: 
-;     angle, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint
-;
-; INPUTS:
-;     fileocemesh a netcdf file that contains (at least):
-;        glamu, gphiu: longitudes and latitudes at U-points
-;        glamv, gphiv: longitudes and latitudes at V-points
-;        glamf, gphif: longitudes and latitudes at F-points
-;
-; KEYWORD PARAMETERS:
-;
-;    IODIRECTORY: the directory path where is located fileocemesh
-;
-;    /DOUBLE: use double precision (default is float)
-;
-; OUTPUTS:
+; @returns
 ;       gsinu,gcosu : sinus and cosinus of the angle 
 ;       gsinv,gcosv   between north-south direction 
 ;       gsint,gcost   and the j-direction of the mesh
-;                     
 ;
-; RESTRICTIONS: to compute the lateral boundary conditions, we assume
+; @restrictions to compute the lateral boundary conditions, we assume
 ; that: 
 ;     (1) the first line is similar to the second line
@@ -37 +21 @@
 ;
 ;
-; MODIFICATION HISTORY:
+; @history
 ;   --------------
 ;       Original :  96-07 (O. Marti)
@@ -45 +29 @@
 ;---------
 ;
-;  fsnspp: north stereographic polar projection
 FUNCTION fsnspp, plam, pphi, DOUBLE = double
   IF keyword_set(double) THEN BEGIN
@@ -59 +42 @@
 END
 ;---------
+;+
+; @file_comments Compute angles between grid lines and direction of the North
+;(fom angle.F,v 2.2 in OPA8.2)
+;
+; @param fileocemesh {in}{required} a netcdf file that contains (at least):
+;        glamu, gphiu: longitudes and latitudes at U-points
+;        glamv, gphiv: longitudes and latitudes at V-points
+;        glamf, gphif: longitudes and latitudes at F-points
+;
+; @keyword IODIRECTORY the directory path where is located fileocemesh
+; @keyword    /DOUBLE use double precision (default is float)
+;-
 ;---------
 ;