Refactor code to remove unused JSDoc types

Author: bregwin

src/client/common/extensions.ts

@@ -28,7 +28,6 @@ declare interface String {
 /**
  * Appropriately formats a string so it can be used as an argument for a command in a shell.
  * E.g. if an argument contains a space, then it will be enclosed within double quotes.
- * @param {String} value.
  */
 String.prototype.toCommandArgumentForPythonExt = function (this: string): string {
     if (!this) {

src/client/repl/nativeRepl.ts

@@ -109,7 +109,6 @@ export class NativeRepl implements Disposable {
 
     /**
      * Function that check if NotebookController for REPL exists, and returns it in Singleton manner.
-     * @returns NotebookController
      */
     public setReplController(): NotebookController {
         if (!this.replController) {
@@ -125,8 +124,6 @@ export class NativeRepl implements Disposable {
 
     /**
      * Function that checks if native REPL's text input box contains complete code.
-     * @param activeEditor
-     * @param pythonServer
      * @returns Promise<boolean> - True if complete/Valid code is present, False otherwise.
      */
     public async checkUserInputCompleteCode(activeEditor: TextEditor | undefined): Promise<boolean> {
@@ -147,7 +144,6 @@ export class NativeRepl implements Disposable {
 
     /**
      * Function that opens interactive repl, selects kernel, and send/execute code to the native repl.
-     * @param code
      */
     public async sendToNativeRepl(code?: string): Promise<void> {
         const notebookEditor = await openInteractiveREPL(this.replController, this.notebookDocument);

src/client/repl/replCommandHandler.ts

@@ -16,9 +16,6 @@ import { PVSC_EXTENSION_ID } from '../common/constants';
 
 /**
  * Function that opens/show REPL using IW UI.
- * @param notebookController
- * @param notebookEditor
- * @returns notebookEditor
  */
 export async function openInteractiveREPL(
     notebookController: NotebookController,
@@ -46,10 +43,6 @@ export async function openInteractiveREPL(
 
 /**
  * Function that selects notebook Kernel.
- * @param notebookEditor
- * @param notebookControllerId
- * @param extensionId
- * @return Promise<void>
  */
 export async function selectNotebookKernel(
     notebookEditor: NotebookEditor,
@@ -65,9 +58,6 @@ export async function selectNotebookKernel(
 
 /**
  * Function that executes notebook cell given code.
- * @param notebookDocument
- * @param code
- * @return Promise<void>
  */
 export async function executeNotebookCell(notebookEditor: NotebookEditor, code: string): Promise<void> {
     const { notebook, replOptions } = notebookEditor;
@@ -83,8 +73,6 @@ export async function executeNotebookCell(notebookEditor: NotebookEditor, code:
 /**
  * Function that adds cell to notebook.
  * This function will only get called when notebook document is defined.
- * @param code
- *
  */
 async function addCellToNotebook(notebookDocument: NotebookDocument, index: number, code: string): Promise<void> {
     const notebookCellData = new NotebookCellData(NotebookCellKind.Code, code as string, 'python');

src/client/repl/replCommands.ts

@@ -20,11 +20,6 @@ import { EventName } from '../telemetry/constants';
 
 /**
  * Register Start Native REPL command in the command palette
- *
- * @param disposables
- * @param interpreterService
- * @param commandManager
- * @returns Promise<void>
  */
 export async function registerStartNativeReplCommand(
     disposables: Disposable[],
@@ -46,9 +41,6 @@ export async function registerStartNativeReplCommand(
 
 /**
  * Registers REPL command for shift+enter if sendToNativeREPL setting is enabled.
- * @param disposables
- * @param interpreterService
- * @returns Promise<void>
  */
 export async function registerReplCommands(
     disposables: Disposable[],
@@ -88,8 +80,6 @@ export async function registerReplCommands(
 
 /**
  * Command triggered for 'Enter': Conditionally call interactive.execute OR insert \n in text input box.
- * @param disposables
- * @param interpreterService
  */
 export async function registerReplExecuteOnEnter(
     disposables: Disposable[],

src/client/repl/replUtils.ts

@@ -9,7 +9,6 @@ import { getMultiLineSelectionText, getSingleLineSelectionText } from '../termin
 
 /**
  * Function that executes selected code in the terminal.
- * @returns Promise<void>
  */
 export async function executeInTerminal(): Promise<void> {
     await commands.executeCommand(Commands.Exec_Selection_In_Terminal);
@@ -45,12 +44,7 @@ export function getSendToNativeREPLSetting(): boolean {
     return configuration.get<boolean>('REPL.sendToNativeREPL', false);
 }
 
-/**
- * Function that inserts new line in the given (input) text editor
- * @param activeEditor
- * @returns void
- */
-
+// Function that inserts new line in the given (input) text editor
 export function insertNewLineToREPLInput(activeEditor: TextEditor | undefined): void {
     if (activeEditor) {
         const position = activeEditor.selection.active;
@@ -70,9 +64,6 @@ export function isMultiLineText(textEditor: TextEditor): boolean {
 /**
  * Function that trigger interpreter warning if invalid interpreter.
  * Function will also return undefined or active interpreter
- * @parm uri
- * @param interpreterService
- * @returns Promise<PythonEnvironment | undefined>
  */
 export async function getActiveInterpreter(
     uri: Uri,
@@ -88,7 +79,6 @@ export async function getActiveInterpreter(
 
 /**
  * Function that will return ViewColumn for existing Native REPL that belongs to given  NotebookDocument.
- * @returns ViewColumn | undefined
  */
 export function getExistingReplViewColumn(notebookDocument: NotebookDocument): ViewColumn | undefined {
     const ourNotebookUri = notebookDocument.uri.toString();

src/test/common/utils/decorators.unit.test.ts

@@ -89,9 +89,6 @@ suite('Common Utils - Decorators', function () {
          * await new Promise(resolve = setTimeout(resolve, 100))
          * console.log(currentTime - startTijme)
          * ```
-         *
-         * @param {number} actualDelay
-         * @param {number} expectedDelay
          */
         function assertElapsedTimeWithinRange(actualDelay: number, expectedDelay: number) {
             const difference = actualDelay - expectedDelay;

src/test/index.ts

@@ -44,8 +44,6 @@ process.on('unhandledRejection', (ex: any, _a) => {
 
 /**
  * Configure the test environment and return the optoins required to run moch tests.
- *
- * @returns {SetupOptions}
  */
 function configure(): SetupOptions {
     process.env.VSC_PYTHON_CI_TEST = '1';
@@ -103,7 +101,6 @@ function configure(): SetupOptions {
  * to complete.
  * That's when we know out PVSC extension specific code is ready for testing.
  * So, this code needs to run always for every test running in VS Code (what we call these `system test`) .
- * @returns
  */
 function activatePythonExtensionScript() {
     const ex = new Error('Failed to initialize Python extension for tests after 3 minutes');

src/test/mocks/vsc/arrays.ts

@@ -186,9 +186,6 @@ export function sortedDiff<T>(before: T[], after: T[], compare: (a: T, b: T) =>
 /**
  * Takes two *sorted* arrays and computes their delta (removed, added elements).
  * Finishes in `Math.min(before.length, after.length)` steps.
- * @param before
- * @param after
- * @param compare
  */
 export function delta<T>(before: T[], after: T[], compare: (a: T, b: T) => number): { removed: T[]; added: T[] } {
     const splices = sortedDiff(before, after, compare);