improve phpdoc

Author: dbu

src/ClassDiscovery.php

@@ -6,6 +6,7 @@
 use Http\Discovery\Exception\DiscoveryFailedException;
 use Http\Discovery\Exception\NoCandidateFoundException;
 use Http\Discovery\Exception\StrategyUnavailableException;
+use Http\Discovery\Strategy\DiscoveryStrategy;
 
 /**
  * Registry that based find results on class existence.
@@ -19,7 +20,7 @@ abstract class ClassDiscovery
     /**
      * A list of strategies to find classes.
      *
-     * @var array
+     * @var DiscoveryStrategy[]
      */
     private static $strategies = [
         Strategy\GeneratedDiscoveryStrategy::class,
@@ -130,7 +131,7 @@ private static function storeInCache($type, $class)
     /**
      * Set new strategies and clear the cache.
      *
-     * @param array $strategies string array of fully qualified class name to a DiscoveryStrategy
+     * @param string[] $strategies list of fully qualified class names that implement DiscoveryStrategy
      */
     public static function setStrategies(array $strategies)
     {
@@ -151,7 +152,7 @@ public static function getStrategies(): iterable
     /**
      * Append a strategy at the end of the strategy queue.
      *
-     * @param string $strategy Fully qualified class name to a DiscoveryStrategy
+     * @param string $strategy Fully qualified class name of a DiscoveryStrategy
      */
     public static function appendStrategy($strategy)
     {
@@ -170,9 +171,6 @@ public static function prependStrategy($strategy)
         self::clearCache();
     }
 
-    /**
-     * Clear the cache.
-     */
     public static function clearCache()
     {
         self::$cache = [];
@@ -238,14 +236,13 @@ protected static function instantiateClass($class)
     }
 
     /**
-     * We want to do a "safe" version of PHP's "class_exists" because Magento has a bug
+     * We need a "safe" version of PHP's "class_exists" because Magento has a bug
      * (or they call it a "feature"). Magento is throwing an exception if you do class_exists()
      * on a class that ends with "Factory" and if that file does not exits.
      *
-     * This function will catch all potential exceptions and make sure it returns a boolean.
+     * This function catches all potential exceptions and makes sure to always return a boolean.
      *
      * @param string $class
-     * @param bool   $autoload
      *
      * @return bool
      */