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

Timestamp:

12/06/07 11:04:53 (17 years ago)

Author:

pinsard

Message:

modification of some headers (+some corrections) to prepare usage of the new idldoc

File:

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

trunk/SRC/ToBeReviewed/TRIANGULATION/definetri.pro

@@ -3 +3 @@
 ; @file_comments
 ; Define a triangulation array like <proidl>TRIANGULATE</proidl>.
-;         But in a VERY SIMPLE CASE:
+;
+; But in a VERY SIMPLE CASE:
 ; the points are regularly-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
 ;
 ; <fixe>
-; fixe
 ;      ny-1*---*---*. . . . . .*---*---*
 ;          |  +|  +|           |  +|  +|
@@ -41 +42 @@
 ; Utilities
 ;
-; @param NX {in}{required}
+; @param nx {in}{required}
 ; The x dimension array
 ;
-; @param NY {in}{required}
+; @param ny {in}{required}
 ; The y dimension array
 ;
-; @param DOWNWARD {in}{optional}
-; When DOWNWARD is undefined all rectangles are cut in using the upward
+; @param downward {in}{optional}
+; When downward is undefined all rectangles are cut in using the upward
 ; diagonal.
-; DOWNWARD is a vector which contains the rectangles numbers which are cut in
+; 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
@@ -62 +63 @@
 ;
 ; IDL> triangles=definetri(3,3,[1,3])
+;
 ; triangles will be this kind of triangulation:
 ;
+; <fixe>
 ;          *---*---*
 ;          |+  |  +|
@@ -74 +77 @@
 ;          *---*---*
 ;
+; <fixe>
 ;
 ; @history
@@ -82 +86 @@
 ; $Id$
 ;-
-;
 FUNCTION definetri, nx, ny, downward
 ;