aboutsummaryrefslogtreecommitdiff
path: root/lib/events/event.h
diff options
context:
space:
mode:
authorAlexey Rusakov <Kitsune-Ral@users.sf.net>2021-11-28 16:53:51 +0100
committerAlexey Rusakov <Kitsune-Ral@users.sf.net>2021-11-28 16:53:51 +0100
commit8a769cddcd1a063dd9400518ff65c0b1f1aec1b4 (patch)
tree4b9a686edd9f482182353fa50f535507bf6f27e6 /lib/events/event.h
parentca1ba482b50c41425bd0a540c7bb68406d10e552 (diff)
downloadlibquotient-8a769cddcd1a063dd9400518ff65c0b1f1aec1b4.tar.gz
libquotient-8a769cddcd1a063dd9400518ff65c0b1f1aec1b4.zip
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.
Diffstat (limited to 'lib/events/event.h')
-rw-r--r--lib/events/event.h3
1 files changed, 3 insertions, 0 deletions
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>