From e144da75e390b064ac95a59be29a0c318caea095 Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Thu, 4 Aug 2016 10:49:34 +0100
Subject: [PATCH] Comment onLoggedOut & consistent comment style

---
 src/Lifecycle.js | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/Lifecycle.js b/src/Lifecycle.js
index 4393c29d37..23bf5f60a5 100644
--- a/src/Lifecycle.js
+++ b/src/Lifecycle.js
@@ -79,6 +79,10 @@ function startMatrixClient() {
     MatrixClientPeg.start();
 }
 
+/*
+ * Stops a running client and all related services, used after
+ * a session has been logged out / ended.
+ */
 function onLoggedOut() {
     if (window.localStorage) {
         const hsUrl = window.localStorage.getItem("mx_hs_url");
@@ -95,7 +99,9 @@ function onLoggedOut() {
     dis.dispatch({action: 'on_logged_out'});
 }
 
-// stop all the background processes related to the current client
+/**
+ * Stop all the background processes related to the current client
+ */
 function _stopMatrixClient() {
     Notifier.stop();
     UserActivity.stop();