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

Timestamp:

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

Author:

navarro

Message:

header improvements + xxx doc

Location:

trunk/SRC/ReadWrite/idl-NetCDF

Files:

• ncdf_listdims.pro (modified) (1 diff)
• ncdf_listvars.pro (modified) (1 diff)
• ncdf_quickread/ncdf_quickread_helper.pro (modified) (6 diffs)
• ncdf_quickwrite/ncdf_quickwrite_helper1.pro (modified) (1 diff)
• ncdf_quickwrite/ncdf_quickwrite_helper2.pro (modified) (3 diffs)
• ncdf_quickwrite/ncdf_quickwrite_helper3.pro (modified) (1 diff)
• ncdf_read.pro (modified) (1 diff)
• ncdf_struct.pro (modified) (1 diff)
• ncdf_struct_free.pro (modified) (1 diff)

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_listdims.pro

@@ +1 @@
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param NCID
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 FUNCTION ncdf_listdims,ncid
 ;

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_listvars.pro

@@ +1 @@
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param NCID
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 FUNCTION ncdf_listvars,ncid
 ;

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.

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper1.pro

@@ +1 @@
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param NCVARSTRING
+;
+;
+; @param NCDFSTRUCT
+;
+;
+; @param STRUCTNAME
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 pro ncdf_quickwrite_helper1,ncvarstring,ncdfstruct,structname
 ;;

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper2.pro

@@ -14 +14 @@
 ;; we use this function enough to give it a short name, but the underscore
 ;; is to make it unlikely to conflict with a user's function.
-
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param STRING
+; String to be split. Contains text after in, out token on output.
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 function _str,string
 return,strcompress(string,/remove_all)
@@ -20 +46 @@
 
 ;------------------------------------------------------
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param NUM
+;
+;
+; @param NAME
+; It is a string giving the name of the file to be opened. If NAME does not contain
+; the separating character of directories ('/' under unix for example), the file
+; will be looked for in the current directory.
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 function ncdf_quickwrite_typename,num,name
 on_error,2
@@ -63 +121 @@
 ;-----------------------------------------------------
 
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param NCFILENAME
+;
+;
+; @param S
+; The string to be searched
+;
+; @param SNAME
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 
 pro ncdf_quickwrite_helper2,ncfilename,s,sname

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_quickwrite/ncdf_quickwrite_helper3.pro

@@ +1 @@
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param S
+; The string to be searched
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 pro ncdf_quickwrite_helper3,s
 ;;

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_read.pro

@@ +1 @@
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param FILENAME
+; The filename
+;
+; @param INFO
+; General info
+;
+; @param DINFO
+; Dimension info
+; 
+; @param VINFO
+; Variable info
+;
+; @param GATTS
+; Global attributes
+;
+; @param VATTS
+; Variable attributes
+;
+; @param DATA
+; Data
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 PRO ncdf_read,filename,info,dinfo,vinfo,gatts,vatts,data
 ;             -------- ---- ----- ----- ----- ----- ----

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_struct.pro

@@ +1 @@
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param FILENAME
+; The file's name
+; 
+; @keyword NODATA
+;
+;
+; @keyword NOATTRIBUTES
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 FUNCTION ncdf_struct,filename,nodata=nodata,noattributes=noattributes
 ;

trunk/SRC/ReadWrite/idl-NetCDF/ncdf_struct_free.pro

@@ +1 @@
+;+
+; @file_comments
+;
+;
+; @categories
+;
+;
+; @param S
+; The string to be searched
+; 
+;
+; @returns
+;
+;
+; @restrictions
+;
+;
+; @examples
+; 
+; 
+; @history
+;
+;
+; @version
+; $Id$
+;
+;-
 PRO ncdf_struct_free,s
 ;