Update incorrect JSDoc annotations (microsoft#12101)

* Update incorrect JSDoc annotations * Create 12101.md * Update src/client/common/utils/cacheUtils.ts Co-authored-by: Kim-Adeline Miguel <51720070+kimadeline@users.noreply.github.com> * Update src/client/datascience/jupyter/kernels/kernelSelector.ts Co-authored-by: Kim-Adeline Miguel <51720070+kimadeline@users.noreply.github.com> * Update src/client/datascience/jupyter/kernels/kernelSelections.ts Co-authored-by: Kim-Adeline Miguel <51720070+kimadeline@users.noreply.github.com> * Update src/test/mocks/vsc/uri.ts Co-authored-by: Kim-Adeline Miguel <51720070+kimadeline@users.noreply.github.com> * Update news/3 Code Health/12101.md Co-authored-by: Kim-Adeline Miguel <51720070+kimadeline@users.noreply.github.com> Co-authored-by: Kartik Raj <karraj@microsoft.com>

Author: 3 people

news/3 Code Health/12101.md

@@ -0,0 +1 @@
+Update JSDoc annotations for many of the APIs (thanks [tonybaloney](https://github.com/tonybaloney))

src/client/common/process/pythonDaemonPool.ts

@@ -106,6 +106,7 @@ export class PythonDaemonExecutionServicePool extends PythonDaemonFactory implem
  * @private
  * @template T
  * @param {(daemon: IPythonExecutionService) => Promise<T>} cb
+ * @param daemonLogMessage
  * @returns {Promise<T>}
  * @memberof PythonDaemonExecutionServicePool
  */
@@ -130,6 +131,7 @@ export class PythonDaemonExecutionServicePool extends PythonDaemonFactory implem
  *
  * @private
  * @param {(daemon: IPythonExecutionService) => ObservableExecutionResult<string>} cb
+ * @param daemonLogMessage
  * @returns {ObservableExecutionResult<string>}
  * @memberof PythonDaemonExecutionServicePool
  */

src/client/common/terminal/environmentActivationProviders/condaActivationProvider.ts

@@ -129,7 +129,7 @@ export class CondaActivationCommandProvider implements ITerminalActivationComman
  * This configuration is documented on Conda.
  * Extension will not attempt to work around issues by trying to setup shell for user.
  *
- * @param {string} envName
+ * @param {string} condaEnv
  * @returns {(Promise<string[] | undefined>)}
  * @memberof CondaActivationCommandProvider
  */

src/client/common/types.ts

@@ -571,6 +571,7 @@ export interface ICryptoUtils {
  * @returns hash as number, or string
  * @param data The string to hash
  * @param hashFormat Return format of the hash, number or string
+ * @param [algorithm]
  */
  createHash<E extends keyof IHashFormat>(
  data: string,

src/client/common/utils/cacheUtils.ts

@@ -23,9 +23,9 @@ const resourceSpecificCacheStores = new Map<string, Map<string, CacheData>>();
  * Get a cache key specific to a resource (i.e. workspace)
  * This key will be used to cache interpreter related data, hence the Python Path
  * used in a workspace will affect the cache key.
- * @param {String} keyPrefix
  * @param {Resource} resource
  * @param {VSCodeType} [vscode=require('vscode')]
+ * @param serviceContainer
  * @returns
  */
 function getCacheKey(
@@ -70,9 +70,9 @@ function getCacheKey(
 }
 /**
  * Gets the cache store for a resource that's specific to the interpreter.
- * @param {string} keyPrefix
  * @param {Resource} resource
  * @param {VSCodeType} [vscode=require('vscode')]
+ * @param serviceContainer
  * @returns
  */
 function getCacheStore(

src/client/datascience/jupyter/interpreter/jupyterInterpreterDependencyService.ts

@@ -57,6 +57,7 @@ function sortProductsInOrderForInstallation(products: Product[]) {
  *
  * @export
  * @param {Product[]} products
+ * @param {string} [interpreterName]
  * @returns {string}
  */
 export function getMessageForLibrariesNotInstalled(products: Product[], interpreterName?: string): string {
@@ -291,7 +292,7 @@ export class JupyterInterpreterDependencyService {
  *
  * @private
  * @param {PythonInterpreter} interpreter
- * @param {CancellationToken} [token]
+ * @param {CancellationToken} [_token]
  * @returns {Promise<boolean>}
  * @memberof JupyterInterpreterConfigurationService
  */

src/client/datascience/jupyter/jupyterDebugger.ts

@@ -243,7 +243,7 @@ export class JupyterDebugger implements IJupyterDebugger, ICellHashListener {
  * (temporary to hard-code and use these in here).
  * The old debugger will soon go away into oblivion...
  * @private
- * @param {INotebook} notebook
+ * @param {INotebook} _notebook
  * @returns {Promise<string>}
  * @memberof JupyterDebugger
  */

src/client/datascience/jupyter/kernels/kernelSelections.ts

@@ -23,6 +23,7 @@ import { IKernelSelectionListProvider, IKernelSpecQuickPickItem, LiveKernelModel
  * Given a kernel spec, this will return a quick pick item with appropriate display names and the like.
  *
  * @param {IJupyterKernelSpec} kernelSpec
+ * @param {IPathUtils} pathUtils
  * @returns {IKernelSpecQuickPickItem}
  */
 function getQuickPickItemForKernelSpec(
@@ -41,6 +42,7 @@ function getQuickPickItemForKernelSpec(
  * Given an active kernel, this will return a quick pick item with appropriate display names and the like.
  *
  * @param {(LiveKernelModel)} kernel
+ * @param {IPathUtils} pathUtils
  * @returns {IKernelSpecQuickPickItem}
  */
 function getQuickPickItemForActiveKernel(kernel: LiveKernelModel, pathUtils: IPathUtils): IKernelSpecQuickPickItem {
@@ -185,6 +187,7 @@ export class KernelSelectionProvider {
  /**
  * Gets a selection of kernel specs from a remote session.
  *
+ * @param {Resource} resource
  * @param {IJupyterSessionManager} sessionManager
  * @param {CancellationToken} [cancelToken]
  * @returns {Promise<IKernelSpecQuickPickItem[]>}
@@ -222,6 +225,8 @@ export class KernelSelectionProvider {
  /**
  * Gets a selection of kernel specs for a local session.
  *
+ * @param {Resource} resource
+ * @param type
  * @param {IJupyterSessionManager} [sessionManager]
  * @param {CancellationToken} [cancelToken]
  * @returns {Promise<IKernelSelectionListProvider>}

src/client/datascience/jupyter/kernels/kernelSelector.ts

@@ -88,8 +88,11 @@ export class KernelSelector {
  /**
  * Selects a kernel from a remote session.
  *
+ * @param {Resource} resource
+ * @param {StopWatch} stopWatch
  * @param {IJupyterSessionManager} session
  * @param {CancellationToken} [cancelToken]
+ * @param {IJupyterKernelSpec | LiveKernelModel} [currentKernel]
  * @returns {Promise<KernelSpecInterpreter>}
  * @memberof KernelSelector
  */
@@ -120,8 +123,12 @@ export class KernelSelector {
  /**
  * Select a kernel from a local session.
  *
+ * @param {Resource} resource
+ * @param type
+ * @param {StopWatch} stopWatch
  * @param {IJupyterSessionManager} [session]
  * @param {CancellationToken} [cancelToken]
+ * @param {IJupyterKernelSpec | LiveKernelModel} [currentKernel]
  * @returns {Promise<KernelSpecInterpreter>}
  * @memberof KernelSelector
  */
@@ -155,8 +162,11 @@ export class KernelSelector {
  * Gets a kernel that needs to be used with a local session.
  * (will attempt to find the best matching kernel, or prompt user to use current interpreter or select one).
  *
+ * @param {Resource} resource
+ * @param type
  * @param {IJupyterSessionManager} [sessionManager]
  * @param {nbformat.INotebookMetadata} [notebookMetadata]
+ * @param {boolean} [disableUI]
  * @param {CancellationToken} [cancelToken]
  * @returns {Promise<KernelSpecInterpreter>}
  * @memberof KernelSelector
@@ -213,6 +223,7 @@ export class KernelSelector {
  * Gets a kernel that needs to be used with a remote session.
  * (will attempt to find the best matching kernel, or prompt user to use current interpreter or select one).
  *
+ * @param {Resource} resource
  * @param {IJupyterSessionManager} [sessionManager]
  * @param {nbformat.INotebookMetadata} [notebookMetadata]
  * @param {CancellationToken} [cancelToken]
@@ -439,9 +450,12 @@ export class KernelSelector {
  * Otherwise, if not provided user is changing the kernel after starting a notebook.
  *
  * @private
+ * @param {Resource} resource
  * @param {PythonInterpreter} interpreter
+ * @param type
  * @param {string} [displayNameOfKernelNotFound]
  * @param {IJupyterSessionManager} [session]
+ * @param {boolean} [disableUI]
  * @param {CancellationToken} [cancelToken]
  * @returns {Promise<KernelSpecInterpreter>}
  * @memberof KernelSelector

src/client/datascience/jupyter/kernels/kernelService.ts

@@ -276,6 +276,7 @@ export class KernelService {
  * - env = Will have environment variables of the activated environment.
  *
  * @param {PythonInterpreter} interpreter
+ * @param {boolean} [disableUI]
  * @param {CancellationToken} [cancelToken]
  * @returns {Promise<IJupyterKernelSpec>}
  * @memberof KernelService