Changeset 130 for trunk/SRC/ReadWrite/ncdf_timeget.pro

Timestamp:

07/06/06 16:48:41 (18 years ago)

Author:

pinsard

Message:

improvements of ReadWrite/?*.pro header

File:

• trunk/SRC/ReadWrite/ncdf_timeget.pro (modified) (3 diffs, 3 props)

trunk/SRC/ReadWrite/ncdf_timeget.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; @file_comments get the time axis fom a netcdf_file and transforms it in
+; @file_comments
+; get the time axis fom a netcdf_file and transforms it in
 ; julian days of IDL.
 ;
 ; @categories reading ncdf_file
 ;
-; @param cdfid {in}{required} the ID of the ncdf_file, which is already open
-; @param timeid {in}{required} the ID or the name of the variable which describe the calendar
+; @param cdfid {in}{required}
+; the ID of the ncdf_file, which is already open
 ;
-; @keyword /YYYYMMDD active to obtain the date as a longinterger with
-;        the format YearYearYearYearMonthMonthDayDay
+; @param timeid {in}{required}
+; the ID or the name of the variable which describe the calendar
 ;
-; @file_comments the keyword parameters of ncdf_varget
+; @keyword YYYYMMDD
+; active to obtain the date as a longinterger with
+; the format YearYearYearYearMonthMonthDayDay
 ;
-; @returns a long array of IDL julian days
+; @keyword _EXTRA
+; the keyword parameters of ncdf_varget
 ;
-; @restrictions the calendar variable must have the units attribute
+; @returns
+; a long array of IDL julian days
+;
+; @restrictions
+; the calendar variable must have the units attribute
 ; following the syntaxe bellow:
 ;
@@ -29 +37 @@
 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      June 2001
+; @version $Id$
 ;-
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-FUNCTION ncdf_timeget, cdfid, timeid, YYYYMMDD = yyyymmdd, _extra = ex
+FUNCTION ncdf_timeget, cdfid, timeid, YYYYMMDD = yyyymmdd, _EXTRA = ex
 ;
   compile_opt idl2, strictarrsubs
@@ -62 +71 @@
          'hours':time = julday(start[1], start[2], start[0])+time/long(24)
          'days':time = julday(start[1], start[2], start[0])+time
-         'months':BEGIN 
+         'months':BEGIN
             for t = 0, n_elements(time)-1  do begin
                time[t] = julday(start[1]+time[t], start[2], start[0])