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

1 files changed, 1 insertions, 1 deletions

diff --git a/lib/events/event.h b/lib/events/event.h
index 76e77cf6..c51afcc4 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 ===