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

Timestamp:

06/12/06 16:49:30 (18 years ago)

Author:

pinsard

Message:

start to modify headers of ReadWrite? *.pro files for better idldoc output

File:

• trunk/SRC/ReadWrite/ncdf_timeget.pro (modified) (2 diffs)

trunk/SRC/ReadWrite/ncdf_timeget.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: ncdf_timeget
-;
-; PURPOSE: 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.
 ;
-; CATEGORY: reading ncdf_file
+; @categories reading ncdf_file
 ;
-; CALLING SEQUENCE: time = ncdf_timeget(cdfid, timeid)
-; 
-; INPUTS:cdfid: the ID of the ncdf_file, which is already open
-;        timeid: 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
+; @param timeid {in}{required} the ID or the name of the variable which describe the calendar
 ;
-; KEYWORD PARAMETERS:
-;        /YYYYMMDD: active to obtain the date as a longinterger with
+; @keyword /YYYYMMDD active to obtain the date as a longinterger with
 ;        the format YearYearYearYearMonthMonthDayDay
 ;
-;        the keyword parameters of ncdf_varget
+; @file_comments the keyword parameters of ncdf_varget
 ;
-; OUTPUTS:a long array of IDL julian days
+; @returns a long array of IDL julian days
 ;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS: the calendar variable must have the units attribute
-; folowing the syntaxe bellow:
+; @restrictions the calendar variable must have the units attribute
+; following the syntaxe bellow:
 ;
 ; time_counter:units = "seconds since 0001-01-01 00:00:00" ;
@@ -36 +27 @@
 ; time_counter:units = "years since 1979-01-01 00:00:00" ;
 ;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      June 2001
 ;-