jsdoc

src/vs/workbench/parts/terminal/electron-browser/terminal.ts

@@ -122,12 +122,47 @@ export interface ITerminalInstance {
 	onTitleChanged: Event<string>;
 	title: string;
 
+	/**
+	 * Dispose the terminal instance, removing it from the panel/service and freeing up resources.
+	 */
 	dispose(): void;
+
+	/**
+	 * Copies the terminal selection to the clipboard.
+	 */
 	copySelection(): void;
+
+	/**
+	 * Focuses the terminal instance.
+	 *
+	 * @param focus Force focus even if there is a selection.
+	 */
 	focus(force?: boolean): void;
+
+	/**
+	 * Focuses and pastes the contents of the clipboard into the terminal instance.
+	 */
 	paste(): void;
+
+	/**
+	 * Send text to the terminal instance. The text is written to the stdin of the underlying pty
+	 * process (shell) of the terminal instance.
+	 *
+	 * @param text The text to send.
+	 * @param addNewLine Whether to add a new line to the text being sent, this is normally
+	 * required to run a command in the terminal. The character(s) added are \n or \r\n
+	 * depending on the platform. This defaults to `true`.
+	 */
 	sendText(text: string, addNewLine: boolean): void;
+
+	/**
+	 * Scroll the terminal buffer down 1 line.
+	 */
 	scrollDown(): void;
+
+	/**
+	 * Scroll the terminal buffer up 1 line.
+	 */
 	scrollUp(): void;
 
 	attachToElement(container: HTMLElement): void;

src/vs/workbench/parts/terminal/electron-browser/terminalInstance.ts

@@ -171,7 +171,6 @@ export class TerminalInstance implements ITerminalInstance {
 		this.onExitCallback(this);
 	}
 
-	// TODO: Document, the purpose of force is not clear
 	public focus(force?: boolean): void {
 		if (!this.xterm) {
 			return;
@@ -227,7 +226,6 @@ export class TerminalInstance implements ITerminalInstance {
 			this.process.on('message', (message) => {
 				if (message.type === 'title') {
 					this._title = message.content ? message.content : '';
-					// TODO: Send title change notification to service/panel
 					this._onTitleChanged.fire();
 				}
 			});