Enalean / tuleap

plugins/git/include/GitRepository.class.php

Doc Comments +11 added lines, -1 removed lines

@@ -426,6 +426,9 @@ 
         return $this->creationDate;
     }
 
+    /**
+     * @param PFUser $user
+     */
     public function setCreator($user) {
         $this->creator = $user;
     }
@@ -695,6 +698,7 @@ 
 
     /**
      * Rename project
+     * @param string $newName
      */
     public function renameProject(Project $project, $newName) {
         $newName = strtolower($newName);
@@ -780,6 +784,9 @@ 
         return $this->getBackend()->userCanRead($user, $this);
     }
 
+    /**
+     * @param PFUser $user
+     */
     public function userCanEditOnline($user) {
         return $user->hasPermission(Git::PERM_WRITE, $this->getId(), $this->getProjectId()) && $this->use_online_edit;
     }
@@ -839,7 +846,7 @@ 
      *
      * @param PFUser $user the user
      *
-     * @return true if the repo is a personnal rep and if it is created by $user
+     * @return boolean if the repo is a personnal rep and if it is created by $user
      */
     public function belongsTo(PFUser $user) {
         return $this->getScope() == self::REPO_SCOPE_INDIVIDUAL && $this->getCreatorId() == $user->getId();
@@ -854,6 +861,9 @@ 
         $this->remote_server_id = $id;
     }
 
+    /**
+     * @return integer
+     */
     public function getRemoteServerId() {
         return $this->remote_server_id;
     }

plugins/git/include/GitRepositoryFactory.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -53,6 +53,7 @@ 
     /**
      * Get a project repository by its id
      *
+     * @param integer $id
      * @return GitRepository the repository or null if not found
      */
     public function getRepositoryByIdUserCanSee(PFUser $user, $id) {
@@ -139,7 +140,6 @@ 
     /**
      * Get a project repository by its id
      *
-     * @param int $id         The id of the repository to load
      *
      * @return GitRepository the repository or null if not found
      */
@@ -234,8 +234,8 @@ 
     /**
      * Attempt to get repository if path match given base directory
      *
-     * @param type $base_dir A top level directory that can contains repo
-     * @param type $path     Full repository path
+     * @param string $base_dir A top level directory that can contains repo
+     * @param string $path     Full repository path
      *
      * @return GitRepository
      */
@@ -309,6 +309,7 @@ 
      * Get the list of all repositories for a given project
      *
      * @param Int $project_id
+     * @param integer $retention_period
      *
      * @return GitRepository[]
      */

plugins/git/include/GitRepositoryManager.class.php

Doc Comments +17 added lines, -3 removed lines

@@ -96,6 +96,9 @@ 
         $this->git_system_event_manager->queueRepositoryUpdate($repository);
     }
 
+    /**
+     * @param string $bundle_path
+     */
     public function createFromBundle(GitRepository $repository, GitRepositoryCreator $creator, $bundle_path) {
         if (!$creator->isNameValid($repository->getName())) {
             throw new Exception($GLOBALS['Language']->getText('plugin_git', 'actions_input_format_error', array($creator->getAllowedCharsInNamePattern(), GitDao::REPO_NAME_MAX_LENGTH)));
@@ -173,6 +176,9 @@ 
         throw new Exception($GLOBALS['Language']->getText('plugin_git', 'actions_no_repository_forked'));
     }
 
+    /**
+     * @param string $namespace
+     */
     private function isNamespaceValid(GitRepository $repository, $namespace) {
         if ($namespace) {
             $ns_chunk = explode('/', $namespace);
@@ -186,6 +192,10 @@ 
         return true;
     }
 
+    /**
+     * @param string $namespace
+     * @param string $scope
+     */
     private function forkAllRepositories(array $repos, PFUser $user, $namespace, $scope, Project $project, array $forkPermissions) {
         $forked = false;
         foreach ($repos as $repo) {
@@ -206,10 +216,8 @@ 
     /**
      * Return true if proposed name already exists as a repository path
      *
-     * @param Project $project
-     * @param String  $name
      *
-     * @return Boolean
+     * @return boolean|null
      */
     public function isRepositoryNameAlreadyUsed(GitRepository $new_repository) {
         $repositories = $this->repository_factory->getAllRepositories($new_repository->getProject());
@@ -228,6 +236,9 @@ 
         }
     }
 
+    /**
+     * @param string $new_path
+     */
     private function nameIsSubPathOfExistingRepository($repository_path, $new_path) {
         $repo_path_without_dot_git = $this->stripFinalDotGit($repository_path);
         if (strpos($new_path, "$repo_path_without_dot_git/") === 0) {
@@ -236,6 +247,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $new_path
+     */
     private function nameAlreadyExistsAsPath($repository_path, $new_path) {
         $new_path = $this->stripFinalDotGit($new_path);
         if (strpos($repository_path, "$new_path/") === 0) {

plugins/git/include/GitViews.class.php

Doc Comments +7 added lines

@@ -43,6 +43,9 @@ 
     /** @var Git_Mirror_MirrorDataMapper */
     private $mirror_data_mapper;
 
+    /**
+     * @param Git $controller
+     */
     public function __construct(
         $controller,
         Git_GitRepositoryUrlManager $url_manager,
@@ -72,6 +75,9 @@ 
         $GLOBALS['HTML']->footer(array());
     }
 
+    /**
+     * @param string $key
+     */
     public function getText($key, $params=array() ) {
         return $GLOBALS['Language']->getText('plugin_git', $key, $params);
     }
@@ -88,6 +94,7 @@ 
 
     /**
      * HELP VIEW
+     * @param string $topic
      */
     public function help($topic, $params=array()) {
         if ( empty($topic) ) {

plugins/git/include/GitViews/RepoManagement/Pane/AccessControl.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
     /**
      * Display access control management for gitshell backend
      *
-     * @return void
+     * @return string
      */
     private function accessControl() {
         $html    = '';
@@ -85,7 +85,7 @@ 
     /**
      * Display access control management for gitolite backend
      *
-     * @return void
+     * @return string
      */
     private function accessControlGitolite() {
         $forkPermissionsManager = new GitForkPermissionsManager($this->repository);

plugins/git/include/GitViews/ShowRepo/Content.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -199,8 +199,9 @@
     /**
      * Fetch the html code to display the icon of a repository (depends on type of project)
      *
-     * @param $access
+     * @param string $access
      * @param $backend_type
+     * @param boolean $backendIsGitolite
      */
     private function getAccessType($access, $backendIsGitolite) {
         if ($backendIsGitolite) {

plugins/git/include/GitViewsRepositoriesTraversalStrategy_Tree.class.php

Doc Comments +7 added lines, -1 removed lines

@@ -34,7 +34,6 @@ 
     /**
      * Constructor
      *
-     * @param GitViews $view The GitViews
      */
     public function __construct($lastPushes, Git_GitRepositoryUrlManager $url_manager) {
         parent::__construct();
@@ -133,6 +132,9 @@ 
         return $html;
     }
     
+    /**
+     * @param integer $depth
+     */
     protected function fetchRows($repositories, $depth) {
         $nodeHtml   = '';
         $leavesHtml = '';
@@ -175,6 +177,10 @@ 
         return $html;
     }
 
+    /**
+     * @param string $class
+     * @param string $description
+     */
     protected function fetchHTMLRow($class, $depth, $label, $description, $lastPush) {
         $HTMLPurifier = Codendi_HTMLPurifier::instance();
         $description = $HTMLPurifier->purify($description, CODENDI_PURIFIER_CONVERT_HTML);

plugins/git/include/Markdown/GitMarkdownFile.class.php

Doc Comments +8 added lines

@@ -44,6 +44,10 @@ 
         return false;
     }
 
+    /**
+     * @param string $file_name
+     * @param string $commit_sha1
+     */
     private function getFormatedMarkdown($file_name, $commit_sha1) {
         $content         = $this->git_exec->getFileContent($commit_sha1, $file_name);
         $content_in_form = GitMarkdownFileContentInForm::getMarkdownContentInForm($content);
@@ -54,6 +58,10 @@ 
         );
     }
 
+    /**
+     * @param string $node
+     * @param string $commit_sha1
+     */
     private function getReadmeFile($node, $commit_sha1) {
         $files_list          = $this->git_exec->lsTree($commit_sha1, $node);
         $path                = preg_quote($node, DIRECTORY_SEPARATOR);

plugins/git/include/mvc/PluginActions.class.php

Doc Comments +3 added lines

@@ -29,6 +29,9 @@
     /** @var Codendi_Request*/
     protected $request;
 
+    /**
+     * @param Git $controller
+     */
     public function __construct( $controller ) {
         $this->controller = $controller;
         $this->user       = $controller->getUser();