Enalean / tuleap

plugins/agiledashboard/include/Planning/VirtualTopMilestoneController.class.php

Doc Comments -1 removed lines

@@ -43,7 +43,6 @@
      *   - pass $request to actions (e.g. show).
      *
      * @param Codendi_Request           $request
-     * @param PlanningFactory           $planning_factory
      * @param Planning_MilestoneFactory $milestone_factory
      */
     public function __construct(

plugins/agiledashboard/include/Planning/VirtualTopMilestonePaneFactory.class.php

Doc Comments +4 added lines, -5 removed lines

@@ -89,8 +89,7 @@ 
     }
 
     /**
-     * @param Planning_Milestone $milestone
-     * @return int
+     * @return string
      */
     private function getMilestoneArtifactId() {
          return self::TOP_MILESTONE_DUMMY_ARTIFACT_ID;
@@ -107,7 +106,7 @@ 
         return $this->active_pane[$milestone_artifact_id];
     }
 
-    /** @return AgileDashboard_PaneInfo[] */
+    /** @return AgileDashboard_PaneInfo */
     public function getListOfPaneInfo(Planning_Milestone $milestone) {
         $milestone_artifact_id = $this->getMilestoneArtifactId();
 
@@ -150,7 +149,7 @@ 
     }
 
     /**
-     * @return \AgileDashboard_Milestone_Pane_Planning_PlanningPaneInfo
+     * @return null|AgileDashboard_Milestone_Pane_TopPlanning_TopPlanningPaneInfo
      */
     private function getTopPlanningPaneInfo(Planning_Milestone $milestone) {
         $milestone_artifact_id = $this->getMilestoneArtifactId();
@@ -174,7 +173,7 @@ 
     }
 
     /**
-     * @return \AgileDashboard_Milestone_Pane_Planning_PlanningPaneInfo
+     * @return null|AgileDashboard_Milestone_Pane_TopPlanning_TopPlanningV2PaneInfo
      */
     private function getTopPlanningV2PaneInfo(Planning_Milestone $milestone) {
         $milestone_artifact_id = $this->getMilestoneArtifactId();

plugins/agiledashboard/tests/builders/aMilestone.php

Doc Comments +3 added lines

@@ -70,6 +70,9 @@
         return $this;
     }
     
+    /**
+     * @param integer $planning_id
+     */
     public function withPlanningId($planning_id) {
         $this->withPlanning(aPlanning()->withId($planning_id)->build());
         return $this;

plugins/agiledashboard/tests/builders/aPlanning.php

Doc Comments +12 added lines

@@ -45,6 +45,9 @@ 
         return $this;
     }
     
+    /**
+     * @param string $name
+     */
     public function withName($name) {
         $this->name = $name;
         return $this;
@@ -55,11 +58,17 @@ 
         return $this;
     }
 
+    /**
+     * @param integer $group_id
+     */
     public function withGroupId($group_id) {
         $this->group_id = $group_id;
         return $this;
     }
     
+    /**
+     * @param integer $planning_tracker_id
+     */
     public function withPlanningTrackerId($planning_tracker_id) {
         $this->planning_tracker_id = $planning_tracker_id;
         return $this;
@@ -71,6 +80,9 @@ 
         return $this;
     }
 
+    /**
+     * @param Tracker $backlog_tracker
+     */
     public function withBacklogTracker($backlog_tracker) {
         $this->backlog_tracker_ids[] = $backlog_tracker->getId();
         $this->backlog_trackers[]    = $backlog_tracker;

plugins/agiledashboard/tests/include/MilestoneFactoryTest.php

Doc Comments +7 added lines

@@ -22,12 +22,19 @@
 
 abstract class Planning_MilestoneBaseTest extends TuleapTestCase {
 
+    /**
+     * @param integer $id
+     */
     public function anArtifactWithId($id) {
         $artifact = aMockArtifact()->withId($id)->build();
         stub($artifact)->getAllAncestors()->returns(array());
         return $artifact;
     }
 
+    /**
+     * @param integer $id
+     * @param Tracker_Artifact[] $linked_artifacts
+     */
     public function anArtifactWithIdAndUniqueLinkedArtifacts($id, $linked_artifacts) {
         $artifact = aMockArtifact()->withId($id)
                               ->withUniqueLinkedArtifacts($linked_artifacts)

plugins/agiledashboard/tests/rest/KanbanTest.php

Doc Comments +6 added lines

@@ -126,6 +126,9 @@ 
         $this->assertFalse($new_state_first_column['is_open']);
     }
 
+    /**
+     * @param string $new_label
+     */
     private function assertThatLabelIsUpdated($new_label) {
         $patch_response = $this->getResponse($this->client->patch(
             'kanban/'. REST_TestDataBuilder::KANBAN_ID,
@@ -223,6 +226,9 @@ 
         );
     }
 
+    /**
+     * @param string $uri
+     */
     private function getIdsOrderedByPriority($uri) {
         $response     = $this->getResponse($this->client->get($uri))->json();
         $actual_order = array();

plugins/boomerang/include/BoomerangDatasProcessor.Class.php

Doc Comments +19 added lines, -1 removed lines

@@ -41,9 +41,9 @@ 
 
     /**
      *
-     * @param array $files Data table containing the name of data files
      * @param array $datas Data table containing picked datas
      * @param string $context_datas Will be written in the log files.
+     * @param string $storage_directory
      * @throws Exception Both arrays must have the same size.
      */
     public function __construct($storage_directory, $datas, $context_datas) {
@@ -93,6 +93,10 @@ 
         }
     }
 
+    /**
+     * @param string $separator
+     * @param integer $column
+     */
     private function extractDatasFromFormattedFile($file, /* & $array, */ $separator, $column = null) {
         $returned_array = array();
         foreach (file($file, FILE_IGNORE_NEW_LINES) as $line) {
@@ -102,6 +106,10 @@ 
         return $returned_array;
     }
 
+    /**
+     * @param string $file_name
+     * @param string $mode
+     */
     private function writeArrayToFile($file_name, $mode, $array) {
         $file = fopen($file_name, $mode);
         foreach ($array as $line) {
@@ -110,6 +118,10 @@ 
         fclose($file);
     }
 
+    /**
+     * @param string $file_name
+     * @param string $documentation
+     */
     private function writeDocumentationtoFile($file_name, $documentation) {
         $file = fopen($file_name, 'a');
         fwrite($file, $documentation);
@@ -150,6 +162,9 @@ 
         fclose($output_file);
     }
 
+    /**
+     * @return string
+     */
     private function formatCell($index, $array, $cell_content) {
         if ($index != count($array) - 1) {
             $cell_content .= ",";
@@ -166,6 +181,9 @@ 
         return $column;
     }
 
+    /**
+     * @param string[] $file_extensions
+     */
     private function removeFilesWithExtensions($file_extensions) {
         foreach ($file_extensions as $file_extension) {
             $files_list = glob('*' . $file_extension);

plugins/boomerang/include/boomerangPlugin.class.php

Doc Comments -1 removed lines

@@ -160,7 +160,6 @@
 
     /**
 	 * for hook administration :display an URL to access Boomerang statistics..
-	 * @param array $params:contains the data which comes from the envent listened.
 	 */
     function siteAdminHooks($params) {
        global $Language;

plugins/boomerang/include/BoomerangPluginInfo.class.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
 
 class BoomerangPluginInfo extends PluginFileInfo {
 
+    /**
+     * @param BoomerangPlugin $plugin
+     */
     public function __construct($plugin) {
         parent::__construct($plugin, 'config');
         $this->setPluginDescriptor(new BoomerangPluginDescriptor());