Enalean / tuleap

plugins/git/include/Git/RemoteServer/Gerrit/ReplicationSSHKey.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 
     /**
      * @param int $id
-     * @return \Git_RemoteServer_GerritReplicationSSHKey
+     * @return Git_RemoteServer_Gerrit_ReplicationSSHKey
      */
     public function setGerritHostId($id) {
         $this->host_id = $id;

plugins/git/include/Git/RemoteServer/GerritServerPresenter.class.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 
 class Git_RemoteServer_GerritServerPresenter {
 
+    /**
+     * @param boolean $is_used
+     */
     public function __construct(Git_RemoteServer_GerritServer $server, $is_used) {
         $this->id               = $server->getId();
         $this->host             = $server->getHost();

plugins/git/include/Git/SystemEventManager.class.php

Doc Comments +6 added lines

@@ -112,6 +112,9 @@ 
         );
     }
 
+    /**
+     * @param integer $remote_server_id
+     */
     public function queueMigrateToGerrit(GitRepository $repository, $remote_server_id, $gerrit_template_id) {
         $this->system_event_manager->createEvent(
             SystemEvent_GIT_GERRIT_MIGRATION::NAME,
@@ -161,6 +164,9 @@ 
         );
     }
 
+    /**
+     * @param string $repository_path
+     */
     public function queueGrokMirrorManifestRepoDelete($repository_path) {
         $this->system_event_manager->createEvent(
             SystemEvent_GIT_GROKMIRROR_MANIFEST_REPODELETE::NAME,

plugins/git/include/Git/UserAccountManager.class.php

Doc Comments +6 added lines, -1 removed lines

@@ -50,6 +50,9 @@ 
         $this->synchroniseSSHKeysWithGerrit($original_keys, $new_keys, $user);
     }
 
+    /**
+     * @param PFUser $user
+     */
     private function synchroniseSSHKeysWithGerrit($original_keys, $new_keys, $user) {
         $this->getGerritUserAccountManager()
             ->synchroniseSSHKeys(
@@ -61,7 +64,6 @@ 
 
     /**
      *
-     * @param Git_RemoteServer_GerritServerFactory $factory
      * @return void
      * @throws Git_UserSynchronisationException
      */
@@ -69,6 +71,9 @@ 
         $this->pushSSHKeysToGerrit($user);
     }
 
+    /**
+     * @param PFUser $user
+     */
     private function pushSSHKeysToGerrit($user) {
         $this->getGerritUserAccountManager()->pushSSHKeys($user);
     }

plugins/git/include/Git_Backend_Interface.php

Doc Comments +7 added lines, -3 removed lines

@@ -26,7 +26,7 @@ 
      * Verify if the repository as already some content within
      *
      * @see    plugins/git/include/Git_Backend_Interface::isInitialized()
-     * @param  GitRepository $repository
+     * @param  GitRepository $respository
      * @return Boolean
      */
     public function isInitialized(GitRepository $respository);
@@ -35,7 +35,7 @@ 
      * Verify if the repository has been created
      *
      * @see    plugins/git/include/Git_Backend_Interface::isCreated()
-     * @param  GitRepository $repository
+     * @param  GitRepository $respository
      * @return Boolean
      */
     public function isCreated(GitRepository $respository);
@@ -105,7 +105,7 @@ 
      * @param Project $project The project to rename
      * @param string  $newName The new name of the project
      *
-     * @return true if success, false otherwise
+     * @return boolean if success, false otherwise
      */
     public function renameProject(Project $project, $newName);
 
@@ -120,6 +120,7 @@ 
      * Perform logical deletion repository in DB
      *
      * @param GitRepository $repository
+     * @return void
      */
     public function markAsDeleted(GitRepository $repository);
 
@@ -127,6 +128,7 @@ 
      * Physically delete a repository already marked for deletion
      *
      * @param GitRepository $repository
+     * @return void
      */
     public function delete(GitRepository $repository);
 
@@ -134,6 +136,7 @@ 
      * Purge archived repository
      *
      * @param GitRepository $repository
+     * @return void
      */
     public function deleteArchivedRepository(GitRepository $repository);
 
@@ -141,6 +144,7 @@ 
      * Move the archived gitolite repositories to the archiving area before purge
      *
      * @param GitRepository $repository
+     * @return boolean
      */
     public function archiveBeforePurge(GitRepository $repository);
 }

plugins/git/include/Git_Exec.class.php

Doc Comments +17 added lines

@@ -32,6 +32,7 @@ 
 
     /**
      * @param String $work_tree The git repository path where we should operate
+     * @param string $git_dir
      */
     public function __construct($work_tree, $git_dir = null) {
         $this->work_tree = $work_tree;
@@ -53,6 +54,9 @@ 
         $this->gitCmd('init');
     }
 
+    /**
+     * @param string $email
+     */
     public function setLocalCommiter($name, $email) {
         $this->gitCmd('config --add user.name '.escapeshellarg($name));
         $this->gitCmd('config --add user.email '.escapeshellarg($email));
@@ -62,14 +66,24 @@ 
         $this->gitCmd('remote add origin '.escapeshellarg($remote));
     }
 
+    /**
+     * @param string $remote
+     * @param string $branch
+     */
     public function pullBranch($remote, $branch) {
         $this->gitCmd('pull --quiet '.$remote.' '.$branch);
     }
 
+    /**
+     * @param string $branch
+     */
     public function checkoutBranch($branch) {
         $this->gitCmd('checkout --quiet '.$branch);
     }
 
+    /**
+     * @param string $file
+     */
     public function configFile($file, $config) {
         $this->gitCmd('config -f '. escapeshellarg($file) .' '. $config);
     }
@@ -162,6 +176,9 @@ 
         return $output;
     }
 
+    /**
+     * @param string $refname
+     */
     private function getOtherBranches($refname) {
         $branches = $this->getAllBranches();
         foreach($branches as $key => $branch) {

plugins/git/include/Git_Gitolite_SSHKeyDumper.class.php

Doc Comments +9 added lines, -1 removed lines

@@ -28,6 +28,9 @@ 
     private $admin_path;
     private $git_exec;
 
+    /**
+     * @param string $admin_path
+     */
     public function __construct($admin_path, Git_Exec $git_exec) {
         $this->admin_path   = $admin_path;
         $this->git_exec     = $git_exec;
@@ -129,6 +132,9 @@ 
         $this->removeUserExistingKeysFromAGivenKeyId($user_name, $ssh_key_id);
     }
 
+    /**
+     * @param string $filePath
+     */
     private function writeKeyIfChanged($filePath, $key) {
         $changed = true;
         if (is_file($filePath)) {
@@ -145,7 +151,6 @@ 
     /**
      * Remove all pub SSH keys previously associated to a user
      *
-     * @param IHaveAnSSHKey $user
      * @param int           $last_key_id
      */
     private function removeUserExistingKeysFromAGivenKeyId($user_name, $last_key_id) {
@@ -159,6 +164,9 @@ 
         }
     }
 
+    /**
+     * @param string $userbase
+     */
     private function getKeyNumber($userbase, $file) {
         $matches = array();
         if (preg_match('%^'.$this->getKeyDirPath().'/'.$userbase.'([0-9]+).pub$%', $file, $matches)) {

plugins/git/include/Git_Gitolite_SSHKeyMassDumper.class.php

Doc Comments +3 added lines

@@ -61,6 +61,9 @@
         }
     }
 
+    /**
+     * @param string $file_name
+     */
     private function isReservedName($file_name) {
         if ($this->isAdminKey($file_name) || $this->isGerritKey($file_name)) {
             return true;

plugins/git/include/Git_GitoliteDriver.class.php

Doc Comments +20 added lines, -6 removed lines

@@ -95,8 +95,6 @@ 
     /**
      * Constructor
      *
-     * @param string $adminPath The path to admin folder of gitolite.
-     *                          Default is $sys_data_dir . "/gitolite/admin"
      */
     public function __construct(
         Logger $logger,
@@ -188,6 +186,9 @@ 
         return realpath($this->adminPath .'/../repositories');
     }
 
+    /**
+     * @param string $adminPath
+     */
     public function setAdminPath($adminPath) {
         $this->oldCwd    = getcwd();
         $this->adminPath = $adminPath;
@@ -264,6 +265,9 @@ 
         return $res;
     }
 
+    /**
+     * @param string $message
+     */
     public function commit($message) {
         return $this->gitExec->commit($message);
     }
@@ -278,7 +282,7 @@ 
      * @param String $oldName The old name of the project
      * @param String $newName The new name of the project
      *
-     * @return true if success, false otherwise
+     * @return boolean if success, false otherwise
      */
     public function renameProject($oldName, $newName) {
         $ok = true;
@@ -302,6 +306,9 @@ 
         return $ok;
     }
 
+    /**
+     * @param string $path
+     */
     public function delete($path) {
         if ( empty($path) || !is_writable($path) ) {
            throw new GitDriverErrorException('Empty path or permission denied '.$path);
@@ -316,6 +323,11 @@ 
         return true;
     }
 
+    /**
+     * @param string $repo
+     * @param string $old_ns
+     * @param string $new_ns
+     */
     public function fork($repo, $old_ns, $new_ns) {
         $source = unixPathJoin(array($this->getRepositoriesPath(), $old_ns, $repo)) .'.git';
         $target = unixPathJoin(array($this->getRepositoriesPath(), $new_ns, $repo)) .'.git';
@@ -337,6 +349,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $cmd
+     */
     protected function executeShellCommand($cmd) {
         $cmd = $cmd.' 2>&1';
         exec($cmd, $output, $retVal);
@@ -364,9 +379,8 @@ 
     /**
      * Backup gitolite repository
      *
-     * @param String $path               The repository path
      * @param String $backup_directory The repository backup directory path
-     * @param String $repositoryName
+     * @param String $repository
      *
      */
     public function backup(GitRepository $repository, $backup_directory) {
@@ -418,6 +432,7 @@ 
      * @param GitRepository $repository
      * @param String git_root_path
      * @param String $backup_directory
+     * @param string $git_root_path
      *
      * @return boolean
      *
@@ -454,7 +469,6 @@ 
      * Extract repository
      *
      * @param String $backup_path
-     * @param String $restore_path
      *
      */
     private function extractRepository($backup_path) {