Salastil/KfChatDotNet
1
0
Fork 0
mirror of https://github.com/barelyprofessional/KfChatDotNet.git synced 2026-05-02 04:22:04 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add XML doc summaries for the value types

Browse Source
This commit is contained in:
barelyprofessional
2026-02-17 21:55:51 -06:00
parent bc114e9f64
commit 75e958cd2a
1 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
KfChatDotNetBot/Models/DbModels/SettingDbModel.cs
View File

@@ -26,10 +26,22 @@ public class SettingDbModel
public enum SettingValueType public enum SettingValueType
{ {
Boolean, Boolean,
Text, // This includes values which are only decimals /// <summary>
Array, // It's presumed that your array contains text, don't use this if your array contains complex types /// This includes values which are only decimals
// You can use the array value type on delimited values or JSON arrays. For JSON, it's presumed to be like ['str'] /// </summary>
Complex, // Basically for JSON blobs that are encoded into settings Text,
Undefined // Default value. Should only be set to this for orphaned settings. My suggestion is you don't allow users /// <summary>
// to interact with settings with an undefined type /// It's presumed that your array contains text, don't use this if your array contains complex types
/// You can use the array value type on delimited values or JSON arrays. For JSON, it's presumed to be like ['str']
/// </summary>
Array,
/// <summary>
/// Basically for JSON blobs that are encoded into settings
/// </summary>
Complex,
/// <summary>
/// Default value. Should only be set to this for orphaned settings. My suggestion is you don't allow users
/// to interact with settings with an undefined type
/// </summary>
Undefined
} }