Revize a35cb648

Added comments to backend

Backend/Core/Services/TagService/ITagService.cs

@@ -12 +12 @@
 {
     public interface ITagService
     {
+        /// <summary>
+        /// Returns a tree-like structure with tag categories, tags, and subtags
+        /// </summary>
+        /// <param name="userRole">Role is used to discriminate categories available to admins only</param>
+        /// <returns></returns>
         public TagTreeResponse GetTagTree(ERole userRole);
+        /// <summary>
+        /// Creates a new category
+        /// </summary>
+        /// <param name="request"></param>
         public void CreateCategory(CreateCategoryRequest request);
+        /// <summary>
+        /// Deleted a category by Id
+        /// </summary>
+        /// <param name="categoryId"></param>
         public void DeleteCategory(Guid categoryId);
+        /// <summary>
+        /// Updates a category by Id
+        /// </summary>
+        /// <param name="request"></param>
+        /// <param name="categoryId"></param>
         public void UpdateCategory(ModifyCategoryRequest request, Guid categoryId);
+        /// <summary>
+        /// Creates a new tag
+        /// </summary>
+        /// <param name="request"></param>
         public void CreateTag(CreateTagRequest request);
+        /// <summary>
+        /// Delete tag by Id
+        /// </summary>
+        /// <param name="tagId"></param>
         public void DeleteTag(Guid tagId);
+        /// <summary>
+        /// Update tag by Id
+        /// </summary>
+        /// <param name="request"></param>
+        /// <param name="tagId"></param>
         public void UpdateTag(ModifyTagRequest request, Guid tagId);
+        /// <summary>
+        /// Create a subtag
+        /// </summary>
+        /// <param name="request"></param>
         public void CreateSubTag(CreateSubTagRequest request);
+        /// <summary>
+        /// Delete subtag by Id
+        /// </summary>
+        /// <param name="subtagId"></param>
         public void DeleteSubTag(Guid subtagId);
+        /// <summary>
+        /// Update subtag by Id
+        /// </summary>
+        /// <param name="request"></param>
+        /// <param name="subtagId"></param>
         public void UpdateSubTag(ModifySubTagRequest request, Guid subtagId);
+        /// <summary>
+        /// Adds a note to tag's instance
+        /// </summary>
+        /// <param name="annotationId">Annotation</param>
+        /// <param name="occurrenceId">Id of the Tag</param>
+        /// <param name="user">User that's doing the adding</param>
+        /// <param name="request"></param>
+        /// <param name="isFinal">Whether the annotationId is for a FinalAnnotation or Annotation</param>
         public void AddNoteToTagInstance(Guid annotationId, Guid occurrenceId, User user, AddNoteToTagOccurenceRequest request, bool isFinal);
     }
 }