silverstripe / silverstripe-framework

control/HTTP.php

Doc Comments +12 added lines, -1 removed lines

@@ -99,7 +99,7 @@ 
 	 * @param string|callable $code Either a string that can evaluate to an expression
 	 * to rewrite links (depreciated), or a callable that takes a single 
 	 * parameter and returns the rewritten URL
-	 * @return The content with all links rewritten as per the logic specified in $code
+	 * @return string content with all links rewritten as per the logic specified in $code
 	 */
 	public static function urlRewriter($content, $code) {
 		if(!is_callable($code)) {
@@ -243,6 +243,9 @@ 
 		return count($result) ? $result : null;
 	}
 	
+	/**
+	 * @param string $content
+	 */
 	public static function getLinksIn($content) {
 		return self::findByTagAndAttribute($content, array("a" => "href"));
 	}
@@ -285,6 +288,7 @@ 
 
 	/**
 	 * Set the maximum age of this page in web caches, in seconds
+	 * @param integer $age
 	 */
 	public static function set_cache_age($age) {
 		self::$cache_age = $age;
@@ -296,11 +300,17 @@ 
 			self::$modification_date = $timestamp;
 	}
 
+	/**
+	 * @param integer $timestamp
+	 */
 	public static function register_modification_timestamp($timestamp) {
 		if($timestamp > self::$modification_date)
 			self::$modification_date = $timestamp;
 	}
 
+	/**
+	 * @param string $etag
+	 */
 	public static function register_etag($etag) {
 		self::$etag = $etag;
 	}
@@ -313,6 +323,7 @@ 
 	 *
 	 * @param SS_HTTPResponse The SS_HTTPResponse object to augment.  Omitted the argument or passing a string is
 	 *                            deprecated; in these cases, the headers are output directly.
+	 * @param SS_HTTPResponse $body
 	 */
 	public static function add_cache_headers($body = null) {
 		$cacheAge = self::$cache_age;

control/injector/Injector.php

Doc Comments +8 added lines, -8 removed lines

@@ -331,14 +331,13 @@ 
 	 * of a particular type is injected, and what items should be injected
 	 * for those properties / methods.
 	 *
-	 * @param type $class
+	 * @param string $class
 	 *					The class to set a mapping for
-	 * @param type $property
+	 * @param string $property
 	 *					The property to set the mapping for
-	 * @param type $injectType
-	 *					The registered type that will be injected
 	 * @param string $injectVia
 	 *					Whether to inject by setting a property or calling a setter
+	 * @param string $toInject
 	 */
 	public function setInjectMapping($class, $property, $toInject, $injectVia = 'property') {
 		$mapping = isset($this->injectMap[$class]) ? $this->injectMap[$class] : array();
@@ -358,7 +357,7 @@ 
 	 *
 	 * @param string $property
 	 *				the name of the property
-	 * @param object $object
+	 * @param string $object
 	 *				the object to be set
 	 */
 	public function addAutoProperty($property, $object) {
@@ -452,7 +451,7 @@ 
 	 *				The name of the service to update the definition for
 	 * @param string $property
 	 *				The name of the property to update.
-	 * @param mixed $value
+	 * @param string $value
 	 *				The value to set
 	 * @param boolean $append
 	 *				Whether to append (the default) when the property is an array
@@ -720,6 +719,7 @@ 
 	 *
 	 * Will recursively call hasService for each depth of dotting
 	 *
+	 * @param string $name
 	 * @return string
 	 *				The name of the service (as it might be different from the one passed in)
 	 */
@@ -764,6 +764,8 @@ 
 	 * Register a service with an explicit name
 	 *
 	 * @deprecated since 3.1.1
+	 * @param string $name
+	 * @param stdClass $service
 	 */
 	public function registerNamedService($name, $service) {
 		return $this->registerService($service, $name);
@@ -895,8 +897,6 @@ 
 	 *
 	 * @param string $name
 	 *				Name of the class to create an object of
-	 * @param array $args
-	 *				Arguments to pass to the constructor
 	 * @return mixed
 	 */
 	public function createWithArgs($name, $constructorArgs) {

control/RequestHandler.php

Doc Comments +5 added lines

@@ -121,6 +121,7 @@ 
 	
 	/**
 	 * Set the DataModel for this request.
+	 * @param DataModel $model
 	 */
 	public function setDataModel($model) {
 		$this->model = $model;
@@ -238,6 +239,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	protected function findAction($request) {
 		$handlerClass = ($this->class) ? $this->class : get_class($this);
 
@@ -384,6 +388,7 @@ 
 
 	/**
 	 * Return the class that defines the given action, so that we know where to check allowed_actions.
+	 * @return string|null
 	 */
 	protected function definingClassForAction($actionOrigCasing) {
 		$action = strtolower($actionOrigCasing);

core/Config.php

Doc Comments +13 added lines

@@ -475,6 +475,9 @@ 
 		$this->cache->clean("__{$class}");
 	}
 
+	/**
+	 * @param integer $sourceOptions
+	 */
 	protected function getUncached($class, $name, $sourceOptions, &$result, $suppress, &$tags) {
 		$tags[] = "__{$class}";
 		$tags[] = "__{$class}__{$name}";
@@ -732,6 +735,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;
@@ -767,6 +774,9 @@ 
 		return $this->miss ? ($this->hit / $this->miss) : 0;
 	}
 
+	/**
+	 * @param integer $key
+	 */
 	public function get($key) {
 		if (isset($this->indexing[$key])) {
 			$this->hit++;
@@ -780,6 +790,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	public function clean($tag = null) {
 		if ($tag) {
 			foreach ($this->cache as $i => $v) {

core/Convert.php

Doc Comments +2 added lines, -1 removed lines

@@ -51,7 +51,7 @@ 
 	 * @see http://www.w3.org/TR/REC-html40/types.html#type-cdata
 	 * @uses Convert::raw2att()
 	 * @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)) {
@@ -200,6 +200,7 @@ 
 	 * call this function directly, Please use {@link Convert::xml2array()}
 	 * 
 	 * @param SimpleXMLElement
+	 * @param SimpleXMLElement $xml
 	 * 
 	 * @return mixed
 	 */

core/PaginatedList.php

Doc Comments +2 added lines, -2 removed lines

@@ -322,14 +322,14 @@
 	}
 
 	/**
-	 * @return int
+	 * @return double
 	 */
 	public function CurrentPage() {
 		return floor($this->getPageStart() / $this->getPageLength()) + 1;
 	}
 
 	/**
-	 * @return int
+	 * @return double
 	 */
 	public function TotalPages() {
 		return ceil($this->getTotalItems() / $this->getPageLength());

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