Changeset 186 for trunk/SRC/ToBeReviewed


Ignore:
Timestamp:
09/20/06 12:50:37 (18 years ago)
Author:
pinsard
Message:

introducing hyperlinks in idldoc outputs (1/2)

Location:
trunk/SRC/ToBeReviewed
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ToBeReviewed/STRING/strtok.pro

    r163 r186  
    99; 
    1010; @param STRING {in}{required} 
    11 ; String to be split.  Contains text after    in, out 
    12 ; token on output. 
     11; String to be split. Contains text after in, out token on output. 
    1312;  
    1413; @param TOKEN {in}{required} 
    … …  
    1615; 
    1716; @keyword TRIM  
    18 ; set to remove leading blanks from old  
    19 ; before returning. 
     17; set to remove leading blanks from old before returning. 
    2018; 
    2119; @keyword HELP 

  • trunk/SRC/ToBeReviewed/TRIANGULATION/definetri.pro

    r163 r186  
    66; the points are regulary-gridded on nx*ny array. 
    77; Find a Delaunay triangulation for this set of points is easy: 
    8 ; Points define (nx-1)*(ny-1) rectangles which we can cut in 2 
    9 ; triangles. cf. figure above 
     8; Points define (nx-1)*(ny-1) rectangles which we can cut in 2 triangles.  
     9; cf. figure above 
    1010; 
    1111; <fixe> 
     12; fixe 
    1213;      ny-1*---*---*. . . . . .*---*---* 
    1314;          |  +|  +|           |  +|  +|       
    … …  
    4748; 
    4849; @param DOWNWARD {in}{optional} 
    49 ; When downward is undefine all rectangles are cut 
    50 ; in using the upward diagonal. Downward is a vector which 
    51 ; contains the rectangles numbers which are cut in using the 
    52 ; downward diagonal. 
    53 ; The rectangle number is define by the index (in a nx*ny 
    54 ; vector) of the lower-left corner of the rectangle. 
     50; When downward is undefine all rectangles are cut in using the upward  
     51; diagonal.  
     52; Downward is a vector which contains the rectangles numbers which are cut in  
     53; using the downward diagonal. 
     54; The rectangle number is defined by the index (in a nx*ny vector) of the  
     55; lower-left corner of the rectangle. 
    5556; 
    5657; @returns 
    57 ; triangles is a 2d array and is dimensions are 3 and 
    58 ; 2*(nx-1)*(ny-1) 
    59 ; triangles is define like in the TRIANGULATE procedure. 
     58; triangles is a 2d array and its dimensions are 3 and 2*(nx-1)*(ny-1). 
     59; triangles is defined like in the TRIANGULATE procedure. 
    6060; 
    6161; @examples 
    6262; 
    63 ; triangles=definetri(3,3,[1,3]) 
    64 ; triangles will be a this kind of triangulation: 
     63; IDL> triangles=definetri(3,3,[1,3]) 
     64; triangles will be this kind of triangulation: 
    6565; 
    6666;          *---*---* 
    67 ;           |+  |  +| 
    68 ;           | + | + | 
    69 ;           |  +|+  | 
     67;          |+  |  +| 
     68;          | + | + | 
     69;          |  +|+  | 
    7070;          *---*---* 
    71 ;           |  +|+  | 
    72 ;           | + | + | 
    73 ;           |+  |  +| 
     71;          |  +|+  | 
     72;          | + | + | 
     73;          |+  |  +| 
    7474;          *---*---* 
    7575; 
    … …  
    103103; we define upward: upward is a vector which contains the rectangles 
    104104; numbers which are cut in using the upward diagonal. 
    105 ; The rectangle number is define by the index (in a nx*ny vector) of 
     105; The rectangle number is defined by the index (in a nx*ny vector) of 
    106106; the lower-left corner of the rectangle. 
    107107      upward = bytarr(nx, ny)+1 

  • trunk/SRC/ToBeReviewed/TRIANGULATION/definetri_e.pro

    r157 r186  
    6060; 
    6161; @param SINGULAR {in}{optional} 
    62 ; When singular is undefined all rectangles are cut 
    63 ; in using the vertical diagonal. Singular is a vector which 
    64 ; contains the rectangles numbers which are cut in using the 
    65 ; horizontal diagonal. 
    66 ; The rectangle number is define by the index (in a nx*ny 
    67 ; vector) of the lower-left corner of the rectangle. 
     62; When singular is undefined all rectangles are cut in using the vertical  
     63; diagonal.  
     64; Singular is a vector which contains the rectangles numbers which are cut in  
     65; using the horizontal diagonal. 
     66; The rectangle number is defined by the index (in a nx*ny vector) of the  
     67; lower-left corner of the rectangle. 
    6868; 
    6969; @keyword SHIFTED 
    … …  
    7171; 
    7272; @returns 
    73 ; Triangles is a 2d array and is dimensions are 3 and 
    74 ; (nx-1)*(ny-1) 
     73; Triangles is a 2d array and is dimensions are 3 and (nx-1)*(ny-1). 
    7574; Triangles is defined like in the TRIANGULATE procedure. 
    7675;         

  • trunk/SRC/ToBeReviewed/TRIANGULATION/section.pro

    r157 r186  
    5858;  
    5959; @version  
     60; $Id$ 
    6061;  
    6162;- 

  • trunk/SRC/ToBeReviewed/WIDGET/xxx.pro

    r163 r186  
    11;+ 
    22; @file_comments 
    3 ; 
     3; see <a href="../../../xmldoc/mini_notice.html">Mini Guide for Basic Commands in the XXX Program</a> 
    44; 
    55; @categories 
Note: See TracChangeset for help on using the changeset viewer.