Merge pull request #23 from php-http/documentation

Documentation

Author: sagikazarmark

src/ClassDiscovery.php

@@ -1,25 +1,16 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery;
 
 /**
- * Registry that based find results on class existence
+ * Registry that based find results on class existence.
  *
  * @author David de Boer <[email protected]>
  */
 abstract class ClassDiscovery
 {
     /**
-     * Add a class (and condition) to the discovery registry
+     * Add a class (and condition) to the discovery registry.
      *
      * @param string $class     Class that will be instantiated if found
      * @param string $condition Optional other class to check for existence
@@ -37,7 +28,7 @@ public static function register($class, $condition = null)
     }
 
     /**
-     * Finds a Class
+     * Finds a Class.
      *
      * @return object
      *
@@ -62,7 +53,7 @@ public static function find()
     }
 
     /**
-     * Evaulates conditions to boolean
+     * Evaulates conditions to boolean.
      *
      * @param mixed $condition
      *

src/HttpAsyncClientDiscovery.php

@@ -5,7 +5,7 @@
 use Http\Client\HttpAsyncClient;
 
 /**
- * Finds an HTTP Asynchronous Client
+ * Finds an HTTP Asynchronous Client.
  *
  * @author Joel Wurtz <[email protected]>
  */
@@ -27,7 +27,7 @@ final class HttpAsyncClientDiscovery extends ClassDiscovery
     ];
 
     /**
-     * Finds an HTTP Async Client
+     * Finds an HTTP Async Client.
      *
      * @return HttpAsyncClient
      *

src/HttpClientDiscovery.php

@@ -1,20 +1,11 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery;
 
 use Http\Client\HttpClient;
 
 /**
- * Finds an HTTP Client
+ * Finds an HTTP Client.
  *
  * @author Márk Sági-Kazár <[email protected]>
  */
@@ -40,11 +31,11 @@ final class HttpClientDiscovery extends ClassDiscovery
     ];
 
     /**
-     * Finds an HTTP Client
+     * Finds an HTTP Client.
      *
      * @return HttpClient
      *
-     * @throws NotFoundException If no suitable client is available
+     * @throws NotFoundException
      */
     public static function find()
     {

src/MessageFactory/DiactorosFactory.php

@@ -1,14 +1,5 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery\MessageFactory;
 
 use Http\Discovery\StreamFactory\DiactorosStreamFactory;
@@ -18,6 +9,8 @@
 use Zend\Diactoros\Response;
 
 /**
+ * Creates Diactoros messages.
+ *
  * @author GeLo <[email protected]>
  */
 final class DiactorosFactory implements MessageFactory

src/MessageFactory/GuzzleFactory.php

@@ -1,21 +1,14 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery\MessageFactory;
 
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use Http\Message\MessageFactory;
 
 /**
+ * Creates Guzzle messages.
+ *
  * @author Márk Sági-Kazár <[email protected]>
  */
 final class GuzzleFactory implements MessageFactory

src/MessageFactoryDiscovery.php

@@ -1,20 +1,11 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery;
 
 use Http\Message\MessageFactory;
 
 /**
- * Finds a Message Factory
+ * Finds a Message Factory.
  *
  * @author Márk Sági-Kazár <[email protected]>
  */
@@ -40,7 +31,7 @@ final class MessageFactoryDiscovery extends ClassDiscovery
     ];
 
     /**
-     * Finds a Message Factory
+     * Finds a Message Factory.
      *
      * @return MessageFactory
      *

src/NotFoundException.php

@@ -1,18 +1,9 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery;
 
 /**
- * Thrown when a discovery does not find any matches
+ * Thrown when a discovery does not find any matches.
  *
  * @author Márk Sági-Kazár <[email protected]>
  */

src/StreamFactory/DiactorosStreamFactory.php

@@ -1,14 +1,5 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery\StreamFactory;
 
 use Http\Message\StreamFactory;
@@ -18,19 +9,14 @@
 use Zend\Diactoros\Stream;
 
 /**
+ * Creates Diactoros streams.
+ *
  * @author Михаил Красильников <[email protected]>
  */
 final class DiactorosStreamFactory implements StreamFactory
 {
     /**
-     * Creates a stream
-     *
-     * @param string|resource|StreamInterface|null $body
-     *
-     * @return StreamInterface
-     *
-     * @throws \InvalidArgumentException If the stream body is invalid
-     * @throws \RuntimeException If cannot write into stream
+     * {@inheritdoc}
      */
     public function createStream($body = null)
     {

src/StreamFactory/GuzzleStreamFactory.php

@@ -1,32 +1,19 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery\StreamFactory;
 
 use Http\Message\StreamFactory;
 use Psr\Http\Message\StreamInterface;
 
 /**
+ * Creates Guzzle streams.
+ *
  * @author Михаил Красильников <[email protected]>
  */
 final class GuzzleStreamFactory implements StreamFactory
 {
     /**
-     * Creates a stream
-     *
-     * @param string|resource|StreamInterface|null $body
-     *
-     * @return StreamInterface
-     *
-     * @throws \InvalidArgumentException if the $body arg is not valid.
+     * {@inheritdoc}
      */
     public function createStream($body = null)
     {

src/StreamFactoryDiscovery.php

@@ -1,20 +1,11 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery;
 
 use Http\Message\StreamFactory;
 
 /**
- * Finds a Stream Factory
+ * Finds a Stream Factory.
  *
  * @author Михаил Красильников <[email protected]>
  */
@@ -40,7 +31,7 @@ final class StreamFactoryDiscovery extends ClassDiscovery
     ];
 
     /**
-     * Finds a Stream Factory
+     * Finds a Stream Factory.
      *
      * @return StreamFactory
      *

src/UriFactory/DiactorosFactory.php

@@ -1,22 +1,13 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery\UriFactory;
 
 use Http\Message\UriFactory;
 use Psr\Http\Message\UriInterface;
 use Zend\Diactoros\Uri;
 
 /**
- * Creates a zend/diactoros URI object
+ * Creates Diactoros URI.
  *
  * @author David de Boer <[email protected]>
  */

src/UriFactory/GuzzleFactory.php

@@ -1,21 +1,12 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery\UriFactory;
 
 use GuzzleHttp\Psr7;
 use Http\Message\UriFactory;
 
 /**
- * Creates a guzzlehttp/psr7 URI object
+ * Creates Guzzle URI.
  *
  * @author David de Boer <[email protected]>
  */

src/UriFactoryDiscovery.php

@@ -1,20 +1,11 @@
 <?php
 
-/*
- * This file is part of the Http Discovery package.
- *
- * (c) PHP HTTP Team <[email protected]>
- *
- * For the full copyright and license information, please read the LICENSE
- * file that was distributed with this source code.
- */
-
 namespace Http\Discovery;
 
 use Http\Message\UriFactory;
 
 /**
- * Finds a URI Factory
+ * Finds a URI Factory.
  *
  * @author David de Boer <[email protected]>
  */
@@ -40,7 +31,7 @@ final class UriFactoryDiscovery extends ClassDiscovery
     ];
 
     /**
-     * Finds a URI Factory
+     * Finds a URI Factory.
      *
      * @return UriFactory
      */