Changeset 101 for trunk/SRC/Interpolation/compute_fromreg_imoms3_weigaddr.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/compute_fromreg_imoms3_weigaddr.pro (modified) (3 diffs)

trunk/SRC/Interpolation/compute_fromreg_imoms3_weigaddr.pro

@@ -1 +1 @@
 ;+
-; NAME: compute_fromreg_imoms3_weigaddr
-;
-; PURPOSE: compute the weight and address neede to interpolate data from a
+;
+; @file_comments compute the weight and address neede to interpolate data from a
 ;          "regular grid" to any grid using the imoms3 method
 ;   
-; CATEGORY:interpolation
-;
-; CALLING SEQUENCE: 
-;     compute_fromreg_imoms3_weigaddr, alon, alat, olon, olat, weig, addr
-;
-; INPUTS:
-;     lonin and latin: longitude/latitude of the input data 
-;     lonout and latout: longitude/latitude of the output data 
-;
-; KEYWORD PARAMETERS: 
-;
-;     /NONORTHERNLINE and /NOSOUTHERNLINE: activate if you don't whant to take into
+; @categories interpolation
+PRO compute_fromreg_imoms3_weigaddr, alonin, alatin, olonin, olat, weig, addr $
+;
+;     @param alonin {in}{required} longitude of the input data 
+;     @param alatin  {in}{required} latitude of the input data 
+;     @param olonin {in}{required} longitude of the output data 
+;     @param olat {in}{required} latitude of the output data 
+;
+; @keyword /NONORTHERNLINE and /NOSOUTHERNLINE activate if you don't whant to take into
 ;          account the northen/southern line of the input data when perfoming the
 ;          interpolation.
 ;
-; OUTPUTS: 
+; @returns 
 ;     weig, addr: 2D arrays, weig and addr are the weight and addresses used to
 ;     perform the interpolation:
@@ -26 +22 @@
 ;          dataout = reform(dataout, jpio, jpjo, /over)
 ;
-; COMMON BLOCKS: none
-;
-; SIDE EFFECTS: ?
-;
-; RESTRICTIONS:
+; @restrictions
 ;  -  the input grid must be a "regular/rectangular grid", defined as a grid for
 ;     which each lontitudes lines have the same latitude and each latitudes columns
@@ -42 +34 @@
 ;     using a imoms3 interpolation only along the longitudinal direction.
 ; 
-; EXAMPLE: 
-;
-; MODIFICATION HISTORY:
-;  November 2005: Sebastien Masson (smasson@lodyc.jussieu.fr) 
+; @history
+;  November 2005: Sebastien Masson (smasson\@lodyc.jussieu.fr) 
 ;  March 2006: works for rectangular grids
 ;-