@@ -15,8 +15,8 @@ import * as Utils from './utils';
15
15
* if connection to Azure
16
16
*
17
17
* @export connectionInfo/fixupConnectionCredentials
18
- * @param { Interfaces.IConnectionCredentials } connCreds connection to be fixed up
19
- * @returns { Interfaces.IConnectionCredentials } the updated connection
18
+ * @param connCreds connection to be fixed up
19
+ * @returns the updated connection
20
20
*/
21
21
export function fixupConnectionCredentials ( connCreds : IConnectionInfo ) : IConnectionInfo {
22
22
if ( ! connCreds . server ) {
@@ -89,9 +89,9 @@ function isAzureDatabase(server: string): boolean {
89
89
* Gets a label describing a connection in the picklist UI
90
90
*
91
91
* @export connectionInfo/getPicklistLabel
92
- * @param { Interfaces.IConnectionCredentials } connCreds connection to create a label for
93
- * @param { Interfaces.CredentialsQuickPickItemType } itemType type of quickpick item to display - this influences the icon shown to the user
94
- * @returns { string } user readable label
92
+ * @param connCreds connection to create a label for
93
+ * @param itemType type of quickpick item to display - this influences the icon shown to the user
94
+ * @returns user readable label
95
95
*/
96
96
export function getPicklistLabel ( connCreds : IConnectionInfo , itemType : Interfaces . CredentialsQuickPickItemType ) : string {
97
97
let profile : Interfaces . IConnectionProfile = < Interfaces . IConnectionProfile > connCreds ;
@@ -107,8 +107,8 @@ export function getPicklistLabel(connCreds: IConnectionInfo, itemType: Interface
107
107
* Gets a description for a connection to display in the picklist UI
108
108
*
109
109
* @export connectionInfo/getPicklistDescription
110
- * @param { Interfaces.IConnectionCredentials } connCreds connection
111
- * @returns { string } description
110
+ * @param connCreds connection
111
+ * @returns description
112
112
*/
113
113
export function getPicklistDescription ( connCreds : IConnectionInfo ) : string {
114
114
let desc : string = `[${ getConnectionDisplayString ( connCreds ) } ]` ;
@@ -119,8 +119,8 @@ export function getPicklistDescription(connCreds: IConnectionInfo): string {
119
119
* Gets detailed information about a connection, which can be displayed in the picklist UI
120
120
*
121
121
* @export connectionInfo/getPicklistDetails
122
- * @param { Interfaces.IConnectionCredentials } connCreds connection
123
- * @returns { string } details
122
+ * @param connCreds connection
123
+ * @returns details
124
124
*/
125
125
export function getPicklistDetails ( connCreds : IConnectionInfo ) : string {
126
126
// In the current spec this is left empty intentionally. Leaving the method as this may change in the future
@@ -132,8 +132,8 @@ export function getPicklistDetails(connCreds: IConnectionInfo): string {
132
132
* information that can be shown in a number of different UI locations
133
133
*
134
134
* @export connectionInfo/getConnectionDisplayString
135
- * @param { Interfaces.IConnectionCredentials } conn connection
136
- * @returns { string } display string that can be used in status view or other locations
135
+ * @param conn connection
136
+ * @returns display string that can be used in status view or other locations
137
137
*/
138
138
export function getConnectionDisplayString ( creds : IConnectionInfo ) : string {
139
139
// Update the connection text
@@ -166,9 +166,9 @@ function appendIfNotEmpty(connectionText: string, value: string): string {
166
166
* Gets a formatted display version of a username, or the domain user if using Integrated authentication
167
167
*
168
168
* @export connectionInfo/getUserNameOrDomainLogin
169
- * @param { Interfaces.IConnectionCredentials } conn connection
170
- * @param { string } [defaultValue] optional default value to use if username is empty and this is not an Integrated auth profile
171
- * @returns { string }
169
+ * @param conn connection
170
+ * @param [defaultValue] optional default value to use if username is empty and this is not an Integrated auth profile
171
+ * @returns
172
172
*/
173
173
export function getUserNameOrDomainLogin ( creds : IConnectionInfo , defaultValue ?: string ) : string {
174
174
if ( ! defaultValue ) {
@@ -186,8 +186,8 @@ export function getUserNameOrDomainLogin(creds: IConnectionInfo, defaultValue?:
186
186
* Gets a detailed tooltip with information about a connection
187
187
*
188
188
* @export connectionInfo/getTooltip
189
- * @param { Interfaces.IConnectionCredentials } connCreds connection
190
- * @returns { string } tooltip
189
+ * @param connCreds connection
190
+ * @returns tooltip
191
191
*/
192
192
export function getTooltip ( connCreds : IConnectionInfo , serverInfo ?: IServerInfo ) : string {
193
193
0 commit comments