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

This commit is contained in:
Kevin Jahns
2018-03-05 03:03:40 +01:00
parent dc22a79ac4
commit a9b610479d
33 changed files with 2426 additions and 168 deletions

View File

@@ -1,4 +1,12 @@
/**
* Changes that are created within a transaction are bundled and sent as one
* message to the remote peers. This implies that the changes are applied
* in one flush and at most one {@link YEvent} per type is created.
*
* It is best to bundle as many changes in a single Transaction as possible.
* This way only few changes need to be computed
*/
export default class Transaction {
constructor (y) {
this.y = y