From 48af79dbb4cf1b4f915bf0d3d05e9fe3770664df Mon Sep 17 00:00:00 2001
From: Zach Copley <zach@status.net>
Date: Fri, 11 Dec 2009 17:50:10 -0800
Subject: Added a bunch of function commment blocks

---
 plugins/RSSCloud/LoggingAggregator.php | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

(limited to 'plugins/RSSCloud/LoggingAggregator.php')

diff --git a/plugins/RSSCloud/LoggingAggregator.php b/plugins/RSSCloud/LoggingAggregator.php
index 02175f43a..c81a987f7 100644
--- a/plugins/RSSCloud/LoggingAggregator.php
+++ b/plugins/RSSCloud/LoggingAggregator.php
@@ -32,6 +32,19 @@ if (!defined('STATUSNET')) {
     exit(1);
 }
 
+/**
+ * Dummy aggregator that acts as a proper notification handler. It
+ * doesn't do anything but respond correctly when notified via
+ * REST.  Mostly, this is just and action I used to develop the plugin
+ * and easily test things end-to-end. I'm leaving it in here as it
+ * may be useful for developing the plugin further.
+ *
+ * @category Plugin
+ * @package  StatusNet
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ **/
 class LoggingAggregatorAction extends Action
 {
 
@@ -45,6 +58,7 @@ class LoggingAggregatorAction extends Action
      *
      * @return boolean false if user doesn't exist
      */
+
     function prepare($args)
     {
         parent::prepare($args);
@@ -58,6 +72,14 @@ class LoggingAggregatorAction extends Action
         return true;
     }
 
+    /**
+     * Handle the request
+     *
+     * @param array $args $_REQUEST data (unused)
+     *
+     * @return void
+     */
+
     function handle($args)
     {
         parent::handle($args);
@@ -98,6 +120,14 @@ class LoggingAggregatorAction extends Action
                    $this->url . ' has been updated.');
     }
 
+    /**
+     * Show an XML error when things go badly
+     *
+     * @param string $msg the error message
+     *
+     * @return void
+     */
+
     function showError($msg)
     {
         header('HTTP/1.1 400 Bad Request');
-- 
cgit v1.2.3-54-g00ecf