Changeset 163 for trunk/SRC/ToBeReviewed/TRIANGULATION/triangule_c.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

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

trunk/SRC/ToBeReviewed/TRIANGULATION/triangule_c.pro

@@ -14 +14 @@
 ; rectangular matrix). A easy way to do triangles between all points is then: 
 ;
-;     for each point (i,j) of the matrix -exept those of the last line and of
+;     for each point (i,j) of the matrix -except those of the last line and of
 ;     the last column- we call rectangle (i,j) the rectangle made of the four
 ;     points (i,j), (i+1,j), (i,j+1), (i+1,j+1). To trace all triangle, we just
@@ -31 +31 @@
 ; Graphics
 ;
-; @param MASKENTREE {in}{optional}
+; @param MASKENTREE {in}{optional}{type=2d array}
 ; It is a 2d array which will serve to mask the field we will trace after with CONTOUR, 
 ; ...TRIANGULATION=triangule(mask)
@@ -42 +42 @@
 ; To keep the triangulation even on the continents
 ;
-; @keyword COINMONTE
-; It is an array. To obtain the array of "ascending land corner" to be treated with 
+; @keyword COINMONTE {type=array}
+; To obtain the array of "ascending land corner" to be treated with 
 ; completecointerre.pro in the variable array instead of make it pass by the global 
 ; variable twin_corners_up.
 ;
-; @keyword COINDESCEND
-; It is an array. See COINMONTE
+; @keyword COINDESCEND {type=array}
+; See COINMONTE
 ;
 ; @returns
 ; res: tableau 2d (3,nbre de triangles).
-; Each line of res represent indexes of points constituing summits of a triangle. 
+; Each line of res represent indexes of points constituting summits of a triangle. 
 ; See how we trace triangles in definetri.pro
 ;