Changeset 7206

Timestamp:

May 25, 2006, 10:52:35 AM (20 years ago)

Author:

Paul Price

Message:

Changing psArgumentParse description to allow arguments to be
specified multiple times (-arg 1 -arg 2) as well as multiple
parameters to an argument (-arg 1 2 3).

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (2 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.393 2006-05-22 22:52:44 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.394 2006-05-25 20:52:35 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1770 +1770 @@
 the appropriate type).  As matching arguments are found on the command
 line, the values shall be read into the \code{arguments} metadata,
-with the appropriate type.  Multiple values (i.e., when an argument
-takes two or more values) are specified using a
+with the appropriate type.
+
+An argument may be specified multiple times on the command line (e.g.,
+\code{-arg 1 -arg 2}) if the argument is specified using a
 \code{PS_DATA_METADATA_MULTI} list (i.e., by specifying a type with
-the \code{PS_META_DUPLICATE_OK} flag).  A boolean argument shall be
-set to \code{true} by the presence of the argument itself (no value is
-specified).  The arguments and their values shall be removed from the
-list of command line arguments as they are processed.  The function
-shall return \code{false} without modifying the \code{arguments} if
-any argument (i.e., a string beginning with a dash; but not a string
-that does not start with a dash, which is likely a mandatory argument
-for the program; the purpose of this requirement is so that the
-default values are preserved) was encountered that is not present in
-the \code{arguments}.
+the \code{PS_META_DUPLICATE_OK} flag on creation of the
+\code{arguments}).  An argument may take more than one parameter
+(e.g., \code{-arg 1 2 3}) by adding a \code{psMetadata} to the
+\code{arguments}, containing an entry for each of the parameters.  A
+boolean argument shall be set to \code{true} by the presence of the
+argument itself (no value is specified).  The arguments and their
+values shall be removed from the list of command line arguments as
+they are processed.  The function shall return \code{false} without
+modifying the \code{arguments} if any argument (i.e., a string
+beginning with a dash; but not a string that does not start with a
+dash, which is likely a mandatory argument for the program; the
+purpose of this requirement is so that the default values are
+preserved) was encountered that is not present in the
+\code{arguments}.
 
 \begin{prototype}