ref(profiling) add comment

Author: JonasBa

packages/core/src/profiling.ts

@@ -5,7 +5,9 @@ import { DEBUG_BUILD } from "./debug-build";
 import { getClient } from "./currentScopes";
 
 /**
- *
+ * Starts the Sentry continuous profiler.
+ * This mode is exclusive with the transaction profiler and will only work if the profilesSampleRate is set to a falsy value.
+ * In continuous profiling mode, the profiler will keep reporting profile chunks to Sentry until it is stopped, which allows for continuous profiling of the application.
  */
 function startProfiler() {
   const client = getClient()
@@ -23,7 +25,8 @@ function startProfiler() {
 }
 
 /**
- *
+ * Stops the Sentry continuous profiler.
+ * Calls to stop will stop the profiler and flush the currently collected profile data to Sentry.
  */
 function stopProfiler() {
   const client = getClient()