From 067633a608a7567168cadf96e1bd1d5907931430 Mon Sep 17 00:00:00 2001
From: Luke Fitzgerald <lw.fitzgerald@googlemail.com>
Date: Sat, 7 Aug 2010 16:32:17 -0700
Subject: Added more commenting

---
 plugins/Irc/ChannelResponseChannel.php | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'plugins/Irc/ChannelResponseChannel.php')

diff --git a/plugins/Irc/ChannelResponseChannel.php b/plugins/Irc/ChannelResponseChannel.php
index 580a3c12d..d29a1da02 100644
--- a/plugins/Irc/ChannelResponseChannel.php
+++ b/plugins/Irc/ChannelResponseChannel.php
@@ -35,11 +35,25 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
 class ChannelResponseChannel extends IMChannel {
     protected $ircChannel;
 
+    /**
+    * Construct a ChannelResponseChannel
+    *
+    * @param IMplugin $imPlugin IMPlugin
+    * @param string $ircChannel IRC Channel to reply to
+    * @return ChannelResponseChannel
+    */
     public function __construct($imPlugin, $ircChannel) {
         $this->ircChannel = $ircChannel;
         parent::__construct($imPlugin);
     }
 
+    /**
+    * Send a message using the plugin
+    *
+    * @param User $user User
+    * @param string $text Message text
+    * @return void
+    */
     public function output($user, $text) {
         $text = $user->nickname.': ['.common_config('site', 'name') . '] ' . $text;
         $this->imPlugin->send_message($this->ircChannel, $text);
-- 
cgit v1.2.3-54-g00ecf