[HttpFoundation] Fix getClientIp @return docblock

symfony · Apr 13, 2017 · 6932072 · 6932072
1 parent 67fba7d
commit 6932072
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -553,7 +553,7 @@ public static function setTrustedProxies(array $proxies)
     /**
      * Gets the list of trusted proxies.
      *
-     * @return array An array of trusted proxies.
+     * @return array an array of trusted proxies
      */
     public static function getTrustedProxies()
     {
@@ -579,7 +579,7 @@ public static function setTrustedHosts(array $hostPatterns)
     /**
      * Gets the list of trusted host patterns.
      *
-     * @return array An array of trusted host patterns.
+     * @return array an array of trusted host patterns
      */
     public static function getTrustedHosts()
     {
@@ -832,7 +832,7 @@ public function getClientIps()
                 unset($clientIps[$key]);
 
                 // Fallback to this when the client IP falls into the range of trusted proxies
-                if (null ===  $firstTrustedIp) {
+                if (null === $firstTrustedIp) {
                     $firstTrustedIp = $clientIp;
                 }
             }
@@ -855,7 +855,7 @@ public function getClientIps()
      * ("Client-Ip" for instance), configure it via "setTrustedHeaderName()" with
      * the "client-ip" key.
      *
-     * @return string The client IP address
+     * @return string|null The client IP address
      *
      * @see getClientIps()
      * @see http://en.wikipedia.org/wiki/X-Forwarded-For
@@ -1392,7 +1392,7 @@ public function getRequestFormat($default = 'html')
     /**
      * Sets the request format.
      *
-     * @param string $format The request format.
+     * @param string $format the request format
      */
     public function setRequestFormat($format)
     {
@@ -1456,7 +1456,7 @@ public function getLocale()
     /**
      * Checks if the request method is of specified type.
      *
-     * @param string $method Uppercase request method (GET, POST etc).
+     * @param string $method uppercase request method (GET, POST etc)
      *
      * @return bool
      */
@@ -1480,7 +1480,7 @@ public function isMethodSafe()
      *
      * @param bool $asResource If true, a resource will be returned
      *
-     * @return string|resource The request body content or a resource to read the body stream.
+     * @return string|resource the request body content or a resource to read the body stream
      *
      * @throws \LogicException
      */
@@ -1666,7 +1666,7 @@ public function getAcceptableContentTypes()
      * It works if your JavaScript library sets an X-Requested-With HTTP header.
      * It is known to work with common JavaScript frameworks:
      *
-     * @link http://en.wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
+     * @see http://en.wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
      *
      * @return bool true if the request is an XMLHttpRequest, false otherwise
      */