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

trunk/SRC/Interpolation/cutpar.pro

@@ -1 +1 @@
 ;+
-; NAME: cutpar
 ;
-; PURPOSE: cut p parallelogram(s) into p*n^2 parallelograms
+; @file_comments cut p parallelogram(s) into p*n^2 parallelograms
 ;
-; CATEGORY: basic work
+; @categories basic work
 ;
-; CALLING SEQUENCE:res = cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n)
+; @examples 
+; res = cutpar(x0, y0, x1, y1, x2, y2, x3, y3, n)
 ;
-; INPUTS:
-;       x0,y0 1d arrays of p elements, giving the edge positions. The
+;       @param x0,y0  {in}{required} 1d arrays of p elements, giving the edge positions. The
 ;       edges must be given as in plot to traw the parallelogram. (see
 ;       example).
-;       n: each parallelogram will be cutted in n^2 pieces
+;       @param n {in}{required} each parallelogram will be cutted in n^2 pieces
 ;
-; KEYWORD PARAMETERS: 
+; @keyword         /endpoints see outputs
 ;
-;         /endpoints: see outputs
-;
-;         /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: 3d array(2,n^2,p) giving the center position of each
 ;        piece of the parallelograms
@@ -28 +25 @@
 ;        of each piece of the parallelograms
 ;
-; COMMON BLOCKS: no
+; @uses cutsegment.pro
 ;
-; SIDE EFFECTS: need cutsegment.pro
-;
-; RESTRICTIONS: ?
-;
-; EXAMPLE:
+; @examples 
 ;
 ; x0 = [2,6,2]
@@ -50 +43 @@
 ; for i=0,2 do oplot, [res[0,*,i]], [res[1,*,i]], color = 20+10*i, psym = 1, thick = 3
 ;
-; MODIFICATION HISTORY:
-;           S. Masson (smasson@lodyc.jussieu.fr)
+; @history
+;           S. Masson (smasson\@lodyc.jussieu.fr)
 ;           July 5th, 2002
 ;-