ookii::value_description< T, CharType, Traits, Alloc > Struct Template Reference

Template used to specify the default value description for a type. More...

#include <ookii/value_description.h>

Static Public Member Functions
static std::basic_string< CharType, Traits, Alloc >	get ()
	Gets the value description for the type.

Detailed Description

template<typename T, typename CharType = char, typename Traits = std::char_traits<char>, typename Alloc = std::allocator<char>>
struct ookii::value_description< T, CharType, Traits, Alloc >

Template used to specify the default value description for a type.

The value description is a short, often one-word description that indicates the types of values an argument accepts. It is not the same as the long description that described an argument's function.

This base template defaults to using the short type name (the type name stripped of any namespace prefixes). The exact result may depend on your compiler, and may not look good for template types.

Specialize this template to provide a different default value description for a type.

Template Parameters

T	The type whose value description to provide.
CharType	The character type to use.
Traits	The character traits to use.
Alloc	The allocator to use for.

---

The documentation for this struct was generated from the following file:

• /mnt/d/Sven/Documents/Code/Ookii.CommandLine.Cpp/include/ookii/value_description.h