Refactor code to remove unused JSDoc types (#24300)

Fixes #24077

Removes redundant type annotations from JSDocs in TypeScript files where
the type is already inferred by TypeScript.

For example:

![image](https://github.com/user-attachments/assets/9ee1f0b6-f36f-4f4f-81dc-5178d46808cb)

Here I removed JSDoc types but I still kept all the useful information. 
I tried to be on the liberal side to avoid removing any comments that
provide useful context or clarify behavior. If I missed any or if more
can be removed, I’m happy to go over it again.

Additionally, if this issue only applies to a specific folder or scope,
please let me know so I can make the necessary adjustments.

Author: bregwin

pythonExtensionApi/src/main.ts

@@ -25,7 +25,6 @@ export interface PythonExtension {
 
         /**
          * Gets the path to the debugger package used by the extension.
-         * @returns {Promise<string>}
          */
         getDebuggerPackagePath(): Promise<string | undefined>;
     };

src/client/activation/types.ts

@@ -12,27 +12,14 @@ import { PythonEnvironment } from '../pythonEnvironments/info';
 export const IExtensionActivationManager = Symbol('IExtensionActivationManager');
 /**
  * Responsible for activation of extension.
- *
- * @export
- * @interface IExtensionActivationManager
- * @extends {IDisposable}
  */
 export interface IExtensionActivationManager extends IDisposable {
-    /**
-     * Method invoked when extension activates (invoked once).
-     *
-     * @returns {Promise<void>}
-     * @memberof IExtensionActivationManager
-     */
+    // Method invoked when extension activates (invoked once).
     activate(startupStopWatch: StopWatch): Promise<void>;
     /**
      * Method invoked when a workspace is loaded.
      * This is where we place initialization scripts for each workspace.
      * (e.g. if we need to run code for each workspace, then this is where that happens).
-     *
-     * @param {Resource} resource
-     * @returns {Promise<void>}
-     * @memberof IExtensionActivationManager
      */
     activateWorkspace(resource: Resource): Promise<void>;
 }
@@ -43,8 +30,6 @@ export const IExtensionActivationService = Symbol('IExtensionActivationService')
  * invoked for every workspace folder (in multi-root workspace folders) during the activation of the extension.
  * This is a great hook for extension activation code, i.e. you don't need to modify
  * the `extension.ts` file to invoke some code when extension gets activated.
- * @export
- * @interface IExtensionActivationService
  */
 export interface IExtensionActivationService {
     supportedWorkspaceTypes: { untrustedWorkspace: boolean; virtualWorkspace: boolean };
@@ -100,8 +85,6 @@ export interface ILanguageServerProxy extends IDisposable {
      * Sends a request to LS so as to load other extensions.
      * This is used as a plugin loader mechanism.
      * Anyone (such as intellicode) wanting to interact with LS, needs to send this request to LS.
-     * @param {{}} [args]
-     * @memberof ILanguageServerProxy
      */
     loadExtension(args?: unknown): void;
 }
@@ -110,9 +93,6 @@ export const ILanguageServerOutputChannel = Symbol('ILanguageServerOutputChannel
 export interface ILanguageServerOutputChannel {
     /**
      * Creates output channel if necessary and returns it
-     *
-     * @type {ILogOutputChannel}
-     * @memberof ILanguageServerOutputChannel
      */
     readonly channel: ILogOutputChannel;
 }
@@ -123,8 +103,6 @@ export const IExtensionSingleActivationService = Symbol('IExtensionSingleActivat
  * invoked during the activation of the extension.
  * This is a great hook for extension activation code, i.e. you don't need to modify
  * the `extension.ts` file to invoke some code when extension gets activated.
- * @export
- * @interface IExtensionSingleActivationService
  */
 export interface IExtensionSingleActivationService {
     supportedWorkspaceTypes: { untrustedWorkspace: boolean; virtualWorkspace: boolean };

src/client/api.ts

@@ -80,7 +80,6 @@ export function buildApi(
              * @param {Resource} [resource] A resource for which the setting is asked for.
              * * When no resource is provided, the setting scoped to the first workspace folder is returned.
              * * If no folder is present, it returns the global setting.
-             * @returns {({ execCommand: string[] | undefined })}
              */
             getExecutionDetails(
                 resource?: Resource,

src/client/api/types.ts

@@ -25,7 +25,6 @@ export interface PythonExtension {
 
         /**
          * Gets the path to the debugger package used by the extension.
-         * @returns {Promise<string>}
          */
         getDebuggerPackagePath(): Promise<string | undefined>;
     };

src/client/application/diagnostics/base.ts

@@ -73,11 +73,6 @@ export abstract class BaseDiagnosticsService implements IDiagnosticsService, IDi
     /**
      * Returns a key used to keep track of whether a diagnostic was handled or not.
      * So as to prevent handling/displaying messages multiple times for the same diagnostic.
-     *
-     * @protected
-     * @param {IDiagnostic} diagnostic
-     * @returns {string}
-     * @memberof BaseDiagnosticsService
      */
     protected getDiagnosticsKey(diagnostic: IDiagnostic): string {
         if (diagnostic.scope === DiagnosticScope.Global) {

src/client/application/types.ts

@@ -11,8 +11,6 @@ export interface IApplicationDiagnostics {
     /**
      * Perform pre-extension activation health checks.
      * E.g. validate user environment, etc.
-     * @returns {Promise<void>}
-     * @memberof IApplicationDiagnostics
      */
     performPreStartupHealthCheck(resource: Resource): Promise<void>;
     register(): void;

src/client/common/application/commands.ts

@@ -14,7 +14,6 @@ export type CommandsWithoutArgs = keyof ICommandNameWithoutArgumentTypeMapping;
 /**
  * Mapping between commands and list or arguments.
  * These commands do NOT have any arguments.
- * @interface ICommandNameWithoutArgumentTypeMapping
  */
 interface ICommandNameWithoutArgumentTypeMapping {
     [Commands.InstallPythonOnMac]: [];
@@ -52,9 +51,6 @@ export type AllCommands = keyof ICommandNameArgumentTypeMapping;
 /**
  * Mapping between commands and list of arguments.
  * Used to provide strong typing for command & args.
- * @export
- * @interface ICommandNameArgumentTypeMapping
- * @extends {ICommandNameWithoutArgumentTypeMapping}
  */
 export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgumentTypeMapping {
     [Commands.Create_Environment]: [CreateEnvironmentOptions];

src/client/common/application/types.ts

@@ -818,9 +818,6 @@ export interface IWorkspaceService {
 
     /**
      * Generate a key that's unique to the workspace folder (could be fsPath).
-     * @param {(Uri | undefined)} resource
-     * @returns {string}
-     * @memberof IWorkspaceService
      */
     getWorkspaceFolderIdentifier(resource: Uri | undefined, defaultValue?: string): string;
     /**

src/client/common/cancellation.ts

@@ -16,11 +16,6 @@ export class CancellationError extends Error {
 }
 /**
  * Create a promise that will either resolve with a default value or reject when the token is cancelled.
- *
- * @export
- * @template T
- * @param {({ defaultValue: T; token: CancellationToken; cancelAction: 'reject' | 'resolve' })} options
- * @returns {Promise<T>}
  */
 export function createPromiseFromCancellation<T>(options: {
     defaultValue: T;
@@ -50,10 +45,6 @@ export function createPromiseFromCancellation<T>(options: {
 
 /**
  * Create a single unified cancellation token that wraps multiple cancellation tokens.
- *
- * @export
- * @param {(...(CancellationToken | undefined)[])} tokens
- * @returns {CancellationToken}
  */
 export function wrapCancellationTokens(...tokens: (CancellationToken | undefined)[]): CancellationToken {
     const wrappedCancellantionToken = new CancellationTokenSource();
@@ -117,15 +108,13 @@ export namespace Cancellation {
 
     /**
      * isCanceled returns a boolean indicating if the cancel token has been canceled.
-     * @param cancelToken
      */
     export function isCanceled(cancelToken?: CancellationToken): boolean {
         return cancelToken ? cancelToken.isCancellationRequested : false;
     }
 
     /**
      * throws a CancellationError if the token is canceled.
-     * @param cancelToken
      */
     export function throwIfCanceled(cancelToken?: CancellationToken): void {
         if (isCanceled(cancelToken)) {

src/client/common/constants.ts

@@ -111,8 +111,6 @@ export function isTestExecution(): boolean {
 /**
  * Whether we're running unit tests (*.unit.test.ts).
  * These tests have a special meaning, they run fast.
- * @export
- * @returns {boolean}
  */
 export function isUnitTestExecution(): boolean {
     return process.env.VSC_PYTHON_UNIT_TEST === '1';