matteosister / GitElephant

src/GitElephant/Objects/Branch.php

Doc Comments +2 added lines, -2 removed lines

@@ -107,7 +107,7 @@ 
 
     /**
      * @param \GitElephant\Repository $repository repository instance
-     * @param string|TreeishInterface $name       branch name
+     * @param string $name       branch name
      * @param bool                    $create     like checkout -b, create a branch and check it out
      *
      * @throws \RuntimeException
@@ -196,7 +196,7 @@ 
      * @param string $branchString branch line output
      *
      * @throws \InvalidArgumentException
-     * @return array
+     * @return Repository
      */
     public static function getMatches(string $branchString)
     {

src/GitElephant/Objects/Commit.php

Doc Comments +3 added lines, -3 removed lines

@@ -357,7 +357,7 @@ 
      *
      * @param bool $short short version
      *
-     * @return mixed
+     * @return string
      */
     public function getSha(bool $short = false)
     {
@@ -367,7 +367,7 @@ 
     /**
      * tree getter
      *
-     * @return mixed
+     * @return string
      */
     public function getTree()
     {
@@ -377,7 +377,7 @@ 
     /**
      * datetimeAuthor getter
      *
-     * @return mixed
+     * @return \DateTime
      */
     public function getDatetimeAuthor()
     {

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/Repository.php

Doc Comments +17 added lines, -17 removed lines

@@ -147,7 +147,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 GitBinary         $binary         binary
      * @param null              $name           repository name
@@ -195,7 +195,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
@@ -213,7 +213,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
@@ -231,8 +231,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
@@ -251,7 +251,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
      *
@@ -305,7 +305,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
@@ -333,7 +333,7 @@ 
     }
 
     /**
-     * @param TreeishInterface|Commit|string $arg
+     * @param Commit $arg
      * @param array                          $options
      */
     public function reset($arg, $options)
@@ -600,7 +600,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
@@ -825,7 +825,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
      *
@@ -848,7 +848,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
      *
@@ -880,7 +880,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
      *
@@ -950,9 +950,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
@@ -967,7 +967,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
      *
      * @throws \RuntimeException
      * @throws \Symfony\Component\Process\Exception\LogicException
@@ -1108,7 +1108,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

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)
     {