[Boost-commit] svn:boost r45448 - branches/release/libs/program_options/doc

From: ghost_at_[hidden]
Date: 2008-05-17 03:07:01

Author: vladimir_prus
Date: 2008-05-17 03:06:59 EDT (Sat, 17 May 2008)
New Revision: 45448
URL: http://svn.boost.org/trac/boost/changeset/45448

Log:
Clarify docs. Fixes #1530.

Text files modified: 
   branches/release/libs/program_options/doc/overview.xml |    16 +++++++++-------                        
   1 files changed, 9 insertions(+), 7 deletions(-)

Modified: branches/release/libs/program_options/doc/overview.xml
==============================================================================
--- branches/release/libs/program_options/doc/overview.xml	(original)
+++ branches/release/libs/program_options/doc/overview.xml	2008-05-17 03:06:59 EDT (Sat, 17 May 2008)
@@ -185,14 +185,16 @@
     ("email", value<string>()->multitoken(), "email to send to")
     ;
       </programlisting>
-      For the first parameter, we specify only the name and the
-      description. No value can be specified in the parsed source.
-      For the first option, the user must specify a value, using a single
-      token. For the third option, the user may either provide a single token
-      for the value, or no token at all. For the last option, the value can
-      span several tokens. For example, the following command line is OK:
+      For the first option (<literal>help</literal>), we specify only the name
+      and the description. No value can be specified in the parsed source.
+      For the second option (<literal>compression</literal>), the user must
+      specify a value, using a single token. For the third option
+      (<literal>verbose</literal>), the user may either provide a single token
+      for the value, or no token at all. For the last option
+      (<literal>email</literal>), the value can span several tokens. For
+      example, the following command line is OK:
       <screen>
-          test --help --compression 10 --verbose --email beadle_at_mars beadle2_at_mars
+          test --help --compression 10 --verbose --email beagle_at_mars beagle2_at_mars
       </screen>      
       </para>