Revize 4b03d2a7

More comments in backend

Backend/Models/Annotations/AnnotationGetRequest.cs

@@ -1 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-
-namespace Models.Annotations
-{
-    public class AnnotationGetRequest
-    {
-        public Guid AnnotationId { get; set; }
-    }
-}

Backend/Models/Annotations/AnnotationInfo.cs

@@ -17 +17 @@
         public EState State { get; set; }
         public EDocumentType Type { get; set; }
         public string Note { get; set; }
+        /// <summary>
+        /// List of tags essentially
+        /// </summary>
         public List<TagInstanceInfo> TagInstances { get; set; } = new();
+        /// <summary>
+        /// CSS for rendering
+        /// </summary>
         public List<TagInstanceCSSInfo> CSSInfo { get; set; } = new();
     }
 }

Backend/Models/Annotations/AnnotationListInfo.cs

@@ -9 +9 @@
 {
     public class AnnotationListInfo
     {
+        /// <summary>
+        /// What document
+        /// </summary>
         public string DocumentName { get; set; }
+        /// <summary>
+        /// In what state
+        /// </summary>
         public EState State { get; set; }
+        /// <summary>
+        /// The annotation
+        /// </summary>
         public Guid AnnotationId { get; set; }
     }
 }

Backend/Models/Annotations/AnnotationsAddRequest.cs

@@ -8 +8 @@
 
 public class AnnotationsAddRequest
 {
+    /// <summary>
+    /// List of users to assigned the documents
+    /// </summary>
     public List<Guid> UserIdList { get; set; }
+    /// <summary>
+    /// List of documents to assign the users
+    /// </summary>
     public List<Guid> DocumentIdList { get; set; }
 }
 

Backend/Models/Documents/DocumentAddInfo.cs

@@ -9 +9 @@
 
 # nullable disable
 /**
- * If the file is plaintext, we except it to be a single document
+ * If the file is plaintext, we except it to be a single document base64 encoded
  * If the file is base64, we expect it to be a ZIP file with plaintext documents in its root
  */
 public class DocumentAddInfo
 {
     public string Name { get; set; }
+
+    /// <summary>
+    /// The backend relies on this being correct
+    /// </summary>
     public EAddDocumentFormat Format { get; set; } = EAddDocumentFormat.TEXTFILE;
+
     public string Content { get; set; }
 }

Backend/Models/Tags/TagInstanceInfo.cs

@@ -10 +10 @@
 {
     public class TagInstanceInfo
     {
-        /** For database */
+        /// <summary>
+        /// unique ID
+        /// </summary>
         public Guid OccurenceId { get; set; }
         public string TagName { get; set; }
+
+        /// <summary>
+        /// ID of the Tag in database
+        /// </summary>
         public Guid TagId { get; set; }
         public string TagCategoryName { get; set; }
+
+        /// <summary>
+        /// ID of the category in database
+        /// </summary>
         public Guid TagCategoryId { get; set; }
         public string? SubTagName { get; set; }
+
+        /// <summary>
+        /// ID of the subtag in database
+        /// </summary>
         public Guid? SubTagId { get; set; }
 
+        /// <summary>
+        /// Instance of the tag (multipart tags share the same instance)
+        /// </summary>
         public Guid Instance { get; set; }
         public int Position { get; set; }
         public int Length { get; set; }
@@ -28 +45 @@
         public ETagSentiment? Sentiment { get; set; }
         public string SelectedText { get; set; }
 
+        /// <summary>
+        /// Optional list of users who have agreed on this tag - only when the annotation is final
+        /// </summary>
         public List<UserInfo>? Users { get; set; }
+        /// <summary>
+        /// Optional information about the tag being resolved - only when the annotation is final
+        /// </summary>
         public bool? IsFinal { get; set; }
     }
 }

Backend/Models/Users/DocumentUserInfo.cs

@@ -9 +9 @@
 {
     public class DocumentUserInfo
     {
+        /// <summary>
+        /// User Id
+        /// </summary>
         public Guid Id { get; set; }
         public string Username { get; set; }
         public string Name { get; set; }
         public string Surname { get; set; }
+
+        /// <summary>
+        /// State of the annotation
+        /// </summary>
         public EState State { get; set; }
+        /// <summary>
+        /// Id of the annotation
+        /// </summary>
         public Guid AnnotationId { get; set; }
     }
 }