8000 Fix phpdocs in components · symfony/symfony@196f558 · GitHub
[go: up one dir, main page]
Skip to content

Commit 196f558

Browse files
nicolas-grekasalamirault
nicolas-grekas
authored and
alamirault
committed
Fix phpdocs in components
1 parent 069b83c commit 196f558

File tree

14 files changed

+38
-38
lines changed

14 files changed

+38
-38
lines changed

‎src/Symfony/Component/Lock/Store/MongoDbStore.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ private function createMongoDateTime(float $seconds): UTCDateTime
351351
/**
352352
* Retrieves an unique token for the given key namespaced to this store.
353353
*
354-
* @param Key lock state container
354+
* @param Key $key lock state container
355355
*/
356356
private function getUniqueToken(Key $key): string
357357
{

‎src/Symfony/Component/Mime/FileinfoMimeTypeGuesser.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class FileinfoMimeTypeGuesser implements MimeTypeGuesserInterface
2424
private $magicFile;
2525

2626
/**
27-
* @param string $magicFile A magic file to use with the finfo instance
27+
* @param string|null $magicFile A magic file to use with the finfo instance
2828
*
2929
* @see http://www.php.net/manual/en/function.finfo-open.php
3030
*/

‎src/Symfony/Component/Process/Process.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -910,7 +910,7 @@ public function getStatus()
910910
* Stops the process.
911911
*
912912
* @param int|float $timeout The timeout in seconds
913-
* @param int $signal A POSIX signal to send in case the process has not stop at timeout, default is SIGKILL (9)
913+
* @param int|null $signal A POSIX signal to send in case the process has not stop at timeout, default is SIGKILL (9)
914914
*
915915
* @return int|null The exit-code of the process or null if it's not running
916916
*/

‎src/Symfony/Component/RateLimiter/LimiterInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ interface LimiterInterface
2626
* future token consumptions. Do not use this method if you intend
2727
* to skip this process.
2828
*
29-
* @param int $tokens the number of tokens required
30-
* @param float $maxTime maximum accepted waiting time in seconds
29+
* @param int $tokens the number of tokens required
30+
* @param float|null $maxTime maximum accepted waiting time in seconds
3131
*
3232
* @throws MaxWaitDurationExceededException if $maxTime is set and the process needs to wait longer than its value (in seconds)
3333
* @throws ReserveNotSupportedException if this limiter implementation doesn't support reserving tokens

‎src/Symfony/Component/RateLimiter/Policy/TokenBucketLimiter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ public function __construct(string $id, int $maxBurst, Rate $rate, StorageInterf
4545
* future token consumptions. Do not use this method if you intend
4646
* to skip this process.
4747
*
48-
* @param int $tokens the number of tokens required
49-
* @param float $maxTime maximum accepted waiting time in seconds
48+
* @param int $tokens the number of tokens required
49+
* @param float|null $maxTime maximum accepted waiting time in seconds
5050
*
5151
* @throws MaxWaitDurationExceededException if $maxTime is set and the process needs to wait longer than its value (in seconds)
5252
* @throws \InvalidArgumentException if $tokens is larger than the maximum burst size

‎src/Symfony/Component/Serializer/Normalizer/CustomNormalizer.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ public function denormalize($data, string $type, string $format = null, array $c
4444
/**
4545
* Checks if the given class implements the NormalizableInterface.
4646
*
47-
* @param mixed $data Data to normalize
48-
* @param string $format The format being (de-)serialized from or into
47+
* @param mixed $data Data to normalize
48+
* @param string|null $format The format being (de-)serialized from or into
4949
*
5050
* @return bool
5151
*/
@@ -57,9 +57,9 @@ public function supportsNormalization($data, string $format = null)
5757
/**
5858
* Checks if the given class implements the DenormalizableInterface.
5959
*
60-
* @param mixed $data Data to denormalize from
61-
* @param string $type The class to which the data should be denormalized
62-
* @param string $format The format being deserialized from
60+
* @param mixed $data Data to denormalize from
61+
* @param string $type The class to which the data should be denormalized
62+
* @param string|null $format The format being deserialized from
6363
*
6464
* @return bool
6565
*/

‎src/Symfony/Component/Serializer/Normalizer/DenormalizerInterface.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ interface DenormalizerInterface
2929
/**
3030
* Denormalizes data back into an object of the given class.
3131
*
32-
* @param mixed $data Data to restore
33-
* @param string $type The expected class to instantiate
34-
* @param string $format Format the given data was extracted from
35-
* @param array $context Options available to the denormalizer
32+
* @param mixed $data Data to restore
33+
* @param string $type The expected class to instantiate
34+
* @param string|null $format Format the given data was extracted from
35+
* @param array $context Options available to the denormalizer
3636
*
3737
* @return mixed
3838
*
@@ -49,9 +49,9 @@ public function denormalize($data, string $type, string $format = null, array $c
4949
/**
5050
* Checks whether the given class is supported for denormalization by this normalizer.
5151
*
< 10000 /code>
52-
* @param mixed $data Data to denormalize from
53-
* @param string $type The class to which the data should be denormalized
54-
* @param string $format The format being deserialized from
52+
* @param mixed $data Data to denormalize from
53+
* @param string $type The class to which the data should be denormalized
54+
* @param string|null $format The format being deserialized from
5555
*
5656
* @return bool
5757
*/

‎src/Symfony/Component/Serializer/Normalizer/NormalizerInterface.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ interface NormalizerInterface
2424
/**
2525
* Normalizes an object into a set of arrays/scalars.
2626
*
27-
* @param mixed $object Object to normalize
28-
* @param string $format Format the normalization result will be encoded as
29-
* @param array $context Context options for the normalizer
27+
* @param mixed $object Object to normalize
28+
* @param string|null $format Format the normalization result will be encoded as
29+
* @param array $context Context options for the normalizer
3030
*
3131
* @return array|string|int|float|bool|\ArrayObject|null \ArrayObject is used to make sure an empty object is encoded as an object not an array
3232
*
@@ -41,8 +41,8 @@ public function normalize($object, string $format = null, array $context = []);
4141
/**
4242
* Checks whether the given class is supported for normalization by this normalizer.
4343
*
44-
* @param mixed $data Data to normalize
45-
* @param string $format The format being (de-)serialized from or into
44+
* @param mixed $data Data to normalize
45+
* @param string|null $format The format being (de-)serialized from or into
4646
*
4747
* @return bool
4848
*/

‎src/Symfony/Component/Serializer/Serializer.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@ public function supportsDenormalization($data, string $type, string $format = nu
257257
/**
258258
* Returns a matching normalizer.
259259
*
260-
* @param mixed $data Data to get the serializer for
261-
* @param string $format Format name, present to give the option to normalizers to act differently based on formats
262-
* @param array $context Options available to the normalizer
260+
* @param mixed $data Data to get the serializer for
261+
* @param string|null $format Format name, present to give the option to normalizers to act differently based on formats
262+
* @param array $context Options available to the normalizer
263263
*/
264264
private function getNormalizer($data, ?string $format, array $context): ?NormalizerInterface
265265
{
@@ -295,10 +295,10 @@ private function getNormalizer($data, ?string $format, array $context): ?Normali
295295
/**
296296
* Returns a matching denormalizer.
297297
*
298-
* @param mixed $data Data to restore
299-
* @param string $class The expected class to instantiate
300-
* @param string $format Format name, present to give the option to normalizers to act differently based on formats
301-
* @param array $context Options available to the denormalizer
298+
* @param mixed $data Data to restore
299+
* @param string $class The expected class to instantiate
300+
* @param string|null $format Format name, present to give the option to normalizers to act differently based on formats
301+
* @param array $context Options available to the denormalizer
302302
*/
303303
private function getDenormalizer($data, string $class, ?string $format, array $context): ?DenormalizerInterface
304304
{

‎src/Symfony/Component/Translation/Loader/IcuResFileLoader.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public function load($resource, string $locale, string $domain = 'messages')
7171
*
7272
* @param \ResourceBundle $rb The ResourceBundle that will be flattened
7373
* @param array $messages Used internally for recursive calls
74-
* @param string $path Current path being parsed, used internally for recursive calls
74+
* @param string|null $path Current path being parsed, used internally for recursive calls
7575
*
7676
* @return array
7777
*/

‎src/Symfony/Component/Translation/MessageCatalogueInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function getDomains();
4141
*
4242
* If $domain is null, it returns all messages.
4343
*
44-
* @param string $domain The domain name
44+
* @param string|null $domain The domain name
4545
*
4646
* @return array
4747
*/

‎src/Symfony/Component/VarDumper/Caster/Caster.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public static function castObject(object $obj, string $class, bool $hasDebugInfo
115115
* @param array $a The array containing the properties to filter
116116
* @param int $filter A bit field of Caster::EXCLUDE_* constants specifying which properties to filter out
117117
* @param string[] $listedProperties List of properties to exclude when Caster::EXCLUDE_VERBOSE is set, and to preserve when Caster::EXCLUDE_NOT_IMPORTANT is set
118-
* @param int &$count Set to the number of removed properties
118+
* @param int|null &$count Set to the number of removed properties
119119
*/
120120
public static function filter(array $a, int $filter, array $listedProperties = [], ?int &$count = 0): array
121121
{

‎src/Symfony/Component/VarExporter/VarExporter.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ final class VarExporter
3434
*
3535
* @param mixed $value The value to export
3636
* @param bool &$isStaticValue Set to true after execution if the provided value is static, false otherwise
37-
* @param bool &$classes Classes found in the value are added to this list as both keys and values
37+
* @param array &$foundClasses Classes found in the value are added to this list as both keys and values
3838
*
3939
* @throws ExceptionInterface When the provided value cannot be serialized
4040
*/

‎src/Symfony/Component/Yaml/Inline.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ public static function initialize(int $flags, int $parsedLineNumber = null, stri
5050
/**
5151
* Converts a YAML string to a PHP value.
5252
*
53-
* @param string $value A YAML string
54-
* @param int $flags A bit field of Yaml::PARSE_* constants to customize the YAML parser behavior
55-
* @param array $references Mapping of variable names to values
53+
* @param string|null $value A YAML string
54+
* @param int $flags A bit field of Yaml::PARSE_* constants to customize the YAML parser behavior
55+
* @param array $references Mapping of variable names to values
5656
*
5757
* @return mixed
5858
*

0 commit comments

Comments
 (0)
0