Enalean / tuleap

plugins/fusionforge_compat/include/include/plugins_utils.php

Doc Comments +6 added lines

@@ -99,12 +99,18 @@
         var $default_values = array();
         var $global = false;
 
+        /**
+         * @param string $name
+         */
         function PluginSpecificRoleSetting(&$role, $name, $global = false) {
                 $this->global = $global;
                 $this->role =& $role;
                 $this->name = $name;
         }
 
+        /**
+         * @param string[] $values
+         */
         function SetAllowedValues($values) {
                 $this->role->role_values = array_replace_recursive($this->role->role_values,
                                                                    array($this->name => $values));

plugins/git/include/events/SystemEvent_GIT_GERRIT_MIGRATION.class.php

Doc Comments +12 added lines

@@ -75,6 +75,10 @@ 
         }
     }
 
+    /**
+     * @param string $sysevent_prefix
+     * @param string $log_prefix
+     */
     private function logError($sysevent_prefix, $log_prefix, Exception $e) {
         $this->error($sysevent_prefix . $e->getMessage());
         $this->logger->error($log_prefix . $this->verbalizeParameters(null), $e);
@@ -99,6 +103,10 @@ 
         }
     }
 
+    /**
+     * @param integer $repo_id
+     * @param boolean $with_link
+     */
     private function verbalizeRepoId($repo_id, $with_link) {
         $txt = '#'. $repo_id;
         if ($with_link) {
@@ -111,6 +119,10 @@ 
         return $txt;
     }
 
+    /**
+     * @param integer $remote_server_id
+     * @param boolean $with_link
+     */
     private function verbalizeRemoteServerId($remote_server_id, $with_link) {
         $txt = '#'. $remote_server_id;
         if ($with_link) {

plugins/git/include/exceptions/GitAuthorizedKeysFileException.class.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
 
 class GitAuthorizedKeysFileException  extends Exception {
 
+    /**
+     * @param string $authorized_keys_file
+     */
     public function __construct($authorized_keys_file) {
         parent::__construct($authorized_keys_file.' is empty'.
             '. In order to retrieve a file with the gitolite admin public key, run the script : '

plugins/git/include/exceptions/GitRepositoryException.class.php

Doc Comments +3 added lines

@@ -26,6 +26,9 @@
 class GitRepositoryException extends Exception {
     //put your code here
 
+    /**
+     * @param string $msg
+     */
     public function __construct($msg) {
         parent::__construct(__CLASS__.' : '.$msg);
     }

plugins/git/include/Git.class.php

Doc Comments +21 added lines

@@ -292,6 +292,9 @@ 
         $this->request->set('repo_id', $repository->getId());
     }
 
+    /**
+     * @param string $parameters
+     */
     private function redirectIfTryingToViewRepositoryAndUserFriendlyURLsActivated(
         Project $project,
         GitRepository $repository,
@@ -339,6 +342,11 @@ 
         $this->permittedActions = $permittedActions;
     }
 
+    /**
+     * @param string $key
+     *
+     * @return string
+     */
     protected function getText($key, $params = array()) {
         return $GLOBALS['Language']->getText('plugin_git', $key, $params);
     }
@@ -350,6 +358,9 @@ 
         return $this->plugin;
     }
 
+    /**
+     * @param PFUser $user
+     */
     protected function definePermittedActions($repoId, $user) {
         if ($this->permissions_manager->userIsGitAdmin($user, $this->projectManager->getProject($this->groupId))) {
             $this->permittedActions = array(
@@ -441,6 +452,10 @@ 
 
     }
 
+    /**
+     * @param string|null $repositoryName
+     * @param PFUser $user
+     */
     public function _dispatchActionAndView($action, $repoId, $repositoryName, $user) {
         $pane = $this->request->get('pane');
         switch ($action) {
@@ -803,6 +818,9 @@ 
         }
     }
 
+    /**
+     * @param GitRepository|null $repository
+     */
     private function getValidatedGerritTemplateId($repository) {
         if (empty($repository)) {
             return null;
@@ -970,6 +988,9 @@ 
         }
     }
 
+    /**
+     * @param string $url
+     */
     protected function checkSynchronizerToken($url) {
         $token = new CSRFSynchronizerToken($url);
         $token->check();

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

Doc Comments +9 added lines

@@ -157,6 +157,9 @@ 
         );
     }
 
+    /**
+     * @param Codendi_Request $request
+     */
     private function setMirrorRestriction($request) {
         $mirror_id   = $request->get('mirror_id');
         $mirror      = $this->git_mirror_mapper->fetch($mirror_id);
@@ -193,6 +196,9 @@ 
         return "/admin/system_events/?queue=git";
     }
 
+    /**
+     * @param Codendi_Request $request
+     */
     private function updateAllowedProjectList($request) {
         $mirror_id             = $request->get('mirror_id');
         $mirror                = $this->git_mirror_mapper->fetch($mirror_id);
@@ -231,6 +237,9 @@ 
         $GLOBALS['Response']->redirect('/plugins/git/admin/?pane=mirrors_admin&action=manage-allowed-projects&mirror_id=' . $mirror->id);
     }
 
+    /**
+     * @param string $url
+     */
     private function checkSynchronizerToken($url) {
         $token = new CSRFSynchronizerToken($url);
         $token->check();

plugins/git/include/Git/Ci/Launcher.class.php

Doc Comments -1 removed lines

@@ -49,7 +49,6 @@
     /**
      * Trigger jobs corresponding to the Git repository
      *
-     * @param GitRepository $repository_location Name of the git repository
      */
     public function executeForRepository(GitRepository $repository) {
         if ($repository->getProject()->usesService('hudson')) {

plugins/git/include/Git/Driver/Gerrit/ExecFetch.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
      * Update a local branch from remote
      *
      * @param String $branch_name
-     * @return type
+     * @return boolean
      */
     public function updateRef($branch_name) {
         return $this->gitCmd("git update-ref refs/heads/$branch_name refs/remotes/$this->remote_name/$branch_name");

plugins/git/include/Git/Driver/Gerrit/MembershipDao.class.php

Doc Comments +4 added lines

@@ -26,6 +26,10 @@
 
 class Git_Driver_Gerrit_MembershipDao extends DataAccessObject {
 
+    /**
+     * @param integer $group_id
+     * @param integer $ugroup_id
+     */
     public function addReference($group_id, $ugroup_id, $remote_server_id) {
         $group_id = $this->da->escapeInt($group_id);
         $ugroup_id = $this->da->escapeInt($ugroup_id);