1
0
mirror of https://github.com/phpbb/phpbb.git synced 2025-08-09 02:06:32 +02:00

[feature/system-cron] Added @param/@return documentation

Also adjusted some function descriptions for greater informativity.

PHPBB3-9596
This commit is contained in:
Oleg Pudeyev
2010-12-19 23:56:43 +01:00
parent 47702b8ca7
commit 53dd847dd5
14 changed files with 98 additions and 11 deletions

View File

@@ -24,9 +24,11 @@ if (!defined('IN_PHPBB'))
class phpbb_cron_task_wrapper
{
/**
* Constructor.
*
* Wraps a task $task, which must implement cron_task interface.
*
* @return void
* @param phpbb_cron_task $task The cron task to wrap.
*/
public function __construct(phpbb_cron_task $task)
{
@@ -34,7 +36,7 @@ class phpbb_cron_task_wrapper
}
/**
* Returns whether this task is parametrized.
* Returns whether the wrapped task is parametrised.
*
* Parametrized tasks accept parameters during initialization and must
* normally be scheduled with parameters.
@@ -72,7 +74,11 @@ class phpbb_cron_task_wrapper
/**
* Returns a url through which this task may be invoked via web.
*
* @return string URL
* When system cron is not in use, running a cron task is accomplished
* by outputting an image with the url returned by this function as
* source.
*
* @return string URL through which this task may be invoked.
*/
public function get_url()
{