big documentation update - all public functions and classes are documented now

src/Struct/Delete.js

@@ -3,6 +3,7 @@ import ID from '../Util/ID.js'
 import { logID } from '../MessageHandler/messageToString.js'
 
 /**
+ * @private
  * Delete all items in an ID-range
  * TODO: implement getItemCleanStartNode for better performance (only one lookup)
  */
@@ -35,13 +36,26 @@ export function deleteItemRange (y, user, clock, range) {
 }
 
 /**
- * Delete is not a real struct. It will not be saved in OS
+ * @private
+ * A Delete change is not a real Item, but it provides the same interface as an
+ * Item. The only difference is that it will not be saved in the ItemStore
+ * (OperationStore), but instead it is safed in the DeleteStore.
  */
 export default class Delete {
   constructor () {
     this._target = null
     this._length = null
   }
+
+  /**
+   * @private
+   * Read the next Item in a Decoder and fill this Item with the read data.
+   *
+   * This is called when data is received from a remote peer.
+   *
+   * @param {Y} y The Yjs instance that this Item belongs to.
+   * @param {BinaryDecoder} decoder The decoder object to read data from.
+   */
   _fromBinary (y, decoder) {
     // TODO: set target, and add it to missing if not found
     // There is an edge case in p2p networks!
@@ -54,15 +68,32 @@ export default class Delete {
       return []
     }
   }
+
+  /**
+   * @private
+   * Transform the properties of this type to binary and write it to an
+   * BinaryEncoder.
+   *
+   * This is called when this Item is sent to a remote peer.
+   *
+   * @param {BinaryEncoder} encoder The encoder to write data to.
+   */
   _toBinary (encoder) {
     encoder.writeUint8(getReference(this.constructor))
     encoder.writeID(this._targetID)
     encoder.writeVarUint(this._length)
   }
+
   /**
-   * - If created remotely (a remote user deleted something),
+   * @private
+   * Integrates this Item into the shared structure.
+   *
+   * This method actually applies the change to the Yjs instance. In the case of
+   * Delete it marks the delete target as deleted.
+   *
+   * * If created remotely (a remote user deleted something),
    *   this Delete is applied to all structs in id-range.
-   * - If created lokally (e.g. when y-array deletes a range of elements),
+   * * If created lokally (e.g. when y-array deletes a range of elements),
    *   this struct is broadcasted only (it is already executed)
    */
   _integrate (y, locallyCreated = false) {
@@ -78,6 +109,12 @@ export default class Delete {
       y.persistence.saveStruct(y, this)
     }
   }
+
+  /**
+   * @private
+   * Transform this Delete to a readable format.
+   * Useful for logging as all Items implement this method.
+   */
   _logString () {
     return `Delete - target: ${logID(this._targetID)}, len: ${this._length}`
   }