Changeset 121 for trunk/SRC/ReadWrite


Ignore:
Timestamp:
06/29/06 16:59:33 (18 years ago)
Author:
pinsard
Message:

correction of some *.pro using aspell list; introduction of default idldoc syntax

Location:
trunk/SRC/ReadWrite
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ReadWrite/read_grads.pro

    r114 r121  
    1515; 
    1616; @file_comments keyword GLAMBOUNDARY (via computegrid.pro) a 2 elements vector, 
    17 ;       {lon1,lon2], giving the longitute boundaries that should be 
     17;       {lon1,lon2], giving the longitude boundaries that should be 
    1818;       used to visualize the data. 
    1919;         lon2 > lon1 
    … …  
    3434;--------------- 
    3535; 
    36 ;       @hidden BOX: a 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1,  
     36;       @hidden BOX a 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1,  
    3737;       depth2], that specifies the area where data must be read 
    3838; 

  • trunk/SRC/ReadWrite/read_oasis.pro

    r114 r121  
    1717; @keyword /I8 
    1818; @keyword /R4 
    19 ; to change the defaut format (R8) of the data to be read. 
     19; to change the default format (R8) of the data to be read. 
    2020; 
    2121; @returns a 2d array 

  • trunk/SRC/ReadWrite/readoldopadistcoast.pro

    r114 r121  
    3333 
    3434;+ 
    35 ;     @param filename {in}{required} filename (with the whole path if necessary) 
    36 ;     @param jpiglo {in}{required} 
    37 ;     @param jpjglo {in}{required} 
    38 ;     @param jpk {in}{required} 
    39 ;      dimensions of the opa grid 
    40 ;     @keyword IBLOC ibloc size, default: ibloc = 4096L 
    41 ;     @keyword JPBYT jpbyt size, default: jpbyt = 8L 
    42 ;     @keyword NUMREC number of records in the file. default: numrec = 19L*jpk 
     35; @param filename {in}{required} filename (with the whole path if necessary) 
     36; @param jpiglo {in}{required} 
     37; @param jpjglo {in}{required} 
     38; @param jpk {in}{required}  
     39; dimensions of the opa grid 
     40; 
     41; @keyword IBLOC {default=4096L} ibloc size 
     42; @keyword JPBYT {default=8L} jpbyt size 
     43; @keyword NUMREC {default=19L*jpk} number of records in the file. 
     44; 
    4345; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    4446;                      June, 2002 
    … …  
    5860; check the size of the file 
    5961   filepamameters = fstat(numcost) 
    60 ; defaut parameter definition for ORCA2 
     62; default parameter definition for ORCA2 
    6163   IF keyword_set(ibloc) THEN ibloc = long(ibloc) ELSE ibloc = 4096L 
    6264   jpiglo = long(jpiglo) 

  • trunk/SRC/ReadWrite/readoldoparestart.pro

    r114 r121  
    4242;      file. 
    4343; @categories for OPA before NetCDF 
    44 ;     @param filename {in}{required} with the whole path if necessary 
    45 ;     @param jpiglo {in}{required} 
    46 ;     @param jpjglo {in}{required} 
    47 ;     @param jpk {in}{required} 
    48 ;       dimensions of the opa grid 
    49 ;     @keyword IBLOC ibloc size, default: ibloc = 4096L 
    50 ;     @keyword JPBYT jpbyt size, defalut: jpbyt = 8L 
    51 ;     @keyword NUMREC number of records in the file. defalut: numrec = 19L*jpk 
    52 ;     @keyword UB 
    53 ;     @keyword VB 
    54 ;     @keyword TB 
    55 ;     @keyword SB 
    56 ;     @keyword ROTB 
    57 ;     @keyword HDIVB 
    58 ;     @keyword UN 
    59 ;     @keyword VN 
    60 ;     @keyword TN 
    61 ;     @keyword SN 
    62 ;     @keyword ROTN 
    63 ;     @keyword HDIVN 
    64 ;     @keyword GCX 
    65 ;     @keyword GCXB 
    66 ;     @keyword ETAB 
    67 ;     @keyword ETAN 
    68 ;     @keyword BSFB 
    69 ;     @keyword BSFN 
    70 ;     @keyword BSFD 
    71 ;     @keyword EN 
    72 ;       the variable we want to read.  
     44; @param filename {in}{required} with the whole path if necessary 
     45; @param jpiglo {in}{required} 
     46; @param jpjglo {in}{required} 
     47; @param jpk {in}{required} 
     48; dimensions of the opa grid 
     49; @keyword IBLOC {default=4096L} ibloc size 
     50; @keyword JPBYT {default=8L} jpbyt size 
     51; @keyword NUMREC {default=19L*jpk} number of records in the file 
     52; @keyword UB 
     53; @keyword VB 
     54; @keyword TB 
     55; @keyword SB 
     56; @keyword ROTB 
     57; @keyword HDIVB 
     58; @keyword UN 
     59; @keyword VN 
     60; @keyword TN 
     61; @keyword SN 
     62; @keyword ROTN 
     63; @keyword HDIVN 
     64; @keyword GCX 
     65; @keyword GCXB 
     66; @keyword ETAB 
     67; @keyword ETAN 
     68; @keyword BSFB 
     69; @keyword BSFN 
     70; @keyword BSFD 
     71; @keyword EN 
     72; the variable we want to read.  
    7373; 
    7474; @returns according to the given keywords. 

  • trunk/SRC/ReadWrite/scanctl.pro

    r114 r121  
    11;+ 
    2 ;       @file_comments GLAMBOUNDARY 2 elements vector, {lon1,lon2], the longitute 
     2; @file_comments GLAMBOUNDARY 2 elements vector, {lon1,lon2], the longitude 
    33;       boundaries that should be used to visualize the data. 
    44;         lon2 > lon1 
    … …  
    3434   spawn, '\grep -i "^FILEHEADER" '+filename, fileheader 
    3535   fileheader = strtrim(fileheader, 2) 
    36    if keyword_set(fileheader) then BEGIN  
     36   if keyword_set(fileheader) then BEGIN 
    3737      fileheader = strsplit(fileheader[0],/extract) 
    3838      fileheader = long(fileheader[1]) 
    … …  
    4040   spawn, '\grep -i "^THEADER" '+filename, theader 
    4141   theader = strtrim(theader, 2) 
    42    if keyword_set(theader) then BEGIN  
     42   if keyword_set(theader) then BEGIN 
    4343      theader = strsplit(theader[0],/extract) 
    4444      theader = long(theader[1]) 
    … …  
    4646   spawn, '\grep -i "^XYHEADER" '+filename, xyheader 
    4747   xyheader = strtrim(xyheader, 2) 
    48    if keyword_set(xyheader) then BEGIN  
     48   if keyword_set(xyheader) then BEGIN 
    4949      xyheader = strsplit(xyheader[0],/extract) 
    5050      xyheader = long(xyheader[1]) 
    … …  
    148148   monthsname = string(format='(C(CMOA))',31*(indgen(12))) 
    149149   case 1 OF 
    150 ; h[h]:mmZd[d]mmmyy[yy]  
     150; h[h]:mmZd[d]mmmyy[yy] 
    151151      strpos(t0, ':') NE -1:BEGIN 
    152152         pp = strpos(t0, ':') 
    … …  
    359359      endcase 
    360360; 
    361 ; number of files  
     361; number of files 
    362362; 
    363363      nof = ceil(jpt/(1.*jpt1file)) 
    … …  
    374374;------------------------ 
    375375;------------------------ 
    376 ; extracting the variables  
     376; extracting the variables 
    377377;------------------------ 
    378378;------------------------ 
    … …  
    386386      stop 
    387387   endif 
    388    varlist = varlist[1:n_elements(varlist)-2]  
     388   varlist = varlist[1:n_elements(varlist)-2] 
    389389   if n_elements(varlist) NE nvars  then begin 
    390390      print, 'Number of variables indicated by VARS ('+strtrim(nvars, 1)+') differs from number of lines (without ''#'' at the beginning) located between VARS and ENDVARS: '+strtrim(n_elements(varlist), 1) 

  • trunk/SRC/ReadWrite/write_oasis.pro

    r114 r121  
    1414; @keyword /I8 
    1515; @keyword /R4 
    16 ; to change the defaut format (R8) of the data to be written. 
     16; to change the default format (R8) of the data to be written. 
    1717; 
    1818; @keyword /APPEND to open the file with the file pointer at the end of 
    … …  
    2121; 
    2222; @restrictions varname is automatically written as a "charactere*8" 
    23 ;              by defaut z2d is written as an R8 array 
     23;              by default z2d is written as an R8 array 
    2424; 
    2525; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
Note: See TracChangeset for help on using the changeset viewer.