silverstripe-australia / silverstripe-queuedjobs

code/forms/QueuedJobListField.php

Doc Comments +6 added lines

@@ -4,6 +4,12 @@
  * @license BSD http://silverstripe.org/bsd-license/
  */
 class QueuedJobListField extends TableListField {
+
+	/**
+	 * @param string $name
+	 * @param string $sourceClass
+	 * @param string $sourceSort
+	 */
 	function __construct($name, $sourceClass, $fieldList = null, $sourceFilter = null,
 		$sourceSort = null, $sourceJoin = null) {
 		parent::__construct($name, $sourceClass, $fieldList, $sourceFilter, $sourceSort, $sourceJoin);

code/jobs/ScheduledExecutionJob.php

Doc Comments +3 added lines

@@ -10,6 +10,9 @@
  */
 class ScheduledExecutionJob extends AbstractQueuedJob {
 	
+	/**
+	 * @param DataObject $dataObject
+	 */
 	public function __construct($dataObject = null, $timesExecuted = 0) {
 		if ($dataObject) {
 			$this->objectID = $dataObject->ID;

code/QJUtils.php

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
 	 *
 	 *
 	 * @param unknown_type $filter
-	 * @return unknown_type
+	 * @return string
 	 */
 	function dbQuote($filter = array(), $join = " AND ") {
 		$QUOTE_CHAR = defined('DB::USE_ANSI_SQL') ? '"' : '';

code/services/QueuedJobService.php

Doc Comments +4 added lines, -1 removed lines

@@ -115,7 +115,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();
@@ -493,6 +493,9 @@ 
 		}
 	}
 
+	/**
+	 * @param integer $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';