Revize a35cb648

Added comments to backend

Backend/Core/Entities/Annotation.cs

@@ -11 +11 @@
 {
     public class Annotation : BaseEntity
     {
-        /*[ForeignKey("Document")]
-        public int DocumentId { get; set; }*/
+        /// <summary>
+        /// Document that the annotation refers to
+        /// </summary>
         public Document Document { get; set; }
         
-        /*[ForeignKey("User")]
-        public int UserId { get; set; }*/
+        /// <summary>
+        /// User the annotation is assigned to
+        /// </summary>
         public User User { get; set; }
 
-        /*[ForeignKey("User")]
-        public int UserAssignedId { get; set; }*/
+        /// <summary>
+        /// The user that assigned the annotation
+        /// </summary>
         public User UserAssigned { get; set; }
 
+        /// <summary>
+        /// The date the annotation was assigned
+        /// </summary>
         public DateTime DateAssigned { get; set; }
+        
+        /// <summary>
+        /// The state of the annotation
+        /// </summary>
         public EState State { get; set; }
+
+        /// <summary>
+        /// The date the annotation was last modified
+        /// </summary>
         public DateTime DateLastChanged { get; set; }
+
+        /// <summary>
+        /// Annotation note
+        /// </summary>
         public string Note { get; set; } = "";
 
+        //Cached information START
         public string CachedDocumentHTML { get; set; } = "";
         public string CachedStartPositions { get; set; } = "";
         public string CachedLengths { get; set; } = "";
         public string CachedClosingPositions { get; set; } = "";
         public string CachedClosingLengths { get; set; } = "";
         public string CachedCSS { get; set; } = "";
+        //Cached information END 
 
+        /// <summary>
+        /// ID of the last modified tag
+        /// </summary>
         public Guid? LastModifiedTagId { get; set; }
+
+        /// <summary>
+        /// The modification that is done
+        /// </summary>
         public EModified ModifiedType { get; set; } = EModified.NONE;
 
+        /// <summary>
+        /// Unused
+        /// </summary>
         public ICollection<Class> Classes { get; set; } = new List<Class>();
 
+        /// <summary>
+        /// So that EF creates a join table as 1 final annotation to N annotations
+        /// </summary>
+
         public ICollection<FinalAnnotation> FinalAnnotations { get; set; } = new List<FinalAnnotation>();
     }
 }