From e79708eee7786186b9b2c402669245197857eb37 Mon Sep 17 00:00:00 2001 From: Vladimir Prus Date: Wed, 26 May 2010 09:51:10 +0000 Subject: [PATCH] Fix types. Closes #4069. [SVN r62235] --- include/boost/program_options/options_description.hpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/boost/program_options/options_description.hpp b/include/boost/program_options/options_description.hpp index 0486f02..8b52241 100644 --- a/include/boost/program_options/options_description.hpp +++ b/include/boost/program_options/options_description.hpp @@ -65,7 +65,7 @@ namespace program_options { 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,12 +81,12 @@ namespace program_options { 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,7 +107,7 @@ namespace program_options { /// 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,7 +211,7 @@ namespace program_options { 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;