diff options
| author | Roy Ben Shabat <Roy.mail.net@gmail.com> | 2020-10-20 21:11:46 +0300 |
|---|---|---|
| committer | Roy Ben Shabat <Roy.mail.net@gmail.com> | 2020-10-20 21:11:46 +0300 |
| commit | a2d2681c91aa3798a27cb2aa9e047f261027389c (patch) | |
| tree | 18db6bc4301531eed8a367763f119865d87524db /Software/Visual_Studio/Tango.DataStore/DataStoreHelper.cs | |
| parent | 50b5a229c4fe547a896539f24c96e5e9a86ebb80 (diff) | |
| download | Tango-a2d2681c91aa3798a27cb2aa9e047f261027389c.tar.gz Tango-a2d2681c91aa3798a27cb2aa9e047f261027389c.zip | |
Little DataStore documentation.
Diffstat (limited to 'Software/Visual_Studio/Tango.DataStore/DataStoreHelper.cs')
| -rw-r--r-- | Software/Visual_Studio/Tango.DataStore/DataStoreHelper.cs | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Software/Visual_Studio/Tango.DataStore/DataStoreHelper.cs b/Software/Visual_Studio/Tango.DataStore/DataStoreHelper.cs index 56afb15b7..bf78bc35e 100644 --- a/Software/Visual_Studio/Tango.DataStore/DataStoreHelper.cs +++ b/Software/Visual_Studio/Tango.DataStore/DataStoreHelper.cs @@ -6,13 +6,27 @@ using System.Threading.Tasks; namespace Tango.DataStore { + /// <summary> + /// Contains data store helper methods. + /// </summary> public static class DataStoreHelper { + /// <summary> + /// Gets the data store data type by the specified object type. + /// </summary> + /// <param name="value">The value.</param> + /// <returns></returns> public static DataType GetDataType(Object value) { return GetDataType(value.GetType()); } + /// <summary> + /// Gets data store data type by the specified .net type. + /// </summary> + /// <param name="type">The type.</param> + /// <returns></returns> + /// <exception cref="System.NotSupportedException"></exception> public static DataType GetDataType(Type type) { if (type == typeof(Int32)) @@ -43,6 +57,12 @@ namespace Tango.DataStore throw new NotSupportedException($"The specified type '{type.Name}' is not supported by the data store."); } + /// <summary> + /// Gets the CLR type by specified data store data type. + /// </summary> + /// <param name="type">The type.</param> + /// <returns></returns> + /// <exception cref="System.NotSupportedException">The specified data type is not supported.</exception> public static Type GetType(DataType type) { switch (type) |
