Fix tsdoc lint error

authgear · Feb 20, 2024 · 566d550 · 566d550
1 parent bf02d98
commit 566d550
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/packages/authgear-capacitor/src/types.ts b/packages/authgear-capacitor/src/types.ts
@@ -55,7 +55,7 @@ export interface AuthenticateOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
@@ -83,7 +83,7 @@ export interface AuthenticateOptions {
   page?: string;
   /**
    * Auto-redirect the user to the OAuth provider. You can set the value for each OAuth provider in Authgear portal via
-   * Authentication > Social / Enterprise Login.
+   * Authentication \> Social / Enterprise Login.
    *
    * For example, to auto-redirect your users to sign in with Google, first, set the alias for Sign in with Google to "google" in Authgear portal,
    * then set oauthProviderAlias to "google".
@@ -104,7 +104,7 @@ export interface ReauthenticateOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
@@ -159,7 +159,7 @@ export interface SettingOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.

diff --git a/packages/authgear-react-native/src/types.ts b/packages/authgear-react-native/src/types.ts
@@ -68,7 +68,7 @@ export interface AuthenticateOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
@@ -100,7 +100,7 @@ export interface AuthenticateOptions {
   page?: string;
   /**
    * Auto-redirect the user to the OAuth provider. You can set the value for each OAuth provider in Authgear portal via
-   * Authentication > Social / Enterprise Login.
+   * Authentication \> Social / Enterprise Login.
    *
    * For example, to auto-redirect your users to sign in with Google, first, set the alias for Sign in with Google to "google" in Authgear portal,
    * then set oauthProviderAlias to "google".
@@ -121,7 +121,7 @@ export interface ReauthenticateOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
@@ -161,7 +161,7 @@ export interface PromoteOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
@@ -209,7 +209,7 @@ export interface SettingOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.

diff --git a/packages/authgear-web/src/types.ts b/packages/authgear-web/src/types.ts
@@ -44,7 +44,7 @@ export interface ReauthenticateOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
@@ -95,7 +95,7 @@ export interface AuthenticateOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
@@ -111,7 +111,7 @@ export interface AuthenticateOptions {
   page?: string;
   /**
    * Auto-redirect the user to the OAuth provider. You can set the value for each OAuth provider in Authgear portal via
-   * Authentication > Social / Enterprise Login.
+   * Authentication \> Social / Enterprise Login.
    *
    * For example, to auto-redirect your users to sign in with Google, first, set the alias for Sign in with Google to "google" in Authgear portal,
    * then set oauthProviderAlias to "google".
@@ -126,7 +126,7 @@ export interface SettingOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.
@@ -162,7 +162,7 @@ export interface PromoteOptions {
   /**
    * UI locale tags. You can use this parameter to set the display language for Auth UI.
    *
-   * First, enable the language you want to change to in Authgear Portal (Your project > UI Settings > click on the settings icon beside Language.)
+   * First, enable the language you want to change to in Authgear Portal (Your project \> UI Settings \> click on the settings icon beside Language.)
    *
    * For example, to change the language for Auth UI to Hong Kong,
    * set the value for uiLocales to ["zh-HK"] after enabling "Chinese (Hong Kong)" in Authgear Portal.