From f0ab3527f605608769acc638fe9217a58958b242 Mon Sep 17 00:00:00 2001
From: Jonathan Jenne <j.jenne@digitaldata.works>
Date: Fri, 4 Feb 2022 13:40:02 +0100
Subject: [PATCH] ZooFlow/State: Comment UserState object

---
 Modules.ZooFlow/State/UserState.vb | 49 ++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/Modules.ZooFlow/State/UserState.vb b/Modules.ZooFlow/State/UserState.vb
index f2305ae9..27244026 100644
--- a/Modules.ZooFlow/State/UserState.vb
+++ b/Modules.ZooFlow/State/UserState.vb
@@ -8,18 +8,67 @@ Namespace State
         Public Const LANG_DE_DE As String = "de-DE"
         Public Const LANG_EN_US As String = "en-US"
 
+        ''' <summary>
+        ''' Numeric UserId, ex. 1
+        ''' </summary>
         Public Property UserId As Integer
+
+        ''' <summary>
+        ''' The windows username, ex. JenneJ
+        ''' </summary>
+        ''' <returns></returns>
         Public Property UserName As String
+
+        ''' <summary>
+        ''' The user's surname, ex. Jenne
+        ''' </summary>
         Public Property Surname As String
+
+        ''' <summary>
+        ''' The user's given name, ex. Jonathan
+        ''' </summary>
         Public Property GivenName As String
+
+        ''' <summary>
+        ''' The shortname given to the user, ex. JJ
+        ''' </summary>
         Public Property ShortName As String
+
+        ''' <summary>
+        ''' The user's email address
+        ''' </summary>
         Public Property Email As String
+
+        ''' <summary>
+        ''' The user's windows machine name, ex. DD-PC-ENT04
+        ''' </summary>
         Public Property MachineName As String
+
+        ''' <summary>
+        ''' The users preferred date format, ex. dd-MM-yyyy
+        ''' </summary>
         Public Property DateFormat As String
+
+        ''' <summary>
+        ''' The user's language code, ex. de-DE
+        ''' </summary>
         Public Property Language As String
+
+        ''' <summary>
+        ''' The user's language id, what is this?
+        ''' </summary>
         Public Property LanguageId As Integer
+
+        ''' <summary>
+        ''' Is the user a general administrator?
+        ''' </summary>
+        ''' <returns></returns>
         Public Property IsAdmin As Boolean = False
 
+        ''' <summary>
+        ''' Should basic config (DB Settings) be hidden from this user?
+        ''' </summary>
+        ''' <returns></returns>
         Public Property HideBasicConfig As Boolean = False
 
         ''' <summary>