Add JSDoc for _getBaggageWithSentryValues function

Author: Lms24

packages/tracing/src/span.ts

@@ -356,9 +356,17 @@ export class Span implements SpanInterface {
   }
 
   /**
+   * Collects and adds data to the passed baggage object.
+   *
+   * Note: This function does not explicitly check if the passed baggage object is allowed
+   * to be modified. Implicitly, `setBaggageValue` will not make modification to the object
+   * if it was already set immutable.
+   *
+   * After adding the data, the baggage object is set immutable to prevent further modifications.
    *
    * @param baggage
-   * @returns
+   *
+   * @returns modified and immutable maggage object
    */
   private _getBaggageWithSentryValues(baggage: Baggage = createBaggage({})): Baggage {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any