[skip ci] docs

packages/analytics/lib/index.d.ts

@@ -85,7 +85,7 @@ export namespace Analytics {
      * });
      * ```
      *
-     * @note 100 characters is the maximum length for param key names.
+     * > 100 characters is the maximum length for param key names.
      *
      * @param name Event name must not conflict with any Reserved Events.
      * @param params Parameters to be sent and displayed with the event.
@@ -103,9 +103,7 @@ export namespace Analytics {
      * await firebase.analytics().setAnalyticsCollectionEnabled(false);
      * ```
      *
-     * @note Analytics collection is enabled by default.
-     *
-     * @param enabled A boolean value representing whether Analytics collection is enabled or disabled.
+     * @param enabled A boolean value representing whether Analytics collection is enabled or disabled. Analytics collection is enabled by default.
      */
     setAnalyticsCollectionEnabled(enabled: boolean): Promise<void>;
 
@@ -118,7 +116,7 @@ export namespace Analytics {
      * await firebase.analytics().setCurrentScreen('ProductScreen', 'ProductScreen');
      * ```
      *
-     * @note Whilst screenClassOverride is optional, it is recommended it is
+     * > Whilst screenClassOverride is optional, it is recommended it is
      * always sent as your current class name. For example on Android it will always
      * show as 'MainActivity' if you do not specify it.
      *

packages/analytics/lib/index.js.flow

@@ -32,9 +32,7 @@ export interface Module extends ReactNativeFirebaseModule {
    * });
    * ```
    *
-   * @note 100 characters is the maximum length for param key names.
-   *
-   * @param name Event name must not conflict with any Reserved Events.
+   * @param name Event name must not conflict with any Reserved Events. 100 characters is the maximum length for param key names.
    * @param params Parameters to be sent and displayed with the event.
    */
   logEvent(name: string, params: { [key: string]: string }): Promise<void>;
@@ -50,9 +48,7 @@ export interface Module extends ReactNativeFirebaseModule {
    * await firebase.analytics().setAnalyticsCollectionEnabled(false);
    * ```
    *
-   * @note Analytics collection is enabled by default.
-   *
-   * @param enabled A boolean value representing whether Analytics collection is enabled or disabled.
+   * @param enabled A boolean value representing whether Analytics collection is enabled or disabled. Analytics collection is enabled by default.
    */
   setAnalyticsCollectionEnabled(enabled: boolean): Promise<void>;
 
@@ -65,7 +61,7 @@ export interface Module extends ReactNativeFirebaseModule {
    * await firebase.analytics().setCurrentScreen('ProductScreen', 'ProductScreen');
    * ```
    *
-   * @note Whilst screenClassOverride is optional, it is recommended it is
+   * > Whilst screenClassOverride is optional, it is recommended it is
    * always sent as your current class name. For example on Android it will always
    * show as 'MainActivity' if you do not specify it.
    *

packages/functions/lib/index.d.ts

@@ -61,7 +61,6 @@ export namespace Functions {
   /**
    * The set of Firebase Functions status codes.
    *
-   * @note
    * The codes are the same at the ones exposed by [gRPC](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md).
    *
    * Possible values:

packages/functions/lib/index.js.flow

@@ -20,7 +20,6 @@ import { ReactNativeFirebaseModule } from '@react-native-firebase/app-types/inde
 /**
  * The set of Firebase Functions status codes.
  *
- * @note
  * The codes are the same at the ones exposed by [gRPC](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md).
  *
  * Possible values:

packages/invites/lib/index.d.ts

@@ -118,7 +118,7 @@ export namespace Invites {
      * This url is a link that will launch the app if already installed or take the user to the appropriate app store
      * if not. In both cases the deep link will be available if provided using setDeepLink(Uri).
      *
-     * @warning Cannot be used with {@link invites.InviteBuilder#setCallToActionText}
+     * > Cannot be used with {@link invites.InviteBuilder#setCallToActionText}
      *
      * #### Example
      *
@@ -209,7 +209,7 @@ export namespace Invites {
     /**
      * Text shown on the email invitation for the user to accept the invitation. Default install text used if not set.
      *
-     * @warning Cannot be used with {@link invites.AndroidInviteBuilder#setEmailHtmlContent}.
+     * > Cannot be used with {@link invites.AndroidInviteBuilder#setEmailHtmlContent}.
      *
      * #### Example
      *

packages/invites/lib/index.js.flow

@@ -78,7 +78,7 @@ export interface AndroidInviteBuilder {
    * This url is a link that will launch the app if already installed or take the user to the appropriate app store
    * if not. In both cases the deep link will be available if provided using setDeepLink(Uri).
    *
-   * @warning Cannot be used with {@link invites.InviteBuilder#setCallToActionText}
+   * > Cannot be used with {@link invites.InviteBuilder#setCallToActionText}
    *
    * #### Example
    *
@@ -169,7 +169,7 @@ export interface InviteBuilder {
   /**
    * Text shown on the email invitation for the user to accept the invitation. Default install text used if not set.
    *
-   * @warning Cannot be used with {@link invites.AndroidInviteBuilder#setEmailHtmlContent}.
+   * > Cannot be used with {@link invites.AndroidInviteBuilder#setEmailHtmlContent}.
    *
    * #### Example
    *

packages/perf/lib/index.d.ts

@@ -279,7 +279,7 @@ export namespace Perf {
      * const response = await fetch(url);
      * metric.setHttpResponseCode(response.status);
      * ```
-     * @warning This is required for every request, if you do not provide this your metric will not be captured.
+     * > This is required for every request, if you do not provide this your metric will not be captured.
      *
      *
      * @param code Value must be greater than 0. Set to null to remove. Invalid usage will be logged natively.

packages/perf/lib/index.js.flow

@@ -241,7 +241,7 @@ export interface HttpMetric {
    * const response = await fetch(url);
    * metric.setHttpResponseCode(response.status);
    * ```
-   * @warning This is required for every request, if you do not provide this your metric will not be captured.
+   * > This is required for every request, if you do not provide this your metric will not be captured.
    *
    * @param code Value must be greater than 0. Set to null to remove. Invalid usage will be logged natively.
    */