jenkins-bot has submitted this change and it was merged.
Change subject: Improve documentation of ChannelFeed and AtomFeed class
......................................................................
Improve documentation of ChannelFeed and AtomFeed class
Change-Id: I1bebaf2d17ac71490aab3ab9cd1f08a4bb1fc3fb
---
M includes/Feed.php
1 file changed, 7 insertions(+), 5 deletions(-)
Approvals:
Tpt: Looks good to me, but someone else must approve
TTO: Looks good to me, approved
jenkins-bot: Verified
diff --git a/includes/Feed.php b/includes/Feed.php
index 2fdfa42..9be3f57 100644
--- a/includes/Feed.php
+++ b/includes/Feed.php
@@ -184,7 +184,8 @@
}
/**
- * @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 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
) );
}
/**
--
To view, visit https://gerrit.wikimedia.org/r/188408
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I1bebaf2d17ac71490aab3ab9cd1f08a4bb1fc3fb
Gerrit-PatchSet: 5
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: AYUSH GARG <[email protected]>
Gerrit-Reviewer: Qgil <[email protected]>
Gerrit-Reviewer: Reedy <[email protected]>
Gerrit-Reviewer: TTO <[email protected]>
Gerrit-Reviewer: Tpt <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
