sminnee / silverstripe-framework

src/Control/Director.php

Doc Comments +3 added lines, -3 removed lines

@@ -534,7 +534,7 @@ 
 	 * Returns the domain part of the URL 'http://www.mysite.com'. Returns FALSE is this environment
 	 * variable isn't set.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function protocolAndHost() {
 		$alternate = Config::inst()->get('Director', 'alternate_base_url');
@@ -869,7 +869,7 @@ 
 	/**
 	 * Returns true if the given file exists. Filename should be relative to the site root.
 	 *
-	 * @param $file
+	 * @param string $file
 	 *
 	 * @return bool
 	 */
@@ -1087,7 +1087,7 @@ 
 	 * Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and
 	 * {@link Director::isLive()}.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function get_environment_type() {
 		if(Director::isLive()) {

src/Control/Email/Email.php

Doc Comments +1 added lines, -1 removed lines

@@ -390,7 +390,7 @@
 	}
 
 	/**
-	 * @return Email|ViewableData_Customised
+	 * @return ViewableData
 	 */
 	protected function templateData() {
 		if($this->template_data) {

src/Control/Email/Mailer.php

Doc Comments +1 added lines, -1 removed lines

@@ -321,7 +321,7 @@
 	/**
 	 * Encode an array of parts using multipart
 	 *
-	 * @param array $parts List of parts
+	 * @param string[] $parts List of parts
 	 * @param string $contentType Content-type of parts
 	 * @param array $headers Existing headers to include in response
 	 * @return array Array with two items, the body followed by headers

src/Control/HTTPRequest.php

Doc Comments +2 added lines, -2 removed lines

@@ -427,9 +427,9 @@
 	 * it's only advisable to send small files through this method.
 	 *
 	 * @static
-	 * @param $fileData
+	 * @param string $fileData
 	 * @param $fileName
-	 * @param null $mimeType
+	 * @param string $mimeType
 	 * @return HTTPResponse
 	 */
 	public static function send_file($fileData, $fileName, $mimeType = null) {

src/Control/RequestHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -289,7 +289,7 @@
 	 *
 	 * Must not raise HTTPResponse_Exceptions - instead it should return
 	 *
-	 * @param $request
+	 * @param HTTPRequest $request
 	 * @param $action
 	 * @return HTTPResponse
 	 */

src/Control/RSS/RSSFeed.php

Doc Comments +1 added lines

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

src/Control/Session.php

Doc Comments +6 added lines

@@ -297,6 +297,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function inst_set($name, $val) {
 		// Quicker execution path for "."-free names
 		if(strpos($name, '.') === false) {
@@ -345,6 +348,9 @@ 
 		$diffVar[sizeof($var)-1] = $val;
 	}
 
+	/**
+	 * @param string $name
+	 */
 	public function inst_get($name) {
 		// Quicker execution path for "."-free names
 		if(strpos($name, '.') === false) {

src/Core/ClassInfo.php

Doc Comments +3 added lines

@@ -276,6 +276,9 @@
 
 	private static $method_from_cache = array();
 
+	/**
+	 * @param string $method
+	 */
 	public static function has_method_from($class, $method, $compclass) {
 		$lClass = strtolower($class);
 		$lMethod = strtolower($method);

src/Core/Config/Config.php

Doc Comments +7 added lines, -1 removed lines

@@ -483,11 +483,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}";
@@ -575,7 +581,7 @@ 
 	 * caching heavily here.
 	 *
 	 * @param $class string - The name of the class to get the value for
-	 * @param $name string - The property to get the value for
+	 * @param string $name string - The property to get the value for
 	 * @param int $sourceOptions Bitmask which can be set to some combintain of Config::UNINHERITED,
 	 *                           Config::FIRST_SET, and Config::EXCLUDE_EXTENSIONS.
 	 *