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/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);
 }

tests/DNEnvironmentTest.php

Doc Comments +5 added lines

@@ -101,6 +101,11 @@
 		$this->assertTrue($environment->canAbort($cancellerbygroup));
 	}
 
+	/**
+	 * @param string $assert
+	 * @param DataObject|null $env
+	 * @param DataObject|null $member
+	 */
 	private function checkSnapshots($assert, $env, $member) {
 		$this->$assert($env->canRestore($member));
 		$this->$assert($env->canBackup($member));

tests/DryRunPipelineTest.php

Doc Comments +1 added lines

@@ -125,6 +125,7 @@
 	/**
 	 * Make the dummy deployment step
 	 *
+	 * @param string $name
 	 * @return SmokeTestPipelineStep
 	 */
 	public function getDummySmokeTestStep($name) {

tests/PipelineTest.php

Doc Comments +13 added lines

@@ -36,14 +36,23 @@ 
 		PipelineTest_RecordingMessageSender::clear();
 	}
 
+	/**
+	 * @param string $message
+	 */
 	protected function assertHasLog($message) {
 		$this->assertTrue(PipelineTest_MockLog::has_message($message), "Assert log \"$message\"");
 	}
 
+	/**
+	 * @param string $message
+	 */
 	protected function assertNotLogged($message) {
 		$this->assertFalse(PipelineTest_MockLog::has_message($message), "Assert not logged \"$message\"");
 	}
 
+	/**
+	 * @param string $recipient
+	 */
 	public function assertSentMessage($message, $recipient) {
 		$this->assertTrue(
 			PipelineTest_RecordingMessageSender::has_message($message, $recipient),
@@ -51,6 +60,10 @@ 
 		);
 	}
 
+	/**
+	 * @param string $message
+	 * @param string $recipient
+	 */
 	public function assertNotSentMessage($message, $recipient) {
 		$this->assertFalse(
 			PipelineTest_RecordingMessageSender::has_message($message, $recipient),