silverstripe / silverstripe-framework

forms/FormField.php

Doc Comments +3 added lines, -4 removed lines

@@ -760,7 +760,6 @@ 
 	 * Set the field value.
 	 *
 	 * @param mixed $value
-	 * @param null|array|DataObject $data {@see Form::loadDataFrom}
 	 *
 	 * @return $this
 	 */
@@ -1184,7 +1183,7 @@ 
 	/**
 	 * @param FormTransformation $transformation
 	 *
-	 * @return mixed
+	 * @return FormField
 	 */
 	public function transform(FormTransformation $transformation) {
 		return $transformation->transform($this);
@@ -1287,7 +1286,7 @@ 
 	 * This function is used by the template processor. If you refer to a field as a $ variable, it
 	 * will return the $Field value.
 	 *
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function forTemplate() {
 		return $this->Field();
@@ -1309,7 +1308,7 @@ 
 	 *
 	 * @param FieldList $containerFieldList
 	 *
-	 * @return FieldList
+	 * @return FormField
 	 */
 	public function setContainerFieldList($containerFieldList) {
 		$this->containerFieldList = $containerFieldList;

forms/TextField.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	}
 
 	/**
-	 * @return null|int
+	 * @return integer
 	 */
 	public function getMaxLength() {
 		return $this->maxLength;
@@ -73,7 +73,7 @@ 
 	}
 
 	/**
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function InternallyLabelledField() {
 		Deprecation::notice('4.0', 'Please use ->setValue() instead');

view/TemplateLoader.php

Doc Comments +9 added lines, -2 removed lines

@@ -24,10 +24,17 @@ 
 		self::$instance = $instance;
 	}
 
+	/**
+	 * @param string $base
+	 */
 	public function __construct($base = null) {
 		$this->base = $base ? $base : BASE_PATH;
 	}
 
+	/**
+	 * @param string $set
+	 * @param ThemeManifest $manifest
+	 */
 	public function addSet($set, $manifest) {
 		$this->sets[$set] = $manifest;
 	}
@@ -72,8 +79,8 @@ 
 	 * format "type/name", where type is the type of template to search for
 	 * (e.g. Includes, Layout).
 	 *
-	 * @param  string|array $templates
-	 * @param  string $theme
+	 * @param  string|array $template
+	 * @param  string $themes
 	 *
 	 * @return array
 	 */

view/ViewableData.php

Doc Comments +2 added lines, -2 removed lines

@@ -129,7 +129,7 @@ 
 	/**
 	 * Get the current failover object if set
 	 *
-	 * @return ViewableData|null
+	 * @return ViewableData
 	 */
 	public function getFailover() {
 		return $this->failover;
@@ -295,7 +295,7 @@ 
 	 *
 	 * @param string|array|SSViewer $template the template to render into
 	 * @param array $customFields fields to customise() the object with before rendering
-	 * @return DBHTMLText
+	 * @return SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function renderWith($template, $customFields = null) {
 		if(!is_object($template)) {

core/Config.php

Doc Comments +27 added lines, -11 removed lines

@@ -470,11 +470,17 @@ 
 
 	protected $extraConfigSources = array();
 
+	/**
+	 * @param string $class
+	 */
 	public function extraConfigSourcesChanged($class) {
 		unset($this->extraConfigSources[$class]);
 		$this->cache->clean("__{$class}");
 	}
 
+	/**
+	 * @param integer $sourceOptions
+	 */
 	protected function getUncached($class, $name, $sourceOptions, &$result, $suppress, &$tags) {
 		$tags[] = "__{$class}";
 		$tags[] = "__{$class}__{$name}";
@@ -603,7 +609,7 @@ 
 	 * replace the current array value, you'll need to call remove first.
 	 *
 	 * @param $class string - The class to update a configuration value for
-	 * @param $name string - The configuration property name to update
+	 * @param string $name string - The configuration property name to update
 	 * @param $value any - The value to update with
 	 *
 	 * Arrays are recursively merged into current configuration as "latest" - for associative arrays the passed value
@@ -648,15 +654,6 @@ 
 	 *
 	 * @param string $class The class to remove a configuration value from
 	 * @param string $name The configuration name
-	 * @param mixed $key An optional key to filter against.
-	 *   If referenced config value is an array, only members of that array that match this key will be removed
-	 *   Must also match value if provided to be removed
-	 * @param mixed $value And optional value to filter against.
-	 *   If referenced config value is an array, only members of that array that match this value will be removed
-	 *   If referenced config value is not an array, value will be removed only if it matches this argument
-	 *   Must also match key if provided and referenced config value is an array to be removed
-	 *
-	 * Matching is always by "==", not by "==="
 	 */
 	public function remove($class, $name /*,$key = null*/ /*,$value = null*/) {
 		$argc = func_num_args();
@@ -735,6 +732,10 @@ 
 		$this->cache = $cloned;
 	}
 
+	/**
+	 * @param integer $key
+	 * @param integer $val
+	 */
 	public function set($key, $val, $tags = array()) {
 		// Find an index to set at
 		$replacing = null;
@@ -775,7 +776,7 @@ 
 	 * For a more robust cache checking, use {@link checkAndGet()}
 	 *
 	 * @param  string $key The cache key
-	 * @return variant     Cached value, if hit. False otherwise
+	 * @return boolean     Cached value, if hit. False otherwise
 	 */
 	public function get($key) {
 		list($hit, $result) = $this->checkAndGet($key);
@@ -803,6 +804,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if ($tag) {
 			foreach ($this->cache as $i => $v) {
@@ -841,6 +845,10 @@ 
 		$this->cache = array();
 	}
 
+	/**
+	 * @param integer $key
+	 * @param integer $val
+	 */
 	public function set($key, $val, $tags = array()) {
 		foreach($tags as $t) {
 			if(!isset($this->tags[$t])) {
@@ -859,6 +867,11 @@ 
 		return $this->miss ? ($this->hit / $this->miss) : 0;
 	}
 
+	/**
+	 * @param integer $key
+	 *
+	 * @return boolean
+	 */
 	public function get($key) {
 		list($hit, $result) = $this->checkAndGet($key);
 		return $hit ? $result : false;
@@ -878,6 +891,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if($tag) {
 			if(isset($this->tags[$tag])) {

email/Email.php

Doc Comments +6 added lines, -6 removed lines

@@ -224,42 +224,42 @@
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
 	public function Subject() {
 		return $this->subject;
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
 	public function Body() {
 		return $this->body;
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
 	public function To() {
 		return $this->to;
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
 	public function From() {
 		return $this->from;
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
 	public function Cc() {
 		return $this->cc;
 	}
 
 	/**
-	 * @return string|null
+	 * @return string
 	 */
 	public function Bcc() {
 		return $this->bcc;