Changeset 230 for trunk/SRC/ToBeReviewed


Ignore:
Timestamp:
03/19/07 11:17:59 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

Location:
trunk/SRC/ToBeReviewed
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ToBeReviewed/HOPE/read_hope.pro

    r226 r230  
    261261; 
    262262; @returns 
    263 ; -1 if typein and varnamein are undefine (this is the widget 
     263; -1 if typein and varnamein are undefined (this is the widget 
    264264; version) 
    265265; 

  • trunk/SRC/ToBeReviewed/PLOTS/DESSINE/bar_plot.pro

    r163 r230  
    11;+ 
    2 ;  
    3 ; @file_comments  
     2; 
     3; @file_comments 
    44; Create a bar graph, or overplot on an existing one. 
    55; 
    6 ; @categories  
     6; @categories 
    77; Graphics 
    88; 
    … …  
    6565; on the same graph. 
    6666; 
    67 ; @keyword OUTLINE  
     67; @keyword OUTLINE 
    6868; If set, this keyword specifies that an outline should be 
    6969; drawn around each bar. 
    7070; 
    71 ; @keyword OVERPLOT  
     71; @keyword OVERPLOT 
    7272; If set, this keyword specifies that the bar plot should be 
    7373; overplotted on an existing graph. 
    … …  
    7777; the background color. 
    7878; 
    79 ; @keyword ROTATE  
     79; @keyword ROTATE 
    8080; If set, this keyword indicates that horizontal rather than 
    8181; vertical bars should be drawn.  The bases of horizontal bars 
    8282; are on the left, "Y" axis and the bars extend to the right. 
    8383; 
    84 ; @examples By using the overplotting capability, it is relatively easy to create 
     84; @examples 
     85; By using the overplotting capability, it is relatively easy to create 
    8586;       stacked bar charts, or different groups of bars on the same graph. 
    8687; 
    … …  
    118119;       this could easily be changed.) 
    119120; 
    120 ; @history August 1990, T.J. Armitage, RSI, initial programming.  Replacement 
     121; @history 
     122; August 1990, T.J. Armitage, RSI, initial programming.  Replacement 
    121123;       for PLOTBAR and OPLOTBAR routines written by William Thompson. 
    122124; 
    … …  
    125127;       spacing the bars slightly. 
    126128; 
     129; @version 
    127130; $Id$ 
    128131; 

  • trunk/SRC/ToBeReviewed/PLOTS/DIVERS/barrecouleur.pro

    r226 r230  
    5252; Used to pass your keywords 
    5353; 
    54 ; @restrictions pass all argument we want thanks to _extra 
     54; @restrictions 
     55; pass all argument we want thanks to _extra 
    5556; 
    5657; @history 
    … …  
    6162; $Id$ 
    6263; 
    63 ; @todo seb: mettre les keyword et les param 
     64; @todo 
     65; seb: mettre les keyword et les param 
    6466;- 
    6567;------------------------------------------------------------ 

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

    r163 r230  
    44; @file_comments 
    55; Return the n'th word from a text string. 
    6 ;  
     6; 
    77; @categories 
     8; String 
    89; 
    9 ; @param TXTSTR {in}{required} 
     10; @param TXTSTR {in}{required} {type=string or array of strings} 
    1011; text string to extract from. 
    1112; The first element is used if txt is an array. 
    1213; 
    13 ; @param NTH {in}{required} 
     14; @param NTH {in}{required} {type=integer} {default=0} 
    1415; word number to get (first = 0 = def) 
    1516; 
    16 ; @param MTH {in}{required} 
     17; @param MTH {in}{optional} {type=integer} 
    1718; optional last word number to get. 
    1819; 
    1920; @keyword LOCATION 
    2021; = l.  Return word n string location. 
    21 ;          
     22; 
    2223; @keyword DELIMITER 
    2324; = d. Set word delimiter (def = space & tab). 
    24 ;          
     25; 
    2526; @keyword LAST 
    2627; means n is offset from last word.  So n=0 gives 
    … …  
    3031; @keyword NOTRIM 
    3132; suppresses whitespace trimming on ends. 
    32 ;  
     33; 
    3334; @keyword NWORDS 
    3435; = n. Returns number of words in string. 
    35 ;  
    36 ; @returns wrd = returned word or words. 
     36; 
     37; @returns 
     38; wrd = returned word or words. 
    3739; 
    3840; @uses 
    3941; getwrd_com 
    40 ;  
     42; 
    4143; @restrictions 
    4244; If a NULL string is given (txt="") then the last string 
    … …  
    7173;- 
    7274;------------------------------------------------------------- 
    73   
    74   
     75 
     76 
    7577        FUNCTION getwrd, TXTSTR, NTH, MTH, help=hlp, location=ll,$ 
    7678           delimiter=delim, notrim=notrim, last=last, nwords=nwords 
    77   
     79 
    7880        common getwrd_com, txtstr0, nwds, loc, len 
    79   
     81 
    8082        if (n_params(0) lt 1) or keyword_set(hlp) then begin 
    8183          print," Return the n'th word from a text string." 
    … …  
    103105          return, -1 
    104106        endif 
    105   
     107 
    106108        if n_params(0) lt 2 then nth = 0                ; Def is first word. 
    107109        IF N_PARAMS(0) LT 3 THEN MTH = NTH              ; Def is one word. 
    108   
     110 
    109111        if strlen(txtstr[0]) gt 0 then begin 
    110112          ddel = ' '                                    ; Def del is a space. 
    … …  
    118120          X = tb NE TST                                 ; Non-delchar (=words). 
    119121          X = [0,X,0]                                   ; 0s at ends. 
    120   
     122 
    121123          Y = (X-SHIFT(X,1)) EQ 1                       ; Diff=1: word start. 
    122124          Z = WHERE(SHIFT(Y,-1) EQ 1)                   ; Word start locations. 
    123125          Y2 = (X-SHIFT(X,-1)) EQ 1                     ; Diff=1: word end. 
    124126          Z2 = WHERE(SHIFT(Y2,1) EQ 1)                  ; Word end locations. 
    125   
     127 
    126128          txtstr0 = txtstr[0]                           ; Move string to common. 
    127129          NWDS = long(TOTAL(Y))                         ; Number of words. 
    … …  
    135137          endif 
    136138        endelse 
    137   
     139 
    138140        nwords = nwds                                   ; Set nwords 
    139   
     141 
    140142        if keyword_set(last) then begin                 ; Offset from last. 
    141143          lst = nwds - 1 
    … …  
    149151          im = im < lst                                 ;  to be last. 
    150152          ll = loc[in]                                  ; Nth word start. 
    151           return, strtrim(strmid(txtstr0,ll,loc[im]-loc[in]+len[im]), 2)  
     153          return, strtrim(strmid(txtstr0,ll,loc[im]-loc[in]+len[im]), 2) 
    152154        endif 
    153   
     155 
    154156        N = ABS(NTH)                                    ; Allow nth<0. 
    155157        IF N GT NWDS-1 THEN RETURN,''                   ; out of range, null. 
    … …  
    157159        IF NTH LT 0 THEN GOTO, NEG                      ; Handle nth<0. 
    158160        IF MTH GT NWDS-1 THEN MTH = NWDS-1              ; Words to end. 
    159   
     161 
    160162        if keyword_set(notrim) then begin 
    161163          RETURN, STRMID(TXTSTR0,ll,LOC[MTH]-LOC[NTH]+LEN[MTH]) 
    … …  
    163165          RETURN, strtrim(STRMID(TXTSTR0,ll,LOC[MTH]-LOC[NTH]+LEN[MTH]), 2) 
    164166        endelse 
    165   
     167 
    166168NEG:    if keyword_set(notrim) then begin 
    167169          RETURN, STRMID(TXTSTR0,ll,9999) 
    … …  
    169171          RETURN, strtrim(STRMID(TXTSTR0,ll,9999), 2) 
    170172        endelse 
    171   
     173 
    172174        END 

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

    r186 r230  
    4848; 
    4949; @param DOWNWARD {in}{optional} 
    50 ; When downward is undefine all rectangles are cut in using the upward  
     50; When DOWNWARD is undefined all rectangles are cut in using the upward  
    5151; diagonal.  
    52 ; Downward is a vector which contains the rectangles numbers which are cut in  
     52; DOWNWARD is a vector which contains the rectangles numbers which are cut in  
    5353; using the downward diagonal. 
    5454; The rectangle number is defined by the index (in a nx*ny vector) of the  
Note: See TracChangeset for help on using the changeset viewer.