diff --git a/modules/aggregator/aggregator.api.php b/modules/aggregator/aggregator.api.php index f31413c..16d19db 100644 --- a/modules/aggregator/aggregator.api.php +++ b/modules/aggregator/aggregator.api.php @@ -85,24 +85,21 @@ function hook_aggregator_fetch_info() { * from $feed->source_string and expose it to other modules as an array of * data items on $feed->items. * - * Feed format: - * - $feed->description (string) - description of the feed - * - $feed->image (string) - image for the feed - * - $feed->etag (string) - value of feed's entity tag header field - * - $feed->modified (UNIX timestamp) - value of feed's last modified header + * An stdClass object containing: + * - description - A string to use for the description of the feed + * - image - A string to use for the image for the feed + * - etag - A string to use for the value of feed's entity tag header field + * - modified - A unix timestamp of the feed's last modified header * field - * - $feed->items (Array) - array of feed items. - * - * By convention, the common format for a single feed item is: - * $item[key-name] = value; - * - * Recognized keys: - * TITLE (string) - the title of a feed item - * DESCRIPTION (string) - the description (body text) of a feed item - * TIMESTAMP (UNIX timestamp) - the feed item's published time as UNIX timestamp - * AUTHOR (string) - the feed item's author - * GUID (string) - RSS/Atom global unique identifier - * LINK (string) - the feed item's URL + * - items - An array of feed items, the common format for a + * single feed item is an associative array containing: + * - title - A string to use for the title of a feed item + * - description - A string to use for the description (body text) of a + * feed item + * - timestamp - A unix timestamp of the feed item's published time + * - author - A string to use for the feed item's author + * - guid - A string to use for the RSS/Atom global unique identifier + * - link - A string to use for the feed item's URL * * @return * TRUE if parsing was successful, FALSE otherwise.