From 89daacac32506e91265b48ac1685798da8a95fed Mon Sep 17 00:00:00 2001
From: Daniel Imms <tyriar@tyriar.com>
Date: Fri, 10 Apr 2020 10:02:09 -0700
Subject: [PATCH] Add missing api docs

---
 typings/xterm.d.ts | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
index 24c7ffaa6..9445d0754 100644
--- a/typings/xterm.d.ts
+++ b/typings/xterm.d.ts
@@ -1222,11 +1222,30 @@ declare module 'xterm' {
     getNullCell(): IBufferCell;
   }
 
+  /**
+   * Represents the terminal's set of buffers.
+   */
   interface IBufferNamespace {
-    readonly alternate: IBuffer;
-    readonly normal: IBuffer;
+    /**
+     * The active buffer, this will either be the normal or alternate buffers.
+     */
     readonly active: IBuffer;
 
+    /**
+     * The normal buffer.
+     */
+    readonly normal: IBuffer;
+
+    /**
+     * The alternate buffer, this becomes the active buffer when an application
+     * enters this mode via DECSET (`CSI ? 4 7 h`)
+     */
+    readonly alternate: IBuffer;
+
+    /**
+     * Adds an event listener for when the active buffer changes.
+     * @returns an `IDisposable` to stop listening.
+     */
     onBufferChange: IEvent<IBuffer>;
   }