updated method comments

This commit is contained in:
Chaitanya Kuber 2012-02-29 22:32:52 -06:00
parent 4700375d25
commit 951d9d37b5

View File

@ -24,7 +24,8 @@ class Resque
* the redis server that Resque will talk to. * the redis server that Resque will talk to.
* *
* @param mixed $server Host/port combination separated by a colon, or * @param mixed $server Host/port combination separated by a colon, or
* a nested array of servers with host/port pairs. * a nested array of servers with host/port pairs.
* @param int $database
*/ */
public static function setBackend($server, $database = 0) public static function setBackend($server, $database = 0)
{ {
@ -88,6 +89,8 @@ class Resque
/** /**
* Return the size (number of pending jobs) of the specified queue. * Return the size (number of pending jobs) of the specified queue.
* *
* @param $queue name of the queue to be checked for pendign jobs
*
* @return int The size of the queue. * @return int The size of the queue.
*/ */
public static function size($queue) public static function size($queue)
@ -101,7 +104,9 @@ class Resque
* @param string $queue The name of the queue to place the job in. * @param string $queue The name of the queue to place the job in.
* @param string $class The name of the class that contains the code to execute the job. * @param string $class The name of the class that contains the code to execute the job.
* @param array $args Any optional arguments that should be passed when the job is executed. * @param array $args Any optional arguments that should be passed when the job is executed.
* @param boolean $monitor Set to true to be able to monitor the status of a job. * @param boolean $trackStatus Set to true to be able to monitor the status of a job.
*
* @return string
*/ */
public static function enqueue($queue, $class, $args = null, $trackStatus = false) public static function enqueue($queue, $class, $args = null, $trackStatus = false)
{ {