Enalean / tuleap

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) {

plugins/git/tests/builders/aGitRepository.php

Doc Comments +24 added lines

@@ -29,21 +29,33 @@ 
         $this->repository = new GitRepository();
     }
 
+    /**
+     * @param string $path
+     */
     public function withPath($path) {
         $this->repository->setPath($path);
         return $this;
     }
 
+    /**
+     * @param string $namespace
+     */
     public function withNamespace($namespace) {
         $this->repository->setNamespace($namespace);
         return $this;
     }
 
+    /**
+     * @param integer $id
+     */
     public function withId($id) {
         $this->repository->setId($id);
         return $this;
     }
 
+    /**
+     * @param string $name
+     */
     public function withName($name) {
         $this->repository->setName($name);
         return $this;
@@ -59,21 +71,33 @@ 
         return $this;
     }
     
+    /**
+     * @param integer $id
+     */
     public function withRemoteServerId($id) {
         $this->repository->setRemoteServerId($id);
         return $this;
     }
 
+    /**
+     * @param string $description
+     */
     public function withDescription($description) {
         $this->repository->setDescription($description);
         return $this;
     }
 
+    /**
+     * @param string $prefix
+     */
     public function withMailPrefix($prefix) {
         $this->repository->setMailPrefix($prefix);
         return $this;
     }
 
+    /**
+     * @param string[] $emails
+     */
     public function withNotifiedEmails($emails) {
         $this->repository->setNotifiedMails($emails);
         return $this;

plugins/git/tests/Git/Driver/GerritTest/REST/GerritREST_Base.php

Doc Comments +3 added lines

@@ -79,6 +79,9 @@
         $this->driver = new Git_Driver_GerritREST($this->guzzle_client, $this->logger);
     }
 
+    /**
+     * @param string $text
+     */
     protected function getGuzzleRequestWithTextResponse($text) {
         $response     = stub('Guzzle\Http\Message\Response')->getBody(true)->returns($text);
         return stub('Guzzle\Http\Message\EntityEnclosingRequest')->send()->returns($response);

plugins/git/tests/Git/Gitolite/ProjectSerializerTest.php

Doc Comments +4 added lines

@@ -277,6 +277,10 @@
         $this->assertEqual('project1/repo', $this->project_serializer->repoFullName($repo, $unix_name));
     }
 
+    /**
+     * @param string $name
+     * @param string $namespace
+     */
     private function _GivenARepositoryWithNameAndNamespace($name, $namespace) {
         $repo = new GitRepository();
         $repo->setName($name);