diff options
Diffstat (limited to 'modules/aggregator/aggregator.api.php')
| -rw-r--r-- | modules/aggregator/aggregator.api.php | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/modules/aggregator/aggregator.api.php b/modules/aggregator/aggregator.api.php index 5fc07778d..cfdac8f16 100644 --- a/modules/aggregator/aggregator.api.php +++ b/modules/aggregator/aggregator.api.php @@ -28,6 +28,9 @@ * $feed->url contains the link to the feed. Download the data at the URL * and expose it to other modules by attaching it to $feed->source_string. * + * @return + * TRUE if fetching was successful, FALSE otherwise. + * * @see hook_aggregator_fetch_info() * @see hook_aggregator_parse() * @see hook_aggregator_process() @@ -82,12 +85,12 @@ function hook_aggregator_fetch_info() { * $feed->source_string contains the raw feed data as a string. Parse data * 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 + * - $feed->modified (UNIX timestamp) - value of feed's last modified header * field * - $feed->items (Array) - array of feed items. * @@ -101,8 +104,8 @@ function hook_aggregator_fetch_info() { * AUTHOR (string) - the feed item's author * GUID (string) - RSS/Atom global unique identifier * LINK (string) - the feed item's URL - * - * @return + * + * @return * TRUE if parsing was successful, FALSE otherwise. * * @see hook_aggregator_parse_info() @@ -116,7 +119,7 @@ function hook_aggregator_parse($feed) { $feed->items = $items; return TRUE; } - return FALSE; + return FALSE; } /** |