jsdoc fixes

This commit is contained in:
Kevin Jahns 2019-04-11 00:48:52 +02:00
parent 759ecb21f7
commit ed3b31e58f
4 changed files with 8 additions and 8 deletions

View File

@ -341,13 +341,11 @@ class YTextEvent extends YEvent {
*/ */
this._delta = null this._delta = null
} }
// TODO: Should put this in a separate function. toDelta shouldn't be included
// in every Yjs distribution
/** /**
* Compute the changes in the delta format. * Compute the changes in the delta format.
* A {@link https://quilljs.com/docs/delta/|Quill Delta}) that represents the changes on the document.
* *
* @type {Array<{delete:number|undefined,retain:number|undefined,insert:string|undefined,attributes:Object<string,any>}>} A {@link https://quilljs.com/docs/delta/|Quill Delta}) that * @type {Array<{delete:number|undefined,retain:number|undefined,insert:string|undefined,attributes:Object<string,any>}>}
* represents the changes on the document.
* *
* @public * @public
*/ */

View File

@ -423,7 +423,6 @@ export class YXmlElement extends YXmlFragment {
} }
} }
// TODO: outsource the binding property.
/** /**
* Creates a Dom Element that mirrors this YXmlElement. * Creates a Dom Element that mirrors this YXmlElement.
* *

View File

@ -15,11 +15,13 @@ export class ID {
*/ */
constructor (client, clock) { constructor (client, clock) {
/** /**
* @type {number} Client id * Client id
* @type {number}
*/ */
this.client = client this.client = client
/** /**
* @type {number} unique per client id, continuous number * unique per client id, continuous number
* @type {number}
*/ */
this.clock = clock this.clock = clock
} }

View File

@ -50,7 +50,8 @@ export class Transaction {
*/ */
constructor (y) { constructor (y) {
/** /**
* @type {Y} The Yjs instance. * The Yjs instance.
* @type {Y}
*/ */
this.y = y this.y = y
/** /**