Enalean / tuleap

plugins/agiledashboard/include/AgileDashboard/Milestone/Backlog/BacklogItemCollectionFactory.class.php

Doc Comments +15 added lines

@@ -108,6 +108,9 @@ 
         return $this->done_collection[$milestone->getArtifactId()];
     }
 
+    /**
+     * @param false|string $redirect_to_self
+     */
     public function getUnassignedOpenCollection(
         PFUser $user,
         Planning_Milestone $milestone,
@@ -119,6 +122,9 @@ 
         return $this->filterOutAssignedBacklogItems($collection, $user);
     }
 
+    /**
+     * @param boolean $redirect_to_self
+     */
     public function getUnassignedCollection(
         PFUser $user,
         Planning_Milestone $milestone,
@@ -221,6 +227,9 @@ 
         return $collection;
     }
 
+    /**
+     * @param string $redirect_to_self
+     */
     public function getInconsistentCollection(
         PFUser $user,
         Planning_Milestone $milestone,
@@ -232,6 +241,9 @@ 
         return $this->inconsistent_collection[$milestone->getArtifactId()];
     }
 
+    /**
+     * @param string $redirect_to_self
+     */
     public function getAllCollection(
         PFUser $user,
         Planning_Milestone $milestone,
@@ -471,6 +483,9 @@ 
         }
     }
 
+    /**
+     * @param integer $artifact_id
+     */
     private function pushItemInDoneCollection(Planning_Milestone $milestone, array $semantics, $artifact_id, AgileDashboard_Milestone_Backlog_IBacklogItem $backlog_item) {
         $this->setInitialEffort($backlog_item, $semantics[$artifact_id]);
 

plugins/agiledashboard/include/AgileDashboard/Milestone/Backlog/BacklogRowPresenter.class.php

Doc Comments +9 added lines

@@ -24,12 +24,21 @@
 
 interface AgileDashboard_Milestone_Backlog_BacklogRowPresenter {
 
+    /**
+     * @return string
+     */
     public function title();
 
     public function url();
 
+    /**
+     * @return integer
+     */
     public function points();
 
+    /**
+     * @return string|null
+     */
     public function parent_title();
 
     public function parent_url();

plugins/agiledashboard/include/AgileDashboard/Milestone/Backlog/DescendantBacklogStrategy.class.php

Doc Comments +3 added lines

@@ -160,6 +160,9 @@
         return $trackers_without_initial_effort_defined;
     }
 
+    /**
+     * @param string $redirect_to_self
+     */
     public function getPresenter(
         PFUser $user,
         Planning_ArtifactMilestone $milestone,

plugins/agiledashboard/include/AgileDashboard/Milestone/Backlog/DescendantItemsFinder.class.php

Doc Comments +5 added lines

@@ -275,6 +275,7 @@ 
      * We only want the section of the tree that goes from a
      * tracker in a milestone to a tracker in a submilestone.
      *
+     * @param integer[] $submilestone_tracker_hierarchy_tree
      */
     private function extractRelevantSubmilestoneBacklogTrackerHierarchyTreeSection(&$submilestone_tracker_hierarchy_tree) {
         foreach ($submilestone_tracker_hierarchy_tree as $key => $value) {
@@ -299,6 +300,7 @@ 
 
     /**
      * get all children of a given type of any of the parent items
+     * @param string $ids_of_parent_items_to_search_in
      */
     private function getIdsOfChildItemsOfOneTrackerType($ids_of_parent_items_to_search_in, $tracker_id) {
         $search = $this->artifact_dao->getLinkedArtifactsOfArtifactsOfTrackerTypeAsString(
@@ -309,6 +311,9 @@ 
         return (string) $search['artifact_ids'];
     }
 
+    /**
+     * @param string $children
+     */
     private function canChildrenBePlanned($children, $tracker_id) {
         return $children && in_array($tracker_id, $this->descendant_tracker_ids);
     }

plugins/agiledashboard/include/AgileDashboard/Milestone/MilestoneDao.class.php

Doc Comments +6 added lines

@@ -78,6 +78,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param integer $milestone_tracker_id
+     */
     public function searchPaginatedTopMilestones(
         $milestone_tracker_id,
         Tuleap\AgileDashboard\Milestone\Criterion\ISearchOnStatus $criterion,
@@ -157,6 +160,9 @@ 
         return array($from_status_statement, $where_status_statement);
     }
 
+    /**
+     * @param integer $milestone_artifact_id
+     */
     public function searchSubMilestones($milestone_artifact_id) {
         $limit     = null;
         $offset    = null;

plugins/agiledashboard/include/AgileDashboard/Milestone/MilestoneReportCriterionOptionsProvider.class.php

Doc Comments +3 added lines

@@ -100,6 +100,9 @@
         return $options;
     }
 
+    /**
+     * @param string $content
+     */
     private function getOptionForSelectBox($selected_milestone_id, $milestone_id, $content) {
         $selected = '';
 

plugins/agiledashboard/include/AgileDashboard/Milestone/MilestoneRepresentationBuilder.class.php

Doc Comments +5 added lines

@@ -69,6 +69,11 @@
         return $milestone_representation;
     }
 
+    /**
+     * @param integer $limit
+     * @param integer $offset
+     * @param string $order
+     */
     public function getPaginatedSubMilestonesRepresentations(
         Planning_Milestone $milestone,
         PFUser $user,

plugins/agiledashboard/include/AgileDashboard/Milestone/MilestoneStatusCounter.class.php

Doc Comments +1 added lines

@@ -41,6 +41,7 @@
      *      Tracker_Artifact::STATUS_CLOSED => no_of_closed,
      *  )
      *
+     * @param integer|null $milestone_artifact_id
      * @return array
      */
     public function getStatus(PFUser $user, $milestone_artifact_id) {

plugins/agiledashboard/include/AgileDashboard/Milestone/Pane/Content/ContentPaneInfo.class.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
     /** @var string */
     private $theme_path;
 
+    /**
+     * @param string $theme_path
+     */
     public function __construct(Planning_Milestone $milestone, $theme_path) {
         parent::__construct($milestone);
         $this->theme_path = $theme_path;