From adbb3a52e5260c950933672bccde59973aae0fd1 Mon Sep 17 00:00:00 2001
From: ehesp <elliot.hesp@gmail.com>
Date: Mon, 29 Apr 2019 17:12:04 +0100
Subject: [PATCH] [skip ci] docs

---
 packages/analytics/lib/index.d.ts    | 16 ++++++++--------
 packages/analytics/lib/index.js.flow | 16 ++++++++--------
 2 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/packages/analytics/lib/index.d.ts b/packages/analytics/lib/index.d.ts
index 60c38331..4b3fd9ec 100644
--- a/packages/analytics/lib/index.d.ts
+++ b/packages/analytics/lib/index.d.ts
@@ -38,8 +38,6 @@ export namespace Analytics {
     /**
      * Log a custom event with optional params.
      *
-     * @note 100 characters is the maximum length for param key names.
-     *
      * #### Example
      *
      * ```js
@@ -48,6 +46,8 @@ export namespace Analytics {
      * });
      * ```
      *
+     * @note 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.
      */
@@ -57,8 +57,6 @@ export namespace Analytics {
      * If true, allows the device to collect analytical data and send it to Firebase.
      * Useful for GDPR.
      *
-     * @note Analytics collection is enabled by default.
-     *
      * #### Example
      *
      * ```js
@@ -66,6 +64,8 @@ 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.
      */
     setAnalyticsCollectionEnabled(enabled: boolean): Promise<void>;
@@ -73,16 +73,16 @@ export namespace Analytics {
     /**
      * Sets the current screen name.
      *
-     * @note 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.
-     *
      * #### Example
      *
      * ```js
      * await firebase().analytics().setCurrentScreen('ProductScreen', 'ProductScreen');
      * ```
      *
+     * @note 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.
+     *
      * @param screenName A screen name, e.g. Product.
      * @param screenClassOverride On Android, React Native runs in a single activity called
      * 'MainActivity'. Setting this parameter overrides the default name shown on logs.
diff --git a/packages/analytics/lib/index.js.flow b/packages/analytics/lib/index.js.flow
index 5f435c68..add4edd3 100644
--- a/packages/analytics/lib/index.js.flow
+++ b/packages/analytics/lib/index.js.flow
@@ -24,8 +24,6 @@ export interface Module extends ReactNativeFirebaseModule {
   /**
    * Log a custom event with optional params.
    *
-   * @note 100 characters is the maximum length for param key names.
-   *
    * #### Example
    *
    * ```js
@@ -34,6 +32,8 @@ 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 params Parameters to be sent and displayed with the event.
    */
@@ -43,8 +43,6 @@ export interface Module extends ReactNativeFirebaseModule {
    * If true, allows the device to collect analytical data and send it to Firebase.
    * Useful for GDPR.
    *
-   * @note Analytics collection is enabled by default.
-   *
    * #### Example
    *
    * ```js
@@ -52,6 +50,8 @@ 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.
    */
   setAnalyticsCollectionEnabled(enabled: boolean): Promise<void>;
@@ -59,16 +59,16 @@ export interface Module extends ReactNativeFirebaseModule {
   /**
    * Sets the current screen name.
    *
-   * @note 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.
-   *
    * #### Example
    *
    * ```js
    * await firebase().analytics().setCurrentScreen('ProductScreen', 'ProductScreen');
    * ```
    *
+   * @note 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.
+   *
    * @param screenName A screen name, e.g. Product.
    * @param screenClassOverride On Android, React Native runs in a single activity called
    * 'MainActivity'. Setting this parameter overrides the default name shown on logs.