symbiote / silverstripe-queuedjobs

src/Services/QueuedJobService.php

Doc Comments +9 added lines, -5 removed lines

@@ -151,7 +151,7 @@ 
      *
      * @param QueuedJob $job
      *          The job to start.
-     * @param $startAfter
+     * @param string $startAfter
      *          The date (in Y-m-d H:i:s format) to start execution after
      * @param int $userId
      *          The ID of a user to execute the job as. Defaults to the current user
@@ -204,7 +204,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)
@@ -374,6 +374,7 @@ 
 
     /**
      * Checks through ll the scheduled jobs that are expected to exist
+     * @param string $queue
      */
     public function checkDefaultJobs($queue = null)
     {
@@ -429,7 +430,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)
     {
@@ -772,7 +773,7 @@ 
     /**
      * @param QueuedJobDescriptor $jobDescriptor
      * @param Member|null $originalUser
-     * @return null
+     * @return null|Member
      */
     protected function setRunAsUser(QueuedJobDescriptor $jobDescriptor, Member $originalUser = null)
     {
@@ -944,6 +945,9 @@ 
         }
     }
 
+    /**
+     * @param double $size
+     */
     protected function humanReadable($size)
     {
         $filesizename = array(" Bytes", " KB", " MB", " GB", " TB", " PB", " EB", " ZB", " YB");
@@ -959,7 +963,7 @@ 
      * @param int $includeUpUntil
      *          The number of seconds to include jobs that have just finished, allowing a job list to be built that
      *          includes recently finished jobs
-     * @return QueuedJobDescriptor
+     * @return DataList
      */
     public function getJobList($type = null, $includeUpUntil = 0)
     {