Ticket #4069: ticket4069.patch

options_description.hpp

@@ -65 +65 @@
             The 'name' parameter is interpreted by the following rules:
             - if there's no "," character in 'name', it specifies long name
             - otherwise, the part before "," specifies long name and the part
-            after -- long name.
+            after -- short name.
         */
         option_description(const char* name,
                            const value_semantic* s);
@@ -81 +81 @@
         enum match_result { no_match, full_match, approximate_match };
 
         /** Given 'option', specified in the input source,
-            return 'true' is 'option' specifies *this.
+            returns 'true' if 'option' specifies *this.
         */
         match_result match(const std::string& option, bool approx,
                            bool long_ignore_case, bool short_ignore_case) const;
 
-        /** Return the key that should identify the option, in
+        /** Returns the key that should identify the option, in
             particular in the variables_map class.
             The 'option' parameter is the option spelling from the
             input source.
@@ -107 +107 @@
         /// Returns the option name, formatted suitably for usage message. 
         std::string format_name() const;
 
-        /** Return the parameter name and properties, formatted suitably for
+        /** Returns the parameter name and properties, formatted suitably for
             usage message. */
         std::string format_parameter() const;
 
@@ -211 +211 @@
         friend BOOST_PROGRAM_OPTIONS_DECL std::ostream& operator<<(std::ostream& os, 
                                              const options_description& desc);
 
-        /** Output 'desc' to the specified stream, calling 'f' to output each
+        /** Outputs 'desc' to the specified stream, calling 'f' to output each
             option_description element. */
         void print(std::ostream& os) const;