From 7c29f33121f58a52f43fa83183eaca47fa374980 Mon Sep 17 00:00:00 2001
From: Kitsune Ral <Kitsune-Ral@users.sf.net>
Date: Sun, 27 Dec 2020 18:33:51 +0100
Subject: More comments/documentation

Notably, recommend using loginFlowsChanged() rather than
homeserverChanged() to detect when a Connection object is ready for
a login sequence. Related: #427.
---
 lib/events/event.cpp | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'lib/events')

diff --git a/lib/events/event.cpp b/lib/events/event.cpp
index 96e33864..7b34114d 100644
--- a/lib/events/event.cpp
+++ b/lib/events/event.cpp
@@ -61,11 +61,14 @@ QString Event::matrixType() const { return fullJson()[TypeKeyL].toString(); }
 
 QByteArray Event::originalJson() const { return QJsonDocument(_json).toJson(); }
 
+// On const below: this is to catch accidental attempts to change event JSON
+// NOLINTNEXTLINE(readability-const-return-type)
 const QJsonObject Event::contentJson() const
 {
     return fullJson()[ContentKeyL].toObject();
 }
 
+// NOLINTNEXTLINE(readability-const-return-type)
 const QJsonObject Event::unsignedJson() const
 {
     return fullJson()[UnsignedKeyL].toObject();
-- 
cgit v1.2.3