Changeset 157 for trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickread

Timestamp:

08/21/06 11:01:50 (18 years ago)

Author:

navarro

Message:

header improvements + xxx doc

File:

• trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickread/ncdf_quickread_helper.pro (modified) (6 diffs)

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickread/ncdf_quickread_helper.pro

@@ -37 +37 @@
 ;                           Also, only stringify attributes of type CHAR.
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-
+;+
+; @file_comments
+; This function returns the filename name from the full path.
+;
+; @categories
+;
+;
+; @param FULLPATH
+; full directory+file path
+;
+; @keyword SUFFIX
+; include inptu suffix in output file name
+;
+; @returns
+; file - filename
+;
+; @restrictions
+;
+;
+; @examples
+; Call: file = ncdf_quickread_getfile(fullpath)
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;-
 function ncdf_quickread_getFile, fullpath, suffix=suffix
 on_error,2
 compile_opt hidden
-; func_description
-; This function returns the filename name from the full path.
-; Inputs:    fullpath - full directory+file path
-; Keyword:   /suffix:   include inptu suffix in output file name
-; Outputs:   file - filename
-; Example Call: file = ncdf_quickread_getfile(fullpath)
-
 ; Retrieve the postion at which the first '/' character occurs from
 ; the end of the string.
@@ -73 +93 @@
 end
 
+;+
+; @file_comments
+; This function returns the directory name from the full path.
+;
+; @categories
+;
+;
+; @param FULLPATH
+; full directory+file path
+;
+; @returns
+; directory path
+;
+; @restrictions
+;
+;
+; @examples
+; Call: dir = ncdf_quickread_getdir(fullpath)
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;-
 
 function ncdf_quickread_getDir, fullpath
 on_error,2
 compile_opt hidden
-; func_description
-; This function returns the directory name from the full path.
-; Inputs:   fullpath - full directory+file path
-; Outputs:  dir - directory path
-; Example Call: dir = ncdf_quickread_getdir(fullpath)
-
 ; Retrieve the postion at which the first '/' character occurs from
 ; the end of the string.
@@ -97 +136 @@
 end
 
-
-function ncdf_quickread_validateName, varname
-on_error,2
-compile_opt hidden
-; func_description
+;+
+; @file_comments
 ; This routine ensures that the given name does not start with a number,
 ; nor contain a dash.  IDL cannot accept a variable starting with a 
@@ -107 +143 @@
 ; underscore is prepended to the name, and if it contains a dash, the 
 ; dash is replaced with an underscore.  
+;
+; @categories
+;
+;
+; @param VARNAME
+; The name of the variable to be read
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;-
+
+function ncdf_quickread_validateName, varname
+on_error,2
+compile_opt hidden
 
 ; Initialize the name.
@@ -138 +201 @@
 ; End function.
 end
-
-
+;+
+; @file_comments
+; This procedure creates a script to read the data in a given netCDF
+; file into IDL.  The default output file is the name of the netCDF
+; file with idl replacing any existing suffix.  The default output is
+; variable data only.
+;
+; @categories
+;
+;
+; @param INFILE
+; full path to netCDF file of interest
+;
+; @keyword VERBOSE  
+; Set this keyword to return an error message in case of an error.
+;
+; @keyword PREFIX
+; see changelog above.
+;
+; @keyword FIELDS
+;
+;
+; @keyword REFORM
+; see changelog above. 
+;
+; @returns
+; array of commands to run at top level
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 function ncdf_quickread_helper, infile, verbose=verbose,  $
                                 prefix=prefix, fields=fields, $
@@ -146 +248 @@
 compile_opt hidden
 ;
-; This procedure creates a script to read the data in a given netCDF
-; file into IDL.  The default output file is the name of the netCDF
-; file with idl replacing any existing suffix.  The default output is
-; variable data only.
-; Inputs:           infile  - full path to netCDF file of interest
-; Optional Inputs:  verbose - includes extractions of all input file 
-;                             attributes in idl script
-;                   prefix, reform - see changelog above.
-;
-; Return value:  array of commands to run at top level
+;
 
 ; Ensure that the netCDF format is supported on the current platform.