silverstripe / silverstripe-framework

model/fieldtypes/Date.php

Doc Comments +5 added lines, -2 removed lines

@@ -28,6 +28,9 @@ 
 	private static $nice_format = 'd/m/Y';
 
 
+	/**
+	 * @param string|null $value
+	 */
 	public function setValue($value, $record = null) {
 		if($value === false || $value === null || (is_string($value) && !strlen($value))) {
 			// don't try to evaluate empty values with strtotime() below, as it returns "1970-01-01" when it should be
@@ -110,7 +113,7 @@ 
 
 	/**
 	 * Returns the day of the month.
-	 * @param boolean $includeOrdinals Include ordinal suffix to day, e.g. "th" or "rd"
+	 * @param boolean $includeOrdinal Include ordinal suffix to day, e.g. "th" or "rd"
 	 * @return string
 	 */
 	public function DayOfMonth($includeOrdinal = false) {
@@ -164,7 +167,7 @@ 
 	 * Return a date formatted as per a CMS user's settings.
 	 *
 	 * @param Member $member
-	 * @return boolean | string A date formatted as per user-defined settings.
+	 * @return false|string | string A date formatted as per user-defined settings.
 	 */
 	public function FormatFromSettings($member = null) {
 		require_once 'Zend/Date.php';

model/fieldtypes/DBField.php

Doc Comments +3 added lines

@@ -209,6 +209,9 @@
 
 	}
 
+	/**
+	 * @param string $tableName
+	 */
 	public function setTable($tableName) {
 		$this->tableName = $tableName;
 	}

model/URLSegmentFilter.php

Doc Comments +1 added lines

@@ -129,6 +129,7 @@
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setAllowMultibyte($bool) {
 		$this->allowMultibyte = $bool;

thirdparty/jstree/_demo/_inc/class._database_i.php

Doc Comments +3 added lines

@@ -92,6 +92,9 @@
 		return $return;
 	}
 
+	/**
+	 * @param boolean $index
+	 */
 	function f($index) {
 		return stripslashes($this->row[$index]);
 	}

view/Requirements.php

Doc Comments +6 added lines, -4 removed lines

@@ -63,6 +63,7 @@ 
 	 * while automatically busting this cache every time the file is changed.
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public static function set_suffix_requirements($var) {
 		self::backend()->set_suffix_requirements($var);
@@ -123,7 +124,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public static function get_custom_scripts() {
 		return self::backend()->get_custom_scripts();
@@ -531,7 +532,7 @@ 
 	/**
 	 * Enable or disable the combination of CSS and JavaScript files
 	 *
-	 * @param $enable
+	 * @param boolean $enable
 	 */
 	public function set_combined_files_enabled($enable) {
 		$this->combined_files_enabled = (bool) $enable;
@@ -599,6 +600,7 @@ 
 	 * Forces the JavaScript requirements to the end of the body, right before the closing tag
 	 *
 	 * @param bool
+	 * @param boolean $var
 	 */
 	public function set_force_js_to_bottom($var) {
 		$this->force_js_to_bottom = $var;
@@ -638,7 +640,7 @@ 
 	/**
 	 * Return all registered custom scripts
 	 *
-	 * @return array
+	 * @return string
 	 */
 	public function get_custom_scripts() {
 		$requirements = "";
@@ -1051,7 +1053,7 @@ 
 	 * @param array  $files            Array of filenames relative to docroot
 	 * @param string $media
 	 *
-	 * @return bool|void
+	 * @return false|null
 	 */
 	public function combine_files($combinedFileName, $files, $media = null) {
 		// duplicate check

core/Config.php

Doc Comments +23 added lines, -9 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}";
@@ -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;
@@ -803,6 +804,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if ($tag) {
 			foreach ($this->cache as $i => $v) {
@@ -834,6 +838,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])) {
@@ -852,6 +860,9 @@ 
 		return $this->miss ? ($this->hit / $this->miss) : 0;
 	}
 
+	/**
+	 * @param integer $key
+	 */
 	public function get($key) {
 		list($hit, $result) = $this->checkAndGet($key);
 		return $hit ? $result : false;
@@ -871,6 +882,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if($tag) {
 			if(isset($this->tags[$tag])) {

core/Convert.php

Doc Comments +3 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
 	 *
 	 * @param array|string $val String to escape, or array of strings
 	 *
-	 * @return array|string
+	 * @return string
 	 */
 	public static function raw2htmlname($val) {
 		if(is_array($val)) {
@@ -181,7 +181,7 @@ 
 	 *
 	 * @param string|array $identifier The identifier to escape. E.g. 'SiteTree.Title'
 	 * @param string $separator The string that delimits subsequent identifiers
-	 * @return string|array The escaped identifier. E.g. '"SiteTree"."Title"'
+	 * @return string The escaped identifier. E.g. '"SiteTree"."Title"'
 	 */
 	public static function symbol2sql($identifier, $separator = '.') {
 		if(is_array($identifier)) {
@@ -266,6 +266,7 @@ 
 	 * call this function directly, Please use {@link Convert::xml2array()}
 	 *
 	 * @param SimpleXMLElement
+	 * @param SimpleXMLElement $xml
 	 *
 	 * @return mixed
 	 */

filesystem/File.php

Doc Comments +2 added lines, -1 removed lines

@@ -234,7 +234,7 @@ 
 	 * Find a File object by the given filename.
 	 *
 	 * @param String $filename Matched against the "Name" property.
-	 * @return mixed null if not found, File object of found file
+	 * @return null|DataObject null if not found, File object of found file
 	 */
 	public static function find($filename) {
 		// Get the base file if $filename points to a resampled file
@@ -449,6 +449,7 @@ 
 	 * showing icons on filelinks, etc.
 	 * Possible group values are: "audio", "mov", "zip", "image".
 	 *
+	 * @param string $ext
 	 * @return String
 	 */
 	public static function get_app_category($ext) {

filesystem/GD.php

Doc Comments +8 added lines

@@ -150,6 +150,7 @@ 
 	 * successfully, the manipulation's cache key is removed.
 	 *
 	 * @param string $filename
+	 * @param string $manipulation
 	 * @return boolean
 	 */
 	public function failedResample($filename, $manipulation) {
@@ -428,6 +429,10 @@ 
 			return $useAsMinimum ? $this->resizeByWidth( $maxWidth ) : $this->resizeByHeight( $maxHeight );
 	}
 
+	/**
+	 * @param resource $image
+	 * @param string $webColor
+	 */
 	public static function color_web2gd($image, $webColor, $transparencyPercent = 0) {
 		if(substr($webColor,0,1) == "#") $webColor = substr($webColor,1);
 		$r = hexdec(substr($webColor,0,2));
@@ -546,6 +551,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'));