Revize a35cb648

Added comments to backend

Backend/Core/Services/HTMLService/IHTMLService.cs

@@ -10 +10 @@
 {
     public interface IHTMLService
     {
+        /// <summary>
+        /// Make a full preprocessing of an HTML document and incorporate any existing tags into it
+        /// </summary>
+        /// <param name="htmlSource"></param>
+        /// <param name="tags"></param>
+        /// <returns>tuple of (HTML document to render, info to cache in the database)</returns>
         public (string, CachedInfo) FullPreprocessHTML(string htmlSource, List<AnnotationTagGeneric> tags);
+        /// <summary>
+        /// Make a partial preprocessing of an HTML document by adding a new tag into it
+        /// </summary>
+        /// <param name="htmlToEdit">already preprocessed HTML document</param>
+        /// <param name="htmlOriginal">original HTML document</param>
+        /// <param name="tagToAdd">the tag to add</param>
+        /// <param name="tags">list of all tags related to the annotation</param>
+        /// <param name="cachedInfo">database-cached info</param>
+        /// <returns></returns>
         public (string, CachedInfo) PartialPreprocessHTMLAddTag(string htmlToEdit, string htmlOriginal, AnnotationTagGeneric tagToAdd, List<AnnotationTagGeneric> tags, CachedInfo cachedInfo);
+        /// <summary>
+        /// Make a partial preprocessing of an HTML document by remove an existing tag from it
+        /// </summary>
+        /// <param name="htmlToEdit">already preprocessed HTML document</param>
+        /// <param name="htmlOriginal">original HTML document</param>
+        /// <param name="tagToRemove">the tag to remove</param>
+        /// <param name="tags">list of all tags related to the annotation</param>
+        /// <param name="cachedInfo">database-cached info</param>
+        /// <returns></returns>
         public (string, CachedInfo) PartialPreprocessHTMLRemoveTag(string htmlToEdit, string htmlOriginal, AnnotationTagGeneric tagToRemove, List<AnnotationTagGeneric> tags, CachedInfo cachedInfo);
     }
 }