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

trunk/SRC/Interpolation/cutsegment.pro

@@ -1 +1 @@
 ;+
-; NAME: cutsegment
 ;
-; PURPOSE: cut p segments into p*n equal parts
+; @file_comments cut p segments into p*n equal parts
 ;
-; CATEGORY: basic work
+; @categories basic work
 ;
-; CALLING SEQUENCE: res = cutsegment(x0, y0, x1, y1, n)
+; @examples  
+; res = cutsegment(x0, y0, x1, y1, n)
 ;
-; INPUTS: 
-;         x0,y0 and x1,y1, 1d arrays of p elements, the coordinates of
+;         @param x0,y0 and x1,y1  {in}{required}  1d arrays of p elements, the coordinates of
 ;         the endpoints of the p segmements
-;         n: the number of pieces we want to cut each segment
+;         @param  n {in}{required}  the number of pieces we want to cut each segment
 ;
-; KEYWORD PARAMETERS:
 ;
-;         /endpoints: see ouputs
+; @keyword         /endpoints see ouputs
 ;
-;         /onsphere: to specify that the points are located on a
+; @keyword         /onsphere to specify that the points are located on a
 ;         sphere. In this case, x and y corresponds to longitude and
 ;         latitude in degrees.
 ;
-; OUTPUTS:
+; @returns
 ;        defaut: a 3d array (2,n,p) that gives the coordinates of the
 ;        middle of the cutted segments.
@@ -27 +25 @@
 ;        coordinates of the endpoints of the cutted segments.
 ;
-; COMMON BLOCKS: no
-;
-; SIDE EFFECTS: no
-;
-; RESTRICTIONS: ?
-;
-; EXAMPLE:
+; @examples 
 ;
 ;  IDL> x0=[2,5]
@@ -46 +38 @@
 ;  IDL> oplot, [res[0,*,1]], [res[1,*,1]], color = 40, psym = 1, thick = 3
 ;
-; MODIFICATION HISTORY:
-;           S. Masson (smasson@lodyc.jussieu.fr)
+; @history
+;           S. Masson (smasson\@lodyc.jussieu.fr)
 ;           July 5th, 2002
 ;-