[Dart-dev] [6417] DART/trunk/utilities/parse_args_mod.f90: just add a bit more usage comments to the header

[nancy at ucar.edu]

Revision: 6417
Author:   nancy
Date:     2013-08-20 09:10:05 -0600 (Tue, 20 Aug 2013)
Log Message:
-----------
just add a bit more usage comments to the header
in the file.  no code changes.

Modified Paths:
--------------
    DART/trunk/utilities/parse_args_mod.f90

-------------- next part --------------
Modified: DART/trunk/utilities/parse_args_mod.f90
===================================================================
--- DART/trunk/utilities/parse_args_mod.f90	2013-08-20 05:14:23 UTC (rev 6416)
+++ DART/trunk/utilities/parse_args_mod.f90	2013-08-20 15:10:05 UTC (rev 6417)
@@ -13,7 +13,7 @@
 ! a line of input read from a terminal/stdin, as opposed to using the
 ! (non-standard) fortran argc command line arg parsing.
 !
-! the intended use would be: 
+! an intended use could be: 
 !   % echo "a b c" | program
 ! or
 !   % cat file
@@ -24,6 +24,14 @@
 !   a b c
 !   EOF
 !
+! OR:
+!
+!   read(unitnum, "(A256)") line
+!   call get_args_from_string(line, wordcount, words)
+!
+! the limit on the number of words and the length of each string
+! is determined by the 'words' character array that is passed in.
+! it should have already been allocated by the caller.
 !---------------------------------------------------------------------
 
 implicit none