From 3deccc5ec8bc10a4c8f42ccb16bbe2f545a6a68f Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Fri, 23 Mar 2012 13:49:00 +0100 Subject: [PATCH] [HttpFoundation] fixed phpdoc --- src/Symfony/Component/HttpFoundation/HeaderBag.php | 8 ++++---- src/Symfony/Component/HttpFoundation/ParameterBag.php | 8 ++++---- .../HttpFoundation/Session/Attribute/AttributeBag.php | 8 ++++---- .../Component/HttpFoundation/Session/Flash/FlashBag.php | 8 ++++---- src/Symfony/Component/HttpFoundation/Session/Session.php | 8 ++++---- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/Symfony/Component/HttpFoundation/HeaderBag.php b/src/Symfony/Component/HttpFoundation/HeaderBag.php index b581dcca82..9670fed2bc 100644 --- a/src/Symfony/Component/HttpFoundation/HeaderBag.php +++ b/src/Symfony/Component/HttpFoundation/HeaderBag.php @@ -268,9 +268,9 @@ class HeaderBag implements \IteratorAggregate, \Countable } /** - * IteratorAggregate method for looping the instance + * Returns an iterator for headers. * - * @return array An array of parameters + * @return \ArrayIterator An \ArrayIterator instance */ public function getIterator() { @@ -278,9 +278,9 @@ class HeaderBag implements \IteratorAggregate, \Countable } /** - * Countable method returning the number of headers + * Returns the number of headers. * - * @return int Number of parameters held in the bag + * @return int The number of headers */ public function count() { diff --git a/src/Symfony/Component/HttpFoundation/ParameterBag.php b/src/Symfony/Component/HttpFoundation/ParameterBag.php index e6a67978fa..db541344c0 100644 --- a/src/Symfony/Component/HttpFoundation/ParameterBag.php +++ b/src/Symfony/Component/HttpFoundation/ParameterBag.php @@ -280,9 +280,9 @@ class ParameterBag implements \IteratorAggregate, \Countable } /** - * IteratorAggregate method for looping the instance + * Returns an iterator for parameters. * - * @return ArrayIterator An array of parameters wrapped in an ArrayIterator + * @return \ArrayIterator An \ArrayIterator instance */ public function getIterator() { @@ -290,9 +290,9 @@ class ParameterBag implements \IteratorAggregate, \Countable } /** - * Countable method returning the number of key/val pairings + * Returns the number of parameters. * - * @return int Number of parameters held in the bag + * @return int The number of parameters */ public function count() { diff --git a/src/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBag.php b/src/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBag.php index 2a49a5398a..2f1a4222e7 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBag.php +++ b/src/Symfony/Component/HttpFoundation/Session/Attribute/AttributeBag.php @@ -136,9 +136,9 @@ class AttributeBag implements AttributeBagInterface, \IteratorAggregate, \Counta } /** + * Returns an iterator for attributes. * - * - * @return ArrayIterator + * @return \ArrayIterator An \ArrayIterator instance */ public function getIterator() { @@ -146,9 +146,9 @@ class AttributeBag implements AttributeBagInterface, \IteratorAggregate, \Counta } /** + * Returns the number of attributes. * - * - * @return int + * @return int The number of attributes */ public function count() { diff --git a/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.php b/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.php index 03880c71df..eea1600cc3 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.php +++ b/src/Symfony/Component/HttpFoundation/Session/Flash/FlashBag.php @@ -157,9 +157,9 @@ class FlashBag implements FlashBagInterface, \IteratorAggregate, \Countable } /** - * IteratorAggregate + * Returns an iterator for flashes. * - * @return ArrayIterator + * @return \ArrayIterator An \ArrayIterator instance */ public function getIterator() { @@ -167,9 +167,9 @@ class FlashBag implements FlashBagInterface, \IteratorAggregate, \Countable } /** - * + * Returns the number of flashes. * - * @return int + * @return int The number of flashes */ public function count() { diff --git a/src/Symfony/Component/HttpFoundation/Session/Session.php b/src/Symfony/Component/HttpFoundation/Session/Session.php index 08a7b0b817..31e879f4c1 100644 --- a/src/Symfony/Component/HttpFoundation/Session/Session.php +++ b/src/Symfony/Component/HttpFoundation/Session/Session.php @@ -299,9 +299,9 @@ class Session implements SessionInterface, \IteratorAggregate, \Countable } /** - * IteratorAggregate method for looping through the session attributes + * Returns an iterator for attributes. * - * @return ArrayIterator + * @return \ArrayIterator An \ArrayIterator instance */ public function getIterator() { @@ -309,9 +309,9 @@ class Session implements SessionInterface, \IteratorAggregate, \Countable } /** - * Get the number of attributes in the session + * Returns the number of attributes. * - * @return int Number of attributes + * @return int The number of attributes */ public function count() {