From 8a769cddcd1a063dd9400518ff65c0b1f1aec1b4 Mon Sep 17 00:00:00 2001
From: Alexey Rusakov <Kitsune-Ral@users.sf.net>
Date: Sun, 28 Nov 2021 16:53:51 +0100
Subject: Comment on const return types in event.h
Proper linters recognise that the returned types are not primitive,
while people might still be confused a bit.
---
lib/events/event.cpp | 3 ---
lib/events/event.h | 3 +++
2 files changed, 3 insertions(+), 3 deletions(-)
(limited to 'lib')
diff --git a/lib/events/event.cpp b/lib/events/event.cpp
index 3d66ab55..96be717c 100644
--- a/lib/events/event.cpp
+++ b/lib/events/event.cpp
@@ -46,14 +46,11 @@ 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();
diff --git a/lib/events/event.h b/lib/events/event.h
index e45fecca..998a386c 100644
--- a/lib/events/event.h
+++ b/lib/events/event.h
@@ -220,6 +220,9 @@ public:
// a "content" object; but since its structure is different for
// different types, we're implementing it per-event type.
+ // NB: const return types below are meant to catch accidental attempts
+ // to change event JSON (e.g., consider contentJson()["inexistentKey"]).
+
const QJsonObject contentJson() const;
template <typename T = QJsonValue, typename KeyT>
--
cgit v1.2.3