docblock for subscribe_to_feed

This commit is contained in:
Christian Weiske 2010-11-07 13:38:15 +01:00 committed by Andrew Dolgov
parent f0266f51ab
commit 2b8290cd5b
1 changed files with 14 additions and 0 deletions

View File

@ -2940,6 +2940,20 @@
print "</rpc-reply>";
}
/**
* Subscribes the user to the given feed
*
* @param resource $link Database connection
* @param string $url Feed URL to subscribe to
* @param integer $cat_id Category ID the feed shall be added to
* @param string $auth_login (optional) Feed username
* @param string $auth_pass (optional) Feed password
*
* @return integer Status code:
* 0 - OK, Feed already exists
* 1 - OK, Feed added
* 2 - Invalid URL
*/
function subscribe_to_feed($link, $url, $cat_id = 0,
$auth_login = '', $auth_pass = '') {