Address PR comments

Author: hsubox76

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

@@ -59,11 +59,11 @@ declare module '@firebase/component' {
 }
 
 /**
- * Returns a {@link Analytics} instance for the given app.
+ * Returns an {@link Analytics} instance for the given app.
  *
  * @public
  *
- * @param app - The `FirebaseApp` to use.
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
  */
 export function getAnalytics(app: FirebaseApp = getApp()): Analytics {
   app = getModularInstance(app);
@@ -81,11 +81,11 @@ export function getAnalytics(app: FirebaseApp = getApp()): Analytics {
 }
 
 /**
- * Returns a {@link Analytics} instance for the given app.
+ * Returns an {@link Analytics} instance for the given app.
  *
  * @public
  *
- * @param app - The `FirebaseApp` to use.
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
  */
 export function initializeAnalytics(
   app: FirebaseApp,
@@ -216,7 +216,7 @@ export function setAnalyticsCollectionEnabled(
   ).catch(e => logger.error(e));
 }
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -239,7 +239,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -262,7 +262,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -283,7 +283,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -305,7 +305,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -329,7 +329,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -349,7 +349,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -369,7 +369,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -388,7 +388,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -409,7 +409,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -435,7 +435,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -454,7 +454,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -473,7 +473,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -493,7 +493,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -514,7 +514,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -535,7 +535,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -555,7 +555,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -576,7 +576,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -595,7 +595,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -617,7 +617,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -638,7 +638,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -659,7 +659,7 @@ export function logEvent(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * @public
@@ -675,7 +675,7 @@ export function logEvent<T extends string>(
 ): void;
 
 /**
- * Sends Google Analytics event with given `eventParams`. This method
+ * Sends a Google Analytics event with given `eventParams`. This method
  * automatically associates this logged event with this Firebase web
  * app instance on this device.
  * List of official event parameters can be found in the gtag.js

packages-exp/analytics-exp/src/public-types.ts

@@ -80,7 +80,7 @@ export interface GtagConfigParams {
 }
 
 /**
- * Firebase Analytics instance initialization options.
+ * {@link Analytics} instance initialization options.
  * @public
  */
 export interface AnalyticsSettings {
@@ -92,7 +92,7 @@ export interface AnalyticsSettings {
 }
 
 /**
- * Additional options that can be passed to Firebase Analytics method
+ * Additional options that can be passed to Analytics method
  * calls such as `logEvent`, `setCurrentScreen`, etc.
  * @public
  */
@@ -110,7 +110,7 @@ export interface AnalyticsCallOptions {
  */
 export interface Analytics {
   /**
-   * The `FirebaseApp` this {@link Analytics} instance is associated with.
+   * The {@link @firebase/app#FirebaseApp} this {@link Analytics} instance is associated with.
    */
   app: FirebaseApp;
 }

packages-exp/app-check-exp/src/api.ts

@@ -44,7 +44,7 @@ export { ReCaptchaV3Provider, CustomProvider } from './providers';
 
 /**
  * Activate App Check for the given app. Can be called only once per app.
- * @param app - the `FirebaseApp` to activate App Check for
+ * @param app - the {@link @firebase/app#FirebaseApp} to activate App Check for
  * @param options - App Check initialization options
  * @public
  */
@@ -193,7 +193,7 @@ export function onTokenChanged(
   onCompletion?: () => void
 ): Unsubscribe;
 /**
- * Wraps addTokenListener/removeTokenListener methods in an `Observer`
+ * Wraps `addTokenListener`/`removeTokenListener` methods in an `Observer`
  * pattern for public use.
  */
 export function onTokenChanged(

packages-exp/app-check-exp/src/public-types.ts

@@ -26,7 +26,7 @@ export { Unsubscribe, PartialObserver } from '@firebase/util';
  */
 export interface AppCheck {
   /**
-   * The `FirebaseApp` this `AppCheck` instance is associated with.
+   * The {@link @firebase/app#FirebaseApp} this `AppCheck` instance is associated with.
    */
   app: FirebaseApp;
 }

packages-exp/app-exp/src/api.ts

@@ -49,7 +49,7 @@ import { deepEqual } from '@firebase/util';
 export const SDK_VERSION = version;
 
 /**
- * Creates and initializes a `FirebaseApp` instance.
+ * Creates and initializes a {@link @firebase/app#FirebaseApp} instance.
  *
  * See
  * {@link
@@ -156,7 +156,7 @@ export function initializeApp(
 }
 
 /**
- * Retrieves a `FirebaseApp` instance.
+ * Retrieves a {@link @firebase/app#FirebaseApp} instance.
  *
  * When called with no arguments, the default app is returned. When an app name
  * is provided, the app corresponding to that name is returned.

packages-exp/app-exp/src/public-types.ts

@@ -19,7 +19,7 @@ import { ComponentContainer } from '@firebase/component';
 import { PlatformLoggerService, VersionService } from './types';
 
 /**
- * A `FirebaseApp` holds the initialization information for a collection of
+ * A {@link @firebase/app#FirebaseApp} holds the initialization information for a collection of
  * services.
  *
  * Do not call this constructor directly. Instead, use

packages-exp/auth-exp/src/core/action_code_url.ts

@@ -115,7 +115,7 @@ export class ActionCodeURL {
 
   /**
    * @param actionLink - The link from which to extract the URL.
-   * @returns The ActionCodeURL object, or null if the link is invalid.
+   * @returns The {@link ActionCodeURL} object, or null if the link is invalid.
    *
    * @internal
    */
@@ -139,7 +139,7 @@ export class ActionCodeURL {
    * otherwise returns null.
    *
    * @param link  - The email action link string.
-   * @returns The `ActionCodeURL` object, or null if the link is invalid.
+   * @returns The {@link ActionCodeURL} object, or null if the link is invalid.
    *
    * @public
    */

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

@@ -358,7 +358,7 @@ export interface Persistence {
  * Interface representing ID token result obtained from {@link User.getIdTokenResult}.
  *
  * @remarks
- * It contains the ID token JWT string and other helper properties for getting different data
+ * `IdTokenResult` contains the ID token JWT string and other helper properties for getting different data
  * associated with the token as well as all the decoded payload claims.
  *
  * Note that these claims are not to be trusted as they are parsed client side. Only server side

packages-exp/functions-exp/src/api.ts

@@ -32,7 +32,7 @@ export * from './public-types';
 
 /**
  * Returns a {@link Functions} instance for the given app.
- * @param app - The `FirebaseApp` to use.
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
  * @param regionOrCustomDomain - one of:
  *   a) The region the callable functions are located in (ex: us-central1)
  *   b) A custom domain hosting the callable functions (ex: https://mydomain.com)

packages-exp/functions-exp/src/public-types.ts

@@ -50,12 +50,12 @@ export interface HttpsCallableOptions {
 }
 
 /**
- * An instance of Firebase Functions.
+ * A `Functions` instance.
  * @public
  */
 export interface Functions {
   /**
-   * The `FirebaseApp` this `Functions` instance is associated with.
+   * The {@link @firebase/app#FirebaseApp} this `Functions` instance is associated with.
    */
   app: FirebaseApp;
 

packages-exp/installations-exp/src/api/get-installations.ts

@@ -19,9 +19,9 @@ import { FirebaseApp, getApp, _getProvider } from '@firebase/app-exp';
 import { Installations } from '../interfaces/public-types';
 
 /**
- * Returns an instance of Firebase Installations associated with the given
- * `FirebaseApp` instance.
- * @param app - The `FirebaseApp` instance.
+ * Returns an instance of {@link Installations} associated with the given
+ * {@link @firebase/app#FirebaseApp} instance.
+ * @param app - The {@link @firebase/app#FirebaseApp} instance.
  *
  * @public
  */

packages-exp/performance-exp/src/index.ts

@@ -51,7 +51,7 @@ const DEFAULT_ENTRY_NAME = '[DEFAULT]';
 
 /**
  * Returns a {@link FirebasePerformance} instance for the given app.
- * @param app - The `FirebaseApp` to use.
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
  * @public
  */
 export function getPerformance(
@@ -65,7 +65,7 @@ export function getPerformance(
 
 /**
  * Returns a {@link FirebasePerformance} instance for the given app. Can only be called once.
- * @param app - The `FirebaseApp` to use.
+ * @param app - The {@link @firebase/app#FirebaseApp} to use.
  * @param settings - Optional settings for the {@link FirebasePerformance} instance.
  * @public
  */