partkeepr

commit 55f29536f4513ab6f0ff7619bc504619383f1ab4
parent ea5f2718fcf56927203a107f3b585bc378c3452d
Author: Timo A. Hummel <felicitus@felicitus.org>
Date:   Fri,  6 Nov 2015 22:19:52 +0100

Added method documentation, related to #474

Diffstat:
M
src/PartKeepr/FrontendBundle/Resources/public/js/Components/Auth/LoginManager.js
 | 
7
++++++-

1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/src/PartKeepr/FrontendBundle/Resources/public/js/Components/Auth/LoginManager.js b/src/PartKeepr/FrontendBundle/Resources/public/js/Components/Auth/LoginManager.js
@@ -62,7 +62,8 @@ Ext.define('PartKeepr.Auth.LoginManager', {
         }
     },
     /**
-     * Triggers the logout process.
+     * Triggers the logout process by calling the backend's logout function, which in turn
+     * clears the session information and de-authenticates the user.
      */
     logout: function ()
     {
@@ -72,6 +73,10 @@ Ext.define('PartKeepr.Auth.LoginManager', {
             true
         );
     },
+    /**
+     * Callback for the logout action. Fires the logout event, which destroys
+     * all windows.
+     */
     onLogout: function () {
         this.loggedIn = false;
         this.fireEvent("logout");