From e635caf283183e52fbaed062d5c5925c1d42afec Mon Sep 17 00:00:00 2001
From: AI-scor <354880559+AI-scor@users.noreply.github.com>
Date: Tue, 10 Nov 2026 16:29:31 +0100
Subject: [PATCH] [Docs] Document what CrashReporter::sendReport returns

---
 cockatrice/src/client/crash/crash_reporter.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/cockatrice/src/client/crash/crash_reporter.h b/cockatrice/src/client/crash/crash_reporter.h
index f06103188..cd14ba74f 100644
--- a/cockatrice/src/client/crash/crash_reporter.h
+++ b/cockatrice/src/client/crash/crash_reporter.h
@@ -74,6 +74,12 @@ public:
     void shutdown();
     void giveConsent();
     void revokeConsent();
+    /**
+     * @return true once the event is queued to the local transport; delivery happens later
+     * and is not reported here. false also covers a captured event whose attachment failed,
+     * so false does not mean "nothing was captured" - callers offer the local-save fallback
+     * rather than treating the report as absent.
+     */
     bool sendReport(const QString &redactedPreview, const QString &userNote = QString());
 
     /**