Add some jsdoc

2017-09-01 16:58:02 -07:00
parent de4fcb9241
commit 2c9dbc6191
2 changed files with 20 additions and 1 deletions
@@ -1,10 +1,30 @@
 import { ITerminal, ITerminalOptions } from '../Interfaces';

 export interface IRenderLayer {
+  /**
+   * Called when the cursor is moved.
+   */
  onCursorMove(terminal: ITerminal): void;
+
+  /**
+   * Called when options change.
+   */
  onOptionsChanged(terminal: ITerminal): void;
+
+  /**
+   * Called when the theme changes.
+   */
  onThemeChanged(terminal: ITerminal, colorSet: IColorSet): void;
+
+  /**
+   * Called when the data in the grid has changed (or needs to be rendered
+   * again).
+   */
  onGridChanged(terminal: ITerminal, startRow: number, endRow: number): void;
+
+  /**
+   * Calls when the selection changes.
+   */
  onSelectionChanged(terminal: ITerminal, start: [number, number], end: [number, number]): void;

  /**