Merge pull request #2715 from DataDog/yl/account-info/documentation

RUM-10247: Update `setUserInfo` and `setAccountInfo` documentation

Author: ambushwork

dd-sdk-android-core/src/main/kotlin/com/datadog/android/Datadog.kt

@@ -9,6 +9,7 @@ package com.datadog.android
 import android.content.Context
 import androidx.annotation.AnyThread
 import androidx.annotation.WorkerThread
+import com.datadog.android.Datadog.clearAccountInfo
 import com.datadog.android.api.InternalLogger
 import com.datadog.android.api.SdkCore
 import com.datadog.android.api.context.UserInfo
@@ -260,7 +261,10 @@ object Datadog {
     }
 
     /**
-     * Sets the user information.
+     * Sets the information used to identify a real user.
+     *
+     * This API should be used to assign a stable identifier for the user, such as a user ID,
+     * email, or username. The information set here will be added to logs, traces and RUM events.
      *
      * @param id (nullable) a unique user identifier (relevant to your business domain)
      * @param name (nullable) the user name or alias
@@ -315,9 +319,14 @@ object Datadog {
     }
 
     /**
-     * Sets current account information.
+     * Sets the account information that the user is currently logged into.
+     *
+     * This API should be used to assign an identifier for the user's account which represents a
+     * contextual identity within the app, typically tied to business or tenant logic. The
+     * information set here will be added to logs, traces and RUM events.
      *
-     * Those will be added to logs, traces and RUM events automatically.
+     * This value should be set when user logs in with his account, and cleared by calling
+     * [clearAccountInfo] when he logs out.
      *
      * @param id Account ID.
      * @param name representing the account, if exists.
@@ -340,7 +349,8 @@ object Datadog {
         )
     }
 
-    /** Add custom attributes to the current account information
+    /**
+     * Add custom attributes to the current account information.
      *
      * This extra info will be added to already existing extra info that is added
      * to Logs, Traces and RUM events automatically.
@@ -358,7 +368,8 @@ object Datadog {
         sdkCore.addAccountExtraInfo(extraInfo)
     }
 
-    /** Clear the current account information
+    /**
+     * Clear the current account information.
      *
      * Account information will set to null
      * Following Logs, Traces, RUM Events will not include the account information anymore.