uiredesign + phpdocs

diff --git a/actions/opensearch.php b/actions/opensearch.php
index 6e6e794e9603b16dbec2bbf60efa3db04f09cc4a..d7705972f0d68055cdaf693efe98cd73af2c29b9 100644 (file)
--- a/actions/opensearch.php
+++ b/actions/opensearch.php
@@ -1,5 +1,17 @@
 <?php
-/*
+
+/**
+ * Opensearch action class.
+ *
+ * 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,32 +29,46 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+    exit(1);
+}
 
+/**
+ * Opensearch action class.
+ *
+ * Formatting of RSS handled by Rss10Action
+ *
+ * @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 OpensearchAction extends Action
 {
-
+    /**
+     * Class handler.
+     *
+     * @param array $args query arguments
+     * 
+     * @return boolean false if user doesn't exist
+     */
     function handle($args)
     {
-
         parent::handle($args);
-
-        $type = $this->trimmed('type');
-
+        $type       = $this->trimmed('type');
         $short_name = '';
         if ($type == 'people') {
-            $type = 'peoplesearch';
+            $type       = 'peoplesearch';
             $short_name = _('People Search');
         } else {
+            $type       = 'noticesearch';
             $short_name = _('Notice Search');
-            $type = 'noticesearch';
         }
-
         header('Content-Type: text/html');
-
         common_start_xml();
         $this->elementStart('OpenSearchDescription', array('xmlns' => 'http://a9.com/-/spec/opensearch/1.1/'));
-
         $short_name =  common_config('site', 'name').' '.$short_name;
         $this->element('ShortName', null, $short_name);
         $this->element('Contact', null, common_config('site', 'email'));
@@ -54,8 +80,8 @@ class OpensearchAction extends Action
         $this->element('Language', null, common_language());
         $this->element('OutputEncoding', null, 'UTF-8');
         $this->element('InputEncoding', null, 'UTF-8');
-
         $this->elementEnd('OpenSearchDescription');
         common_end_xml();
     }
 }
+