Changeset 186 for trunk/SRC/ToBeReviewed/TRIANGULATION/definetri.pro

Timestamp:

09/20/06 12:50:37 (18 years ago)

Author:

pinsard

Message:

introducing hyperlinks in idldoc outputs (1/2)

File:

• trunk/SRC/ToBeReviewed/TRIANGULATION/definetri.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/TRIANGULATION/definetri.pro

@@ -6 +6 @@
 ; the points are regulary-gridded on nx*ny array.
 ; Find a Delaunay triangulation for this set of points is easy:
-; Points define (nx-1)*(ny-1) rectangles which we can cut in 2
-; triangles. cf. figure above
+; Points define (nx-1)*(ny-1) rectangles which we can cut in 2 triangles. 
+; cf. figure above
 ;
 ; <fixe>
+; fixe
 ;      ny-1*---*---*. . . . . .*---*---*
 ;          |  +|  +|           |  +|  +|      
@@ -47 +48 @@
 ;
 ; @param DOWNWARD {in}{optional}
-; When downward is undefine all rectangles are cut
-; in using the upward diagonal. Downward is a vector which
-; contains the rectangles numbers which are cut in using the
-; downward diagonal.
-; The rectangle number is define by the index (in a nx*ny
-; vector) of the lower-left corner of the rectangle.
+; When downward is undefine all rectangles are cut in using the upward 
+; diagonal. 
+; Downward is a vector which contains the rectangles numbers which are cut in 
+; using the downward diagonal.
+; The rectangle number is defined by the index (in a nx*ny vector) of the 
+; lower-left corner of the rectangle.
 ;
 ; @returns
-; triangles is a 2d array and is dimensions are 3 and
-; 2*(nx-1)*(ny-1)
-; triangles is define like in the TRIANGULATE procedure.
+; triangles is a 2d array and its dimensions are 3 and 2*(nx-1)*(ny-1).
+; triangles is defined like in the TRIANGULATE procedure.
 ;
 ; @examples
 ;
-; triangles=definetri(3,3,[1,3])
-; triangles will be a this kind of triangulation:
+; IDL> triangles=definetri(3,3,[1,3])
+; triangles will be this kind of triangulation:
 ;
 ;          *---*---*
-;           |+  |  +|
-;           | + | + |
-;           |  +|+  |
+;          |+  |  +|
+;          | + | + |
+;          |  +|+  |
 ;          *---*---*
-;           |  +|+  |
-;           | + | + |
-;           |+  |  +|
+;          |  +|+  |
+;          | + | + |
+;          |+  |  +|
 ;          *---*---*
 ;
@@ -103 +103 @@
 ; we define upward: upward is a vector which contains the rectangles
 ; numbers which are cut in using the upward diagonal.
-; The rectangle number is define by the index (in a nx*ny vector) of
+; The rectangle number is defined by the index (in a nx*ny vector) of
 ; the lower-left corner of the rectangle.
       upward = bytarr(nx, ny)+1