Improve documentation of ChannelFeed and AtomFeed class

Change-Id: I1bebaf2d17ac71490aab3ab9cd1f08a4bb1fc3fb

diff --git a/includes/Feed.php b/includes/Feed.php
index 2fdfa42..9be3f57 100644 (file)
--- 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 ) );
        }
 
        /**