Enalean / tuleap

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

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

Doc Comments +3 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,8 @@ 
     }
 
     /**
+     * @param integer $tracker_id
+     * @param integer $field_id
      * @return boolean true if success
      */
     public function save($tracker_id, $field_id) {

plugins/agiledashboard/include/AgileDashboard/SequenceIdManager.php

Doc Comments +9 added lines

@@ -41,6 +41,9 @@ 
         return $this->getArtifactPosition((int) $milestone->getArtifactId(), $artifact_id);
     }
 
+    /**
+     * @param integer $milestone_id
+     */
     private function getArtifactPosition($milestone_id, $artifact_id) {
         if (! isset($this->backlog_item_ids[$milestone_id][$artifact_id])) {
             return;
@@ -75,6 +78,9 @@ 
         }
     }
 
+    /**
+     * @param integer $milestone_id
+     */
     private function storeTopBacklogArtifacts($milestone_id, AgileDashboard_Milestone_Backlog_BacklogItemCollection $backlog_items) {
         $artifact_position = 1;
         foreach ($backlog_items as $backlog_item) {
@@ -83,6 +89,9 @@ 
         }
     }
 
+    /**
+     * @param integer $milestone_id
+     */
     private function storeBacklogArtifacts($milestone_id,AgileDashboard_Milestone_Backlog_DescendantItemsCollection $backlog_artifacts) {
         $artifact_position = 1;
         foreach ($backlog_artifacts as $backlog_artifact) {

plugins/agiledashboard/include/AgileDashboard/XMLExporter.class.php

Doc Comments +6 added lines

@@ -126,12 +126,18 @@
         return self::TRACKER_ID_PREFIX . (string) $tracker_id ;
     }
 
+    /**
+     * @param string $value
+     */
     private function checkString($value, $value_denomination) {
         if (! $value ||  (is_string($value) && $value == '')) {
             throw new AgileDashboard_XMLExporterUnableToGetValueException('Unable to get value for attribute: ' . $value_denomination);
         }
     }
 
+    /**
+     * @param string $id
+     */
     private function checkId($id, $value_denomination) {
         if ($id == self::TRACKER_ID_PREFIX) {
             throw new AgileDashboard_XMLExporterUnableToGetValueException('Unable to get value for attribute: ' . $value_denomination);

plugins/agiledashboard/include/agiledashboardPlugin.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -512,7 +512,7 @@
 
     /**
      *
-     * @param array $param
+     * @param array $params
      *  Expected key/ values:
      *      project_id  int             The ID of the project for the import
      *      xml_content SimpleXmlObject A string of valid xml

plugins/agiledashboard/include/AgileDashboardPluginInfo.class.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
  */
 class AgileDashboardPluginInfo extends PluginInfo {
 
+    /**
+     * @param AgileDashboardPlugin $plugin
+     */
     function __construct($plugin) {
         parent::__construct($plugin);
         $this->setPluginDescriptor(new AgileDashboardPluginDescriptor());