silverstripe / deploynaut

code/backends/DeploymentStrategy.php

Doc Comments +2 added lines

@@ -75,6 +75,7 @@ 
 	}
 
 	/**
+	 * @param string $code
 	 */
 	public function setActionCode($code) {
 		$this->actionCode = $code;
@@ -89,6 +90,7 @@ 
 
 	/**
 	 * @param int
+	 * @param string $seconds
 	 */
 	public function setEstimatedTime($seconds) {
 		$this->estimatedTime = $seconds;

code/api/nouns/APINoun.php

Indentation +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@
 <?php
 /**
- * Base class for the APINouns
- */
+	 * Base class for the APINouns
+	 */
 class APINoun extends Controller {
 
 	/**

code/tasks/DNMigrate1_1to1_2.php

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * Will convert the Filename to the version 1.2 of deploynaut where it
- * more or less is exactly is the same as the Name but with .rb
- */
+	 * Will convert the Filename to the version 1.2 of deploynaut where it
+	 * more or less is exactly is the same as the Name but with .rb
+	 */
 class DNMigrate1_1to1_2 extends BuildTask {
 	/**
 	 * @param SS_HTTPRequest $request

code/tasks/FilesystemSyncTask.php

Indentation +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@
 <?php
 /**
- * Surface Filesystem::sync() as a dev task in case CMS has not been included.
- */
+	 * Surface Filesystem::sync() as a dev task in case CMS has not been included.
+	 */
 class CMSFilesystemSyncTask extends BuildTask {
 	public function run($request = null) {
 		Filesystem::sync();

code/backends/DeploymentBackend.php

Doc Comments +5 added lines

@@ -10,6 +10,7 @@ 
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
 	 * @param type $leaveMaintenancePage
+	 * @return void
 	 */
 	public function deploy(DNEnvironment $environment, $sha, DeploynautLogFile $log, DNProject $project, $leaveMaintenancePage = false);
 
@@ -19,6 +20,7 @@ 
 	 *
 	 * @param DNDataTransfer $dataTransfer
 	 * @param DeploynautLogFile $log
+	 * @return void
 	 */
 	public function dataTransfer(DNDataTransfer $dataTransfer, DeploynautLogFile $log);
 
@@ -28,6 +30,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function enableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 
@@ -37,6 +40,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function disableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 
@@ -46,6 +50,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function ping(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 

code/control/DNRoot.php

Doc Comments +1 added lines, -1 removed lines

@@ -961,7 +961,7 @@
 	 * @param array $data
 	 * @param Form $form
 	 *
-	 * @return bool|HTMLText|SS_HTTPResponse
+	 * @return SS_HTTPResponse|null
 	 */
 	public function doCreateEnvironment($data, Form $form) {
 		$this->setCurrentActionType(self::ACTION_ENVIRONMENTS);

code/backends/PackageCache.php

Doc Comments +1 added lines

@@ -13,6 +13,7 @@
 	 * @param string $sha The SHA of the commit to be deployed
 	 * @param string $repositoryDir The directory where the repository resides
 	 * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
+	 * @return string
 	 */
 	public function getPackageFilename(
 		PackageGenerator $generator,

code/control/Dispatcher.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
 	 * Usage: $getReactComponent(YourComponent);
 	 *
 	 * @param string $name Used to name the DOM elements and obtain the initial model.
-	 * @return string A snippet good for adding to a SS template.
+	 * @return HTMLText A snippet good for adding to a SS template.
 	 */
 	public function getReactComponent($name) {
 		$model = $this->getModel($name);
@@ -120,7 +120,7 @@ 
 	/**
 	 * Decode the data submitted by the form.jsx control.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	protected function getFormData() {
 		return $this->stripNonPrintables(json_decode($this->request->postVar('Details'), true));

code/model/PipelineData.php

Doc Comments +1 added lines

@@ -13,6 +13,7 @@
 	 * Log message
 	 *
 	 * @param string $message The message to log
+	 * @return void
 	 */
 	public function log($message);
 }