aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/cron/task/task.php
diff options
context:
space:
mode:
authorAndreas Fischer <bantu@phpbb.com>2010-12-17 01:24:27 +0100
committerOleg Pudeyev <oleg@bsdpower.com>2011-02-12 22:05:53 -0500
commit47702b8ca72aeaa2b33dd13f2aa762ae7271c10a (patch)
tree301bc2522dd6195cafd92a9d29fc4031ed9cf10c /phpBB/includes/cron/task/task.php
parent3c0561b68fc3bcff387d46d255ca1accc80df88a (diff)
downloadforums-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/task.php')
-rw-r--r--phpBB/includes/cron/task/task.php8
1 files changed, 8 insertions, 0 deletions
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();
}