silverstripe / silverstripe-framework

view/SSViewer.php

Doc Comments +14 added lines, -5 removed lines

@@ -369,7 +369,6 @@ 
 	/**
 	 * Returns the modulus of the numerical position of the item in the data set.
 	 * The count starts from $startIndex, which defaults to 1.
-	 * @param int $Mod The number to perform Mod operation to.
 	 * @param int $startIndex Number to start count from.
 	 * @return int
 	 */
@@ -443,6 +442,10 @@ 
 		$this->underlay = $underlay ? $underlay : array();
 	}
 
+	/**
+	 * @param string $interfaceToQuery
+	 * @param string $variableMethod
+	 */
 	protected function createCallableArray(&$extraArray, $interfaceToQuery, $variableMethod, $createObject = false) {
 		$implementers = ClassInfo::implementorsOf($interfaceToQuery);
 		if($implementers) foreach($implementers as $implementer) {
@@ -843,7 +846,7 @@ 
 	 *
 	 * @param $className string - valid class name
 	 * @param $suffix string
-	 * @param $baseClass string
+	 * @param string $baseClass string
 	 *
 	 * @return array
 	 */
@@ -873,7 +876,7 @@ 
 	}
 
 	/**
-	 * @param string|array $templateList If passed as a string with .ss extension, used as the "main" template.
+	 * @param string|array $templates If passed as a string with .ss extension, used as the "main" template.
 	 *  If passed as an array, it can be used for template inheritance (first found template "wins").
 	 *  Usually the array values are PHP class names, which directly correlate to template names.
 	 *  <code>
@@ -1227,7 +1230,7 @@ 
 	 * @param string $template Template name
 	 * @param mixed $data Data context
 	 * @param array $arguments Additional arguments
-	 * @return string Evaluated result
+	 * @return DBHTMLText Evaluated result
 	 */
 	public static function execute_template($template, $data, $arguments = null, $scope = null) {
 		$v = new SSViewer($template);
@@ -1253,6 +1256,9 @@ 
 		return $v->process($data, $arguments);
 	}
 
+	/**
+	 * @param string $content
+	 */
 	public function parseTemplateContent($content, $template="") {
 		return $this->getParser()->compileString(
 			$content,
@@ -1282,7 +1288,7 @@ 
 	 * Return an appropriate base tag for the given template.
 	 * It will be closed on an XHTML document, and unclosed on an HTML document.
 	 *
-	 * @param $contentGeneratedSoFar The content of the template generated so far; it should contain
+	 * @param string $contentGeneratedSoFar The content of the template generated so far; it should contain
 	 * the DOCTYPE declaration.
 	 */
 	public static function get_base_tag($contentGeneratedSoFar) {
@@ -1323,6 +1329,9 @@ 
 	 */
 	protected $cacheTemplate;
 
+	/**
+	 * @param string $content
+	 */
 	public function __construct($content, TemplateParser $parser = null) {
 		if ($parser) {
 			$this->setParser($parser);

forms/ReadonlyField.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 	 * If $dontEscape is false the returned value will be safely encoded,
 	 * but should not be escaped by the frontend.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function Value() {
 		// Get raw value

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;

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])) {

core/manifest/ManifestCache.php

Doc Comments +18 added lines

@@ -7,9 +7,27 @@
  * @subpackage manifest
  */
 interface ManifestCache {
+
+	/**
+	 * @return void
+	 */
 	public function __construct($name);
+
+	/**
+	 * @param string $key
+	 */
 	public function load($key);
+
+	/**
+	 * @param string $key
+	 *
+	 * @return void
+	 */
 	public function save($data, $key);
+
+	/**
+	 * @return void
+	 */
 	public function clear();
 }
 

view/ThemeResourceLoader.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
 		self::$instance = $instance;
 	}
 
+	/**
+	 * @param string $base
+	 */
 	public function __construct($base = null) {
 		$this->base = $base ? $base : BASE_PATH;
 	}

admin/code/CMSMenuItem.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 	/**
 	 * @param array
 	 *
-	 * @return HTML
+	 * @return DBField
 	 */
 	public function getAttributesHTML($attrs = null) {
 		$exclude = (is_string($attrs)) ? func_get_args() : null;

forms/DatetimeField.php

Doc Comments +22 added lines, -4 removed lines

@@ -64,6 +64,10 @@ 
 	 */
 	protected $config;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		$this->config = $this->config()->default_config;
 
@@ -74,6 +78,9 @@ 
 		parent::__construct($name, $title, $value);
 	}
 
+	/**
+	 * @param Form $form
+	 */
 	public function setForm($form) {
 		parent::setForm($form);
 
@@ -84,6 +91,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function setName($name) {
 		parent::setName($name);
 
@@ -96,7 +106,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function FieldHolder($properties = array()) {
 		$config = array(
@@ -110,7 +120,7 @@ 
 
 	/**
 	 * @param array $properties
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function Field($properties = array()) {
 		Requirements::css(FRAMEWORK_DIR . '/client/dist/styles/DatetimeField.css');
@@ -223,6 +233,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setReadonly($bool) {
 		parent::setReadonly($bool);
 		$this->dateField->setReadonly($bool);
@@ -240,6 +253,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param DateField $field
 	 */
 	public function setDateField($field) {
 		$expected = $this->getName() . '[date]';
@@ -265,6 +279,7 @@ 
 
 	/**
 	 * @param FormField
+	 * @param TimeField $field
 	 */
 	public function setTimeField($field) {
 		$expected = $this->getName() . '[time]';
@@ -312,7 +327,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;
@@ -330,7 +345,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) {
@@ -340,6 +355,9 @@ 
 		}
 	}
 
+	/**
+	 * @param RequiredFields $validator
+	 */
 	public function validate($validator) {
 		$dateValid = $this->dateField->validate($validator);
 		$timeValid = $this->timeField->validate($validator);

forms/TimeField.php

Doc Comments +8 added lines, -1 removed lines

@@ -52,6 +52,10 @@ 
 
 	protected $schemaDataType = FormField::SCHEMA_DATA_TYPE_TIME;
 
+	/**
+	 * @param string $name
+	 * @param string $title
+	 */
 	public function __construct($name, $title = null, $value = ""){
 		if(!$this->locale) {
 			$this->locale = i18n::get_locale();
@@ -213,7 +217,7 @@ 
 
 	/**
 	 * @param String $name Optional, returns the whole configuration array if empty
-	 * @return mixed|array
+	 * @return string|null
 	 */
 	public function getConfig($name = null) {
 		if($name) {
@@ -230,6 +234,9 @@ 
 		return $this->castedCopy('TimeField_Readonly');
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function castedCopy($class) {
 		$copy = parent::castedCopy($class);
 		if($copy->hasMethod('setConfig')) {