From 47702b8ca72aeaa2b33dd13f2aa762ae7271c10a Mon Sep 17 00:00:00 2001 From: Andreas Fischer Date: Fri, 17 Dec 2010 01:24:27 +0100 Subject: [feature/system-cron] Add phpDoc documentation for everything else. PHPBB3-9596 --- phpBB/includes/cron/task/task.php | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'phpBB/includes/cron/task/task.php') diff --git a/phpBB/includes/cron/task/task.php b/phpBB/includes/cron/task/task.php index 050e85c35e..72fda91dd0 100644 --- a/phpBB/includes/cron/task/task.php +++ b/phpBB/includes/cron/task/task.php @@ -23,6 +23,8 @@ interface phpbb_cron_task { /** * Runs this cron task. + * + * @return void */ public function run(); @@ -31,17 +33,23 @@ interface phpbb_cron_task * * For example, a cron task that prunes forums can only run when * forum pruning is enabled. + * + * @return bool */ public function is_runnable(); /** * Returns whether this cron task should run now, because enough time * has passed since it was last run. + * + * @return bool */ public function should_run(); /** * Returns whether this cron task can be run in shutdown function. + * + * @return bool */ public function is_shutdown_function_safe(); } -- cgit v1.2.1