silverstripe-australia / advancedworkflow

code/forms/gridfield/GridFieldExportAction.php

Doc Comments +2 added lines, -2 removed lines

@@ -49,7 +49,7 @@ 
 	 * Which columns are handled by this component
 	 * 
 	 * @param type $gridField
-	 * @return type 
+	 * @return string[] 
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -59,7 +59,7 @@ 
 	 * Which GridField actions are this component handling
 	 *
 	 * @param GridField $gridField
-	 * @return array 
+	 * @return string[] 
 	 */
 	public function getActions($gridField) {
 		return array('exportrecord');

code/forms/gridfield/GridFieldWorkflowRestrictedEditButton.php

Doc Comments +2 added lines, -2 removed lines

@@ -59,7 +59,7 @@ 
 	 * Which columns are handled by this component
 	 * 
 	 * @param type $gridField
-	 * @return type 
+	 * @return string[] 
 	 */
 	public function getColumnsHandled($gridField) {
 		return array('Actions');
@@ -70,7 +70,7 @@ 
 	 * @param DataObject $record
 	 * @param string $columnName
 	 *
-	 * @return string - the HTML for the column 
+	 * @return HTMLText - the HTML for the column 
 	 */
 	public function getColumnContent($gridField, $record, $columnName) {
 		$data = new ArrayData(array(

code/jobs/WorkflowPublishTargetJob.php

Doc Comments +3 added lines

@@ -6,6 +6,9 @@
  */
 class WorkflowPublishTargetJob extends AbstractQueuedJob {
 
+	/**
+	 * @param string $type
+	 */
 	public function __construct($obj = null, $type = null) {
 		if ($obj) {
 			$this->setObject($obj);

code/services/WorkflowService.php

Doc Comments +2 added lines, -2 removed lines

@@ -63,6 +63,7 @@ 
 	 * Will recursively query parent elements until it finds one, if available
 	 *
 	 * @param DataObject $dataObject
+	 * @return null|DataObject
 	 */
 	public function getDefinitionFor(DataObject $dataObject) {
 		if ($dataObject->hasExtension('WorkflowApplicable') || $dataObject->hasExtension('FileWorkflowApplicable')) {
@@ -87,6 +88,7 @@ 
 	 *
 	 *	@param data object
 	 *	@param integer
+	 * @param DataObject $object
 	 *	@return workflow definition
 	 */
 
@@ -288,7 +290,6 @@ 
 	/**
 	 * Get items that the passed-in user has awaiting for them to action
 	 * 
-	 * @param Member $member
 	 * @return DataList $userInstances
 	 */
 	public function userPendingItems(Member $user) {
@@ -315,7 +316,6 @@ 
 	/**
 	 * Get items that the passed-in user has submitted for workflow review
 	 *
-	 * @param Member $member
 	 * @return DataList $userInstances
 	 */
 	public function userSubmittedItems(Member $user) {

code/formfields/WorkflowFieldActionController.php

Doc Comments +4 added lines

@@ -19,6 +19,10 @@
 	protected $parent;
 	protected $name;
 
+	/**
+	 * @param WorkflowField $parent
+	 * @param string $name
+	 */
 	public function __construct($parent, $name) {
 		$this->parent = $parent;
 		$this->name   = $name;

code/templates/WorkflowTemplate.php

Doc Comments +5 added lines, -2 removed lines

@@ -71,6 +71,9 @@ 
 	 */
 	protected $structure;
 	
+	/**
+	 * @param string $name
+	 */
 	public function __construct($name, $description = '', $version = '0.0', $remindDays = 0, $sort = 0) {
 		$this->name = $name;
 		$this->description = $description;
@@ -112,7 +115,7 @@ 
 	 * Creates the relevant data objects for this structure, returning an array
 	 * of actions in the order they've been created 
 	 * 
-	 * @param WorkflowDefinition $definitino
+	 * @param WorkflowDefinition $definition
 	 *				An optional workflow definition to bind the actions into
 	 * @return array
 	 */
@@ -164,7 +167,7 @@ 
 	 * Create a workflow action based on a template
 	 * 
 	 * @param string $name
-	 * @param array $template
+	 * @param array $actionTemplate
 	 * @param WorkflowDefinition $definition
 	 * @return WorkflowAction
 	 */