mirror of
https://github.com/phpbb/phpbb.git
synced 2025-07-30 21:40:43 +02:00
[feature/system-cron] Added @param/@return documentation
Also adjusted some function descriptions for greater informativity. PHPBB3-9596
This commit is contained in:
@@ -55,7 +55,16 @@ abstract class phpbb_cron_task_base implements phpbb_cron_task
|
||||
/**
|
||||
* Returns whether this cron task can be run in shutdown function.
|
||||
*
|
||||
* @return bool
|
||||
* By the time shutdown sequence invokes a particular piece of code,
|
||||
* resources that that code requires may already be released.
|
||||
* If so, a particular cron task may be marked shutdown function-
|
||||
* unsafe, and it will be executed in normal program flow.
|
||||
*
|
||||
* Generally speaking cron tasks should start off as shutdown function-
|
||||
* safe, and only be marked shutdown function-unsafe if a problem
|
||||
* is discovered.
|
||||
*
|
||||
* @return bool Whether the cron task is shutdown function-safe.
|
||||
*/
|
||||
public function is_shutdown_function_safe()
|
||||
{
|
||||
|
Reference in New Issue
Block a user