From: Antoine Musso <hashar@users.mediawiki.org>
Date: Fri, 3 Sep 2004 23:53:56 +0000 (+0000)
Subject: some comments
X-Git-Tag: 1.5.0alpha1~2122
X-Git-Url: http://git.cyclocoop.org/%22%20.%20generer_url_ecrire%28%22auteur_infos%22%2C%20%22id_auteur=%24id%22%29%20.%20%22?a=commitdiff_plain;h=486a5a21c1bfdd0f2927b91e8d64d5d15d1db571;p=lhc%2Fweb%2Fwiklou.git

some comments
---

diff --git a/includes/Feed.php b/includes/Feed.php
index 9caf38876e..f50d7ee628 100644
--- a/includes/Feed.php
+++ b/includes/Feed.php
@@ -113,31 +113,35 @@ class FeedItem {
 class ChannelFeed extends FeedItem {
 	/**#@+
 	 * Abstract function, override!
+	 * @abstract
 	 */
 	 
 	/**
-	 * @todo document
+	 * Generate Header of the feed
 	 */
 	function outHeader() {
 		# print "<feed>";
 	}
 	
 	/**
-	 * @todo document
+	 * Generate an item
+	 * @param $item
 	 */
 	function outItem( $item ) {
 		# print "<item>...</item>";
 	}
 	
 	/**
-	 * @todo document
+	 * Generate Footer of the feed
 	 */
 	function outFooter() {
 		# print "</feed>";
 	}
+	/**#@-*/
 	
 	/**
 	 * @todo document
+	 * @param string $mimetype (optional) type of output
 	 */
 	function outXmlHeader( $mimetype='application/xml' ) {
 		global $wgServer, $wgStylePath, $wgOut;
@@ -151,7 +155,6 @@ class ChannelFeed extends FeedItem {
 		print '<' . '?xml-stylesheet type="text/css" href="' .
 			htmlspecialchars( "$wgServer$wgStylePath/feed.css" ) . '"?' . ">\n";
 	}
-	/**#@-*/
 }
 
 /**
@@ -162,14 +165,16 @@ class ChannelFeed extends FeedItem {
 class RSSFeed extends ChannelFeed {
 
 	/**
-	 * @todo document
+	 * Format a date given a timestamp
+	 * @param integer $ts Timestamp
+	 * @return string Date string
 	 */
 	function formatTime( $ts ) {
 		return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp2Unix( $ts ) );
 	}
 	
 	/**
-	 * @todo document
+	 * Ouput an RSS 2.0 header
 	 */
 	function outHeader() {
 		global $wgVersion;
@@ -187,7 +192,8 @@ class RSSFeed extends ChannelFeed {
 	}
 	
 	/**
-	 * @todo document
+	 * Output an RSS 2.0 item
+	 * @param FeedItem item to be output
 	 */
 	function outItem( $item ) {
 	?>
@@ -203,7 +209,7 @@ class RSSFeed extends ChannelFeed {
 	}
 
 	/**
-	 * @todo document
+	 * Ouput an RSS 2.0 footer
 	 */
 	function outFooter() {
 	?>