Enalean / tuleap

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();

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

Doc Comments +12 added lines, -2 removed lines

@@ -64,6 +64,9 @@ 
         $this->request          = $request;
     }
 
+    /**
+     * @return Codendi_Request
+     */
     public function getRequest() {
         return $this->request;
     }
@@ -80,6 +83,7 @@ 
     /**
      * Wrapper of global redirect method
      * @param String url
+     * @param string $url
      */
     public function redirect($url) {
         $GLOBALS['HTML']->redirect($url);
@@ -127,7 +131,7 @@ 
     }
     /**
      *
-     * @param <type> $action 
+     * @param string $action 
      */
     public function addPermittedAction($action) {
         $this->permittedActions[] = $action;
@@ -161,10 +165,16 @@ 
         return $this->actionResultData;
     }    
 
+    /**
+     * @param string $viewName
+     */
     public function addView($viewName, $params=array()) {
         $this->views[$viewName] = $params;
     }
 
+    /**
+     * @param string $actionName
+     */
     public function addAction($actionName, $params=array()) {
         $this->actions[$actionName] = $params;
     }
@@ -201,7 +211,7 @@ 
      * This functions execute all methods added to the actions class array ($this->actions)
      * An action is a method of PluginAction class child, several can be added for one request
      * @TODO associate an action and a view in order to skip action call to provide data to a given view.(like Symfony framework component)
-     * @return null
+     * @return false|null
      */
     function executeActions() {
         if ( empty($this->actions) ) {

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

Doc Comments +3 added lines

@@ -60,6 +60,9 @@
         call_user_func_array(array($this,$name), $params);
     }
 
+    /**
+     * @param string $href
+     */
     public static function linkTo($link, $href, $options='' ) {
         $linkTo = '<a href="'.$href.'" '.$options.' >'.$link.'</a>';
         return $linkTo;

plugins/git/include/PathJoinUtil.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
     return preg_replace('%/{1,}%',"/", $path);
 }
 
+/**
+ * @param string $namespace
+ */
 function userRepoPath($username, $namespace) {
     $path = unixPathJoin(array('u', $username, $namespace));
     if (strpos($path, '..') !== false) {

plugins/git/include/REST/v1/GitRepositoryPermissionRepresentation.class.php

Doc Comments +3 added lines

@@ -65,6 +65,9 @@
         return $this->buildUGroupRepresentations($repository, $rewind_ugroups_rows);
     }
 
+    /**
+     * @param \DataAccessResult $ugroup_rows
+     */
     private function buildUGroupRepresentations(GitRepository $repository, $ugroup_rows) {
         $ugroup_representations = array();
         foreach ($ugroup_rows as $row) {