Skip to content

Commit 0c52fb6

Browse files
committed
Change Markdown links in code docs to JSDoc links
This change updates links in code documentation that are in Markdown format to be in the expected JSDoc link format, so that they can be correctly parsed by the api-documenter.
1 parent 4be78a3 commit 0c52fb6

File tree

4 files changed

+15
-9
lines changed

4 files changed

+15
-9
lines changed

packages/auth/src/core/strategies/email.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ import { getModularInstance } from '@firebase/util';
3434

3535
/**
3636
* Gets the list of possible sign in methods for the given email address. This method returns an
37-
* empty list when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, irrespective of the number of
38-
* authentication methods available for the given email.
37+
* empty list when
38+
* {@link https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection | Email Enumeration Protection}
39+
* is enabled, irrespective of the number of authentication methods available for the given email.
3940
*
4041
* @remarks
4142
* This is useful to differentiate methods of sign-in for the same provider, eg.
@@ -47,7 +48,8 @@ import { getModularInstance } from '@firebase/util';
4748
* @param email - The user's email address.
4849
*
4950
* Deprecated. Migrating off of this method is recommended as a security best-practice.
50-
* Learn more in the Identity Platform documentation for [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection).
51+
* Learn more in the Identity Platform documentation for
52+
* {@link https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection | Email Enumeration Protection}.
5153
* @public
5254
*/
5355
export async function fetchSignInMethodsForEmail(

packages/auth/src/core/strategies/email_and_password.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ async function recachePasswordPolicy(auth: Auth): Promise<void> {
6767
/**
6868
* Sends a password reset email to the given email address. This method does not throw an error when
6969
* there's no user account with the given email address and
70-
* [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled.
70+
* {@link https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection | Email Enumeration Protection}
71+
* is enabled.
7172
*
7273
* @remarks
7374
* To complete the password reset, call {@link confirmPasswordReset} with the code supplied in
@@ -316,9 +317,10 @@ export async function createUserWithEmailAndPassword(
316317
* Asynchronously signs in using an email and password.
317318
*
318319
* @remarks
319-
* Fails with an error if the email address and password do not match.
320-
* When [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled,
321-
* this method fails with "auth/invalid-credential" in case of an invalid email/password.
320+
* Fails with an error if the email address and password do not match. When
321+
* {@link https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection | Email Enumeration Protection}
322+
* is enabled, this method fails with "auth/invalid-credential" in case of an invalid
323+
* email/password.
322324
*
323325
* This method is not supported on {@link Auth} instances created with a
324326
* {@link @firebase/app#FirebaseServerApp}.

packages/auth/src/core/user/account_info.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,9 @@ export async function updateProfile(
9393
* @param user - The user.
9494
* @param newEmail - The new email address.
9595
*
96-
* Throws "auth/operation-not-allowed" error when [Email Enumeration Protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled.
96+
* Throws "auth/operation-not-allowed" error when
97+
* {@link https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection | Email Enumeration Protection}
98+
* is enabled.
9799
* Deprecated - Use {@link verifyBeforeUpdateEmail} instead.
98100
*
99101
* @public

packages/auth/src/model/public_types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export interface Config {
7070
/**
7171
* Interface representing reCAPTCHA parameters.
7272
*
73-
* See the [reCAPTCHA docs](https://developers.google.com/recaptcha/docs/display#render_param)
73+
* See the {@link https://developers.google.com/recaptcha/docs/display#render_param | reCAPTCHA docs}
7474
* for the list of accepted parameters. All parameters are accepted except for `sitekey`: Firebase Auth
7575
* provisions a reCAPTCHA for each project and will configure the site key upon rendering.
7676
*

0 commit comments

Comments
 (0)