diff --git a/docs/manual.html b/docs/manual.html index bb18f61..4695f50 100644 --- a/docs/manual.html +++ b/docs/manual.html @@ -144,8 +144,8 @@ work.
@@ -155,7 +155,7 @@ These properties are set in the constructors of the arguments.
+
As we understand things, Visual C++ does not have the file config.h which is used to make platform specific definitions. In this situation, we assume that you @@ -411,13 +411,14 @@ This is called "exclusive or" or "XOR". To accomodate this situation, there is now an option to add two or more Args to a CmdLine that are exclusively or'd with one another: -xorAdd(). This means that exactly one of the +xorAdd(). This means that exactly one of the Args must be set and no more.
-xorAdd() comes in two flavors, either xorAdd(Arg& a, Arg& b) +xorAdd() comes in two flavors, either +xorAdd(Arg& a, Arg& b) to add just two Args to be xor'd and -xorAdd( vector<Arg*> xorList ) to add more than two -Args. +xorAdd( vector<Arg*> xorList ) +to add more than two Args.
@@ -438,10 +439,11 @@ marked as set. The question then, is how to determine which of the Args has been set? This is accomplished by calling the isSet() method for each Arg. If the Arg has been -matched on the command line, the isSet() will return +matched on the command line, the isSet() will return TRUE, whereas if the Arg has been set as a result of matching the other Arg -that was xor'd isSet() will return FALSE. +that was xor'd isSet() will +return FALSE. (Of course, if the Arg was not xor'd and wasn't matched, it will also return FALSE.) @@ -508,7 +510,8 @@ be relatively small, although there is no limit on this. Obviously, a list of allowed values isn't always the best way to constrain things. For instance, one might wish to allow only integers greater than 0. In this case, the best strategy is for you -to evaluate the value returned from the getValue() call and if it +to evaluate the value returned from the getValue() +call and if it isn't valid, throw an ArgException. Be sure that the description provided with the Arg reflects the constraint you choose. diff --git a/docs/manual.xml b/docs/manual.xml index 62dfe74..70dbfc0 100644 --- a/docs/manual.xml +++ b/docs/manual.xml @@ -192,8 +192,8 @@ USAGE and an error message. specified directly.A delimiter character can be specified. This means that if you -prefer arguments of the style "-s=asdf" instead of "-s asdf", you -can do so. +prefer arguments of the style-s=asdf instead of +-s asdf , you can do so.Always wrap everything in a try block that catches ArgExceptions! Any problems found in constructing the @@ -214,7 +214,7 @@ signals the beginning of the argument on the command line.Arguments also have names, which can, if desired also be used as a flag on the command line, this time preceeded by two dashes -(--) [like the familiar getopt_long()]. +(--) [like the familiargetopt_long() ].Next is the description of the argument. This is a short description of the argument displayed in the help/usage message @@ -540,15 +540,16 @@ This is called "exclusive or" or "XOR". To accomodate this situation, there is now an option to add two or more Arg s to aCmdLine that are exclusively or'd with one another: -xorAdd(). This means that exactly one of the +xorAdd() . This means that exactly one of theArg s must be set and no more.-xorAdd() comes in two flavors, either xorAdd(Arg& a, Arg& b) + xorAdd() comes in two flavors, either +xorAdd(Arg& a, Arg& b) to add just twoArg s to be xor'd and -xorAdd( vector<Arg*> xorList ) to add more than two -Arg s. +xorAdd( vector<Arg*> xorList ) +to add more than twoArg s.@@ -569,10 +570,11 @@ marked as set. The question then, is how to determine which of the Arg s has been set? This is accomplished by calling the isSet() method for eachArg . If theArg has been -matched on the command line, the isSet() will return +matched on the command line, theisSet() will returnTRUE , whereas if theArg has been set as a result of matching the otherArg -that was xor'd isSet() will returnFALSE . +that was xor'disSet() will +returnFALSE . (Of course, if theArg was not xor'd and wasn't matched, it will also returnFALSE .) @@ -653,7 +655,8 @@ be relatively small, although there is no limit on this. Obviously, a list of allowed values isn't always the best way to constrain things. For instance, one might wish to allow only integers greater than 0. In this case, the best strategy is for you -to evaluate the value returned from the getValue() call and if it +to evaluate the value returned from thegetValue() +call and if it isn't valid, throw anArgException . Be sure that the description provided with theArg reflects the constraint you choose. @@ -752,7 +755,8 @@ heart's content.Ideally this library would use RTTI to return a human readable name of the type declared for a particular argument. Unfortunately, at -least for g++, the names returned aren't particularly useful. +least for diff --git a/docs/style.css b/docs/style.css index 59615c8..d3c88c8 100755 --- a/docs/style.css +++ b/docs/style.css @@ -86,13 +86,9 @@ tt.classname { } tt.constant { - font-style:italic; font-weight:bold; } -tt.methodname { - font-style:italic; -} p { line-height: 1.5em;g++ , the names returned aren't +particularly useful.