jsdoc fixes

This commit is contained in:
Kevin Jahns
2018-11-25 05:43:18 +01:00
parent 9f9f465238
commit e4a5f2caec
7 changed files with 22 additions and 16 deletions

View File

@@ -12,12 +12,13 @@ import { Item } from '../structs/Item.js' // eslint-disable-line
/**
* Event that describes the changes on a YArray
*
* @param {YArray} yarray The changed type
* @param {Boolean} remote Whether the changed was caused by a remote peer
* @param {Transaction} transaction The transaction object
*/
export class YArrayEvent extends YEvent {
/**
* @param {YArray} yarray The changed type
* @param {Boolean} remote Whether the changed was caused by a remote peer
* @param {Transaction} transaction The transaction object
*/
constructor (yarray, remote, transaction) {
super(yarray)
this.remote = remote

View File

@@ -10,12 +10,13 @@ import { YEvent } from '../utils/YEvent.js'
/**
* Event that describes the changes on a YMap.
*
* @param {YMap} ymap The YArray that changed.
* @param {Set<any>} subs The keys that changed.
* @param {boolean} remote Whether the change was created by a remote peer.
*/
export class YMapEvent extends YEvent {
/**
* @param {YMap} ymap The YArray that changed.
* @param {Set<any>} subs The keys that changed.
* @param {boolean} remote Whether the change was created by a remote peer.
*/
constructor (ymap, subs, remote) {
super(ymap)
this.keysChanged = subs

View File

@@ -461,10 +461,11 @@ class YTextEvent extends YArrayEvent {
* This type replaces y-richtext as this implementation is able to handle
* block formats (format information on a paragraph), embeds (complex elements
* like pictures and videos), and text formats (**bold**, *italic*).
*
* @param {String} string The initial value of the YText.
*/
export class YText extends YArray {
/**
* @param {String} string The initial value of the YText.
*/
constructor (string) {
super()
if (typeof string === 'string') {

View File

@@ -10,8 +10,6 @@ import { DomBinding } from '../bindings/dom/DomBinding.js' // eslint-disable-lin
/**
* Represents text in a Dom Element. In the future this type will also handle
* simple formatting information like bold and italic.
*
* @param {String} arg1 Initial value.
*/
export class YXmlText extends YText {
/**