summaryrefslogtreecommitdiff
path: root/ace/Arg_Shifter.h
diff options
context:
space:
mode:
authorljb1 <ljb1@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>1999-10-28 01:32:20 +0000
committerljb1 <ljb1@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>1999-10-28 01:32:20 +0000
commitea8eb7732bce70a087005dd78be52aace7cba33c (patch)
tree8d845e1d1b26d40dbc1ca94ae398eb973f916005 /ace/Arg_Shifter.h
parenta474a2b019fee5e19bd4e2ec943d6c4e95698b08 (diff)
downloadATCD-ea8eb7732bce70a087005dd78be52aace7cba33c.tar.gz
Wed Oct 27 20:31:22 1999 Luther J Baker <ljb1@cs.wustl.edu>
Diffstat (limited to 'ace/Arg_Shifter.h')
-rw-r--r--ace/Arg_Shifter.h21
1 files changed, 11 insertions, 10 deletions
diff --git a/ace/Arg_Shifter.h b/ace/Arg_Shifter.h
index 41769d17320..579c55ef4f5 100644
--- a/ace/Arg_Shifter.h
+++ b/ace/Arg_Shifter.h
@@ -59,31 +59,32 @@ public:
// this method will attempt to return the associated
// parameter value
//
- // Safe to call without checking for a current argument
+ // Safe to call without checking that a current arg exists
//
- // A char* to 'value' is returned:
+ // In the following examples, a pointer to the char* "value" is ret
//
// eg: main -foobar value, main -FooBar value
// main -FOOBARvalue
//
// all of the above will all match the <flag> == -FooBar
- // and will return a char* to 'value'
+ // and will return a char* to "value"
//
- // main -foobar 4 would succeed and return a char* to '4'
- // main -foobar -4 wound not succeed (-4 is not a parameter)
+ // main -foobar 4 would succeed and return a char* to "4"
+ // main -foobar -4 does not succeed (-4 is not a parameter)
// but instead, would return 0
//
// 0 is returned:
// If the current argument does not match flag
// If there is no parameter found after a 'matched' flag
//
- // If the flag is mateched and the flag and paramter DO NOT RUN
+ // If the flag is matched and the flag and paramter DO NOT RUN
// together, the flag is consumed, the parameter is returned,
- // and the new current argument is the paramter value.
- // ie '-foobarflag VALUE
+ // and the new current argument is the parameter value.
+ // ie '-foobarflag VALUE' leaves the new cur arg == "VALUE"
//
- // If the flag is matched and the flag and parameter DO RUN
- // together '-foobarflagVALUE, the flag is NOT consumed
+ // If the flag is matched and the flag and parameter RUN
+ // together '-foobarflagVALUE', the flag is NOT consumed
+ // and the cur arg is left pointing to the entire flag/value pair
int cur_arg_strncasecmp (const char* flag);
// Check if the current argument matches (case insensitive) <flag>