summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Huston <shuston@riverace.com>2002-08-28 02:49:30 +0000
committerSteve Huston <shuston@riverace.com>2002-08-28 02:49:30 +0000
commit2ba2ba0f0d17493c380c4cca74f47165dc177c79 (patch)
tree51fe8e5f0879d7a069457b6599d2c2a96c63f025
parent8d8b98a0ea81a300ae41657a041865665613492f (diff)
downloadATCD-2ba2ba0f0d17493c380c4cca74f47165dc177c79.tar.gz
ChangeLogTag:Tue Aug 27 19:09:17 2002 Steve Huston <shuston@riverace.com>
-rw-r--r--ChangeLog4
-rw-r--r--ChangeLogs/ChangeLog-03a4
-rw-r--r--ace/Get_Opt.h12
3 files changed, 19 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index 094f91b6c1e..c6f0f1209a6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Tue Aug 27 19:09:17 2002 Steve Huston <shuston@riverace.com>
+
+ * ace/Get_Opt.h: Documentation improvements.
+
Tue Aug 27 17:00:20 2002 Douglas C. Schmidt <schmidt@macarena.cs.wustl.edu>
* ace/Signal.cpp: Fixed the ACE_Sig_Action constructors so that
diff --git a/ChangeLogs/ChangeLog-03a b/ChangeLogs/ChangeLog-03a
index 094f91b6c1e..c6f0f1209a6 100644
--- a/ChangeLogs/ChangeLog-03a
+++ b/ChangeLogs/ChangeLog-03a
@@ -1,3 +1,7 @@
+Tue Aug 27 19:09:17 2002 Steve Huston <shuston@riverace.com>
+
+ * ace/Get_Opt.h: Documentation improvements.
+
Tue Aug 27 17:00:20 2002 Douglas C. Schmidt <schmidt@macarena.cs.wustl.edu>
* ace/Signal.cpp: Fixed the ACE_Sig_Action constructors so that
diff --git a/ace/Get_Opt.h b/ace/Get_Opt.h
index a45542a0322..d7544cb0853 100644
--- a/ace/Get_Opt.h
+++ b/ace/Get_Opt.h
@@ -218,6 +218,16 @@ public:
int &opt_ind (void);
/// Adds a long option with no corresponding short option.
+ /**
+ * If the @a name option is seen, @c operator() returns 0.
+ *
+ * @param name The long option to add.
+ * @param has_arg Defines the argument requirements for
+ * the new option.
+ *
+ * @retval 0 Success
+ * @retval -1 The long option can not be added.
+ */
int long_option (const ACE_TCHAR *name,
OPTION_ARG_MODE has_arg = NO_ARG);
@@ -230,7 +240,7 @@ public:
* the new option. If the short option has already
* been supplied in the @a optstring, @a has_arg
* must match or an error is returned; otherwise, the
- * new short option it is added to the @a optstring.
+ * new short option is added to the @a optstring.
*
* @retval 0 Success
* @retval -1 The long option can not be added.