Enalean / tuleap

plugins/agiledashboard/include/AgileDashboard/REST/v1/Kanban/KanbanColumnsResource.php

Doc Comments +2 added lines, -2 removed lines

@@ -112,7 +112,6 @@ 
      *
      * @param int                             $id        Id of the column
      * @param int                             $kanban_id Id of the Kanban {@from query}
-     * @param KanbanColumnPATCHRepresentation $column    The kanban column {@from body} {@type Tuleap\AgileDashboard\REST\v1\Kanban\KanbanColumnPATCHRepresentation}
      *
      * @throws 401
      * @throws 404
@@ -182,7 +181,8 @@ 
         }
     }
 
-    /** @return AgileDashboard_Kanban */
+    /** @param integer $id
+/** @return AgileDashboard_Kanban */
     private function getKanban(PFUser $user, $id) {
         try {
             $kanban = $this->kanban_factory->getKanban($user, $id);

plugins/agiledashboard/include/AgileDashboard/REST/v1/Kanban/KanbanItemCollectionRepresentation.php

Doc Comments +5 added lines

@@ -32,6 +32,11 @@
     /** @var int */
     public $total_size;
 
+    /**
+     * @param integer $column_id
+     * @param integer $limit
+     * @param integer $offset
+     */
     public function build(PFUser $user, AgileDashboard_Kanban $kanban, $column_id, $limit, $offset) {
         $dao             = new AgileDashboard_KanbanItemDao();
         $factory         = Tracker_ArtifactFactory::instance();

plugins/agiledashboard/include/AgileDashboard/REST/v1/Kanban/KanbanItemsResource.php

Doc Comments +3 added lines, -2 removed lines

@@ -229,7 +229,7 @@ 
      * @access hybrid
      *
      * @param  int  $id     Id of the artifact
-     * @return Tuleap\AgileDashboard\REST\v1\Kanban\KanbanRepresentation
+     * @return KanbanItemRepresentation
      */
     protected function get($id) {
         $this->checkAccess();
@@ -325,7 +325,8 @@ 
 
     }
 
-    /** @return AgileDashboard_Kanban */
+    /** @param integer $id
+/** @return AgileDashboard_Kanban */
     private function getKanban(PFUser $user, $id) {
         try {
             $kanban = $this->kanban_factory->getKanban($user, $id);

plugins/agiledashboard/include/AgileDashboard/REST/v1/Kanban/KanbanRepresentation.php

Doc Comments +5 added lines

@@ -85,6 +85,11 @@
      */
     public $user_can_reorder_columns;
 
+    /**
+     * @param boolean $user_can_add_columns
+     * @param boolean $user_can_reorder_columns
+     * @param boolean $user_can_add_in_place
+     */
     public function build(
         AgileDashboard_Kanban $kanban,
         AgileDashboard_KanbanColumnFactory $column_factory,

plugins/agiledashboard/include/AgileDashboard/REST/v1/Kanban/KanbanRepresentationBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
     }
 
     /**
-     * @return Tuleap\AgileDashboard\REST\v1\Kanban\KanbanRepresentation
+     * @return KanbanRepresentation
      */
     public function build(AgileDashboard_Kanban $kanban, PFUser $user) {
 

plugins/agiledashboard/include/AgileDashboard/REST/v1/Kanban/KanbanResource.php

Doc Comments +21 added lines, -5 removed lines

@@ -338,7 +338,7 @@ 
      * @param int $limit  Number of elements displayed per page
      * @param int $offset Position of the first element to display
      *
-     * @return Tuleap\AgileDashboard\REST\v1\Kanban\KanbanBacklogRepresentation
+     * @return KanbanBacklogRepresentation
      *
      * @throws 403
      * @throws 404
@@ -502,6 +502,9 @@ 
         return count(array_diff($add->ids, $all_kanban_item_ids)) === 0;
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     private function getKanbanBacklogItemIds($tracker_id) {
         $backlog_item_ids = array();
         foreach ($this->kanban_item_dao->getKanbanBacklogItemIds($tracker_id) as $artifact) {
@@ -539,7 +542,7 @@ 
      * @param int $limit  Number of elements displayed per page
      * @param int $offset Position of the first element to display
      *
-     * @return Tuleap\AgileDashboard\REST\v1\Kanban\KanbanArchiveRepresentation
+     * @return KanbanArchiveRepresentation
      *
      * @throws 403
      * @throws 404
@@ -626,6 +629,9 @@ 
         }
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     private function getKanbanArchiveItemIds($tracker_id) {
         $archive_item_ids = array();
         foreach ($this->kanban_item_dao->getKanbanArchiveItemIds($tracker_id) as $artifact) {
@@ -665,7 +671,7 @@ 
      * @param int $limit  Number of elements displayed per page
      * @param int $offset Position of the first element to display
      *
-     * @return Tuleap\AgileDashboard\REST\v1\Kanban\KanbanItemCollectionRepresentation
+     * @return KanbanItemCollectionRepresentation
      *
      * @throws 403
      * @throws 404
@@ -773,6 +779,10 @@ 
         }
     }
 
+    /**
+     * @param integer $tracker_id
+     * @param integer $column_id
+     */
     private function getItemsInColumn($tracker_id, $column_id) {
         $column_item_ids = array();
         foreach ($this->kanban_item_dao->getItemsInColumn($tracker_id, $column_id) as $artifact) {
@@ -851,7 +861,7 @@ 
      *
      * @status 201
      *
-     * @return Tuleap\AgileDashboard\REST\v1\Kanban\KanbanColumnRepresentation
+     * @return KanbanColumnRepresentation
      */
     protected function postColumns($id, KanbanColumnPOSTRepresentation $column) {
         $current_user = $this->getCurrentUser();
@@ -983,7 +993,7 @@ 
     }
 
     /**
-     * @return Tracker
+     * @return \Tracker
      */
     private function getTrackerForKanban(AgileDashboard_Kanban $kanban) {
         $tracker = $this->tracker_factory->getTrackerById($kanban->getTrackerId());
@@ -1001,6 +1011,12 @@ 
         return $this->tracker_factory->getTrackerById($kanban->getTrackerId())->getGroupId();
     }
 
+    /**
+     * @param PFUser $current_user
+     * @param AgileDashboard_Kanban $kanban
+     * @param OrderRepresentation|null $order
+     * @param KanbanAddRepresentation|null $add
+     */
     private function sendMessageForDroppingItem($current_user, $kanban, $order, $add, $in_column) {
         if(isset($_SERVER[self::HTTP_CLIENT_UUID]) && $_SERVER[self::HTTP_CLIENT_UUID]) {
             $data = array(

plugins/agiledashboard/include/AgileDashboard/REST/v1/MilestoneResource.class.php

Doc Comments +21 added lines, -1 removed lines

@@ -251,7 +251,7 @@ 
      *
      * @param int $id Id of the milestone
      *
-     * @return Tuleap\AgileDashboard\REST\v1\MilestoneRepresentation
+     * @return MilestoneRepresentation
      *
      * @throws 403
      * @throws 404
@@ -800,6 +800,9 @@ 
         $this->sendAllowHeaderForBacklog();
     }
 
+    /**
+     * @param PFUser $user
+     */
     private function getBacklogItemAsArtifact($user, $artifact_id) {
         $artifact = $this->tracker_artifact_factory->getArtifactById($artifact_id);
 
@@ -894,6 +897,9 @@ 
         return $burndown;
     }
 
+    /**
+     * @param integer $id
+     */
     private function getMilestoneById(PFUser $user, $id) {
         try {
             $milestone = $this->milestone_factory->getValidatedBareMilestoneByArtifactId($user, $id);
@@ -917,6 +923,10 @@ 
         return UserManager::instance()->getCurrentUser();
     }
 
+    /**
+     * @param \Planning_ArtifactMilestone $milestone
+     * @param \AgileDashboard_Milestone_Backlog_DescendantBacklogStrategy $strategy
+     */
     private function getMilestoneContentItems($milestone, $strategy) {
         return $this->backlog_item_collection_factory->getAllCollection(
             $this->getCurrentUser(),
@@ -926,6 +936,9 @@ 
         );
     }
 
+    /**
+     * @param integer $limit
+     */
     private function checkContentLimit($limit) {
         if (! $this->limitValueIsAcceptable($limit)) {
              throw new RestException(406, 'Maximum value for limit exceeded');
@@ -940,6 +953,10 @@ 
         Header::allowOptionsGetPutPatch();
     }
 
+    /**
+     * @param integer $limit
+     * @param integer $offset
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         Header::sendPaginationHeaders($limit, $offset, $size, self::MAX_LIMIT);
     }
@@ -952,6 +969,9 @@ 
         Header::allowOptionsGetPut();
     }
 
+    /**
+     * @param \Planning_ArtifactMilestone $milestone
+     */
     private function sendAllowHeadersForMilestone($milestone) {
         $date = $milestone->getLastModifiedDate();
         Header::allowOptionsGet();

plugins/agiledashboard/include/AgileDashboard/REST/v1/MilestoneResourceValidator.class.php

Doc Comments +6 added lines

@@ -96,6 +96,9 @@ 
         return $this->validateArtifactsForMilestoneContent($ids, $milestone, $user, true);
     }
 
+    /**
+     * @param boolean $accept_closed
+     */
     private function validateArtifactsForMilestoneContent(array $ids, Planning_Milestone $milestone, PFUser $user, $accept_closed) {
         $open_unplanned = null;
         $todo           = null;
@@ -274,6 +277,9 @@ 
         return $index;
     }
 
+    /**
+     * @param Planning_Milestone $milestone
+     */
     private function getMilestoneBacklogItems(PFUser $user, $milestone) {
         return $this->backlog_item_collection_factory->getUnplannedOpenCollection(
             $user,

plugins/agiledashboard/include/AgileDashboard/REST/v1/PlanningResource.class.php

Doc Comments +10 added lines

@@ -117,6 +117,9 @@ 
         return $planning;
     }
 
+    /**
+     * @param integer $limit
+     */
     private function limitValueIsAcceptable($limit) {
         return $limit <= self::MAX_LIMIT;
     }
@@ -125,6 +128,10 @@ 
         return UserManager::instance()->getCurrentUser();
     }
 
+    /**
+     * @param integer $limit
+     * @param integer $offset
+     */
     private function getMilestonesByPlanning(Planning $planning, $limit, $offset) {
         $all_milestones = array();
         $milestones = $this->milestone_factory->getAllBareMilestones($this->getCurrentUser(), $planning);
@@ -137,6 +144,9 @@ 
         return $milestones_representations;
     }
 
+    /**
+     * @param integer $size
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         Header::sendPaginationHeaders($limit, $offset, $size, self::MAX_LIMIT);
     }