symbiote / silverstripe-queuedjobs

src/Controllers/QueuedJobsAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -162,7 +162,7 @@
     /**
      * @param  array $data
      * @param  Form $form
-     * @return HTTPResponse
+     * @return \SilverStripe\Control\HTTPResponse
      */
     public function createjob($data, Form $form)
     {

src/DataObjects/QueuedJobDescriptor.php

Doc Comments +1 added lines, -1 removed lines

@@ -263,7 +263,7 @@
     }
 
     /**
-     * @return FieldList
+     * @return \SilverStripe\Forms\FieldList
      */
     public function getCMSFields()
     {

src/Forms/GridFieldQueuedJobExecute.php

Doc Comments +3 added lines, -3 removed lines

@@ -104,7 +104,7 @@ 
      * Which columns are handled by this component
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getColumnsHandled($gridField)
     {
@@ -115,7 +115,7 @@ 
      * Which GridField actions are this component handling
      *
      * @param GridField $gridField
-     * @return array
+     * @return string[]
      */
     public function getActions($gridField)
     {
@@ -126,7 +126,7 @@ 
      * @param GridField $gridField
      * @param DataObject $record
      * @param string $columnName
-     * @return string|void - the HTML for the column
+     * @return null|\SilverStripe\ORM\FieldType\DBHTMLText - the HTML for the column
      */
     public function getColumnContent($gridField, $record, $columnName)
     {

src/Jobs/CleanupJob.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
 
     /**
      * Required because we aren't extending object
-     * @return Config_ForClass
+     * @return \SilverStripe\Core\Config\Config_ForClass
      */
     public function config()
     {

src/Tasks/Engines/DoormanRunner.php

Doc Comments +2 added lines, -2 removed lines

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

src/Services/QueuedJobService.php

Doc Comments +9 added lines, -5 removed lines

@@ -146,7 +146,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
@@ -195,7 +195,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)
@@ -212,7 +212,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)
     {
@@ -365,6 +365,7 @@ 
 
     /**
      * Checks through ll the scheduled jobs that are expected to exist
+     * @param string $queue
      */
     public function checkDefaultJobs($queue = null)
     {
@@ -419,7 +420,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)
     {
@@ -889,6 +890,9 @@ 
         }
     }
 
+    /**
+     * @param double $size
+     */
     protected function humanReadable($size)
     {
         $filesizename = array(" Bytes", " KB", " MB", " GB", " TB", " PB", " EB", " ZB", " YB");
@@ -904,7 +908,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)
     {