diff options
| author | Steve Huston <shuston@riverace.com> | 2002-07-22 22:01:04 +0000 |
|---|---|---|
| committer | Steve Huston <shuston@riverace.com> | 2002-07-22 22:01:04 +0000 |
| commit | daeea59f4d5813c0a957968bae431250c186d7f2 (patch) | |
| tree | b7cbc209ff011cb4c59cc193cd671cd05a6430e9 | |
| parent | 0270ecad2808ca2afad1be32970d2f37e9e29cca (diff) | |
| download | ATCD-daeea59f4d5813c0a957968bae431250c186d7f2.tar.gz | |
ChangeLogTag:Mon Jul 22 17:45:48 2002 Steve Huston <shuston@riverace.com>
| -rw-r--r-- | ace/Get_Opt.h | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/ace/Get_Opt.h b/ace/Get_Opt.h index 58f0e61fa4b..4a4f47fcb6a 100644 --- a/ace/Get_Opt.h +++ b/ace/Get_Opt.h @@ -174,14 +174,15 @@ public: * a long option. If @c operator() is called repeatedly, it returns * each of the option characters from each of the option elements. * - * @return The parsed option character. - * @retval 0 A long option was found - * @retval ? An unknown option character was found and the first - * character of @a optstring was not a colon. - * @retval : An unknown option character was found and the first - * character of @a optstring was a colon. - * @retval 1 @c RETURN_IN_ORDER was specified and a non-option argument - * was found. + * @return The parsed option character. The following characters have + * special significance. + * @retval 0 A long option was found + * @retval \'?\' An unknown option character was found and the first + * character of @a optstring was not a colon. + * @retval \':\' An unknown option character was found and the first + * character of @a optstring was a colon. + * @retval \'1\' @c RETURN_IN_ORDER was specified and a non-option argument + * was found. * @retval EOF No more option characters were found. @c opt_ind() will * return the index in @a argv of the first @a argv element * that is not an option. If @c PERMUTE_ARGS was |