Skip to content

Commit e6b93b3

Browse files
Feiyang1Feiyang1
committed
fix links in comments
1 parent 6b5f366 commit e6b93b3

File tree

24 files changed

+66
-66
lines changed

24 files changed

+66
-66
lines changed

‎packages-exp/auth-exp/src/core/errors.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ function _prodErrorMap(): ErrorMap<AuthErrorCode> {
374374
/**
375375
* A verbose error map with detailed descriptions for most error codes.
376376
*
377-
* See discussion at {@link @firebase/auth-types#AuthErrorMap}
377+
* See discussion at {@link AuthErrorMap}
378378
*
379379
* @public
380380
*/
@@ -383,7 +383,7 @@ export const debugErrorMap: AuthErrorMap = _debugErrorMap;
383383
/**
384384
* A minimal error map with all verbose error messages stripped.
385385
*
386-
* See discussion at {@link @firebase/auth-types#AuthErrorMap}
386+
* See discussion at {@link AuthErrorMap}
387387
*
388388
* @public
389389
*/

‎packages-exp/auth-exp/src/core/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export { debugErrorMap, prodErrorMap } from './errors';
3737
* ```
3838
*
3939
* @param auth - The Auth instance.
40-
* @param persistence - The {@link @firebase/auth-types#Persistence} to use.
40+
* @param persistence - The {@link Persistence} to use.
4141
* @returns A promise that resolves once the persistence change has completed
4242
*
4343
* @public
@@ -99,8 +99,8 @@ export function useDeviceLanguage(auth: Auth): void {
9999
auth.useDeviceLanguage();
100100
}
101101
/**
102-
* Asynchronously sets the provided user as {@link @firebase/auth-types#Auth.currentUser} on the
103-
* {@link @firebase/auth-types#Auth} instance.
102+
* Asynchronously sets the provided user as {@link Auth.currentUser} on the
103+
* {@link Auth} instance.
104104
*
105105
* @remarks
106106
* A new instance copy of the user provided will be made and set as currentUser.
@@ -112,7 +112,7 @@ export function useDeviceLanguage(auth: Auth): void {
112112
* project.
113113
*
114114
* @param auth - The Auth instance.
115-
* @param user - The new {@link @firebase/auth-types#User}.
115+
* @param user - The new {@link User}.
116116
*
117117
* @public
118118
*/

‎packages-exp/auth-exp/src/core/persistence/in_memory.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export class InMemoryPersistence implements PersistenceInternal {
5858
}
5959

6060
/**
61-
* An implementation of {@link @firebase/auth-types#Persistence} of type 'NONE'.
61+
* An implementation of {@link Persistence} of type 'NONE'.
6262
*
6363
* @public
6464
*/

‎packages-exp/auth-exp/src/core/providers/facebook.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { OAuthCredential } from '../credentials/oauth';
2828
import { OAuthProvider } from './oauth';
2929

3030
/**
31-
* Provider for generating an {@link OAuthCredential} for {@link @firebase/auth-types#ProviderId.FACEBOOK}.
31+
* Provider for generating an {@link OAuthCredential} for {@link ProviderId.FACEBOOK}.
3232
*
3333
* @example
3434
* ```javascript
@@ -67,9 +67,9 @@ import { OAuthProvider } from './oauth';
6767
* @public
6868
*/
6969
export class FacebookAuthProvider extends OAuthProvider {
70-
/** Always set to {@link @firebase/auth-types#SignInMethod.FACEBOOK}. */
70+
/** Always set to {@link SignInMethod.FACEBOOK}. */
7171
static readonly FACEBOOK_SIGN_IN_METHOD = SignInMethod.FACEBOOK;
72-
/** Always set to {@link @firebase/auth-types#ProviderId.FACEBOOK}. */
72+
/** Always set to {@link ProviderId.FACEBOOK}. */
7373
static readonly PROVIDER_ID = ProviderId.FACEBOOK;
7474

7575
constructor() {
@@ -97,7 +97,7 @@ export class FacebookAuthProvider extends OAuthProvider {
9797
}
9898

9999
/**
100-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}.
100+
* Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
101101
*
102102
* @param userCredential - The user credential.
103103
*/
@@ -110,7 +110,7 @@ export class FacebookAuthProvider extends OAuthProvider {
110110
}
111111

112112
/**
113-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was
113+
* Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
114114
* thrown during a sign-in, link, or reauthenticate operation.
115115
*
116116
* @param userCredential - The user credential.

‎packages-exp/auth-exp/src/core/providers/github.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { OAuthCredential } from '../credentials/oauth';
2828
import { OAuthProvider } from './oauth';
2929

3030
/**
31-
* Provider for generating an {@link OAuthCredential} for {@link @firebase/auth-types#ProviderId.GITHUB}.
31+
* Provider for generating an {@link OAuthCredential} for {@link ProviderId.GITHUB}.
3232
*
3333
* @remarks
3434
* GitHub requires an OAuth 2.0 redirect, so you can either handle the redirect directly, or use
@@ -70,9 +70,9 @@ import { OAuthProvider } from './oauth';
7070
* @public
7171
*/
7272
export class GithubAuthProvider extends OAuthProvider {
73-
/** Always set to {@link @firebase/auth-types#SignInMethod.GITHUB}. */
73+
/** Always set to {@link SignInMethod.GITHUB}. */
7474
static readonly GITHUB_SIGN_IN_METHOD = SignInMethod.GITHUB;
75-
/** Always set to {@link @firebase/auth-types#ProviderId.GITHUB}. */
75+
/** Always set to {@link ProviderId.GITHUB}. */
7676
static readonly PROVIDER_ID = ProviderId.GITHUB;
7777

7878
constructor() {
@@ -93,7 +93,7 @@ export class GithubAuthProvider extends OAuthProvider {
9393
}
9494

9595
/**
96-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}.
96+
* Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
9797
*
9898
* @param userCredential - The user credential.
9999
*/
@@ -106,7 +106,7 @@ export class GithubAuthProvider extends OAuthProvider {
106106
}
107107

108108
/**
109-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was
109+
* Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
110110
* thrown during a sign-in, link, or reauthenticate operation.
111111
*
112112
* @param userCredential - The user credential.

‎packages-exp/auth-exp/src/core/providers/google.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { OAuthCredential } from '../credentials/oauth';
2929
import { OAuthProvider } from './oauth';
3030

3131
/**
32-
* Provider for generating an an {@link OAuthCredential} for {@link @firebase/auth-types#ProviderId.GOOGLE}.
32+
* Provider for generating an an {@link OAuthCredential} for {@link ProviderId.GOOGLE}.
3333
*
3434
* @example
3535
* ```javascript
@@ -70,9 +70,9 @@ import { OAuthProvider } from './oauth';
7070
* @public
7171
*/
7272
export class GoogleAuthProvider extends OAuthProvider {
73-
/** Always set to {@link @firebase/auth-types#SignInMethod.GOOGLE}. */
73+
/** Always set to {@link SignInMethod.GOOGLE}. */
7474
static readonly GOOGLE_SIGN_IN_METHOD = SignInMethod.GOOGLE;
75-
/** Always set to {@link @firebase/auth-types#ProviderId.GOOGLE}. */
75+
/** Always set to {@link ProviderId.GOOGLE}. */
7676
static readonly PROVIDER_ID = ProviderId.GOOGLE;
7777

7878
constructor() {
@@ -106,7 +106,7 @@ export class GoogleAuthProvider extends OAuthProvider {
106106
}
107107

108108
/**
109-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}.
109+
* Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
110110
*
111111
* @param userCredential - The user credential.
112112
*/
@@ -118,7 +118,7 @@ export class GoogleAuthProvider extends OAuthProvider {
118118
);
119119
}
120120
/**
121-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was
121+
* Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
122122
* thrown during a sign-in, link, or reauthenticate operation.
123123
*
124124
* @param userCredential - The user credential.

‎packages-exp/auth-exp/src/core/providers/oauth.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ export class OAuthProvider implements AuthProvider {
207207
}
208208

209209
/**
210-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}.
210+
* Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
211211
*
212212
* @param userCredential - The user credential.
213213
*/
@@ -219,7 +219,7 @@ export class OAuthProvider implements AuthProvider {
219219
);
220220
}
221221
/**
222-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was
222+
* Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
223223
* thrown during a sign-in, link, or reauthenticate operation.
224224
*
225225
* @param userCredential - The user credential.

‎packages-exp/auth-exp/src/core/providers/twitter.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ import { OAuthCredential } from '../credentials/oauth';
4646
import { OAuthProvider } from './oauth';
4747

4848
/**
49-
* Provider for generating an {@link OAuthCredential} for {@link @firebase/auth-types#ProviderId.TWITTER}.
49+
* Provider for generating an {@link OAuthCredential} for {@link ProviderId.TWITTER}.
5050
*
5151
* @example
5252
* ```javascript
@@ -108,7 +108,7 @@ export class TwitterAuthProvider extends OAuthProvider {
108108
}
109109

110110
/**
111-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#UserCredential}.
111+
* Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
112112
*
113113
* @param userCredential - The user credential.
114114
*/
@@ -121,7 +121,7 @@ export class TwitterAuthProvider extends OAuthProvider {
121121
}
122122

123123
/**
124-
* Used to extract the underlying {@link OAuthCredential} from a {@link @firebase/auth-types#AuthError} which was
124+
* Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
125125
* thrown during a sign-in, link, or reauthenticate operation.
126126
*
127127
* @param userCredential - The user credential.

‎packages-exp/auth-exp/src/core/strategies/credential.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export async function _signInWithCredential(
5858
* Asynchronously signs in with the given credentials.
5959
*
6060
* @remarks
61-
* An {@link @firebase/auth-types#AuthProvider} can be used to generate the credential.
61+
* An {@link AuthProvider} can be used to generate the credential.
6262
*
6363
* @param auth - The Auth instance.
6464
* @param credential - The auth credential.
@@ -76,7 +76,7 @@ export async function signInWithCredential(
7676
* Links the user account with the given credentials.
7777
*
7878
* @remarks
79-
* An {@link @firebase/auth-types#AuthProvider} can be used to generate the credential.
79+
* An {@link AuthProvider} can be used to generate the credential.
8080
*
8181
* @param user - The user.
8282
* @param credential - The auth credential.

‎packages-exp/auth-exp/src/core/strategies/email.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ import { _setActionCodeSettingsOnRequest } from './action_code_settings';
3737
* @remarks
3838
* This is useful to differentiate methods of sign-in for the same provider, eg.
3939
* {@link EmailAuthProvider} which has 2 methods of sign-in,
40-
* {@link @firebase/auth-types#SignInMethod.EMAIL_PASSWORD} and
41-
* {@link @firebase/auth-types#SignInMethod.EMAIL_LINK} .
40+
* {@link SignInMethod.EMAIL_PASSWORD} and
41+
* {@link SignInMethod.EMAIL_LINK} .
4242
*
4343
* @param auth - The Auth instance.
4444
* @param email - The user's email address.
@@ -89,7 +89,7 @@ export async function fetchSignInMethodsForEmail(
8989
* ```
9090
*
9191
* @param user - The user.
92-
* @param actionCodeSettings - The {@link @firebase/auth-types#ActionCodeSettings}.
92+
* @param actionCodeSettings - The {@link ActionCodeSettings}.
9393
*
9494
* @public
9595
*/
@@ -148,7 +148,7 @@ export async function sendEmailVerification(
148148
*
149149
* @param user - The user.
150150
* @param newEmail - The new email address to be verified before update.
151-
* @param actionCodeSettings - The {@link @firebase/auth-types#ActionCodeSettings}.
151+
* @param actionCodeSettings - The {@link ActionCodeSettings}.
152152
*
153153
* @public
154154
*/

‎packages-exp/auth-exp/src/core/strategies/email_and_password.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ import { AuthErrorCode } from '../errors';
6464
*
6565
* @param auth - The Auth instance.
6666
* @param email - The user's email address.
67-
* @param actionCodeSettings - The {@link @firebase/auth-types#ActionCodeSettings}.
67+
* @param actionCodeSettings - The {@link ActionCodeSettings}.
6868
*
6969
* @public
7070
*/

‎packages-exp/auth-exp/src/core/strategies/email_link.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ import { _assert } from '../util/assert';
6565
*
6666
* @param auth - The Auth instance.
6767
* @param email - The user's email address.
68-
* @param actionCodeSettings - The {@link @firebase/auth-types#ActionCodeSettings}.
68+
* @param actionCodeSettings - The {@link ActionCodeSettings}.
6969
*
7070
* @public
7171
*/

‎packages-exp/auth-exp/src/core/user/additional_user_info.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ class TwitterAdditionalUserInfo extends FederatedAdditionalUserInfoWithUsername
132132
}
133133

134134
/**
135-
* Extracts provider specific {@link @firebase/auth-types#AdditionalUserInfo} for the given credential.
135+
* Extracts provider specific {@link AdditionalUserInfo} for the given credential.
136136
*
137137
* @param userCredential - The user credential.
138138
*

‎packages-exp/auth-exp/src/mfa/mfa_resolver.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,11 @@ export class MultiFactorResolverImpl implements MultiFactorResolver {
111111
}
112112

113113
/**
114-
* Provides a {@link @firebase/auth-types#MultiFactorResolver} suitable for completion of a
114+
* Provides a {@link MultiFactorResolver} suitable for completion of a
115115
* multi-factor flow.
116116
*
117117
* @param auth - The auth instance.
118-
* @param error - The {@link @firebase/auth-types#MultiFactorError} raised during a sign-in, or
118+
* @param error - The {@link MultiFactorError} raised during a sign-in, or
119119
* reauthentication operation.
120120
*
121121
* @public

‎packages-exp/auth-exp/src/mfa/mfa_user.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ export class MultiFactorUserImpl implements MultiFactorUser {
103103
const multiFactorUserCache = new WeakMap<User, MultiFactorUser>();
104104

105105
/**
106-
* The {@link @firebase/auth-types#MultiFactorUser} corresponding to the user.
106+
* The {@link MultiFactorUser} corresponding to the user.
107107
*
108108
* @remarks
109109
* This is used to access all multi-factor properties and operations related to the user.

‎packages-exp/auth-exp/src/model/public_types.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ export interface ApplicationVerifier {
524524
}
525525

526526
/**
527-
* Interface that represents an auth provider, used to facilitate creating {@link @firebase/auth-types#AuthCredential}.
527+
* Interface that represents an auth provider, used to facilitate creating {@link AuthCredential}.
528528
*
529529
* @public
530530
*/
@@ -556,7 +556,7 @@ export interface ConfirmationResult {
556556
*
557557
* @remarks
558558
* This can be used along with the verification code to initialize a
559-
* {@link @firebase/auth-types#PhoneAuthCredential}.
559+
* {@link PhoneAuthCredential}.
560560
*/
561561
readonly verificationId: string;
562562
/**
@@ -643,7 +643,7 @@ export interface MultiFactorInfo {
643643
}
644644

645645
/**
646-
* The class used to facilitate recovery from {@link @firebase/auth-types#MultiFactorError} when a user needs to
646+
* The class used to facilitate recovery from {@link MultiFactorError} when a user needs to
647647
* provide a second factor to sign in.
648648
*
649649
* @example
@@ -701,7 +701,7 @@ export interface MultiFactorResolver {
701701
readonly session: MultiFactorSession;
702702
/**
703703
* A helper function to help users complete sign in with a second factor using an
704-
* {@link @firebase/auth-types#MultiFactorAssertion} confirming the user successfully completed the second factor
704+
* {@link MultiFactorAssertion} confirming the user successfully completed the second factor
705705
* challenge.
706706
*
707707
* @example
@@ -757,12 +757,12 @@ export interface MultiFactorUser {
757757
* await multiFactorUser.enroll(multiFactorAssertion);
758758
* ```
759759
*
760-
* @returns The promise that resolves with the {@link @firebase/auth-types#MultiFactorSession}.
760+
* @returns The promise that resolves with the {@link MultiFactorSession}.
761761
*/
762762
getSession(): Promise<MultiFactorSession>;
763763
/**
764764
*
765-
* Enrolls a second factor as identified by the {@link @firebase/auth-types#MultiFactorAssertion} for the
765+
* Enrolls a second factor as identified by the {@link MultiFactorAssertion} for the
766766
* user.
767767
*
768768
* @remarks
@@ -825,7 +825,7 @@ export interface MultiFactorUser {
825825

826826
/**
827827
* The class for asserting ownership of a phone second factor. Provided by
828-
* {@link @firebase/auth-types#PhoneMultiFactorGenerator.assertion}.
828+
* {@link PhoneMultiFactorGenerator.assertion}.
829829
*
830830
* @public
831831
*/

‎packages-exp/auth-exp/src/platform_browser/persistence/indexed_db.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ class IndexedDBLocalPersistence implements InternalPersistence {
436436
}
437437

438438
/**
439-
* An implementation of {@link @firebase/auth-types#Persistence} of type 'LOCAL' using `indexedDB`
439+
* An implementation of {@link Persistence} of type 'LOCAL' using `indexedDB`
440440
* for the underlying storage.
441441
*
442442
* @public

‎packages-exp/auth-exp/src/platform_browser/persistence/local_storage.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ class BrowserLocalPersistence
242242
}
243243

244244
/**
245-
* An implementation of {@link @firebase/auth-types#Persistence} of type 'LOCAL' using `localStorage`
245+
* An implementation of {@link Persistence} of type 'LOCAL' using `localStorage`
246246
* for the underlying storage.
247247
*
248248
* @public

0 commit comments

Comments
 (0)