check-param-names (#18189)

src/sql/platform/connection/common/connectionStatusManager.ts

@@ -182,7 +182,6 @@ export class ConnectionStatusManager {
 	 * Only if the db name in the original uri is different when connection is complete, we need to use the original uri
 	 * Returns the generated ownerUri for the connection profile if not existing connection found
 	 * @param ownerUri connection owner uri to find an existing connection
-	 * @param purpose purpose for the connection
 	 */
 	public getOriginalOwnerUri(ownerUri: string): string {
 		let ownerUriToReturn: string = ownerUri;

src/sql/platform/connection/common/connectionStore.ts

@@ -106,7 +106,7 @@ export class ConnectionStore {
 	 * Password values are stored to a separate credential store if the "savePassword" option is true
 	 *
 	 * @param profile the profile to save
-	 * @param whether the plaintext password should be written to the settings file
+	 * @param forceWritePlaintextPassword whether the plaintext password should be written to the settings file
 	 * @returns a Promise that returns the original profile, for help in chaining calls
 	 */
 	public async saveProfile(profile: IConnectionProfile, forceWritePlaintextPassword?: boolean, matcher?: ProfileMatcher): Promise<IConnectionProfile> {
@@ -192,7 +192,6 @@ export class ConnectionStore {
 	 * Password values are stored to a separate credential store if the "savePassword" option is true
 	 *
 	 * @param conn the connection to add
-	 * @param addToMru Whether to add this connection to the MRU
 	 * @returns a Promise that returns when the connection was saved
 	 */
 	public addRecentConnection(conn: IConnectionProfile): Promise<void> {

src/sql/platform/telemetry/common/adsTelemetryService.ts

@@ -157,7 +157,8 @@ export class AdsTelemetryService implements IAdsTelemetryService {
 
 	/**
 	 * Sends a Metrics event. This is used to log measurements taken.
-	 * @param measurements The metrics to send
+	 * @param metrics The metrics to send
+	 * @param groupName The name of the group these metrics belong to
 	 */
 	public sendMetricsEvent(metrics: ITelemetryEventMeasures, groupName: string = ''): void {
 		this.createMetricsEvent(metrics, groupName).send();
@@ -169,7 +170,6 @@ export class AdsTelemetryService implements IAdsTelemetryService {
 	 * @param name The friendly name of the error
 	 * @param errorCode The error code returned
 	 * @param errorType The specific type of error
-	 * @param properties Optional additional properties
 	 */
 	public createErrorEvent(view: string, name: string, errorCode: string = '', errorType: string = ''): ITelemetryEvent {
 		return new TelemetryEventImpl(this.telemetryService, this.logService, EventName.Error, {

src/sql/workbench/browser/modal/modal.ts

@@ -172,6 +172,13 @@ export abstract class Modal extends Disposable implements IThemable {
 	 * Constructor for modal
 	 * @param _title Title of the modal, if undefined, the title section is not rendered
 	 * @param _name Name of the modal, used for telemetry
+	 * @param _telemetryService
+	 * @param layoutService
+	 * @param _clipboardService
+	 * @param _themeService
+	 * @param logService
+	 * @param textResourcePropertiesService
+	 * @param _contextKeyService
 	 * @param options Modal options
 	 */
 	constructor(
@@ -530,7 +537,6 @@ export abstract class Modal extends Disposable implements IThemable {
 	/**
 	 * Returns a footer button matching the provided label
 	 * @param label Label to show on the button
-	 * @param onSelect The callback to call when the button is selected
 	 */
 	protected findFooterButton(label: string): Button | undefined {
 		return this._footerButtons.find(e => {

src/sql/workbench/browser/taskUtilities.ts

@@ -14,6 +14,9 @@ import { DashboardInput } from 'sql/workbench/browser/editor/profiler/dashboardI
  * is focused or there is no such editor, in which case it comes from the OE selection. Returns
  * undefined when there is no such connection.
  *
+ * @param objectExplorerService
+ * @param connectionManagementService
+ * @param workbenchEditorService
  * @param topLevelOnly If true, only return top-level (i.e. connected) Object Explorer connections instead of database connections when appropriate
 */
 export function getCurrentGlobalConnection(objectExplorerService: IObjectExplorerService, connectionManagementService: IConnectionManagementService, workbenchEditorService: IEditorService, topLevelOnly: boolean = false): IConnectionProfile | undefined {

src/sql/workbench/contrib/dashboard/browser/core/dashboardHelper.ts

@@ -93,7 +93,6 @@ export function initExtensionConfigs(configurations: WidgetConfig[]): Array<Widg
 
 /**
  * Add provider to the passed widgets and returns the new widgets
- * @param widgets Array of widgets to add provider onto
  */
 export function addProvider<T extends { connectionManagementService: SingleConnectionManagementService }>(config: WidgetConfig[], collection: T): Array<WidgetConfig> {
 	const provider = collection.connectionManagementService.connectionInfo.providerId;
@@ -107,7 +106,6 @@ export function addProvider<T extends { connectionManagementService: SingleConne
 
 /**
  * Adds the edition to the passed widgets and returns the new widgets
- * @param widgets Array of widgets to add edition onto
  */
 export function addEdition<T extends { connectionManagementService: SingleConnectionManagementService }>(config: WidgetConfig[], collection: T): Array<WidgetConfig> {
 	const connectionInfo: ConnectionManagementInfo = collection.connectionManagementService.connectionInfo;
@@ -126,7 +124,6 @@ export function addEdition<T extends { connectionManagementService: SingleConnec
 
 /**
  * Adds the context to the passed widgets and returns the new widgets
- * @param widgets Array of widgets to add context to
  */
 export function addContext(config: WidgetConfig[], collection: any, context: string): Array<WidgetConfig> {
 	return config.map((item) => {

src/sql/workbench/contrib/notebook/browser/cellViews/markdownToolbar.component.ts

@@ -349,7 +349,6 @@ export class MarkdownToolbarComponent extends AngularDisposable {
 
 	/**
 	 * Instantiate modal for use as callout when inserting Link or Image into markdown.
-	 * @param calloutStyle Style of callout passed in to determine which callout is rendered.
 	 * Returns markup created after user enters values and submits the callout.
 	 */
 	private async createCallout(type: MarkdownButtonType, triggerElement: HTMLElement): Promise<ILinkCalloutDialogOptions> {

src/sql/workbench/contrib/notebook/browser/markdownToolbarActions.ts

@@ -173,6 +173,7 @@ export class MarkdownTextTransformer {
 	 * @param endRange range for end text that was inserted
 	 * @param type MarkdownButtonType
 	 * @param editorControl code editor widget
+	 * @param editorModel
 	 * @param noSelection controls whether there was no previous selection in the editor
 	 */
 	private setEndSelection(endRange: IRange, type: MarkdownButtonType, editorControl: CodeEditorWidget, editorModel: TextModel, noSelection: boolean, isUndo: boolean): void {

src/sql/workbench/contrib/query/browser/keyboardQueryActions.ts

@@ -362,6 +362,7 @@ export class RunQueryShortcutAction extends Action {
 	 * Runs one of the optionally registered query shortcuts. This will lookup the shortcut's stored procedure
 	 * reference from the settings, and if found will execute it plus any
 	 *
+	 * @param editor
 	 * @param shortcutIndex which shortcut should be run?
 	 */
 	public runQueryShortcut(editor: QueryEditor, shortcutIndex: number): Thenable<void> {

src/sql/workbench/services/connection/browser/connectionManagementService.ts

@@ -207,6 +207,7 @@ export class ConnectionManagementService extends Disposable implements IConnecti
 	/**
 	 * Opens the connection dialog
 	 * @param params Include the uri, type of connection
+	 * @param options
 	 * @param model the existing connection profile to create a new one from
 	 */
 	public showConnectionDialog(params?: INewConnectionParams, options?: IConnectionCompletionOptions, model?: Partial<interfaces.IConnectionProfile>, connectionResult?: IConnectionResult): Promise<void> {
@@ -287,7 +288,7 @@ export class ConnectionManagementService extends Disposable implements IConnecti
 
 	/**
 	 * Loads the  password and try to connect. If fails, shows the dialog so user can change the connection
-	 * @param Connection Profile
+	 * @param connection Profile
 	 * @param owner of the connection. Can be the editors
 	 * @param options to use after the connection is complete
 	 */
@@ -361,7 +362,7 @@ export class ConnectionManagementService extends Disposable implements IConnecti
 
 	/**
 	 * Load the password and opens a new connection
-	 * @param Connection Profile
+	 * @param connection Profile
 	 * @param uri assigned to the profile (used only when connecting from an editor)
 	 * @param options to be used after the connection is completed
 	 * @param callbacks to call after the connection is completed
@@ -761,7 +762,7 @@ export class ConnectionManagementService extends Disposable implements IConnecti
 	 *
 	 * @param uri the URI of the resource whose language has changed
 	 * @param language the base language
-	 * @param flavor the specific language flavor that's been set
+	 * @param provider
 	 * @throws {Error} if the provider is not in the list of registered providers
 	 */
 	public doChangeLanguageFlavor(uri: string, language: string, provider: string): void {

src/sql/workbench/services/objectExplorer/browser/treeSelectionHandler.ts

@@ -92,6 +92,12 @@ export class TreeSelectionHandler {
 
 	/**
 	 *
+	 * @param connectionManagementService
+	 * @param objectExplorerService
+	 * @param isDoubleClick
+	 * @param isKeyboard
+	 * @param selection
+	 * @param tree
 	 * @param connectionCompleteCallback A function that gets called after a connection is established due to the selection, if needed
 	 */
 	private handleTreeItemSelected(connectionManagementService: IConnectionManagementService, objectExplorerService: IObjectExplorerService, isDoubleClick: boolean, isKeyboard: boolean, selection: any[], tree: AsyncServerTree | ITree, connectionCompleteCallback: () => void): void {

src/sql/workbench/services/query/common/dataService.ts

@@ -135,9 +135,6 @@ export class DataService {
 
 	/**
 	 * send request to save the selected result set as csv
-	 * @param uri of the calling document
-	 * @param batchId The batch id of the batch with the result to save
-	 * @param resultId The id of the result to save as csv
 	 */
 	sendSaveRequest(saveRequest: ISaveRequest): void {
 		let serializer = this._instantiationService.createInstance(ResultSerializer);

src/sql/workbench/test/electron-browser/api/extHostModelView.test.ts

@@ -446,6 +446,7 @@ suite('ExtHostModelView Validation Tests', () => {
  * Helper function that creates a simple declarative table. Supports just a single column
  * of data.
  * @param modelView The ModelView used to create the component
+ * @param dataType
  * @param data The rows of data
  */
 function createDeclarativeTable(modelView: azdata.ModelView, dataType: DeclarativeDataType, data?: any[]): azdata.DeclarativeTableComponent {