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

trunk/SRC/Interpolation/spl_fstdrv.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:spl_fstdrv
 ;
-; PURPOSE: SPL_FSTDRV returns the values of the first derivative of
+; @file_comments SPL_FSTDRV returns the values of the first derivative of
 ; the interpolating function at the points X2i. it is a double
 ; precision array.
@@ -15 +14 @@
 ; in a way that interpolated value are also in ascending order
 ;
-; CATEGORY:
+; @examples  y2 =  spl_fstdrv(x, y, yscd, x2)
 ;
-; CALLING SEQUENCE: y2 =  spl_fstdrv(x, y, yscd, x2)
-;
-; INPUTS:
-;
-;    x: An n-element (at least 2) input vector that specifies the
+;    @param x {in}{required}  An n-element (at least 2) input vector that specifies the
 ;    tabulate points in ascending order.
 ;
-;    y: f(x) = y. An n-element input vector that specifies the values
+;    @param y {in}{required}  f(x) = y. An n-element input vector that specifies the values
 ;    of the tabulated function F(Xi) corresponding to Xi.
 ;
-;    yscd: The output from SPL_INIT for the specified X and Y.
+;    @param yscd {in}{required}  The output from SPL_INIT for the specified X and Y.
 ;
-;    x2: The input values for which the first derivative values are
+;    @param x2 {in}{required}  The input values for which the first derivative values are
 ;    desired. X can be scalar or an array of values.
 
-; KEYWORD PARAMETERS: none
-;
-; OUTPUTS: 
+; @returns 
 ;
 ;    y2: f'(x2) = y2. 
 ;
-; COMMON BLOCKS: none
 ;
-; SIDE EFFECTS: ?
-;
-; RESTRICTIONS: ?
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:
-;  Sebastien Masson (smasson@lodyc.jussieu.fr): May 2005
+; @history
+;  Sebastien Masson (smasson\@lodyc.jussieu.fr): May 2005
 ;-
 ;------------------------------------------------------------