From: ayush_garg <ayush.ce13@iitp.ac.in>
Date: Tue, 3 Feb 2015 19:09:15 +0000 (+0530)
Subject: Improve documentation of ChannelFeed and AtomFeed class
X-Git-Tag: 1.31.0-rc.0~12516^2
X-Git-Url: http://git.cyclocoop.org/%40spipnet%40?a=commitdiff_plain;h=e2a257ac7fee1582fe1233c0c64a779f9bb43b9a;p=lhc%2Fweb%2Fwiklou.git

Improve documentation of ChannelFeed and AtomFeed class

Change-Id: I1bebaf2d17ac71490aab3ab9cd1f08a4bb1fc3fb
---

diff --git a/includes/Feed.php b/includes/Feed.php
index 2fdfa424c4..9be3f577cb 100644
--- a/includes/Feed.php
+++ b/includes/Feed.php
@@ -184,7 +184,8 @@ class FeedItem {
 }
 
 /**
- * @todo document (needs one-sentence top-level class description).
+ * Class to support the outputting of syndication feeds in Atom and RSS format.
+ *
  * @ingroup Feed
  */
 abstract class ChannelFeed extends FeedItem {
@@ -338,13 +339,14 @@ class RSSFeed extends ChannelFeed {
  */
 class AtomFeed extends ChannelFeed {
 	/**
-	 * @todo document
-	 * @param string|int $ts
+	 * Format a date given timestamp.
+	 *
+	 * @param string|int $timestamp
 	 * @return string
 	 */
-	function formatTime( $ts ) {
+	function formatTime( $timestamp ) {
 		// need to use RFC 822 time format at least for rss2.0
-		return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX, $ts ) );
+		return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX, $timestamp ) );
 	}
 
 	/**