From 1fc5a9aada66e2b01a77894e3aa6e39ad4aea3bf Mon Sep 17 00:00:00 2001 From: YuviPanda Date: Fri, 11 Nov 2016 16:27:01 -0800 Subject: [PATCH 1/3] Add docstring for the title event --- src/xterm.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/xterm.js b/src/xterm.js index e915edfb..992c5dd2 100644 --- a/src/xterm.js +++ b/src/xterm.js @@ -3144,6 +3144,12 @@ Terminal.prototype.handler = function(data) { * @param {string} title The title to populate in the event. */ Terminal.prototype.handleTitle = function(title) { + /** + * This event is emitted when the title of the terminal is changed + * from inside the terminal. The parameter is the new title. + * + * @event title + */ this.emit('title', title); }; From 5712365cac4f96569cb69f28cb7c6105339e283f Mon Sep 17 00:00:00 2001 From: YuviPanda Date: Fri, 11 Nov 2016 16:27:10 -0800 Subject: [PATCH 2/3] Add docstring for the open event --- src/xterm.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/xterm.js b/src/xterm.js index 992c5dd2..231622c4 100644 --- a/src/xterm.js +++ b/src/xterm.js @@ -630,6 +630,11 @@ Terminal.prototype.open = function(parent) { Terminal.brokenBold = isBoldBroken(this.document); } + /** + * This event is emitted when terminal has completed opening. + * + * @event open + */ this.emit('open'); }; From 6dcf7267a5b87e8bfe44e319a2420d097c8557d5 Mon Sep 17 00:00:00 2001 From: YuviPanda Date: Fri, 11 Nov 2016 16:28:25 -0800 Subject: [PATCH 3/3] Add doc comment for scroll event --- src/xterm.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/xterm.js b/src/xterm.js index 231622c4..55c2a2c7 100644 --- a/src/xterm.js +++ b/src/xterm.js @@ -1290,6 +1290,12 @@ Terminal.prototype.scroll = function() { this.updateRange(this.scrollTop); this.updateRange(this.scrollBottom); + /** + * This event is emitted whenever the terminal is scrolled. + * The one parameter passed is the new y display position. + * + * @event scroll + */ this.emit('scroll', this.ydisp); };