Polish

xtermjs · Oct 31, 2022 · 4d05905 · 4d05905
1 parent dda3f5f
commit 4d05905
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/addons/xterm-addon-canvas/typings/xterm-addon-canvas.d.ts b/addons/xterm-addon-canvas/typings/xterm-addon-canvas.d.ts
@@ -17,7 +17,9 @@ declare module 'xterm-addon-canvas' {
      */
     public readonly onChangeTextureAtlas: IEvent<HTMLCanvasElement>;
 
-    // TODO: Doc
+    /**
+     * An event that is fired when the a new page is added to the texture atlas.
+     */
     public readonly onAddTextureAtlasCanvas: IEvent<HTMLCanvasElement>;
 
     constructor();

diff --git a/addons/xterm-addon-webgl/typings/xterm-addon-webgl.d.ts b/addons/xterm-addon-webgl/typings/xterm-addon-webgl.d.ts
@@ -22,7 +22,9 @@ declare module 'xterm-addon-webgl' {
      */
     public readonly onChangeTextureAtlas: IEvent<HTMLCanvasElement>;
 
-    // TODO: Doc
+    /**
+     * An event that is fired when the a new page is added to the texture atlas.
+     */
     public readonly onAddTextureAtlasCanvas: IEvent<HTMLCanvasElement>;
 
     constructor(preserveDrawingBuffer?: boolean);

diff --git a/src/browser/renderer/shared/TextureAtlas.ts b/src/browser/renderer/shared/TextureAtlas.ts
@@ -137,7 +137,7 @@ export class TextureAtlas implements ITextureAtlas {
     if (this._pages.length === 4 || this._pages.length === 7) {
       this._increaseTextureSize();
     }
-    // TODO: Clear all pages and restart if the maximum page count is reached
+    // TODO: Ensure pages aren't created beyond the maximum supported
     const newPage = new AtlasPage(this._document, this._textureSize);
     this._pages.push(newPage);
     this._activePages.push(newPage);