silverstripe / silverstripe-framework

core/startup/ErrorControlChain.php

Doc Comments +9 added lines

@@ -36,6 +36,9 @@ 
 		$this->error = (bool)$error;
 	}
 
+	/**
+	 * @param boolean $suppression
+	 */
 	public function setSuppression($suppression) {
 		$this->suppression = (bool)$suppression;
 		if ($this->handleFatalErrors) ini_set('display_errors', !$suppression);
@@ -61,10 +64,16 @@ 
 		return $this->then($callback, false);
 	}
 
+	/**
+	 * @param Closure $callback
+	 */
 	public function thenIfErrored($callback) {
 		return $this->then($callback, true);
 	}
 
+	/**
+	 * @param Closure $callback
+	 */
 	public function thenAlways($callback) {
 		return $this->then($callback, null);
 	}

dev/FixtureBlueprint.php

Doc Comments +6 added lines, -1 removed lines

@@ -245,6 +245,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $type
+	 */
 	protected function invokeCallbacks($type, $args = array()) {
 		foreach($this->callbacks[$type] as $callback) {
 			call_user_func_array($callback, $args);
@@ -255,7 +258,6 @@ 
 	 * Parse a value from a fixture file.  If it starts with => 
 	 * it will get an ID from the fixture dictionary
 	 *
-	 * @param String $fieldVal
 	 * @param  Array $fixtures See {@link createObject()}
 	 * @return String Fixture database ID, or the original value
 	 */
@@ -282,6 +284,9 @@ 
 		$obj->$name = $this->parseValue($value, $fixtures);
 	}
 
+	/**
+	 * @param string $fieldName
+	 */
 	protected function overrideField($obj, $fieldName, $value, $fixtures = null) {
 		$table = ClassInfo::table_for_object_field(get_class($obj), $fieldName);
 		$value = $this->parseValue($value, $fixtures);

dev/install/MySQLDatabaseConfigurationHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	/**
 	 * Get the database version for the MySQL connection, given the
 	 * database parameters.
-	 * @return mixed string Version number as string | boolean FALSE on failure
+	 * @return string string Version number as string | boolean FALSE on failure
 	 */
 	public function getDatabaseVersion($databaseConfig) {
 		$conn = new MySQLi($databaseConfig['server'], $databaseConfig['username'], $databaseConfig['password']);

dev/SapphireTest.php

Doc Comments +5 added lines, -3 removed lines

@@ -138,6 +138,7 @@ 
 
 	/**
 	 * Set the manifest to be used to look up test classes by helper functions
+	 * @param SS_ClassManifest $manifest
 	 */
 	public static function set_test_class_manifest($manifest) {
 		self::$test_class_manifest = $manifest;
@@ -389,7 +390,7 @@ 
 	/**
 	 * Get the ID of an object from the fixture.
 	 *
-	 * @param $className The data class, as specified in your fixture file.  Parent classes won't work
+	 * @param string $className The data class, as specified in your fixture file.  Parent classes won't work
 	 * @param $identifier The identifier string, as provided in your fixture file
 	 * @return int
 	 */
@@ -412,7 +413,7 @@ 
 	 * Will collate all IDs form all fixtures if multiple fixtures are provided.
 	 *
 	 * @param string $className
-	 * @return array A map of fixture-identifier => object-id
+	 * @return A A map of fixture-identifier => object-id
 	 */
 	protected function allFixtureIDs($className) {
 		return $this->getFixtureFactory()->getIds($className);
@@ -572,7 +573,7 @@ 
 	/**
 	 * Assert that the matching email was sent since the last call to clearEmails()
 	 * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
-	 * @param $to
+	 * @param string $to
 	 * @param $from
 	 * @param $subject
 	 * @param $content
@@ -871,6 +872,7 @@ 
 	/**
 	 * Create a member and group with the given permission code, and log in with it.
 	 * Returns the member ID.
+	 * @return integer
 	 */
 	public function logInWithPermission($permCode = "ADMIN") {
 		if(!isset($this->cache_generatedMembers[$permCode])) {

email/Mailer.php

Doc Comments +5 added lines

@@ -110,6 +110,7 @@ 
 	 *   - if you pass the entire $_FILES entry, the user-uploaded filename will be preserved
 	 *   use $plainContent to override default plain-content generation
 	 * 
+	 * @param string $htmlContent
 	 * @return bool
 	 */
 	public function sendHTML($to, $from, $subject, $htmlContent, $attachedFiles = false, $customheaders = false,
@@ -233,6 +234,7 @@ 
 
 		/**
 		 * @todo Make visibility protected in 3.2
+	 * @param string $contentType
 	 */
 	function encodeMultipart($parts, $contentType, $headers = false) {
 		$separator = "----=_NextPart_" . preg_replace('/[^0-9]/', '', rand() * 10000000000);
@@ -466,6 +468,7 @@ 
  * @package framework
  * @subpackage email
  * @deprecated 3.1
+ * @param string $contentType
  */
 function encodeMultipart($parts, $contentType, $headers = false) {
 	Deprecation::notice('3.1', 'Use Email->$this->encodeMultipart() instead');
@@ -515,6 +518,7 @@ 
  * @package framework
  * @subpackage email
  * @deprecated 3.1
+ * @param string $disposition
  */
 function encodeFileForEmail($file, $destFileName = false, $disposition = NULL, $extraHeaders = "") {
 	Deprecation::notice('3.1', 'Please add files through Email->attachFile()');
@@ -527,6 +531,7 @@ 
  * @package framework
  * @subpackage email
  * @deprecated 3.1
+ * @return boolean
  */
 function QuotedPrintable_encode($quotprint) {
 	Deprecation::notice('3.1', 'No longer available, handled internally');

filesystem/GD.php

Doc Comments +7 added lines

@@ -342,6 +342,10 @@ 
 			return $useAsMinimum ? $this->resizeByWidth( $maxWidth ) : $this->resizeByHeight( $maxHeight );
 	}
 	
+	/**
+	 * @param resource $image
+	 * @param string $webColor
+	 */
 	public static function color_web2gd($image, $webColor) {
 		if(substr($webColor,0,1) == "#") $webColor = substr($webColor,1);
 		$r = hexdec(substr($webColor,0,2));
@@ -446,6 +450,9 @@ 
 		return $output;
 	}
 	
+	/**
+	 * @param string $dirname
+	 */
 	public function makeDir($dirname) {
 		if(!file_exists(dirname($dirname))) $this->makeDir(dirname($dirname));
 		if(!file_exists($dirname)) mkdir($dirname, Config::inst()->get('Filesystem', 'folder_create_mask'));

forms/CompositeField.php

Doc Comments +8 added lines, -2 removed lines

@@ -93,7 +93,8 @@ 
 	}
 
 	/** 
-	 * @param string 
+	 * @param string
+	 * @param string $tag 
 	 */
 	public function setTag($tag) {
 		$this->tag = $tag;
@@ -109,7 +110,8 @@ 
 	}
 
 	/** 
-	 * @param string 
+	 * @param string
+	 * @param string $legend 
 	 */
 	public function setLegend($legend) {
 		$this->legend = $legend;
@@ -200,6 +202,9 @@ 
 		return false; 
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function fieldByName($name) {
 		return $this->children->fieldByName($name);
 	}
@@ -306,6 +311,7 @@ 
 	 * the children collection. Doesn't work recursively.
 	 * 
 	 * @param string|FormField
+	 * @param string $field
 	 * @return int Position in children collection (first position starts with 0). Returns FALSE if the field can't
 	 *             be found.
 	 */

forms/ConfirmedPasswordField.php

Doc Comments +1 added lines, -1 removed lines

@@ -409,7 +409,7 @@
 	 *
 	 * @param DataObjectInterface $record
 	 *
-	 * @return boolean
+	 * @return false|null
 	 */
 	public function saveInto(DataObjectInterface $record) {
 		if(!$this->isSaveable()) {

forms/DatetimeField.php

Doc Comments +17 added lines, -2 removed lines

@@ -56,6 +56,10 @@ 
 	 */
 	protected $config;
 		
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 		
@@ -68,6 +72,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 		
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 		
@@ -78,6 +85,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -229,6 +239,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -254,6 +265,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -292,7 +304,7 @@ 
 	 * to set field-specific config options.
 	 * 
 	 * @param string $name
-	 * @param mixed $val
+	 * @param string $val
 	 */
 	public function setConfig($name, $val) {
 		$this->config[$name] = $val;
@@ -310,7 +322,7 @@ 
 	 * to get field-specific config options.
 	 * 
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed
+	 * @return string|null
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -320,6 +332,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);