silverstripe-australia / silverstripe-queuedjobs

code/services/QueuedJobService.php

Doc Comments +7 added lines, -3 removed lines

@@ -162,7 +162,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) {
@@ -178,7 +178,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) {
 		$data = $job->getJobData();
@@ -322,6 +322,7 @@ 
 
 	/**
 	 * Checks through all the scheduled jobs that are expected to exist
+	 * @param string $queue
 	 */
 	public function checkdefaultJobs($queue = null) {
 		$queue = $queue ?: QueuedJob::QUEUED;
@@ -375,7 +376,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) {
 		if ($stalledJob->ResumeCounts < Config::inst()->get(__CLASS__, 'stall_threshold')) {
@@ -791,6 +792,9 @@ 
 		}
 	}
 
+	/**
+	 * @param double $size
+	 */
 	protected function humanReadable($size) {
 		$filesizename = array(" Bytes", " KB", " MB", " GB", " TB", " PB", " EB", " ZB", " YB");
 		return $size ? round($size/pow(1024, ($i = floor(log($size, 1024)))), 2) . $filesizename[$i] : '0 Bytes';