silverstripe / silverstripe-framework

src/Control/Director.php

Doc Comments +3 added lines, -3 removed lines

@@ -555,7 +555,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()
     {
@@ -912,7 +912,7 @@ 
     /**
      * Returns true if the given file exists. Filename should be relative to the site root.
      *
-     * @param $file
+     * @param string $file
      *
      * @return bool
      */
@@ -1145,7 +1145,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()
     {

src/Control/Email/Email.php

Doc Comments +1 added lines, -1 removed lines

@@ -433,7 +433,7 @@
     }
 
     /**
-     * @return Email|ViewableData_Customised
+     * @return ViewableData
      */
     protected function templateData()
     {

src/Control/Email/Mailer.php

Doc Comments +1 added lines, -1 removed lines

@@ -344,7 +344,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

@@ -458,9 +458,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

@@ -296,7 +296,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

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

src/Control/Session.php

Doc Comments +6 added lines

@@ -330,6 +330,9 @@ 
         }
     }
 
+    /**
+     * @param string $name
+     */
     public function inst_set($name, $val)
     {
         // Quicker execution path for "."-free names
@@ -379,6 +382,9 @@ 
         $diffVar[sizeof($var)-1] = $val;
     }
 
+    /**
+     * @param string $name
+     */
     public function inst_get($name)
     {
         // Quicker execution path for "."-free names

src/Core/ClassInfo.php

Doc Comments +5 added lines

@@ -297,6 +297,9 @@ 
 
     private static $method_from_cache = array();
 
+    /**
+     * @param string $method
+     */
     public static function has_method_from($class, $method, $compclass)
     {
         $lClass = strtolower($class);
@@ -322,6 +325,8 @@ 
 
     /**
      * @deprecated 4.0..5.0
+     * @param string $candidateClass
+     * @param string $fieldName
      */
     public static function table_for_object_field($candidateClass, $fieldName)
     {

src/Core/Config/Config.php

Doc Comments +7 added lines, -1 removed lines

@@ -521,12 +521,18 @@ 
 
     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}";
@@ -627,7 +633,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.
      *