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

src/MessageHandler/binaryEncode.js

@@ -1,8 +1,15 @@
+
 import { writeStructs } from './syncStep1.js'
 import { integrateRemoteStructs } from './integrateRemoteStructs.js'
 import { readDeleteSet, writeDeleteSet } from './deleteSet.js'
 import BinaryEncoder from '../Binary/Encoder.js'
 
+/**
+ * Read the Decoder and fill the Yjs instance with data in the decoder.
+ *
+ * @param {Y} y The Yjs instance
+ * @param {BinaryDecoder} decoder The BinaryDecoder to read from.
+ */
 export function fromBinary (y, decoder) {
   y.transact(function () {
     integrateRemoteStructs(y, decoder)
@@ -10,6 +17,13 @@ export function fromBinary (y, decoder) {
   })
 }
 
+/**
+ * Encode the Yjs model to binary format.
+ *
+ * @param {Y} y The Yjs instance
+ * @return {BinaryEncoder} The encoder instance that can be transformed
+ *                         to ArrayBuffer or Buffer.
+ */
 export function toBinary (y) {
   let encoder = new BinaryEncoder()
   writeStructs(y, encoder, new Map())

src/MessageHandler/integrateRemoteStructs.js

@@ -11,6 +11,7 @@ class MissingEntry {
 }
 
 /**
+ * @private
  * Integrate remote struct
  * When a remote struct is integrated, other structs might be ready to ready to
  * integrate.

src/MessageHandler/syncStep1.js

@@ -30,6 +30,11 @@ export function sendSyncStep1 (connector, syncUser) {
   connector.send(syncUser, encoder.createBuffer())
 }
 
+/**
+ * @private
+ * Write all Items that are not not included in ss to
+ * the encoder object.
+ */
 export function writeStructs (y, encoder, ss) {
   const lenPos = encoder.pos
   encoder.writeUint32(0)