From 6dcf7267a5b87e8bfe44e319a2420d097c8557d5 Mon Sep 17 00:00:00 2001
From: YuviPanda <yuvipanda@gmail.com>
Date: Fri, 11 Nov 2016 16:28:25 -0800
Subject: [PATCH] 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);
 };