mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-11-14 04:03:36 -06:00
Jordan Wages
87bd044b31
The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer. Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now.
1.8 KiB
1.8 KiB
GetDescription Method
An Enum extension method that gets a description.
Definition
Namespace: CapyKit.Extensions
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0
C#
public static string GetDescription(
this Enum enumeration
)
F#
[<ExtensionAttribute>]
static member GetDescription :
enumeration : Enum -> string
Parameters
- Enum
- The enumeration to act on.
Return Value
String
The description if available, otherwise the string representation of the enumeration.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type Enum. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).