Merge pull request #22636 from eileenmcnaughton/exampley

[civicrm-core.git] / CRM / Queue / Task.php

diff --git a/CRM/Queue/Task.php b/CRM/Queue/Task.php
index 11fc6797f426409c4744bccb819822b95a88fa90..cb510da2058079e2b4a2030367829b2ba7a717f7 100644 (file)
--- a/CRM/Queue/Task.php
+++ b/CRM/Queue/Task.php
@@ -25,17 +25,19 @@ class CRM_Queue_Task {
   const TASK_FAIL = 2;
 
   /**
-   * @var mixed, serializable
+   * @var mixed
+   * serializable
    */
   public $callback;
 
   /**
-   * @var array, serializable
+   * @var array
+   * serializable
    */
   public $arguments;
 
   /**
-   * @var string, NULL-able
+   * @var string|null
    */
   public $title;
 
@@ -57,12 +59,11 @@ class CRM_Queue_Task {
   /**
    * Perform the task.
    *
-   * @param array $taskCtx
-   *   Array with keys:
-   *   - log: object 'Log'
-   *
+   * @param \CRM_Queue_TaskContext $taskCtx
    * @throws Exception
-   * @return bool, TRUE if task completes successfully
+   * @return bool
+   *   TRUE if task completes successfully.
+   *   FALSE or exception if task fails.
    */
   public function run($taskCtx) {
     $args = $this->arguments;