diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts index f76d28c2..3f71af29 100644 --- a/addons/xterm-addon-search/src/SearchAddon.ts +++ b/addons/xterm-addon-search/src/SearchAddon.ts @@ -126,7 +126,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon { * doesn't exist, do nothing. * @param term The search term. * @param searchOptions Search options. - * @return Whether a result was found. + * @returns Whether a result was found. */ public findNext(term: string, searchOptions?: ISearchOptions): boolean { if (!this._terminal) { @@ -307,7 +307,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon { * doesn't exist, do nothing. * @param term The search term. * @param searchOptions Search options. - * @return Whether a result was found. + * @returns Whether a result was found. */ public findPrevious(term: string, searchOptions?: ISearchOptions): boolean { if (!this._terminal) { @@ -480,7 +480,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon { * @param searchPosition The position to start the search. * @param searchOptions Search options. * @param isReverseSearch Whether the search should start from the right side of the terminal and search to the left. - * @return The search result if it was found. + * @returns The search result if it was found. */ protected _findInLine(term: string, searchPosition: ISearchPosition, searchOptions: ISearchOptions = {}, isReverseSearch: boolean = false): ISearchResult | undefined { const terminal = this._terminal!; @@ -662,7 +662,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon { /** * Selects and scrolls to a result. * @param result The result to select. - * @return Whether a result was selected. + * @returns Whether a result was selected. */ private _selectResult(result: ISearchResult | undefined, options?: ISearchDecorationOptions, noScroll?: boolean): boolean { const terminal = this._terminal!; diff --git a/src/browser/input/CompositionHelper.ts b/src/browser/input/CompositionHelper.ts index 39ccaa23..ba7d4b6a 100644 --- a/src/browser/input/CompositionHelper.ts +++ b/src/browser/input/CompositionHelper.ts @@ -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) { diff --git a/src/browser/selection/SelectionModel.ts b/src/browser/selection/SelectionModel.ts index 041c7b24..b26cf944 100644 --- a/src/browser/selection/SelectionModel.ts +++ b/src/browser/selection/SelectionModel.ts @@ -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. diff --git a/src/common/CircularList.ts b/src/common/CircularList.ts index b7e1e075..8ab80d56 100644 --- a/src/common/CircularList.ts +++ b/src/common/CircularList.ts @@ -82,7 +82,7 @@ export class CircularList extends Disposable implements ICircularList { * 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 extends Disposable implements ICircularList { /** * 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)]; diff --git a/typings/xterm-headless.d.ts b/typings/xterm-headless.d.ts index 7453b7e2..af55ffac 100644 --- a/typings/xterm-headless.d.ts +++ b/typings/xterm-headless.d.ts @@ -1080,7 +1080,7 @@ declare module 'xterm-headless' { * Return true if the sequence was handled; false if we should try * a previous handler (set by addCsiHandler or setCsiHandler). * The most recently added handler is tried first. - * @return An IDisposable you can call to remove this handler. + * @returns An IDisposable you can call to remove this handler. */ registerCsiHandler(id: IFunctionIdentifier, callback: (params: (number | number[])[]) => boolean): IDisposable; @@ -1099,7 +1099,7 @@ declare module 'xterm-headless' { * Return true if the sequence was handled; false if we should try * a previous handler (set by addDcsHandler or setDcsHandler). * The most recently added handler is tried first. - * @return An IDisposable you can call to remove this handler. + * @returns An IDisposable you can call to remove this handler. */ registerDcsHandler(id: IFunctionIdentifier, callback: (data: string, param: (number | number[])[]) => boolean): IDisposable; @@ -1112,7 +1112,7 @@ declare module 'xterm-headless' { * Return true if the sequence was handled; false if we should try * a previous handler (set by addEscHandler or setEscHandler). * The most recently added handler is tried first. - * @return An IDisposable you can call to remove this handler. + * @returns An IDisposable you can call to remove this handler. */ registerEscHandler(id: IFunctionIdentifier, handler: () => boolean): IDisposable; @@ -1130,7 +1130,7 @@ declare module 'xterm-headless' { * Return true if the sequence was handled; false if we should try * a previous handler (set by addOscHandler or setOscHandler). * The most recently added handler is tried first. - * @return An IDisposable you can call to remove this handler. + * @returns An IDisposable you can call to remove this handler. */ registerOscHandler(ident: number, callback: (data: string) => boolean): IDisposable; } diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts index 0e2b0357..aec0fdbc 100644 --- a/typings/xterm.d.ts +++ b/typings/xterm.d.ts @@ -905,7 +905,7 @@ declare module 'xterm' { * with a string of text that is eligible for joining and returns an array * where each entry is an array containing the start (inclusive) and end * (exclusive) indexes of ranges that should be rendered as a single unit. - * @return The ID of the new joiner, this can be used to deregister + * @returns The ID of the new joiner, this can be used to deregister */ registerCharacterJoiner(handler: (text: string) => [number, number][]): number; @@ -1558,7 +1558,7 @@ declare module 'xterm' { * array will contain subarrays with their numercial values. * Return `true` if the sequence was handled, `false` if the parser should try * a previous handler. The most recently added handler is tried first. - * @return An IDisposable you can call to remove this handler. + * @returns An IDisposable you can call to remove this handler. */ registerCsiHandler(id: IFunctionIdentifier, callback: (params: (number | number[])[]) => boolean | Promise): IDisposable; @@ -1576,7 +1576,7 @@ declare module 'xterm' { * The function gets the payload and numerical parameters as arguments. * Return `true` if the sequence was handled, `false` if the parser should try * a previous handler. The most recently added handler is tried first. - * @return An IDisposable you can call to remove this handler. + * @returns An IDisposable you can call to remove this handler. */ registerDcsHandler(id: IFunctionIdentifier, callback: (data: string, param: (number | number[])[]) => boolean | Promise): IDisposable; @@ -1588,7 +1588,7 @@ declare module 'xterm' { * @param callback The function to handle the sequence. * Return `true` if the sequence was handled, `false` if the parser should try * a previous handler. The most recently added handler is tried first. - * @return An IDisposable you can call to remove this handler. + * @returns An IDisposable you can call to remove this handler. */ registerEscHandler(id: IFunctionIdentifier, handler: () => boolean | Promise): IDisposable; @@ -1605,7 +1605,7 @@ declare module 'xterm' { * The callback is called with OSC data string. * Return `true` if the sequence was handled, `false` if the parser should try * a previous handler. The most recently added handler is tried first. - * @return An IDisposable you can call to remove this handler. + * @returns An IDisposable you can call to remove this handler. */ registerOscHandler(ident: number, callback: (data: string) => boolean | Promise): IDisposable; }