More phpdoc fixes

vlucas · Dec 12, 2019 · 2508028 · 2508028
1 parent f1d0fb7
commit 2508028
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 9 deletions.
diff --git a/src/Loader/Lines.php b/src/Loader/Lines.php
@@ -105,7 +105,7 @@ private static function looksLikeMultilineStop($line, $started)
      *
      * @param string $line
      *
-     * @return bool
+     * @return bool[]
      */
     private static function getCharPairs($line)
     {

diff --git a/src/Loader/Parser.php b/src/Loader/Parser.php
@@ -23,7 +23,7 @@ class Parser
      *
      * @throws \Dotenv\Exception\InvalidFileException
      *
-     * @return array
+     * @return array<string|null>
      */
     public static function parse($entry)
     {
@@ -39,7 +39,7 @@ public static function parse($entry)
      *
      * @throws \Dotenv\Exception\InvalidFileException
      *
-     * @return array
+     * @return array<string|null>
      */
     private static function splitStringIntoParts($line)
     {
@@ -129,7 +129,7 @@ private static function parseValue($value)
      * @param int    $state
      * @param string $char
      *
-     * @return array
+     * @return \Dotenv\Result\Result
      */
     private static function processChar($state, $char)
     {

diff --git a/src/Loader/Value.php b/src/Loader/Value.php
@@ -58,11 +58,21 @@ public function append($char, $var)
         );
     }
 
+    /**
+     * Get the string representation of the parsed value.
+     *
+     * @return string
+     */
     public function getChars()
     {
         return $this->chars;
     }
 
+    /**
+     * Get the locations of the variables in the value.
+     *
+     * @return int[]
+     */
     public function getVars()
     {
         $vars = $this->vars;

diff --git a/src/Repository/AdapterRepository.php b/src/Repository/AdapterRepository.php
@@ -7,14 +7,14 @@ class AdapterRepository extends AbstractRepository
     /**
      * The set of readers to use.
      *
-     * @var \Dotenv\Repository\Adapter\ReadersInterface[]
+     * @var \Dotenv\Repository\Adapter\ReaderInterface[]
      */
     protected $readers;
 
     /**
      * The set of writers to use.
      *
-     * @var \Dotenv\Repository\Adapter\WritersInterface[]
+     * @var \Dotenv\Repository\Adapter\WriterInterface[]
      */
     protected $writers;
 

diff --git a/src/Repository/RepositoryBuilder.php b/src/Repository/RepositoryBuilder.php
@@ -13,14 +13,14 @@ class RepositoryBuilder
     /**
      * The set of readers to use.
      *
-     * @var \Dotenv\Repository\Adapter\ReadersInterface[]|null
+     * @var \Dotenv\Repository\Adapter\ReaderInterface[]|null
      */
     private $readers;
 
     /**
      * The set of writers to use.
      *
-     * @var \Dotenv\Repository\Adapter\WritersInterface[]|null
+     * @var \Dotenv\Repository\Adapter\WriterInterface[]|null
      */
     private $writers;
 

diff --git a/src/Store/StoreBuilder.php b/src/Store/StoreBuilder.php
@@ -58,7 +58,7 @@ public static function create()
      *
      * @param string|string[] $paths
      *
-     * @return \Dotenv\Repository\RepositoryBuilder
+     * @return \Dotenv\Store\StoreBuilder
      */
     public function withPaths($paths)
     {