g1a / hubph

src/Cli/HubphCommands.php

Doc Comments +15 added lines, -6 removed lines

@@ -194,6 +194,9 @@ 
         return $this->getProjectWithOrfFromUrl($remote);
     }
 
+    /**
+     * @param string $remote
+     */
     protected function getProjectWithOrfFromUrl($remote)
     {
         $remote = preg_replace('#^git@[^:]*:#', '', $remote);
@@ -251,7 +254,7 @@ 
      *   _links: Links
      * @default-fields number,user,title
      * @default-string-field number
-     * @return Consolidation\OutputFormatters\StructuredData\RowsOfFields
+     * @return RowsOfFields
     */
     public function prFind($projectWithOrg = '', $options = ['as' => 'default', 'format' => 'yaml', 'q' => ''])
     {
@@ -311,7 +314,7 @@ 
      * @default-fields full_name,language,default_branch
      * @default-string-field full_name
      *
-     * @return Consolidation\OutputFormatters\StructuredData\RowsOfFields
+     * @return RowsOfFields
      */
     public function orgRepos($org, $options = ['as' => 'default', 'format' => 'table'])
     {
@@ -362,7 +365,7 @@ 
      *   license: License
      *   permissions: Permissions
      *
-     * @return Consolidation\OutputFormatters\StructuredData\PropertyList
+     * @return PropertyList
      */
     public function repoInfo($projectWithOrg = '', $options = ['as' => 'default', 'format' => 'table'])
     {
@@ -426,6 +429,9 @@ 
         $this->logger->notice("Set default branch to {new}.", ['new' => $newDefault]);
     }
 
+    /**
+     * @param WorkingCopy $workingCopy
+     */
     protected function configureDefaultWithWorkingCopy($workingCopy, $currentDefault, $newDefault, $currentHeadSha)
     {
         $statusResult = $workingCopy->status();
@@ -503,7 +509,7 @@ 
      *   head: Head
      *   base: Base
      *   _links: Links
-     * @return Consolidation\OutputFormatters\StructuredData\PropertyList
+     * @return PropertyList
      */
     public function prShow($projectWithOrg = '', $number = '', $options = ['as' => 'default', 'format' => 'table'])
     {
@@ -540,7 +546,7 @@ 
      *   updated_at: Updated
      * @default-fields id,creator,state,description
      * @default-string-field description
-     * @return Consolidation\OutputFormatters\StructuredData\RowsOfFields
+     * @return RowsOfFields
      */
     public function prStatuses($projectWithOrg = '', $number = '', $options = ['as' => 'default', 'format' => 'yaml'])
     {
@@ -598,7 +604,7 @@ 
      *   _links: Links
      * @default-fields number,user,title
      * @default-string-field number
-     * @return Consolidation\OutputFormatters\StructuredData\RowsOfFields
+     * @return RowsOfFields
      */
     public function prList($projectWithOrg = '', $options = ['state' => 'open', 'as' => 'default', 'format' => 'table'])
     {
@@ -649,6 +655,9 @@ 
         );
     }
 
+    /**
+     * @param string $field
+     */
     protected function keyById($data, $field)
     {
         return

src/Git/Remote.php

Doc Comments +7 added lines

@@ -45,6 +45,9 @@ 
         return !empty($this->remote);
     }
 
+    /**
+     * @return string
+     */
     public function projectWithOrg()
     {
         return static::projectWithOrgFromUrl($this->remote);
@@ -123,6 +126,9 @@ 
         $this->git('push --delete {remote} {tag}', ['remote' => $this->remote, 'tag' => $tag]);
     }
 
+    /**
+     * @param string $tag
+     */
     protected function satisfies($tag, $version_constraints)
     {
         // If we are using a regex rather than semver, then pass anything.
@@ -184,6 +190,7 @@ 
     /**
      * Run a git function on the local working copy. Fail on error.
      *
+     * @param string $cmd
      * @return string stdout
      */
     public function git($cmd, $replacements = [], $redacted = [])

src/Git/WorkingCopy.php

Doc Comments +8 added lines

@@ -35,6 +35,9 @@ 
         $this->confirmCachedRepoHasCorrectRemote();
     }
 
+    /**
+     * @param string $dir
+     */
     public static function fromDir($dir, $remoteName = 'origin', $api = null)
     {
         $remote = Remote::fromDir($dir, $remoteName);
@@ -218,6 +221,9 @@ 
         return Remote::fromDir($this->dir, $remote_name);
     }
 
+    /**
+     * @return string
+     */
     public function url($remote_name = '')
     {
         return $this->remote($remote_name)->url();
@@ -258,6 +264,8 @@ 
 
     /**
      * Fetch from the specified remote.
+     * @param string $remote
+     * @param string $branch
      */
     public function fetch($remote, $branch)
     {

src/Util/ExecWithRedactionTrait.php

Doc Comments +3 added lines

@@ -3,6 +3,9 @@
 
 trait ExecWithRedactionTrait
 {
+    /**
+     * @param string $cmd
+     */
     protected function execWithRedaction($cmd, $replacements = [], $redacted = [])
     {
         $redactedReplacements = $this->redactedReplacements($replacements, $redacted);