Changeset 231 for trunk/SRC/ToBeReviewed/TRIANGULATION/definetri_e.pro

Timestamp:

03/19/07 18:15:51 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

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

trunk/SRC/ToBeReviewed/TRIANGULATION/definetri_e.pro

@@ -1 +1 @@
 ;+
+;
 ; @file_comments
 ;
-;
 ; @categories
-;
 ;
 ; @param INDEX
@@ -15 +14 @@
 ; The y dimension array
 ;
-;
 ; @returns
 ;
+; @restrictions
 ;
-; @restrictions
-; 
-; 
 ; @examples
-; 
-; 
+;
 ; @history
-;
 ;
 ; @version
 ; $Id$
 ;-
- function numtri, index, nx, ny
+;
+FUNCTION numtri, index, nx, ny
 ;
   compile_opt idl2, strictarrsubs
@@ -42 +37 @@
    return, numtri
 end
-
-
+;
 ;+
 ;
 ; @file_comments
-; Define a triangulation array like TRIANGULATE but for a
+; Define a triangulation array like <pro>TRIANGULATE</pro> but for a
 ; E-grid type
 ;
 ; @categories
 ; Make contours with E-grid type
-; 
+;
 ; @param NX {in}{required}
 ; The x dimension array
@@ -60 +54 @@
 ;
 ; @param SINGULAR {in}{optional}
-; When singular is undefined all rectangles are cut in using the vertical 
-; diagonal. 
-; Singular is a vector which contains the rectangles numbers which are cut in 
+; When singular is undefined all rectangles are cut in using the vertical
+; diagonal.
+; Singular is a vector which contains the rectangles numbers which are cut in
 ; using the horizontal diagonal.
-; The rectangle number is defined by the index (in a nx*ny vector) of the 
+; The rectangle number is defined by the index (in a nx*ny vector) of the
 ; lower-left corner of the rectangle.
 ;
 ; @keyword SHIFTED
 ;
-;
 ; @returns
 ; Triangles is a 2d array and is dimensions are 3 and (nx-1)*(ny-1).
 ; Triangles is defined like in the TRIANGULATE procedure.
-;        
+;
 ; @history
 ; Sebastien Masson (smlod\@ipsl.jussieu.fr)
@@ -81 +74 @@
 ; $Id$
 ;
-; @todo 
+; @todo
 ; seb: documenter SHIFTED
 ;-