docs: Clarify no debugger for SentrySDK.crash (#2976)

Clarify in code docs to not use a debugger attached when testing the SDK with SentrySDK.crash.
getsentry · May 2, 2023 · 17afc4b · 17afc4b
1 parent 14a1101
commit 17afc4b
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/Sources/Sentry/Public/SentrySDK.h b/Sources/Sentry/Public/SentrySDK.h
@@ -269,7 +269,11 @@ SENTRY_NO_INIT
 + (void)endSession;
 
 /**
- * This forces a crash, useful to test the @c SentryCrash integration
+ * This forces a crash, useful to test the @c SentryCrash integration.
+ *
+ * @note The SDK can't report a crash when a debugger is attached. Your application needs to run
+ * without a debugger attached to capture the crash and send it to Sentry the next time you launch
+ * your application.
  */
 + (void)crash;