From 4471f62bc5d883fda015156ec7d3391cc7f3ac41 Mon Sep 17 00:00:00 2001
From: Robin Millette <millette@plantard.controlezvous.ca>
Date: Tue, 20 Jan 2009 20:55:16 +0000
Subject: uiredesign + phpdocs

---
 actions/logout.php | 47 +++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 41 insertions(+), 6 deletions(-)

(limited to 'actions/logout.php')

diff --git a/actions/logout.php b/actions/logout.php
index 86d6270ab..0ff8dc754 100644
--- a/actions/logout.php
+++ b/actions/logout.php
@@ -1,5 +1,16 @@
 <?php
-/*
+/**
+ * Logout action.
+ *
+ * PHP version 5
+ *
+ * @category Action
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Robin Millette <millette@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://laconi.ca/
+ *
  * Laconica - a distributed open-source microblogging tool
  * Copyright (C) 2008, Controlez-Vous, Inc.
  *
@@ -17,18 +28,42 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/openid.php');
+require_once INSTALLDIR.'/lib/openid.php';
 
+/**
+ * Logout action class.
+ *
+ * @category Action
+ * @package  Laconica
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @author   Robin Millette <millette@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://laconi.ca/
+ */
 class LogoutAction extends Action
 {
     
+    /**
+     * This is read only.
+     * 
+     * @return boolean true
+     */
     function isReadOnly()
     {
         return true;
     }
-    
+
+    /**
+     * Class handler.
+     * 
+     * @param array $args array of arguments
+     *
+     * @return nothing
+     */
     function handle($args)
     {
         parent::handle($args);
@@ -36,8 +71,8 @@ class LogoutAction extends Action
             $this->clientError(_('Not logged in.'));
         } else {
             common_set_user(null);
-            common_real_login(false); # not logged in
-            common_forgetme(); # don't log back in!
+            common_real_login(false); // not logged in
+            common_forgetme(); // don't log back in!
             common_redirect(common_local_url('public'));
         }
     }
-- 
cgit v1.2.3-54-g00ecf