diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2010-12-19 23:56:43 +0100 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-02-12 22:05:53 -0500 |
| commit | 53dd847dd582930c84518d77a805468543e32ad0 (patch) | |
| tree | 51a2a1e49c7eaf0bf084df7fa5b1731a2bd6be69 /phpBB/includes/cron/task/wrapper.php | |
| parent | 47702b8ca72aeaa2b33dd13f2aa762ae7271c10a (diff) | |
| download | forums-53dd847dd582930c84518d77a805468543e32ad0.tar forums-53dd847dd582930c84518d77a805468543e32ad0.tar.gz forums-53dd847dd582930c84518d77a805468543e32ad0.tar.bz2 forums-53dd847dd582930c84518d77a805468543e32ad0.tar.xz forums-53dd847dd582930c84518d77a805468543e32ad0.zip | |
[feature/system-cron] Added @param/@return documentation
Also adjusted some function descriptions for greater informativity.
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron/task/wrapper.php')
| -rw-r--r-- | phpBB/includes/cron/task/wrapper.php | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/phpBB/includes/cron/task/wrapper.php b/phpBB/includes/cron/task/wrapper.php index 23cd4de724..238d97853c 100644 --- a/phpBB/includes/cron/task/wrapper.php +++ b/phpBB/includes/cron/task/wrapper.php @@ -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() { |