sminnee / silverstripe-framework

tests/forms/RequirementsTest.php

Doc Comments +9 added lines

@@ -118,6 +118,11 @@ 
 		);
 	}
 	
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param boolean $async
+	 * @param boolean $defer
+	 */
 	protected function setupCombinedRequirementsJavascriptAsyncDefer($backend, $async, $defer) {
         $basePath = $this->getCurrentRelativePath();
         $this->setupRequirements($backend);
@@ -805,6 +810,10 @@ 
 		}
 	}
 
+	/**
+	 * @param Requirements_Backend $backend
+	 * @param string $type
+	 */
 	public function assertFileNotIncluded($backend, $type, $files) {
 		$includedFiles = $this->getBackendFiles($backend, $type);
 		if(is_array($files)) {

tests/i18n/i18nTextCollectorTest.php

Doc Comments +10 added lines

@@ -843,6 +843,10 @@ 
  * Assist with testing of specific protected methods
  */
 class i18nTextCollectorTest_Collector extends i18nTextCollector implements TestOnly {
+
+	/**
+	 * @param string $directory
+	 */
 	public function getModules_Test($directory) {
 		return $this->getModules($directory);
 	}
@@ -851,6 +855,9 @@ 
 		return $this->resolveDuplicateConflicts($entitiesByModule);
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public function getFileListForModule_Test($module) {
 		return $this->getFileListForModule($module);
 	}
@@ -859,6 +866,9 @@ 
 		return $this->getConflicts($entitiesByModule);
 	}
 
+	/**
+	 * @param string $class
+	 */
 	public function findModuleForClass_Test($class) {
 		return $this->findModuleForClass($class);
 	}

tests/model/VersionedOwnershipTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -730,7 +730,7 @@ 
 	/**
 	 * All custom objects with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function Custom() {
 		$title = str_replace('Page', 'Custom', $this->Title);
@@ -784,7 +784,7 @@ 
 	/**
 	 * All pages with the same number. E.g. 'Page 1' owns 'Custom 1'
 	 *
-	 * @return DataList
+	 * @return SilverStripe\ORM\DataList
 	 */
 	public function Pages() {
 		$title = str_replace('Custom', 'Page', $this->Title);

api/RSSFeed.php

Doc Comments +1 added lines

@@ -227,6 +227,7 @@
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;

control/Controller.php

Doc Comments +3 added lines, -2 removed lines

@@ -137,6 +137,7 @@ 
 	 * {@inheritdoc}
 	 *
 	 * Also set the URLParams
+	 * @param SS_HTTPRequest $request
 	 */
 	public function setRequest($request) {
 		$return = parent::setRequest($request);
@@ -513,7 +514,7 @@ 
 	 *
 	 * @param array $params
 	 *
-	 * @return string
+	 * @return DBHTMLText
 	 */
 	public function render($params = null) {
 		$template = $this->getViewer($this->getAction());
@@ -678,7 +679,7 @@ 
 	 * Tests whether a redirection has been requested. If redirect() has been called, it will return
 	 * the URL redirected to. Otherwise, it will return null.
 	 *
-	 * @return null|string
+	 * @return boolean
 	 */
 	public function redirectedTo() {
 		return $this->getResponse() && $this->getResponse()->getHeader('Location');

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/CustomMethods.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
 	/**
 	 * Get meta-data details on a named method
 	 *
-	 * @param array $method
+	 * @param string $method
 	 * @return array List of custom method details, if defined for this method
 	 */
 	protected function getExtraMethodConfig($method) {

filesystem/flysystem/AssetAdapter.php

Doc Comments +4 added lines, -1 removed lines

@@ -39,6 +39,9 @@ 
         ]
 	);
 
+	/**
+	 * @param string $root
+	 */
 	public function __construct($root = null, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS) {
 		// Get root path
 		$root = $this->findRoot($root);
@@ -119,7 +122,7 @@ 
 	 * Render server configuration file from a template file
 	 *
 	 * @param string $template
-	 * @return DBHTMLText Rendered results
+	 * @return string Rendered results
 	 */
 	protected function renderTemplate($template) {
 		// Build allowed extensions

forms/ConfirmedPasswordField.php

Doc Comments +1 added lines, -1 removed lines

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