style(lint): de-lint all jsdoc/typedoc comments

Author: mikehardy

packages/ai/lib/index.ts

@@ -49,7 +49,7 @@ export {
 
 /**
  * Returns the default {@link AI} instance that is associated with the provided
- * {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new instance with the
+ * {@link @firebase/app!FirebaseApp}. If no instance exists, initializes a new instance with the
  * default settings.
  *
  * @example
@@ -69,9 +69,9 @@ export {
  * const ai = getAI(app, { backend: new VertexAIBackend() });
  * ```
  *
- * @param app - The {@link @firebase/app#FirebaseApp} to use.
+ * @param app - The {@link @firebase/app!FirebaseApp} to use.
  * @param options - {@link AIOptions} that configure the AI instance.
- * @returns The default {@link AI} instance for the given {@link @firebase/app#FirebaseApp}.
+ * @returns The default {@link AI} instance for the given {@link @firebase/app!FirebaseApp}.
  *
  * @public
  */

packages/ai/lib/public-types.ts

@@ -87,7 +87,7 @@ export type BackendType = (typeof BackendType)[keyof typeof BackendType];
  */
 export interface AI {
   /**
-   * The {@link @firebase/app#FirebaseApp} this {@link AI} instance is associated with.
+   * The {@link @firebase/app!FirebaseApp} this {@link AI} instance is associated with.
    */
   app: ReactNativeFirebase.FirebaseApp;
   appCheck?: FirebaseAppCheckTypes.Module | null;

packages/ai/lib/types/imagen/requests.ts

@@ -73,7 +73,7 @@ export interface ImagenGenerationConfig {
   numberOfImages?: number;
   /**
    * The aspect ratio of the generated images. The default value is square 1:1.
-   * Supported aspect ratios depend on the Imagen model, see {@link (ImagenAspectRatio:type)}
+   * Supported aspect ratios depend on the Imagen model, see {@link ImagenAspectRatio}
    * for more details.
    */
   aspectRatio?: ImagenAspectRatio;

packages/ai/lib/types/imagen/responses.ts

@@ -71,8 +71,8 @@ export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGC
    * The reason that images were filtered out. This property will only be defined if one
    * or more images were filtered.
    *
-   * Images may be filtered out due to the {@link (ImagenSafetyFilterLevel:type)},
-   * {@link (ImagenPersonFilterLevel:type)}, or filtering included in the model.
+   * Images may be filtered out due to the {@link ImagenSafetyFilterLevel},
+   * {@link ImagenPersonFilterLevel}, or filtering included in the model.
    * The filter levels may be adjusted in your {@link ImagenSafetySettings}.
    *
    * See the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen | Responsible AI and usage guidelines for Imagen}

packages/ai/typedoc.json

@@ -1,5 +1,6 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "entryPoints": ["lib/index.ts"],
-  "tsconfig": "tsconfig.json"
+  "tsconfig": "tsconfig.json",
+  "intentionallyNotExported": ["ApiSettings", "WebSocketHandler"]
 }

packages/analytics/lib/modular.ts

@@ -948,10 +948,10 @@ export function initiateOnDeviceConversionMeasurementWithEmailAddress(
  * start privacy-sensitive on-device conversion management.
  * This is iOS-only.
  * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile
+ * {@link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials}
  *
  * @param analytics Analytics instance.
  * @param hashedEmailAddress sha256-hashed of normalized email address, properly formatted complete with domain name e.g, 'user@example.com'
- * @link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials
  */
 export function initiateOnDeviceConversionMeasurementWithHashedEmailAddress(
   analytics: Analytics,
@@ -988,10 +988,10 @@ export function initiateOnDeviceConversionMeasurementWithPhoneNumber(
  * start privacy-sensitive on-device conversion management.
  * This is iOS-only.
  * This is a no-op if you do not include '$RNFirebaseAnalyticsGoogleAppMeasurementOnDeviceConversion = true' in your Podfile
+ * {@link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials}
  *
  * @param analytics Analytics instance.
  * @param hashedPhoneNumber sha256-hashed of normalized phone number in E.164 format - that is a leading + sign, then up to 15 digits, no dashes or spaces.
- * @link https://firebase.google.com/docs/tutorials/ads-ios-on-device-measurement/step-3#use-hashed-credentials
  */
 export function initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(
   analytics: Analytics,
@@ -1031,9 +1031,10 @@ export function setConsent(analytics: Analytics, consentSettings: ConsentSetting
 /**
  * Configures Firebase Analytics to use custom gtag or dataLayer names.
  * Intended to be used if gtag.js script has been installed on this page independently of Firebase Analytics, and is using non-default names for either the gtag function or for dataLayer. Must be called before calling `getAnalytics()` or it won't have any effect. Web only.
- * @param {SettingsOptions} options - See SettingsOptions.
+ * @param {SettingsOptions} _options - See SettingsOptions - currently unused.
  * @returns {void}
  */
+
 export function settings(_options: SettingsOptions): void {
   // Returns nothing until Web implemented.
 }

packages/analytics/typedoc.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/modular.ts", "lib/types/analytics.ts"],
+  "tsconfig": "tsconfig.json",
+  "intentionallyNotExported": [
+    "_AddPaymentInfoEventParameters",
+    "_AddShippingInfoEventParameters",
+    "_AddShippingInfoParameters",
+    "_AddToCartEventParameters",
+    "_AddToWishlistEventParameters",
+    "_AnalyticsCallOptions",
+    "_AnalyticsSettings",
+    "_BeginCheckoutEventParameters",
+    "_CampaignDetailsEventParameters",
+    "_ConsentSettings",
+    "_EarnVirtualCurrencyEventParameters",
+    "_EventParams",
+    "_GenerateLeadEventParameters",
+    "_GtagConfigParams",
+    "_Item",
+    "_JoinGroupEventParameters",
+    "_LevelEndEventParameters",
+    "_LevelStartEventParameters",
+    "_LevelUpEventParameters",
+    "_LoginEventParameters",
+    "_PostScoreEventParameters",
+    "_PurchaseEventParameters",
+    "_RefundEventParameters",
+    "_RemoveFromCartEventParameters",
+    "_ScreenViewParameters",
+    "_SearchEventParameters",
+    "_SelectContentEventParameters",
+    "_SelectItemEventParameters",
+    "_SelectPromotionEventParameters",
+    "_SetCheckoutOptionEventParameters",
+    "_SettingsOptions",
+    "_ShareEventParameters",
+    "_SignUpEventParameters",
+    "_SpendVirtualCurrencyEventParameters",
+    "_Statics",
+    "_UnlockAchievementEventParameters",
+    "_ViewCartEventParameters",
+    "_ViewItemEventParameters",
+    "_ViewItemListEventParameters",
+    "_ViewPromotionEventParameters",
+    "_ViewSearchResultsParameters"
+  ]
+}

packages/app-check/typedoc.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["lib/modular.ts", "lib/types/appcheck.ts"],
+  "tsconfig": "tsconfig.json",
+  "intentionallyNotExported": [
+    "_AppCheck",
+    "_AppCheckListenerResult",
+    "_AppCheckOptions",
+    "_AppCheckProvider",
+    "_AppCheckStatics",
+    "_AppCheckToken",
+    "_AppCheckTokenResult",
+    "_CustomProviderOptions"
+  ]
+}

packages/app-distribution/typedoc.json

@@ -1,4 +1,8 @@
 {
   "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["lib/index.d.ts"]
+  "entryPoints": ["lib/modular/index.d.ts"],
+  "intentionallyNotExported": [
+    "FirebaseAppDistributionTypes.Module",
+    "FirebaseAppDistributionTypes.AppDistributionRelease"
+  ]
 }

packages/app/lib/types/app.ts

@@ -17,8 +17,6 @@
 
 /**
  * Core React Native Firebase package types.
- *
- * @firebase app
  */
 // eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace ReactNativeFirebase {
@@ -238,8 +236,6 @@ export namespace ReactNativeFirebase {
      * level is set to a higher (more verbose) setting.
      * Note that iOS is missing firebase-js-sdk log levels 'verbose' and 'silent'.
      * 'verbose' if used will map to 'debug', 'silent' has no valid mapping and will return an error if used.
-     *
-     * @ios
      */
     setLogLevel(logLevel: LogLevelString): void;
 
@@ -333,7 +329,7 @@ export namespace ReactNativeFirebase {
 }
 
 /**
- * @firebase utils
+ * A namespace used exlusively for native-related utilities
  */
 // eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace Utils {
@@ -350,13 +346,11 @@ export namespace Utils {
    */
   export interface FilePath {
     /**
-     * Returns an absolute path to the applications main bundle.
+     * Returns an absolute path to the applications main bundle - iOS only
      *
      * ```js
      * firebase.utils.FilePath.MAIN_BUNDLE;
      * ```
-     *
-     * @ios iOS only
      */
     MAIN_BUNDLE: string;
 
@@ -410,7 +404,7 @@ export namespace Utils {
     LIBRARY_DIRECTORY: string;
 
     /**
-     * Returns an absolute path to the directory on the primary shared/external storage device.
+     * Returns null on iOS, or on Android an absolute path to the directory on the primary shared/external storage device.
      *
      * Here your application can place persistent files it owns. These files are internal to the application, and not typically visible to the user as media.
      *
@@ -419,8 +413,6 @@ export namespace Utils {
      * ```js
      * firebase.utils.FilePath.EXTERNAL_DIRECTORY;
      * ```
-     *
-     * @android Android only - iOS returns null
      */
     EXTERNAL_DIRECTORY: string | null;
 
@@ -429,14 +421,12 @@ export namespace Utils {
      *
      * Traditionally this is an SD card, but it may also be implemented as built-in storage on a device.
      *
-     * Returns null if no external storage directory found, e.g. removable media has been ejected by the user.
+     * Returns null on iOS or if on android no external storage directory found, e.g. removable media has been ejected by the user.
      * Requires special permission granted by Play Store review team on Android, is unlikely to be a valid path.
      *
      * ```js
      * firebase.utils.FilePath.EXTERNAL_STORAGE_DIRECTORY;
      * ```
-     *
-     * @android Android only - iOS returns null
      */
     EXTERNAL_STORAGE_DIRECTORY: string | null;
 
@@ -497,57 +487,52 @@ export namespace Utils {
 
   export interface PlayServicesAvailability {
     /**
-     * Returns a numeric status code. Please refer to Android documentation
+     * Returns a numeric status code. Always 0 on iOS, For Android please refer to Android documentation
      * for further information:
      * https://developers.google.com/android/reference/com/google/android/gms/common/ConnectionResult
      *
      * ```js
      * firebase.utils().playServicesAvailability.status;
      * ```
-     *
-     * @android Android only - iOS returns 0
      */
     status: PlayServicesAvailabilityStatusCodes;
 
     /**
-     * Returns a boolean indicating whether Play Store is available on the device
+     * Returns a boolean indicating whether Play Store is available on the device, always true on iOS
      *
      * ```js
      * firebase.utils().playServicesAvailability.isAvailable;
      * ```
-     *
-     * @android Android only - iOS returns true
      */
     isAvailable: boolean;
 
     /**
      * If Play Services is not available on the device, hasResolution indicates
-     * whether it is possible to do something about it (e.g. install Play Services).
+     * whether it is possible to do something about it (e.g. install Play Services),
+     * always returns undefined on iOS
      *
      * ```js
      * firebase.utils().playServicesAvailability.hasResolution;
      * ```
-     * @android Android only - iOS returns undefined
      */
     hasResolution: boolean | undefined;
 
     /**
-     * If an error was received, this indicates whether the error is resolvable
+     * If an error was received, this indicates whether the error is resolvable,
+     * always returns undefined on iOS
      *
      * ```js
      * firebase.utils().playServicesAvailability.isUserResolvableError;
      * ```
-     * @android Android only - iOS returns undefined
      */
     isUserResolvableError: boolean | undefined;
 
     /**
-     * A human readable error string
+     * A human readable error string, always undefined on iOS
      *
      * ```js
      * firebase.utils().playServicesAvailability.error;
      * ```
-     * @android Android only - iOS returns undefined
      */
     error: string | undefined;
   }
@@ -567,76 +552,65 @@ export namespace Utils {
    */
   export abstract class Module extends FirebaseModule {
     /**
-     * Returns true if this app is running inside a Firebase Test Lab environment.
+     * Returns true if this app is running inside a Firebase Test Lab environment, always false on iOS
      *
      * #### Example
      *
      * ```js
      * const isRunningInTestLab = await firebase.utils().isRunningInTestLab;
      * ```
-     * @android Android only - iOS returns false
      */
     abstract isRunningInTestLab: boolean;
     /**
-     * Returns PlayServicesAvailability properties
+     * Returns PlayServicesAvailability properties, always `{ isAvailable: true, status: 0 }` on iOS
      *
      * #### Example
      *
      * ```js
      * const PlayServicesAvailability = await firebase.utils().playServicesAvailability;
      * ```
-     *
-     * @android Android only - iOS always returns { isAvailable: true, status: 0 }
      */
     abstract playServicesAvailability: PlayServicesAvailability;
 
     /**
-     * Returns PlayServicesAvailability properties
+     * Returns PlayServicesAvailability properties, always `{ isAvailable: true, status: 0 }` on iOS
      *
      * #### Example
      *
      * ```js
      * const PlayServicesAvailability = await firebase.utils().getPlayServicesStatus();
      * ```
-     *
-     * @android Android only - iOS always returns { isAvailable: true, status: 0 }
      */
     abstract getPlayServicesStatus(): Promise<PlayServicesAvailability>;
 
     /**
-     * A prompt appears on the device to ask the user to update play services
+     * A prompt appears on the device to ask the user to update play services, returns undefined on iOS
      *
      * #### Example
      *
      * ```js
      * await firebase.utils().promptForPlayServices();
      * ```
-     *
-     * @android Android only - iOS returns undefined
      */
     abstract promptForPlayServices(): Promise<void>;
     /**
-     * Attempts to make Google Play services available on this device
+     * Attempts to make Google Play services available on this device, returns undefined on iOS
      *
      * #### Example
      *
      * ```js
      * await firebase.utils().makePlayServicesAvailable();
      * ```
-     *
-     * @android Android only - iOS returns undefined
      */
     abstract makePlayServicesAvailable(): Promise<void>;
     /**
-     * Resolves an error by starting any intents requiring user interaction.
+     * Resolves an error by starting any intents requiring user interaction, returns undefined on iOS
      *
      * #### Example
      *
      * ```js
      * await firebase.utils().resolutionForPlayServices();
      * ```
-     *
-     * @android Android only - iOS returns undefined
      */
     abstract resolutionForPlayServices(): Promise<void>;
   }