Changeset 238 for trunk/SRC/ReadWrite


Ignore:
Timestamp:
03/27/07 15:43:18 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

Location:
trunk/SRC/ReadWrite
Files:
8 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ReadWrite/ncdf_timeget.pro

    r232 r238  
    55; Julian days of IDL. 
    66; 
    7 ; @categories  
     7; @categories 
    88; Reading 
    99; 
    … …  
    3434; time_counter:units = "years since 1979-01-01 00:00:00" ; 
    3535; 
    36 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     36; @history 
     37; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3738;                      June 2001 
    38 ; @version $Id$ 
     39; @version 
     40; $Id$ 
    3941;- 
    4042; 

  • trunk/SRC/ReadWrite/read_oasis.pro

    r236 r238  
    77; Reading 
    88; 
    9 ; @param FILENAME {in}{required}  
     9; @param FILENAME {in}{required} 
    1010; the filename 
    1111; 
    12 ; @param VARNAME {in}{required}  
     12; @param VARNAME {in}{required} 
    1313; the name of the variable to be read 
    1414; 
    … …  
    2424; to change the default format (R8) of the data to be read. 
    2525; 
    26 ; @returns a 2d array 
     26; @returns 
     27; a 2d array 
    2728; 
    2829; @examples 
    … …  
    3233; see also IDL> scanoasis,'grids_orca_t106' 
    3334; 
    34 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     35; @history 
     36; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3537;                      July 01, 2002 
    36 ; @version $Id$ 
     38; @version 
     39; $Id$ 
     40; 
    3741;- 
    3842; 

  • trunk/SRC/ReadWrite/readbat.pro

    r236 r238  
    1212; @keyword ZERO to put 0 on land instead of negatives values for the islands. 
    1313; 
    14 ; @returns a 2d array 
     14; @returns 
     15; a 2d array 
    1516; 
    16 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     17; @history 
     18; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1719;                      May 31, 2002 
    1820;    based on batlec2.pro, written by Maurice Imbard, March 17, 1998 
    1921; 
    20 ; @version $Id$ 
     22; @version 
     23;  $Id$ 
    2124; 
    2225;- 

  • trunk/SRC/ReadWrite/readoldopadistcoast.pro

    r236 r238  
    66; based on the OPA subroutines dtacof and parctl 
    77; 
    8 ; @categories  
     8; @categories 
    99; For OPA 
    1010; 
    1111; @param UNIT 
    1212; 
     13; @param PARAMS 
    1314; 
    14 ; @param PARAMS 
    15 ;  
    16 ;  
    1715; @param NUM 
    18 ;  
    1916; 
    20 ; @returns   
     17; @returns 
    2118; a structure that contains two elements: tdistcoast (the 
    2219; distance for the t-points) and fdiscoast (the distance for the 
    2320; f-points). 
    2421; 
    25 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     22; @history 
     23; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2624;                      June, 2002 
    27 ; @version $Id$ 
     25; @version 
     26; $Id$ 
     27; 
    2828;- 
    2929; 
    … …  
    3737   return, b 
    3838end 
    39  
     39; 
    4040;+ 
     41; 
    4142; @file_comments 
    42 ; 
    4343; 
    4444; @categories 
    … …  
    5050; @param JPIGLO {in}{required} 
    5151; 
    52 ; 
    5352; @param JPJGLO {in}{required} 
    54 ; 
    5553; 
    5654; @param JPK {in}{required} 
    … …  
    5957; @keyword IBLOC {default=4096L} 
    6058; Ibloc size 
    61 ;  
     59; 
    6260; @keyword JPBYT {default=8L} 
    6361; Jpbyt size 
    64 ;  
     62; 
    6563; @keyword NUMREC {default=19L*jpk} 
    6664; Number of records in the file. 
    … …  
    7270; @version 
    7371; $Id$ 
     72; 
    7473;- 
     74; 
    7575FUNCTION readoldopadistcoast, filename, jpiglo, jpjglo, jpk, IBLOC = ibloc, JPBYT = jpbyt, NUMREC = numrec 
    7676; 

  • trunk/SRC/ReadWrite/scanctl.pro

    r237 r238  
    3232; @param xyheader 
    3333; 
    34 ; @keyword VARFMT  
     34; @keyword VARFMT 
    3535; 
    3636; @keyword _EXTRA 
    3737; 
    38 ; @version  
     38; @version 
    3939; $Id$ 
    4040; 

  • trunk/SRC/ReadWrite/scanoasis.pro

    r236 r238  
    66; @categories know what is inside 
    77; 
    8 ; @param FILENAME {in}{required}  
     8; @param FILENAME {in}{required} 
    99; The file name 
    1010; 
    11 ; @restrictions  
     11; @restrictions 
    1212; List the variable names included in a Oasis file 
    1313; 
    … …  
    1515; IDL> scanoasis,'grids_orca_t106' 
    1616; 
    17 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     17; @history 
     18; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1819;                            July 01, 2002 
    19 ; @version $Id$ 
     20; @version 
     21; $Id$ 
     22; 
    2023;- 
    2124; 

  • trunk/SRC/ReadWrite/write_oasis.pro

    r236 r238  
    44; write an Oasis file (version < 2.5) 
    55; 
    6 ; @param FILENAME {in}{required}  
     6; @param FILENAME {in}{required} 
    77; the filename 
    88; 
    9 ; @param VARNAME {in}{required}  
     9; @param VARNAME {in}{required} 
    1010; the name of the variable to be written 
    1111; 
    12 ; @param Z2D {in}{required}  
     12; @param Z2D {in}{required} 
    1313; the variable (2D array) to be written 
    1414; 
    … …  
    1919; to change the default format (R8) of the data to be written. 
    2020; 
    21 ; @keyword APPEND  
    22 ; to open the file with the file pointer at the end of the file, ready for  
     21; @keyword APPEND 
     22; to open the file with the file pointer at the end of the file, ready for 
    2323; data to be appended. 
    2424; 
    25 ; @restrictions  
     25; @restrictions 
    2626; varname is automatically written as a "character*8" 
    2727; by default z2d is written as an R8 array 
    2828; 
    29 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     29; @history 
     30; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    3031;                      July 01, 2002 
    31 ; @version $Id$ 
     32; @version 
     33; $Id$ 
     34; 
    3235;- 
    3336; 
    … …  
    4245      return 
    4346   endif 
    44     
     47 
    4548   writeu, unit, string(varname, format='(a8)') 
    4649   case 1 of 

  • trunk/SRC/ReadWrite/writebat.pro

    r236 r238  
    44; write the bathymetry ASCII file of OPA 
    55; 
    6 ; @categories  
     6; @categories 
    77; For OPA 
    88; 
    9 ; @param ZBAT {in}{required}  
     9; @param ZBAT {in}{required} 
    1010; the bathymetry, a 2d array 
    1111; 
    … …  
    1313; It contains the filename 
    1414; 
    15 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     15; @history 
     16;  Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1617;                      Sept 30, 2003 
    1718;    based on batsav2.pro, written by Maurice Imbard, March 17, 1998 
    1819; 
    19 ; @version $Id$ 
     20; @version 
     21; $Id$ 
     22; 
    2023;- 
    2124; 
Note: See TracChangeset for help on using the changeset viewer.