Enalean / tuleap

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

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

Doc Comments +7 added lines

@@ -233,6 +233,10 @@ 
         }
     }
 
+    /**
+     * @param PFUser $user
+     * @param Project $project
+     */
     private function validateArtifactIdsAreInUnassignedTopBacklog($ids, $user, $project) {
         try {
             $this->milestone_validator->validateArtifactIdsAreInUnassignedTopBacklog($ids, $user, $project);
@@ -245,6 +249,9 @@ 
         }
     }
 
+    /**
+     * @param integer $size
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         Header::sendPaginationHeaders($limit, $offset, $size, self::MAX_LIMIT);
     }

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

Doc Comments +3 added lines

@@ -137,6 +137,9 @@
         $this->sendAllowHeaders();
     }
 
+    /**
+     * @param integer $size
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         Header::sendPaginationHeaders($limit, $offset, $size, self::MAX_LIMIT);
     }

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

Doc Comments +3 added lines

@@ -63,6 +63,9 @@
         $this->sendAllowHeaders();
     }
 
+    /**
+     * @param integer $size
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         Header::sendPaginationHeaders($limit, $offset, $size, self::MAX_LIMIT);
     }

plugins/agiledashboard/include/AgileDashboard/REST/v2/BacklogItemRepresentationFactory.class.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
         return $backlog_item_representation;
     }
 
+    /**
+     * @param AgileDashboard_Milestone_Backlog_IBacklogItem $backlog_item
+     */
     private function getBacklogItemCardFields($backlog_item) {
         $current_user         = UserManager::instance()->getCurrentUser();
         $card_fields_semantic = $this->getCardFieldsSemantic($backlog_item);

plugins/agiledashboard/include/AgileDashboard/REST/v2/ProjectBacklogResource.class.php

Doc Comments +3 added lines

@@ -178,6 +178,9 @@
         return $this->backlog_item_collection_factory->getUnassignedOpenCollection($user, $top_milestone, $strategy_unassigned, false);
     }
 
+    /**
+     * @param integer $size
+     */
     private function sendPaginationHeaders($limit, $offset, $size) {
         Header::sendPaginationHeaders($limit, $offset, $size, self::MAX_LIMIT);
     }

plugins/agiledashboard/include/AgileDashboard/Semantic/Dao/Dao_InitialEffort.class.php

Doc Comments +2 added lines

@@ -30,6 +30,7 @@ 
     }
 
     /**
+     * @param integer $tracker_id
      * @return mixed either false if error or object DataAccessResult
      */
     public function searchByTrackerId($tracker_id) {
@@ -43,6 +44,7 @@ 
     }
 
     /**
+     * @param integer $tracker_id
      * @return boolean true if success
      */
     public function save($tracker_id, $field_id) {