Skip to content

Commit 2901ed0

Browse files
hsubox76hsubox76
authored
Update doc comments (#5233)
1 parent fbb32e7 commit 2901ed0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+384
-369
lines changed

‎common/api-review/auth-exp.api.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,14 @@ export class AuthCredential {
101101
protected constructor(
102102
providerId: string,
103103
signInMethod: string);
104-
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts
105-
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
104+
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.doc.d.ts
105+
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.doc.d.ts
106106
//
107107
// @internal (undocumented)
108108
_getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;
109109
// @internal (undocumented)
110110
_getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;
111-
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
111+
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.doc.d.ts
112112
//
113113
// @internal (undocumented)
114114
_linkToIdToken(_auth: AuthInternal, _idToken: string): Promise<IdTokenResponse>;
@@ -276,6 +276,9 @@ export function connectAuthEmulator(auth: Auth, url: string, options?: {
276276
disableWarnings: boolean;
277277
}): void;
278278

279+
// @public
280+
export const cordovaPopupRedirectResolver: PopupRedirectResolver;
281+
279282
// @public
280283
export function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
281284

@@ -339,7 +342,7 @@ export interface EmulatorConfig {
339342

340343
export { ErrorFn }
341344

342-
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
345+
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.doc.d.ts
343346
//
344347
// @public
345348
export class FacebookAuthProvider extends BaseOAuthProvider {
@@ -481,7 +484,7 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
481484
export class OAuthCredential extends AuthCredential {
482485
accessToken?: string;
483486
static fromJSON(json: string | object): OAuthCredential | null;
484-
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
487+
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.doc.d.ts
485488
//
486489
// @internal (undocumented)
487490
static _fromParams(params: OAuthCredentialParams): OAuthCredential;
@@ -560,7 +563,7 @@ export class PhoneAuthCredential extends AuthCredential {
560563
_getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;
561564
// @internal (undocumented)
562565
_linkToIdToken(auth: AuthInternal, idToken: string): Promise<IdTokenResponse>;
563-
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts
566+
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.doc.d.ts
564567
//
565568
// @internal (undocumented)
566569
_makeVerificationRequest(): SignInWithPhoneNumberRequest;
@@ -633,6 +636,9 @@ export interface ReactNativeAsyncStorage {
633636
setItem(key: string, value: string): Promise<void>;
634637
}
635638

639+
// @public
640+
export const reactNativeLocalPersistence: Persistence;
641+
636642
// @public
637643
export function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
638644

@@ -651,13 +657,13 @@ export interface RecaptchaParameters {
651657
[key: string]: any;
652658
}
653659

654-
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts
660+
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.doc.d.ts
655661
//
656662
// @public
657663
export class RecaptchaVerifier implements ApplicationVerifierInternal {
658664
constructor(containerOrId: HTMLElement | string, parameters: RecaptchaParameters, authExtern: Auth);
659665
clear(): void;
660-
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts
666+
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.doc.d.ts
661667
//
662668
// @internal (undocumented)
663669
readonly _recaptchaLoader: ReCaptchaLoader;
@@ -671,7 +677,7 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
671677
// @public
672678
export function reload(user: User): Promise<void>;
673679

674-
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
680+
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.doc.d.ts
675681
//
676682
// @public
677683
export class SAMLAuthProvider extends FederatedAuthProvider {
@@ -815,4 +821,6 @@ export function verifyBeforeUpdateEmail(user: User, newEmail: string, actionCode
815821
export function verifyPasswordResetCode(auth: Auth, code: string): Promise<string>;
816822

817823

824+
// (No @packageDocumentation comment for this package)
825+
818826
```

‎packages-exp/analytics-exp/src/api.ts

+36-36
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ declare module '@firebase/component' {
6060
}
6161

6262
/**
63-
* Returns a Firebase Analytics instance for the given app.
63+
* Returns an {@link Analytics} instance for the given app.
6464
*
6565
* @public
6666
*
67-
* @param app - The FirebaseApp to use.
67+
* @param app - The {@link @firebase/app#FirebaseApp} to use.
6868
*/
6969
export function getAnalytics(app: FirebaseApp = getApp()): Analytics {
7070
app = getModularInstance(app);
@@ -82,11 +82,11 @@ export function getAnalytics(app: FirebaseApp = getApp()): Analytics {
8282
}
8383

8484
/**
85-
* Returns a Firebase Analytics instance for the given app.
85+
* Returns an {@link Analytics} instance for the given app.
8686
*
8787
* @public
8888
*
89-
* @param app - The FirebaseApp to use.
89+
* @param app - The {@link @firebase/app#FirebaseApp} to use.
9090
*/
9191
export function initializeAnalytics(
9292
app: FirebaseApp,
@@ -115,7 +115,7 @@ export function initializeAnalytics(
115115
* 1. Check if it's not a browser extension environment.
116116
* 2. Check if cookies are enabled in current browser.
117117
* 3. Check if IndexedDB is supported by the browser environment.
118-
* 4. Check if the current browser context is valid for using IndexedDB.open().
118+
* 4. Check if the current browser context is valid for using `IndexedDB.open()`.
119119
*
120120
* @public
121121
*
@@ -140,11 +140,11 @@ export async function isSupported(): Promise<boolean> {
140140
}
141141

142142
/**
143-
* Use gtag 'config' command to set 'screen_name'.
143+
* Use gtag `config` command to set `screen_name`.
144144
*
145145
* @public
146146
*
147-
* @param analyticsInstance - Firebase Analytics instance.
147+
* @param analyticsInstance - The {@link Analytics} instance.
148148
* @param screenName - Screen name to set.
149149
*/
150150
export function setCurrentScreen(
@@ -162,11 +162,11 @@ export function setCurrentScreen(
162162
}
163163

164164
/**
165-
* Use gtag 'config' command to set 'user_id'.
165+
* Use gtag `config` command to set `user_id`.
166166
*
167167
* @public
168168
*
169-
* @param analyticsInstance - Firebase Analytics instance.
169+
* @param analyticsInstance - The {@link Analytics} instance.
170170
* @param id - User ID to set.
171171
*/
172172
export function setUserId(
@@ -184,7 +184,7 @@ export function setUserId(
184184
}
185185

186186
/**
187-
* Use gtag 'config' command to set all params specified.
187+
* Use gtag `config` command to set all params specified.
188188
*
189189
* @public
190190
*/
@@ -203,12 +203,12 @@ export function setUserProperties(
203203
}
204204

205205
/**
206-
* Sets whether analytics collection is enabled for this app on this device.
207-
* window['ga-disable-analyticsId'] = true;
206+
* Sets whether Google Analytics collection is enabled for this app on this device.
207+
* Sets global `window['ga-disable-analyticsId'] = true;`
208208
*
209209
* @public
210210
*
211-
* @param analyticsInstance - Firebase Analytics instance.
211+
* @param analyticsInstance - The {@link Analytics} instance.
212212
* @param enabled - If true, enables collection, if false, disables it.
213213
*/
214214
export function setAnalyticsCollectionEnabled(
@@ -222,7 +222,7 @@ export function setAnalyticsCollectionEnabled(
222222
).catch(e => logger.error(e));
223223
}
224224
/**
225-
* Sends analytics event with given `eventParams`. This method
225+
* Sends a Google Analytics event with given `eventParams`. This method
226226
* automatically associates this logged event with this Firebase web
227227
* app instance on this device.
228228
* @public
@@ -245,7 +245,7 @@ export function logEvent(
245245
): void;
246246

247247
/**
248-
* Sends analytics event with given `eventParams`. This method
248+
* Sends a Google Analytics event with given `eventParams`. This method
249249
* automatically associates this logged event with this Firebase web
250250
* app instance on this device.
251251
* @public
@@ -268,7 +268,7 @@ export function logEvent(
268268
): void;
269269

270270
/**
271-
* Sends analytics event with given `eventParams`. This method
271+
* Sends a Google Analytics event with given `eventParams`. This method
272272
* automatically associates this logged event with this Firebase web
273273
* app instance on this device.
274274
* @public
@@ -289,7 +289,7 @@ export function logEvent(
289289
): void;
290290

291291
/**
292-
* Sends analytics event with given `eventParams`. This method
292+
* Sends a Google Analytics event with given `eventParams`. This method
293293
* automatically associates this logged event with this Firebase web
294294
* app instance on this device.
295295
* @public
@@ -311,7 +311,7 @@ export function logEvent(
311311
): void;
312312

313313
/**
314-
* Sends analytics event with given `eventParams`. This method
314+
* Sends a Google Analytics event with given `eventParams`. This method
315315
* automatically associates this logged event with this Firebase web
316316
* app instance on this device.
317317
* @public
@@ -335,7 +335,7 @@ export function logEvent(
335335
): void;
336336

337337
/**
338-
* Sends analytics event with given `eventParams`. This method
338+
* Sends a Google Analytics event with given `eventParams`. This method
339339
* automatically associates this logged event with this Firebase web
340340
* app instance on this device.
341341
* @public
@@ -355,7 +355,7 @@ export function logEvent(
355355
): void;
356356

357357
/**
358-
* Sends analytics event with given `eventParams`. This method
358+
* Sends a Google Analytics event with given `eventParams`. This method
359359
* automatically associates this logged event with this Firebase web
360360
* app instance on this device.
361361
* @public
@@ -375,7 +375,7 @@ export function logEvent(
375375
): void;
376376

377377
/**
378-
* Sends analytics event with given `eventParams`. This method
378+
* Sends a Google Analytics event with given `eventParams`. This method
379379
* automatically associates this logged event with this Firebase web
380380
* app instance on this device.
381381
* @public
@@ -394,7 +394,7 @@ export function logEvent(
394394
): void;
395395

396396
/**
397-
* Sends analytics event with given `eventParams`. This method
397+
* Sends a Google Analytics event with given `eventParams`. This method
398398
* automatically associates this logged event with this Firebase web
399399
* app instance on this device.
400400
* @public
@@ -415,7 +415,7 @@ export function logEvent(
415415
): void;
416416

417417
/**
418-
* Sends analytics event with given `eventParams`. This method
418+
* Sends a Google Analytics event with given `eventParams`. This method
419419
* automatically associates this logged event with this Firebase web
420420
* app instance on this device.
421421
* @public
@@ -441,7 +441,7 @@ export function logEvent(
441441
): void;
442442

443443
/**
444-
* Sends analytics event with given `eventParams`. This method
444+
* Sends a Google Analytics event with given `eventParams`. This method
445445
* automatically associates this logged event with this Firebase web
446446
* app instance on this device.
447447
* @public
@@ -460,7 +460,7 @@ export function logEvent(
460460
): void;
461461

462462
/**
463-
* Sends analytics event with given `eventParams`. This method
463+
* Sends a Google Analytics event with given `eventParams`. This method
464464
* automatically associates this logged event with this Firebase web
465465
* app instance on this device.
466466
* @public
@@ -479,7 +479,7 @@ export function logEvent(
479479
): void;
480480

481481
/**
482-
* Sends analytics event with given `eventParams`. This method
482+
* Sends a Google Analytics event with given `eventParams`. This method
483483
* automatically associates this logged event with this Firebase web
484484
* app instance on this device.
485485
* @public
@@ -499,7 +499,7 @@ export function logEvent(
499499
): void;
500500

501501
/**
502-
* Sends analytics event with given `eventParams`. This method
502+
* Sends a Google Analytics event with given `eventParams`. This method
503503
* automatically associates this logged event with this Firebase web
504504
* app instance on this device.
505505
* @public
@@ -520,7 +520,7 @@ export function logEvent(
520520
): void;
521521

522522
/**
523-
* Sends analytics event with given `eventParams`. This method
523+
* Sends a Google Analytics event with given `eventParams`. This method
524524
* automatically associates this logged event with this Firebase web
525525
* app instance on this device.
526526
* @public
@@ -541,7 +541,7 @@ export function logEvent(
541541
): void;
542542

543543
/**
544-
* Sends analytics event with given `eventParams`. This method
544+
* Sends a Google Analytics event with given `eventParams`. This method
545545
* automatically associates this logged event with this Firebase web
546546
* app instance on this device.
547547
* @public
@@ -561,7 +561,7 @@ export function logEvent(
561561
): void;
562562

563563
/**
564-
* Sends analytics event with given `eventParams`. This method
564+
* Sends a Google Analytics event with given `eventParams`. This method
565565
* automatically associates this logged event with this Firebase web
566566
* app instance on this device.
567567
* @public
@@ -582,7 +582,7 @@ export function logEvent(
582582
): void;
583583

584584
/**
585-
* Sends analytics event with given `eventParams`. This method
585+
* Sends a Google Analytics event with given `eventParams`. This method
586586
* automatically associates this logged event with this Firebase web
587587
* app instance on this device.
588588
* @public
@@ -601,7 +601,7 @@ export function logEvent(
601601
): void;
602602

603603
/**
604-
* Sends analytics event with given `eventParams`. This method
604+
* Sends a Google Analytics event with given `eventParams`. This method
605605
* automatically associates this logged event with this Firebase web
606606
* app instance on this device.
607607
* @public
@@ -623,7 +623,7 @@ export function logEvent(
623623
): void;
624624

625625
/**
626-
* Sends analytics event with given `eventParams`. This method
626+
* Sends a Google Analytics event with given `eventParams`. This method
627627
* automatically associates this logged event with this Firebase web
628628
* app instance on this device.
629629
* @public
@@ -644,7 +644,7 @@ export function logEvent(
644644
): void;
645645

646646
/**
647-
* Sends analytics event with given `eventParams`. This method
647+
* Sends a Google Analytics event with given `eventParams`. This method
648648
* automatically associates this logged event with this Firebase web
649649
* app instance on this device.
650650
* @public
@@ -665,7 +665,7 @@ export function logEvent(
665665
): void;
666666

667667
/**
668-
* Sends analytics event with given `eventParams`. This method
668+
* Sends a Google Analytics event with given `eventParams`. This method
669669
* automatically associates this logged event with this Firebase web
670670
* app instance on this device.
671671
* @public
@@ -681,7 +681,7 @@ export function logEvent<T extends string>(
681681
): void;
682682

683683
/**
684-
* Sends analytics event with given `eventParams`. This method
684+
* Sends a Google Analytics event with given `eventParams`. This method
685685
* automatically associates this logged event with this Firebase web
686686
* app instance on this device.
687687
* List of official event parameters can be found in the gtag.js

0 commit comments

Comments
 (0)