Improve documentation of `Buffer` and `BufferSet` classes

[mirror_xterm.js.git] / src / Buffer.ts

diff --git a/src/Buffer.ts b/src/Buffer.ts
index 51ee0f18cd0c41648275064db93d0bae61b98045..256f6c903f9b2dadc06b264c0f6a9bc4a32d7d6f 100644 (file)
--- a/src/Buffer.ts
+++ b/src/Buffer.ts
@@ -6,16 +6,20 @@ import { ITerminal } from './Interfaces';
 import { CircularList } from './utils/CircularList';
 
 /**
- * This class represents a terminal buffer (an internal state of the terminal)/
+ * This class represents a terminal buffer (an internal state of the terminal), where the
+ * following information is stored (in high-level):
+ *   - text content of this particular buffer
+ *   - cursor position
+ *   - scroll position
  */
 export class Buffer {
   public lines: CircularList<[string, number, string]>;
 
   /**
    * Create a new Buffer.
-   * @param {Terminal} terminal - The terminal the buffer will belong to
-   * @param {number} ydisp - The scroll position of the buffer in the viewport
-   * @param {number} ybase - The scroll position of the y cursor (ybase + y = the y position within the buffer)
+   * @param {Terminal} terminal - The terminal the Buffer will belong to
+   * @param {number} ydisp - The scroll position of the Buffer in the viewport
+   * @param {number} ybase - The scroll position of the y cursor (ybase + y = the y position within the Buffer)
    * @param {number} y - The cursor's y position after ybase
    * @param {number} x - The cursor's x position after ybase
    */