X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2Frcfeed%2FRCFeedFormatter.php;h=f7e62ee6cfd60141513b21e6f7da1adc7290a82c;hb=ecdd1d6ff4d11d19bf446c74529cbbcca4aa1657;hp=6c9f804211fc18c95450da04478ed34012c8200c;hpb=b8af5d9485c3977d4ccea6a3ff2b28f535193237;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/rcfeed/RCFeedFormatter.php b/includes/rcfeed/RCFeedFormatter.php
index 6c9f804211..f7e62ee6cf 100644
--- a/includes/rcfeed/RCFeedFormatter.php
+++ b/includes/rcfeed/RCFeedFormatter.php
@@ -1,13 +1,39 @@
 <?php
+
+/**
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+/**
+ * Interface for RC feed formatters
+ *
+ * @since 1.22
+ */
 interface RCFeedFormatter {
 	/**
-	 * Formats the line for the live feed.
+	 * Formats the line to be sent by an engine
 	 *
 	 * @param array $feed The feed, as configured in an associative array.
 	 * @param RecentChange $rc The RecentChange object showing what sort
 	 *                         of event has taken place.
 	 * @param string|null $actionComment
-	 * @return string The text to send.
+	 * @return string|null The text to send.  If the formatter returns null,
+	 *  the line will not be sent.
 	 */
 	public function getLine( array $feed, RecentChange $rc, $actionComment );
 }