Merge branch 'mrsmuneton-RssFeedArgumentsDocNote' into 3.1

Closes #2798
This commit is contained in:
Simon Welsh 2014-03-15 21:26:04 +13:00
commit cc9ce325bd

View File

@ -21,7 +21,7 @@ define an AbsoluteLink() method.
RSSFeed::linkToFeed($link, $title) RSSFeed::linkToFeed($link, $title)
This line should go in your `[api:Controller]` subclass in the action you want This line should go in your `[api:Controller]` subclass in the action you want
to include the HTML link. to include the HTML link. Not all arguments are required, see `[api:RSSFeed]` and example below. Last Modified Time is expected in seconds like time().
:::php :::php
$feed = new RSSFeed( $feed = new RSSFeed(
@ -31,7 +31,9 @@ to include the HTML link.
$description, $description,
$titleField, $titleField,
$descriptionField, $descriptionField,
$authorField $authorField,
$lastModifiedTime,
$etag
); );
Creates a new `[api:RSSFeed]` instance to be returned. The arguments notify Creates a new `[api:RSSFeed]` instance to be returned. The arguments notify