removed dots at the end of @param and @return

symfony · Jun 28, 2016 · 10f89ef · 10f89ef
1 parent 1ff8149
commit 10f89ef
Show file tree

Hide file tree

Showing 23 changed files with 49 additions and 49 deletions.
diff --git a/File/UploadedFile.php b/File/UploadedFile.php
@@ -194,7 +194,7 @@ public function getError()
     /**
      * Returns whether the file was uploaded successfully.
      *
-     * @return bool True if the file has been uploaded with HTTP and no error occurred.
+     * @return bool True if the file has been uploaded with HTTP and no error occurred
      */
     public function isValid()
     {

diff --git a/IpUtils.php b/IpUtils.php
@@ -57,7 +57,7 @@ public static function checkIp($requestIp, $ips)
      * @param string $requestIp IPv4 address to check
      * @param string $ip        IPv4 address or subnet in CIDR notation
      *
-     * @return bool Whether the request IP matches the IP, or whether the request IP is within the CIDR subnet.
+     * @return bool Whether the request IP matches the IP, or whether the request IP is within the CIDR subnet
      */
     public static function checkIp4($requestIp, $ip)
     {

diff --git a/ParameterBag.php b/ParameterBag.php
@@ -242,11 +242,11 @@ public function getBoolean($key, $default = false, $deep = false)
     /**
      * Filter key.
      *
-     * @param string $key     Key.
-     * @param mixed  $default Default = null.
-     * @param bool   $deep    Default = false.
-     * @param int    $filter  FILTER_* constant.
-     * @param mixed  $options Filter options.
+     * @param string $key     Key
+     * @param mixed  $default Default = null
+     * @param bool   $deep    Default = false
+     * @param int    $filter  FILTER_* constant
+     * @param mixed  $options Filter options
      *
      * @see http://php.net/manual/en/function.filter-var.php
      *

diff --git a/RedirectResponse.php b/RedirectResponse.php
@@ -66,7 +66,7 @@ public function getTargetUrl()
      *
      * @param string $url The URL to redirect to
      *
-     * @return RedirectResponse The current response.
+     * @return RedirectResponse The current response
      *
      * @throws \InvalidArgumentException
      */

diff --git a/Request.php b/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()
     {
@@ -1396,7 +1396,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)
     {
@@ -1460,7 +1460,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
      */
@@ -1484,7 +1484,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
      */

diff --git a/Response.php b/Response.php
@@ -262,7 +262,7 @@ public function __clone()
      *
      * @param Request $request A Request instance
      *
-     * @return Response The current response.
+     * @return Response The current response
      */
     public function prepare(Request $request)
     {

diff --git a/ResponseHeaderBag.php b/ResponseHeaderBag.php
@@ -230,7 +230,7 @@ public function clearCookie($name, $path = '/', $domain = null, $secure = false,
      *                                 is semantically equivalent to $filename. If the filename is already ASCII,
      *                                 it can be omitted, or just copied from $filename
      *
-     * @return string A string suitable for use as a Content-Disposition field-value.
+     * @return string A string suitable for use as a Content-Disposition field-value
      *
      * @throws \InvalidArgumentException
      *

diff --git a/Session/Attribute/NamespacedAttributeBag.php b/Session/Attribute/NamespacedAttributeBag.php
@@ -29,8 +29,8 @@ class NamespacedAttributeBag extends AttributeBag
     /**
      * Constructor.
      *
-     * @param string $storageKey         Session storage key.
-     * @param string $namespaceCharacter Namespace character to use in keys.
+     * @param string $storageKey         Session storage key
+     * @param string $namespaceCharacter Namespace character to use in keys
      */
     public function __construct($storageKey = '_sf2_attributes', $namespaceCharacter = '/')
     {

diff --git a/Session/Flash/AutoExpireFlashBag.php b/Session/Flash/AutoExpireFlashBag.php
@@ -37,7 +37,7 @@ class AutoExpireFlashBag implements FlashBagInterface
     /**
      * Constructor.
      *
-     * @param string $storageKey The key used to store flashes in the session.
+     * @param string $storageKey The key used to store flashes in the session
      */
     public function __construct($storageKey = '_sf2_flashes')
     {

diff --git a/Session/Flash/FlashBag.php b/Session/Flash/FlashBag.php
@@ -39,7 +39,7 @@ class FlashBag implements FlashBagInterface, \IteratorAggregate
     /**
      * Constructor.
      *
-     * @param string $storageKey The key used to store flashes in the session.
+     * @param string $storageKey The key used to store flashes in the session
      */
     public function __construct($storageKey = '_sf2_flashes')
     {

diff --git a/Session/Flash/FlashBagInterface.php b/Session/Flash/FlashBagInterface.php
@@ -39,8 +39,8 @@ public function set($type, $message);
     /**
      * Gets flash messages for a given type.
      *
-     * @param string $type    Message category type.
-     * @param array  $default Default value if $type does not exist.
+     * @param string $type    Message category type
+     * @param array  $default Default value if $type does not exist
      *
      * @return array
      */
@@ -57,7 +57,7 @@ public function peekAll();
      * Gets and clears flash from the stack.
      *
      * @param string $type
-     * @param array  $default Default value if $type does not exist.
+     * @param array  $default Default value if $type does not exist
      *
      * @return array
      */

diff --git a/Session/Session.php b/Session/Session.php
@@ -46,7 +46,7 @@ class Session implements SessionInterface, \IteratorAggregate, \Countable
     /**
      * Constructor.
      *
-     * @param SessionStorageInterface $storage    A SessionStorageInterface instance.
+     * @param SessionStorageInterface $storage    A SessionStorageInterface instance
      * @param AttributeBagInterface   $attributes An AttributeBagInterface instance, (defaults null for default AttributeBag)
      * @param FlashBagInterface       $flashes    A FlashBagInterface instance (defaults null for default FlashBag)
      */

diff --git a/Session/SessionBagInterface.php b/Session/SessionBagInterface.php
@@ -42,7 +42,7 @@ public function getStorageKey();
     /**
      * Clears out data from bag.
      *
-     * @return mixed Whatever data was contained.
+     * @return mixed Whatever data was contained
      */
     public function clear();
 }
diff --git a/Session/SessionInterface.php b/Session/SessionInterface.php
@@ -23,7 +23,7 @@ interface SessionInterface
     /**
      * Starts the session storage.
      *
-     * @return bool True if session started.
+     * @return bool True if session started
      *
      * @throws \RuntimeException If session fails to start.
      */
@@ -32,7 +32,7 @@ public function start();
     /**
      * Returns the session ID.
      *
-     * @return string The session ID.
+     * @return string The session ID
      */
     public function getId();
 
@@ -46,7 +46,7 @@ public function setId($id);
     /**
      * Returns the session name.
      *
-     * @return mixed The session name.
+     * @return mixed The session name
      */
     public function getName();
 
@@ -68,21 +68,21 @@ public function setName($name);
      *                      to expire with browser session. Time is in seconds, and is
      *                      not a Unix timestamp.
      *
-     * @return bool True if session invalidated, false if error.
+     * @return bool True if session invalidated, false if error
      */
     public function invalidate($lifetime = null);
 
     /**
      * Migrates the current session to a new session id while maintaining all
      * session attributes.
      *
-     * @param bool $destroy  Whether to delete the old session or leave it to garbage collection.
+     * @param bool $destroy  Whether to delete the old session or leave it to garbage collection
      * @param int  $lifetime Sets the cookie lifetime for the session cookie. A null value
      *                       will leave the system settings unchanged, 0 sets the cookie
      *                       to expire with browser session. Time is in seconds, and is
      *                       not a Unix timestamp.
      *
-     * @return bool True if session migrated, false if error.
+     * @return bool True if session migrated, false if error
      */
     public function migrate($destroy = false, $lifetime = null);
 
@@ -108,7 +108,7 @@ public function has($name);
      * Returns an attribute.
      *
      * @param string $name    The attribute name
-     * @param mixed  $default The default value if not found.
+     * @param mixed  $default The default value if not found
      *
      * @return mixed
      */

diff --git a/Session/Storage/Handler/MemcacheSessionHandler.php b/Session/Storage/Handler/MemcacheSessionHandler.php
@@ -19,7 +19,7 @@
 class MemcacheSessionHandler implements \SessionHandlerInterface
 {
     /**
-     * @var \Memcache Memcache driver.
+     * @var \Memcache Memcache driver
      */
     private $memcache;
 
@@ -29,7 +29,7 @@ class MemcacheSessionHandler implements \SessionHandlerInterface
     private $ttl;
 
     /**
-     * @var string Key prefix for shared environments.
+     * @var string Key prefix for shared environments
      */
     private $prefix;
 

diff --git a/Session/Storage/Handler/MemcachedSessionHandler.php b/Session/Storage/Handler/MemcachedSessionHandler.php
@@ -24,7 +24,7 @@
 class MemcachedSessionHandler implements \SessionHandlerInterface
 {
     /**
-     * @var \Memcached Memcached driver.
+     * @var \Memcached Memcached driver
      */
     private $memcached;
 
@@ -34,7 +34,7 @@ class MemcachedSessionHandler implements \SessionHandlerInterface
     private $ttl;
 
     /**
-     * @var string Key prefix for shared environments.
+     * @var string Key prefix for shared environments
      */
     private $prefix;
 

diff --git a/Session/Storage/Handler/NativeFileSessionHandler.php b/Session/Storage/Handler/NativeFileSessionHandler.php
@@ -23,7 +23,7 @@ class NativeFileSessionHandler extends NativeSessionHandler
     /**
      * Constructor.
      *
-     * @param string $savePath Path of directory to save session files.
+     * @param string $savePath Path of directory to save session files
      *                         Default null will leave setting as defined by PHP.
      *                         '/path', 'N;/path', or 'N;octal-mode;/path
      *

diff --git a/Session/Storage/MetadataBag.php b/Session/Storage/MetadataBag.php
@@ -56,7 +56,7 @@ class MetadataBag implements SessionBagInterface
     /**
      * Constructor.
      *
-     * @param string $storageKey      The key used to store bag in the session.
+     * @param string $storageKey      The key used to store bag in the session
      * @param int    $updateThreshold The time to wait between two UPDATED updates
      */
     public function __construct($storageKey = '_sf2_meta', $updateThreshold = 0)

diff --git a/Session/Storage/MockArraySessionStorage.php b/Session/Storage/MockArraySessionStorage.php
@@ -66,7 +66,7 @@ class MockArraySessionStorage implements SessionStorageInterface
      * Constructor.
      *
      * @param string      $name    Session name
-     * @param MetadataBag $metaBag MetadataBag instance.
+     * @param MetadataBag $metaBag MetadataBag instance
      */
     public function __construct($name = 'MOCKSESSID', MetadataBag $metaBag = null)
     {

diff --git a/Session/Storage/MockFileSessionStorage.php b/Session/Storage/MockFileSessionStorage.php
@@ -32,9 +32,9 @@ class MockFileSessionStorage extends MockArraySessionStorage
     /**
      * Constructor.
      *
-     * @param string      $savePath Path of directory to save session files.
-     * @param string      $name     Session name.
-     * @param MetadataBag $metaBag  MetadataBag instance.
+     * @param string      $savePath Path of directory to save session files
+     * @param string      $name     Session name
+     * @param MetadataBag $metaBag  MetadataBag instance
      */
     public function __construct($savePath = null, $name = 'MOCKSESSID', MetadataBag $metaBag = null)
     {

diff --git a/Session/Storage/NativeSessionStorage.php b/Session/Storage/NativeSessionStorage.php
@@ -92,9 +92,9 @@ class NativeSessionStorage implements SessionStorageInterface
      * upload_progress.min-freq, "1"
      * url_rewriter.tags, "a=href,area=href,frame=src,form=,fieldset="
      *
-     * @param array                                                            $options Session configuration options.
+     * @param array                                                            $options Session configuration options
      * @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $handler
-     * @param MetadataBag                                                      $metaBag MetadataBag.
+     * @param MetadataBag                                                      $metaBag MetadataBag
      */
     public function __construct(array $options = array(), $handler = null, MetadataBag $metaBag = null)
     {
@@ -323,7 +323,7 @@ public function isStarted()
      * For convenience we omit 'session.' from the beginning of the keys.
      * Explicitly ignores other ini keys.
      *
-     * @param array $options Session ini directives array(key => value).
+     * @param array $options Session ini directives array(key => value)
      *
      * @see http://php.net/session.configuration
      */

diff --git a/Session/Storage/Proxy/NativeProxy.php b/Session/Storage/Proxy/NativeProxy.php
@@ -32,7 +32,7 @@ public function __construct()
     /**
      * Returns true if this handler wraps an internal PHP session save handler using \SessionHandler.
      *
-     * @return bool False.
+     * @return bool False
      */
     public function isWrapper()
     {

diff --git a/Session/Storage/SessionStorageInterface.php b/Session/Storage/SessionStorageInterface.php
@@ -24,7 +24,7 @@ interface SessionStorageInterface
     /**
      * Starts the session.
      *
-     * @return bool True if started.
+     * @return bool True if started
      *
      * @throws \RuntimeException If something goes wrong starting the session.
      */
@@ -33,14 +33,14 @@ public function start();
     /**
      * Checks if the session is started.
      *
-     * @return bool True if started, false otherwise.
+     * @return bool True if started, false otherwise
      */
     public function isStarted();
 
     /**
      * Returns the session ID.
      *
-     * @return string The session ID or empty.
+     * @return string The session ID or empty
      */
     public function getId();
 
@@ -54,7 +54,7 @@ public function setId($id);
     /**
      * Returns the session name.
      *
-     * @return mixed The session name.
+     * @return mixed The session name
      */
     public function getName();