From 17afc4b3c47807a1cf8010aab1faffd6c99ae97a Mon Sep 17 00:00:00 2001
From: Philipp Hofmann <philipp.hofmann@sentry.io>
Date: Tue, 2 May 2023 14:22:51 +0200
Subject: [PATCH] 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.
---
 Sources/Sentry/Public/SentrySDK.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/Sources/Sentry/Public/SentrySDK.h b/Sources/Sentry/Public/SentrySDK.h
index 8b5a67ffc26..344eb1ffe0b 100644
--- 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;