diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2010-12-17 01:24:27 +0100 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2011-02-12 22:05:53 -0500 |
| commit | 47702b8ca72aeaa2b33dd13f2aa762ae7271c10a (patch) | |
| tree | 301bc2522dd6195cafd92a9d29fc4031ed9cf10c /phpBB/includes/cron/task/wrapper.php | |
| parent | 3c0561b68fc3bcff387d46d255ca1accc80df88a (diff) | |
| download | forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.tar forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.tar.gz forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.tar.bz2 forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.tar.xz forums-47702b8ca72aeaa2b33dd13f2aa762ae7271c10a.zip | |
[feature/system-cron] Add phpDoc documentation for everything else.
PHPBB3-9596
Diffstat (limited to 'phpBB/includes/cron/task/wrapper.php')
| -rw-r--r-- | phpBB/includes/cron/task/wrapper.php | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/phpBB/includes/cron/task/wrapper.php b/phpBB/includes/cron/task/wrapper.php index c2e7e42830..23cd4de724 100644 --- a/phpBB/includes/cron/task/wrapper.php +++ b/phpBB/includes/cron/task/wrapper.php @@ -25,6 +25,8 @@ class phpbb_cron_task_wrapper { /** * Wraps a task $task, which must implement cron_task interface. + * + * @return void */ public function __construct(phpbb_cron_task $task) { @@ -36,6 +38,8 @@ class phpbb_cron_task_wrapper * * Parametrized tasks accept parameters during initialization and must * normally be scheduled with parameters. + * + * @return bool Whether or not this task is parametrized. */ public function is_parametrized() { @@ -47,6 +51,8 @@ class phpbb_cron_task_wrapper * * A task is ready to run when it is runnable according to current configuration * and enough time has passed since it was last run. + * + * @return bool Whether the wrapped task is ready to run. */ public function is_ready() { @@ -55,6 +61,8 @@ class phpbb_cron_task_wrapper /** * Returns the name of wrapped task. It is the same as the wrapped class's class name. + * + * @return string Class name of wrapped task. */ public function get_name() { @@ -63,6 +71,8 @@ class phpbb_cron_task_wrapper /** * Returns a url through which this task may be invoked via web. + * + * @return string URL */ public function get_url() { @@ -88,6 +98,8 @@ class phpbb_cron_task_wrapper /** * Forwards all other method calls to the wrapped task implementation. + * + * @return mixed */ public function __call($name, $args) { |