silverstripe-australia / silverstripe-queuedjobs

code/forms/GridFieldQueuedJobExecute.php

Doc Comments +5 added lines, -2 removed lines

@@ -33,6 +33,9 @@ 
      */
     protected $viewCheck;
 
+    /**
+     * @param Closure $check
+     */
     public function __construct($action = 'execute', $check = null)
     {
         $this->action = $action;
@@ -89,7 +92,7 @@ 
      * Which columns are handled by this component
      *
      * @param type $gridField
-     * @return type
+     * @return string[]
      */
     public function getColumnsHandled($gridField)
     {
@@ -100,7 +103,7 @@ 
      * Which GridField actions are this component handling
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getActions($gridField)
     {

code/jobs/DoormanQueuedJobTask.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
     /**
      * @inheritdoc
      *
-     * @return null|int
+     * @return integer
      */
     public function getId()
     {

code/services/DefaultQueueHandler.php

Doc Comments +3 added lines

@@ -13,6 +13,9 @@
         $job->activateOnQueue();
     }
 
+    /**
+     * @param Date $date
+     */
     public function scheduleJob(QueuedJobDescriptor $job, $date)
     {
         // noop

code/services/QueuedJobService.php

Doc Comments +7 added lines, -4 removed lines

@@ -157,7 +157,7 @@ 
     /**
      * Start a job (or however the queue handler determines it should be started)
      *
-     * @param JobDescriptor $jobDescriptor
+     * @param QueuedJobDescriptor $jobDescriptor
      * @param date $startAfter
      */
     public function startJob($jobDescriptor, $startAfter = null)
@@ -174,7 +174,7 @@ 
      * Copies data from a job into a descriptor for persisting
      *
      * @param QueuedJob $job
-     * @param JobDescriptor $jobDescriptor
+     * @param DataObject $jobDescriptor
      */
     protected function copyJobToDescriptor($job, $jobDescriptor)
     {
@@ -321,7 +321,7 @@ 
      * Attempt to restart a stalled job
      *
      * @param QueuedJobDescriptor $stalledJob
-     * @return bool True if the job was successfully restarted
+     * @return boolean|null True if the job was successfully restarted
      */
     protected function restartStalledJob($stalledJob)
     {
@@ -364,7 +364,7 @@ 
      * @param QueuedJobDescriptor $jobDescriptor
      *			The Job descriptor of a job to prepare for execution
      *
-     * @return QueuedJob|boolean
+     * @return QueuedJob
      */
     protected function initialiseJob(QueuedJobDescriptor $jobDescriptor)
     {
@@ -742,6 +742,9 @@ 
         }
     }
 
+    /**
+     * @param double $size
+     */
     protected function humanReadable($size)
     {
         $filesizename = array(" Bytes", " KB", " MB", " GB", " TB", " PB", " EB", " ZB", " YB");

code/tasks/engines/BaseRunner.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
     /**
      * Logs the status of the queued job descriptor.
      *
-     * @param bool|null|QueuedJobDescriptor $descriptor
+     * @param DataObject|null $descriptor
      * @param string $queue
      */
     protected function logDescriptorStatus($descriptor, $queue)

code/tasks/engines/DoormanRunner.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
     }
 
     /**
-     * @return array List of rules
+     * @return string List of rules
      */
     public function getDefaultRules()
     {
@@ -71,7 +71,7 @@ 
 
     /**
      * @param string $queue
-     * @return null|QueuedJobDescriptor
+     * @return DataObject|null
      */
     protected function getNextJobDescriptorWithoutMutex($queue)
     {