Skip to content

Commit e79708e

Browse files
committed
Fix types. Closes #4069.
[SVN r62235]
1 parent 444146b commit e79708e

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

include/boost/program_options/options_description.hpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ namespace program_options {
6565
The 'name' parameter is interpreted by the following rules:
6666
- if there's no "," character in 'name', it specifies long name
6767
- otherwise, the part before "," specifies long name and the part
68-
after -- long name.
68+
after -- short name.
6969
*/
7070
option_description(const char* name,
7171
const value_semantic* s);
@@ -81,12 +81,12 @@ namespace program_options {
8181
enum match_result { no_match, full_match, approximate_match };
8282

8383
/** Given 'option', specified in the input source,
84-
return 'true' is 'option' specifies *this.
84+
returns 'true' if 'option' specifies *this.
8585
*/
8686
match_result match(const std::string& option, bool approx,
8787
bool long_ignore_case, bool short_ignore_case) const;
8888

89-
/** Return the key that should identify the option, in
89+
/** Returns the key that should identify the option, in
9090
particular in the variables_map class.
9191
The 'option' parameter is the option spelling from the
9292
input source.
@@ -107,7 +107,7 @@ namespace program_options {
107107
/// Returns the option name, formatted suitably for usage message.
108108
std::string format_name() const;
109109

110-
/** Return the parameter name and properties, formatted suitably for
110+
/** Returns the parameter name and properties, formatted suitably for
111111
usage message. */
112112
std::string format_parameter() const;
113113

@@ -211,7 +211,7 @@ namespace program_options {
211211
friend BOOST_PROGRAM_OPTIONS_DECL std::ostream& operator<<(std::ostream& os,
212212
const options_description& desc);
213213

214-
/** Output 'desc' to the specified stream, calling 'f' to output each
214+
/** Outputs 'desc' to the specified stream, calling 'f' to output each
215215
option_description element. */
216216
void print(std::ostream& os) const;
217217

0 commit comments

Comments
 (0)