description()

const xtd::string & xtd::diagnostics::switch_base::description ( ) const

noexcept

Gets a description of the switch.

Returns

The description of the switch. The default value is an empty string ("").

Remarks

This property should indicate the function of the switch; for example, "Enables tracing for a directory watcher component." The value is set by the descriptor parameter in the switch_base constructor.