From 3a17df4daf6cd84afe8ee69b0f7b263f830566d7 Mon Sep 17 00:00:00 2001
From: usodhi <61431818+usodhi@users.noreply.github.com>
Date: Wed, 31 Mar 2021 18:11:59 -0400
Subject: sharing bugfix + minor restructure + some comments

---
 src/fields/Doc.ts | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'src/fields/Doc.ts')

diff --git a/src/fields/Doc.ts b/src/fields/Doc.ts
index d0ccce9cf..5b3e21e34 100644
--- a/src/fields/Doc.ts
+++ b/src/fields/Doc.ts
@@ -429,6 +429,11 @@ export namespace Doc {
         index = allowProtos && index !== -1 ? index : list.reduce((p, v, i) => (v instanceof Doc && Doc.AreProtosEqual(v, toFind)) ? i : p, -1);
         return index; // list.findIndex(doc => doc === toFind || Doc.AreProtosEqual(doc, toFind));
     }
+
+    /**
+     * Removes doc from the list of Docs at listDoc[fieldKey]
+     * @returns true if successful, false otherwise.
+     */
     export function RemoveDocFromList(listDoc: Doc, fieldKey: string | undefined, doc: Doc) {
         const key = fieldKey ? fieldKey : Doc.LayoutFieldKey(listDoc);
         if (listDoc[key] === undefined) {
@@ -444,6 +449,11 @@ export namespace Doc {
         }
         return false;
     }
+
+    /**
+     * Adds doc to the list of Docs stored at listDoc[fieldKey].
+     * @returns true if successful, false otherwise.
+     */
     export function AddDocToList(listDoc: Doc, fieldKey: string | undefined, doc: Doc, relativeTo?: Doc, before?: boolean, first?: boolean, allowDuplicates?: boolean, reversed?: boolean) {
         const key = fieldKey ? fieldKey : Doc.LayoutFieldKey(listDoc);
         if (listDoc[key] === undefined) {
@@ -477,9 +487,9 @@ export namespace Doc {
         return false;
     }
 
-    //
-    // Computes the bounds of the contents of a set of documents.
-    //
+    /**
+     * Computes the bounds of the contents of a set of documents.
+     */
     export function ComputeContentBounds(docList: Doc[]) {
         const bounds = docList.reduce((bounds, doc) => {
             const [sptX, sptY] = [NumCast(doc.x), NumCast(doc.y)];
-- 
cgit v1.2.3-70-g09d2