silverstripe / deploynaut

code/api/DeploynautAPI.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 	/**
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return string
+	 * @return SS_HTTPResponse
 	 */
 	public function listProjects(SS_HTTPRequest $request) {
 		$response = array(

code/backends/CapistranoDeploymentBackend.php

Doc Comments +1 added lines

@@ -300,6 +300,7 @@
 	/**
 	 * Utility function for triggering the db rebuild and flush.
 	 * Also cleans up and generates new error pages.
+	 * @param DeploynautLogFile $log
 	 */
 	public function rebuild(DNEnvironment $environment, $log) {
 		$name = $environment->getFullName();

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/backends/PackageGenerator.php

Doc Comments +2 added lines, -1 removed lines

@@ -13,8 +13,9 @@
 	/**
 	 * Generate the package file, saving to the given location
 	 *
-	 * @param $baseDir string The base directory of the project, checked out from git.
+	 * @param string $baseDir string The base directory of the project, checked out from git.
 	 * @param $outputFilename string The filename to write to.
+	 * @param string $sha
 	 *
 	 * @return boolean True on success
 	 */

code/backends/SizeRestrictedPackageCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	/**
 	 * Take the identifier an make it safe to use as a directory name.
 	 *
-	 * @param string $identfiier The unsanitised directory name.
+	 * @param string $identifier The unsanitised directory name.
 	 */
 	protected function sanitiseDirName($identifier) {
 		$safe = preg_replace('/[^A-Za-z0-9_-]/', '', $identifier);

code/control/DeployForm.php

Doc Comments +5 added lines, -1 removed lines

@@ -18,6 +18,7 @@ 
 	 * Validate a commit sha
 	 *
 	 * @param string $sha
+	 * @param string $field
 	 * @return boolean
 	 */
 	protected function validateCommit($sha, $field) {
@@ -100,6 +101,10 @@ 
  */
 class DeployForm extends Form {
 
+	/**
+	 * @param DNRoot $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name, DNEnvironment $environment, DNProject $project) {
 		if($environment->HasPipelineSupport()) {
 			// Determine if commits are filtered
@@ -261,7 +266,6 @@ 
 	/**
 	 * Generate fields necessary to select from a filtered commit list
 	 *
-	 * @param DNEnvironment $environment
 	 * @param DataList $commits List of commits
 	 * @return FormField
 	 */

code/control/DNRoot.php

Doc Comments +7 added lines, -4 removed lines

@@ -161,7 +161,7 @@ 
 	/**
 	 * Action
 	 *
-	 * @return string - HTML
+	 * @return HTMLText - HTML
 	 */
 	public function projects(SS_HTTPRequest $request) {
 		// Performs canView permission check by limiting visible projects in DNProjectsList() call.
@@ -854,6 +854,7 @@ 
 	}
 
 	/**
+	 * @param SS_HTTPRequest $request
 	 * @return Form
 	 */
 	public function getDataTransferForm($request) {
@@ -1189,6 +1190,8 @@ 
 
 	/**
 	 * Build snapshot move form.
+	 * @param SS_HTTPRequest $request
+	 * @param DataObject $dataArchive
 	 */
 	public function getMoveForm($request, $dataArchive = null) {
 		$dataArchive = $dataArchive ? $dataArchive : DNDataArchive::get()->byId($request->requestVar('DataArchiveID'));
@@ -1330,7 +1333,7 @@ 
 	 * TODO To be replaced with a method that just returns the list of archives this {@link Member} has access to.
 	 *
 	 * @param Member $member The {@link Member} to check (or null to check the currently logged in Member)
-	 * @return boolean true if $member has access to upload or download to at least one {@link DNEnvironment}.
+	 * @return boolean|null true if $member has access to upload or download to at least one {@link DNEnvironment}.
 	 */
 	public function CanViewArchives(Member $member = null) {
 		if(!$member) $member = Member::currentUser();
@@ -1357,7 +1360,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList The list of all archive files that can be accessed by the currently logged-in {@link Member}
+	 * @return PaginatedList The list of all archive files that can be accessed by the currently logged-in {@link Member}
 	 */
 	public function CompleteDataArchives() {
 		$project = $this->getCurrentProject();
@@ -1375,7 +1378,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList The list of "pending" data archives which are waiting for a file
+	 * @return PaginatedList The list of "pending" data archives which are waiting for a file
 	 * to be delivered offline by post, and manually uploaded into the system.
 	 */
 	public function PendingDataArchives() {

code/control/EmailMessagingService.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 	 *
 	 * @param PipelineStep $source Client step
 	 * @param string $from
-	 * @param string|Member $to
+	 * @param string $to
 	 * @param string $subject
 	 * @param string $body
 	 */

code/model/DNEnvironment.php

Doc Comments +3 added lines

@@ -919,6 +919,9 @@
 		$fields->insertAfter($createConfigField, 'noDeployConfig');
 	}
 
+	/**
+	 * @param FieldList $fields
+	 */
 	protected function setPipelineConfigurationFields($fields) {
 		if(!$this->config()->get('allow_web_editing')) {
 			return;