]> git.proxmox.com Git - mirror_xterm.js.git/commitdiff
Move CompositionHelper header comment to class
authorDaniel Imms <daimms@microsoft.com>
Tue, 22 Nov 2016 19:54:42 +0000 (11:54 -0800)
committerDaniel Imms <daimms@microsoft.com>
Tue, 22 Nov 2016 19:54:42 +0000 (11:54 -0800)
src/CompositionHelper.ts

index 8a29ed72277b23a2f3dfef2ae61d9744e4db7d0e..a7f97ad19aa6f83c11d466c02a87789adbae5ece 100644 (file)
@@ -10,6 +10,11 @@ interface IPosition {
   end: number;
 }
 
+/**
+ * Encapsulates the logic for handling compositionstart, compositionupdate and compositionend
+ * events, displaying the in-progress composition to the UI and forwarding the final composition
+ * to the handler.
+ */
 export class CompositionHelper {
   /**
    * Whether input composition is currently happening, eg. via a mobile keyboard, speech input or
@@ -29,9 +34,7 @@ export class CompositionHelper {
   private isSendingComposition: boolean;
 
   /**
-   * Encapsulates the logic for handling compositionstart, compositionupdate and compositionend
-   * events, displaying the in-progress composition to the UI and forwarding the final composition
-   * to the handler.
+   * Creates a new CompositionHelper.
    * @param textarea The textarea that xterm uses for input.
    * @param compositionView The element to display the in-progress composition in.
    * @param terminal The Terminal to forward the finished composition to.