Skip to content

Commit 0f95805

Browse files
committed
Update docblocks
1 parent a59b0a9 commit 0f95805

13 files changed

+28
-33
lines changed

src/ClassDiscovery.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
namespace Http\Discovery;
44

55
/**
6-
* Registry that based find results on class existence
6+
* Registry that based find results on class existence.
77
*
88
* @author David de Boer <[email protected]>
99
*/
1010
abstract class ClassDiscovery
1111
{
1212
/**
13-
* Add a class (and condition) to the discovery registry
13+
* Add a class (and condition) to the discovery registry.
1414
*
1515
* @param string $class Class that will be instantiated if found
1616
* @param string $condition Optional other class to check for existence
@@ -28,7 +28,7 @@ public static function register($class, $condition = null)
2828
}
2929

3030
/**
31-
* Finds a Class
31+
* Finds a Class.
3232
*
3333
* @return object
3434
*
@@ -53,7 +53,7 @@ public static function find()
5353
}
5454

5555
/**
56-
* Evaulates conditions to boolean
56+
* Evaulates conditions to boolean.
5757
*
5858
* @param mixed $condition
5959
*

src/HttpAsyncClientDiscovery.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use Http\Client\HttpAsyncClient;
66

77
/**
8-
* Finds an HTTP Asynchronous Client
8+
* Finds an HTTP Asynchronous Client.
99
*
1010
* @author Joel Wurtz <[email protected]>
1111
*/
@@ -27,7 +27,7 @@ class HttpAsyncClientDiscovery extends ClassDiscovery
2727
];
2828

2929
/**
30-
* Finds an HTTP Async Client
30+
* Finds an HTTP Async Client.
3131
*
3232
* @return HttpAsyncClient
3333
*

src/HttpClientDiscovery.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use Http\Client\HttpClient;
66

77
/**
8-
* Finds an HTTP Client
8+
* Finds an HTTP Client.
99
*
1010
* @author Márk Sági-Kazár <[email protected]>
1111
*/
@@ -31,11 +31,11 @@ class HttpClientDiscovery extends ClassDiscovery
3131
];
3232

3333
/**
34-
* Finds an HTTP Client
34+
* Finds an HTTP Client.
3535
*
3636
* @return HttpClient
3737
*
38-
* @throws NotFoundException If no suitable client is available
38+
* @throws NotFoundException
3939
*/
4040
public static function find()
4141
{

src/MessageFactory/DiactorosFactory.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
use Zend\Diactoros\Stream;
1010

1111
/**
12+
* Creates Diactoros messages.
13+
*
1214
* @author GeLo <[email protected]>
1315
*/
1416
class DiactorosFactory implements MessageFactory

src/MessageFactory/GuzzleFactory.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
use Http\Message\MessageFactory;
88

99
/**
10+
* Creates Guzzle messages.
11+
*
1012
* @author Márk Sági-Kazár <[email protected]>
1113
*/
1214
class GuzzleFactory implements MessageFactory

src/MessageFactoryDiscovery.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use Http\Message\MessageFactory;
66

77
/**
8-
* Finds a Message Factory
8+
* Finds a Message Factory.
99
*
1010
* @author Márk Sági-Kazár <[email protected]>
1111
*/
@@ -31,7 +31,7 @@ class MessageFactoryDiscovery extends ClassDiscovery
3131
];
3232

3333
/**
34-
* Finds a Message Factory
34+
* Finds a Message Factory.
3535
*
3636
* @return MessageFactory
3737
*

src/NotFoundException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace Http\Discovery;
44

55
/**
6-
* Thrown when a discovery does not find any matches
6+
* Thrown when a discovery does not find any matches.
77
*
88
* @author Márk Sági-Kazár <[email protected]>
99
*/

src/StreamFactory/DiactorosStreamFactory.php

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,14 @@
99
use Zend\Diactoros\Stream;
1010

1111
/**
12+
* Creates Diactoros streams.
13+
*
1214
* @author Михаил Красильников <[email protected]>
1315
*/
1416
class DiactorosStreamFactory implements StreamFactory
1517
{
1618
/**
17-
* Creates a stream
18-
*
19-
* @param string|resource|StreamInterface|null $body
20-
*
21-
* @return StreamInterface
22-
*
23-
* @throws \InvalidArgumentException If the stream body is invalid
24-
* @throws \RuntimeException If cannot write into stream
19+
* {@inheritdoc}
2520
*/
2621
public function createStream($body = null)
2722
{

src/StreamFactory/GuzzleStreamFactory.php

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,14 @@
66
use Psr\Http\Message\StreamInterface;
77

88
/**
9+
* Creates Guzzle streams.
10+
*
911
* @author Михаил Красильников <[email protected]>
1012
*/
1113
class GuzzleStreamFactory implements StreamFactory
1214
{
1315
/**
14-
* Creates a stream
15-
*
16-
* @param string|resource|StreamInterface|null $body
17-
*
18-
* @return StreamInterface
19-
*
20-
* @throws \InvalidArgumentException if the $body arg is not valid.
16+
* {@inheritdoc}
2117
*/
2218
public function createStream($body = null)
2319
{

src/StreamFactoryDiscovery.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use Http\Message\StreamFactory;
66

77
/**
8-
* Finds a Stream Factory
8+
* Finds a Stream Factory.
99
*
1010
* @author Михаил Красильников <[email protected]>
1111
*/
@@ -31,7 +31,7 @@ class StreamFactoryDiscovery extends ClassDiscovery
3131
];
3232

3333
/**
34-
* Finds a Stream Factory
34+
* Finds a Stream Factory.
3535
*
3636
* @return StreamFactory
3737
*

0 commit comments

Comments
 (0)