matteosister / GitElephant

src/GitElephant/Objects/Diff/Diff.php

Doc Comments +2 added lines, -2 removed lines

@@ -55,7 +55,7 @@ 
      *
      * @param \GitElephant\Repository                 $repository repository
      * @param null|string|\GitElephant\Objects\Commit $commit1    first commit
-     * @param null|string|\GitElephant\Objects\Commit $commit2    second commit
+     * @param null|string $commit2    second commit
      * @param null|string                             $path       path to consider
      *
      * @throws \RuntimeException
@@ -90,7 +90,7 @@ 
      *
      * @param null $commit1 commit 1
      * @param null $commit2 commit 2
-     * @param null $path    path
+     * @param null|string $path    path
      *
      * @throws \RuntimeException
      * @throws \Symfony\Component\Process\Exception\InvalidArgumentException

src/GitElephant/Objects/LogRange.php

Doc Comments +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
      * @param string                  $refEnd      ending reference
      * @param null                    $path        path
      * @param int                     $limit       limit
-     * @param null                    $offset      offset
+     * @param null|integer                    $offset      offset
      * @param boolean                 $firstParent first parent
      *
      * @throws \RuntimeException
@@ -81,7 +81,7 @@ 
      * @param string  $refEnd      treeish reference
      * @param string  $path        path
      * @param int     $limit       limit
-     * @param string  $offset      offset
+     * @param integer  $offset      offset
      * @param boolean $firstParent first parent
      *
      * @throws \RuntimeException

src/GitElephant/Status/Status.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
     /**
      * @param string $line
      *
-     * @return mixed
+     * @return string[]
      */
     protected function splitStatusLine(string $line)
     {

src/GitElephant/Repository.php

Doc Comments +17 added lines, -17 removed lines

@@ -143,7 +143,7 @@ 
      * create a repository from a remote git url, or a local filesystem
      * and save it in a temp folder
      *
-     * @param string|Repository $git            the git remote url, or the filesystem path
+     * @param string $git            the git remote url, or the filesystem path
      * @param null              $repositoryPath path
      * @param string|null $binary         the path to the git binary
      * @param null              $name           repository name
@@ -191,7 +191,7 @@ 
     /**
      * Stage the working tree content
      *
-     * @param string|NodeObject $path the path to store
+     * @param string $path the path to store
      *
      * @throws \RuntimeException
      * @throws \Symfony\Component\Process\Exception\LogicException
@@ -209,7 +209,7 @@ 
     /**
      * Unstage a tree content
      *
-     * @param string|NodeObject $path the path to unstage
+     * @param string $path the path to unstage
      *
      * @throws \RuntimeException
      * @throws \Symfony\Component\Process\Exception\LogicException
@@ -227,8 +227,8 @@ 
     /**
      * Move a file/directory
      *
-     * @param string|NodeObject $from source path
-     * @param string|NodeObject $to   destination path
+     * @param string $from source path
+     * @param string $to   destination path
      *
      * @throws \RuntimeException
      * @throws \Symfony\Component\Process\Exception\LogicException
@@ -247,7 +247,7 @@ 
     /**
      * Remove a file/directory
      *
-     * @param string|NodeObject $path      the path to remove
+     * @param string $path      the path to remove
      * @param bool              $recursive recurse
      * @param bool              $force     force
      *
@@ -301,7 +301,7 @@ 
      * rev-parse command - often used to return a commit tag.
      *
      * @param array                    $options the options to apply to rev-parse
-     * @param string|NodeObject|Commit $arg     the argument (may be a branch head, etc)
+     * @param string $arg     the argument (may be a branch head, etc)
      *
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
@@ -329,7 +329,7 @@ 
     }
 
     /**
-     * @param TreeishInterface|Commit|string $arg
+     * @param Commit $arg
      * @param array                          $options
      */
     public function reset($arg, $options)
@@ -597,7 +597,7 @@ 
      *
      * @param string $name       The new tag name
      * @param null   $startPoint The reference to create the tag from
-     * @param null   $message    the tag message
+     * @param null|string   $message    the tag message
      *
      * @throws \RuntimeException
      * @throws \Symfony\Component\Process\Exception\RuntimeException
@@ -820,7 +820,7 @@ 
      *
      * @param string|TreeishInterface|array $ref         the treeish to check, as a string, as an object or as an array
      * @param string|NodeObject             $path        the physical path to the tree relative to the repository root
-     * @param int|null                      $limit       limit to n entries
+     * @param integer                      $limit       limit to n entries
      * @param int|null                      $offset      skip n entries
      * @param boolean|false                 $firstParent skip commits brought in to branch by a merge
      *
@@ -842,7 +842,7 @@ 
      * @param string            $refStart
      * @param string            $refEnd
      * @param string|NodeObject $path        the physical path to the tree relative to the repository root
-     * @param int|null          $limit       limit to n entries
+     * @param integer          $limit       limit to n entries
      * @param int|null          $offset      skip n entries
      * @param boolean|false     $firstParent skip commits brought in to branch by a merge
      *
@@ -873,7 +873,7 @@ 
      * Get a log for an object
      *
      * @param \GitElephant\Objects\NodeObject         $obj    The Object instance
-     * @param null|string|\GitElephant\Objects\Branch $branch The branch to read from
+     * @param string|null $branch The branch to read from
      * @param int                                     $limit  Limit to n entries
      * @param int|null                                $offset Skip n entries
      *
@@ -943,9 +943,9 @@ 
     /**
      * Get a Diff object for a commit with its parent, by default the diff is between the current head and its parent
      *
-     * @param \GitElephant\Objects\Commit|string      $commit1 A TreeishInterface instance
-     * @param \GitElephant\Objects\Commit|string|null $commit2 A TreeishInterface instance
-     * @param null|string|NodeObject                  $path    The path to get the diff for or a Object instance
+     * @param string      $commit1 A TreeishInterface instance
+     * @param null|string $commit2 A TreeishInterface instance
+     * @param null|string                  $path    The path to get the diff for or a Object instance
      *
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
@@ -960,7 +960,7 @@ 
      * Clone a repository
      *
      * @param string      $url           the repository url (i.e. git://github.com/matteosister/GitElephant.git)
-     * @param null        $to            where to clone the repo
+     * @param null|string        $to            where to clone the repo
      * @param string|null $repoReference Repo reference to clone. Required if performing a shallow clone.
      * @param int|null    $depth         Depth to clone repo. Specify 1 to perform a shallow clone
      * @param bool        $recursive     Whether to recursively clone child repos.
@@ -1104,7 +1104,7 @@ 
      * output a node content as an array of lines
      *
      * @param \GitElephant\Objects\NodeObject              $obj     The Object of type BLOB
-     * @param \GitElephant\Objects\TreeishInterface|string $treeish A treeish object
+     * @param null|Branch $treeish A treeish object
      *
      * @throws \RuntimeException
      * @throws \Symfony\Component\Process\Exception\LogicException

tests/GitElephant/TestCase.php

Doc Comments +17 added lines, -3 removed lines

@@ -49,7 +49,7 @@ 
     protected $finder;
 
     /**
-     * @param null $name
+     * @param integer $name
      *
      * @return \GitElephant\Repository
      */
@@ -120,7 +120,7 @@ 
     /**
      * @param string      $name       file name
      * @param string|null $folder     folder name
-     * @param null        $content    content
+     * @param string|null        $content    content
      * @param Repository  $repository repository to add file to
      *
      * @return void
@@ -201,7 +201,7 @@ 
     }
 
     /**
-     * @param $classname
+     * @param string $classname
      *
      * @return \PHPUnit\Framework\MockObject\MockObject
      */
@@ -250,6 +250,9 @@ 
             ->will($this->returnValue($this->getMockCommand()));
     }
 
+    /**
+     * @param string[] $output
+     */
     protected function addOutputToMockRepo(\PHPUnit\Framework\MockObject\MockObject $repo, $output)
     {
         $repo
@@ -281,6 +284,17 @@ 
         );
     }
 
+    /**
+     * @param string $sha
+     * @param string $tree
+     * @param string $author
+     * @param string $committer
+     * @param string $emailAuthor
+     * @param string $emailCommitter
+     * @param string $datetimeAuthor
+     * @param string $datetimeCommitter
+     * @param string $message
+     */
     protected function doCommitTest(
         Commit $commit,
         $sha,

src/GitElephant/Objects/Diff/DiffChunk.php

Doc Comments +1 added lines, -1 removed lines

@@ -78,7 +78,7 @@
     /**
      * Class constructor
      *
-     * @param array $lines output lines from git binary
+     * @param string $lines output lines from git binary
      *
      * @throws \Exception
      */

src/GitElephant/Objects/Diff/DiffObject.php

Doc Comments +2 added lines, -2 removed lines

@@ -79,7 +79,7 @@ 
     /**
      * Class constructor
      *
-     * @param array $lines output lines for the diff
+     * @param string $lines output lines for the diff
      *
      * @throws \InvalidArgumentException
      */
@@ -114,7 +114,7 @@ 
     /**
      * toString magic method
      *
-     * @return mixed
+     * @return string
      */
     public function __toString()
     {

src/GitElephant/Objects/Log.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
      * @param string  $ref         treeish reference
      * @param string  $path        path
      * @param int     $limit       limit
-     * @param string  $offset      offset
+     * @param integer  $offset      offset
      * @param boolean $firstParent first parent
      *
      * @throws \RuntimeException

src/GitElephant/Command/Caller/Caller.php

Doc Comments +2 added lines, -2 removed lines

@@ -70,8 +70,8 @@
      *
      * @param string $cmd               the command to execute
      * @param bool   $git               if the command is git or a generic command
-     * @param null   $cwd               the directory where the command must be executed
-     * @param array  $acceptedExitCodes exit codes accepted to consider the command execution successful
+     * @param string|null   $cwd               the directory where the command must be executed
+     * @param integer[]  $acceptedExitCodes exit codes accepted to consider the command execution successful
      *
      * @throws \RuntimeException
      * @throws \Symfony\Component\Process\Exception\InvalidArgumentException