Fix invalid jsdoc tags

This commit is contained in:
Daniel Imms
2022-10-15 08:41:49 -07:00
parent 49e0480f78
commit 9f1a71485c
6 changed files with 17 additions and 17 deletions
+1 -1
View File
@@ -89,7 +89,7 @@ export class CompositionHelper {
/**
* Handles the keydown event, routing any necessary events to the CompositionHelper functions.
* @param ev The keydown event.
* @return Whether the Terminal should continue processing the keydown event.
* @returns Whether the Terminal should continue processing the keydown event.
*/
public keydown(ev: KeyboardEvent): boolean {
if (this._isComposing || this._isSendingComposition) {
+1 -1
View File
@@ -118,7 +118,7 @@ export class SelectionModel {
/**
* Handle the buffer being trimmed, adjust the selection position.
* @param amount The amount the buffer is being trimmed.
* @return Whether a refresh is necessary.
* @returns Whether a refresh is necessary.
*/
public handleTrim(amount: number): boolean {
// Adjust the selection position based on the trimmed amount.
+2 -2
View File
@@ -82,7 +82,7 @@ export class CircularList<T> extends Disposable implements ICircularList<T> {
* Note that for performance reasons there is no bounds checking here, the index reference is
* circular so this should always return a value and never throw.
* @param index The index of the value to get.
* @return The value corresponding to the index.
* @returns The value corresponding to the index.
*/
public get(index: number): T | undefined {
return this._array[this._getCyclicIndex(index)];
@@ -138,7 +138,7 @@ export class CircularList<T> extends Disposable implements ICircularList<T> {
/**
* Removes and returns the last value on the list.
* @return The popped value.
* @returns The popped value.
*/
public pop(): T | undefined {
return this._array[this._getCyclicIndex(this._length-- - 1)];