matteosister / GitElephant

src/GitElephant/Command/MainCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
      * @param bool $bare
      *
      * @throws \RuntimeException
-     * @return MainCommand
+     * @return string
      */
     public function init($bare = false): string
     {

src/GitElephant/Command/SubCommandCommand.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
         $this->orderedSubjects = null;
     }
 
+    /**
+     * @param string $subject
+     */
     protected function addCommandSubject($subject): void
     {
         $this->orderedSubjects[] = $subject;

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
@@ -192,7 +192,7 @@ 
      * @param string $branchString branch line output
      *
      * @throws \InvalidArgumentException
-     * @return array
+     * @return Repository
      */
     public static function getMatches(string $branchString): array
     {

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(): string
     {

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): void
@@ -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
@@ -818,7 +818,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
      *
@@ -840,7 +840,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
      *
@@ -871,7 +871,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
      *
@@ -941,9 +941,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
@@ -958,7 +958,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.
@@ -1101,7 +1101,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 +12 added lines, -1 removed lines

@@ -124,7 +124,7 @@ 
     /**
      * @param string      $name       file name
      * @param string|null $folder     folder name
-     * @param null        $content    content
+     * @param null|string        $content    content
      * @param Repository  $repository repository to add file to
      *
      * @return void
@@ -282,6 +282,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,