summaryrefslogtreecommitdiff
path: root/boost/program_options/options_description.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'boost/program_options/options_description.hpp')
-rw-r--r--boost/program_options/options_description.hpp10
1 files changed, 10 insertions, 0 deletions
diff --git a/boost/program_options/options_description.hpp b/boost/program_options/options_description.hpp
index eff1f90d8e..62530b2dc1 100644
--- a/boost/program_options/options_description.hpp
+++ b/boost/program_options/options_description.hpp
@@ -102,6 +102,16 @@ namespace program_options {
*/
const std::string& key(const std::string& option) const;
+
+ /** Returns the canonical name for the option description to enable the user to
+ recognised a matching option.
+ 1) For short options ('-', '/'), returns the short name prefixed.
+ 2) For long options ('--' / '-') returns the long name prefixed
+ 3) All other cases, returns the long name (if present) or the short name,
+ unprefixed.
+ */
+ std::string canonical_display_name(int canonical_option_style = 0) const;
+
const std::string& long_name() const;
/// Explanation of this option