[This is preliminary documentation and is subject to change.]

Returns the description text for a given config key.

Namespace: fCraft
Assembly: fCraft (in fCraft.dll) Version: 0.6.2.4 (0.6.2.4)

Syntax

   
 C# 
public static string GetDescription(
	this ConfigKey key
)

Parameters

key
ConfigKey

[Missing <param name="key"/> documentation for "M:fCraft.Config.GetDescription(fCraft.ConfigKey)"]

Return Value

[Missing <returns> documentation for "M:fCraft.Config.GetDescription(fCraft.ConfigKey)"]

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ConfigKey. When you use instance method syntax to call this method, omit the first parameter.

See Also