From a3150b2050f2669b1e263db7213235e0a317ae31 Mon Sep 17 00:00:00 2001
From: Kitsune Ral <Kitsune-Ral@users.sf.net>
Date: Sun, 11 Nov 2018 15:24:13 +0900
Subject: Improvements in comments

- registerEventType(): comment the cryptic _ variable
- Room::postEvent: document the return value
- Room::Private: upgrade comments to doc-comments - even though in Private, they still are helpful to show hints in IDEs.
- General cleanup
---
 lib/events/event.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib/events')

diff --git a/lib/events/event.h b/lib/events/event.h
index 5b33628f..e0d83976 100644
--- a/lib/events/event.h
+++ b/lib/events/event.h
@@ -209,7 +209,7 @@ namespace QMatrixClient
     inline auto registerEventType()
     {
         static const auto _ = setupFactory<EventT>();
-        return _;
+        return _; // Only to facilitate usage in static initialisation
     }
 
     // === Event ===
-- 
cgit v1.2.3