Enalean / tuleap

plugins/graphontrackersv5/include/data-transformation/GraphOnTrackersV5_Burndown_DataBuilder.class.php

Doc Comments +6 added lines

@@ -46,6 +46,9 @@ 
         $engine->duration    = $this->chart->getDuration();
     }
     
+    /**
+     * @param integer $effort_field_id
+     */
     protected function getBurnDownData($effort_field_id, $type) {
         $artifact_ids = explode(',', $this->artifacts['id']);
         $sql = "SELECT c.artifact_id AS id, TO_DAYS(FROM_UNIXTIME(submitted_on)) - TO_DAYS(FROM_UNIXTIME(0)) as day, value
@@ -58,6 +61,9 @@ 
         return new GraphOnTrackersV5_Burndown_Data(db_query($sql), $artifact_ids);
     }
     
+    /**
+     * @param Tracker_FormElement_Field $effort_field
+     */
     protected function isValidEffortField($effort_field, $type) {
         return $effort_field && $effort_field->userCanRead(UserManager::instance()->getCurrentUser());
     }

plugins/graphontrackersv5/include/data-transformation/GraphOnTrackersV5_Chart_GanttDataBuilder.class.php

Doc Comments +3 added lines

@@ -122,6 +122,9 @@
         return strcmp($a_date, $b_date);
     }
 
+    /**
+     * @return string
+     */
     private function getSuitableDateForSorting($artifact_data) {
         $date = $artifact_data['start'];
         // a milestone has no start date, only a end one

plugins/graphontrackersv5/include/data-transformation/GraphOnTrackersV5_CumulativeFlow_DataBuilder.class.php

Doc Comments +4 added lines, -2 removed lines

@@ -100,6 +100,9 @@ 
         return $this->filterEmptyLines($result);;
     }
 
+    /**
+     * @param Tracker_FormElement_Field $observed_field
+     */
     protected function isValidObservedField($observed_field, $type) {
         return $observed_field && $observed_field->userCanRead(UserManager::instance()->getCurrentUser());
     }
@@ -116,7 +119,6 @@ 
     /**
      *
      * Fetch the colors, and initialize an empty result array. => $tempData[timestamp][label_id] = 0
-     * @param int $field_id ID of the observed field
      * @return array $resultArray Initialized array for this graph
      */
     private function initEmptyResultArrayFromField($engine) {
@@ -149,7 +151,7 @@ 
     /**
      *
      * Get the the last changeset BEFORE the timestamp for each artifact
-     * @param int $beforeTimestamp
+     * @param double $timestamp
      * @return $changesets array of changeset_id
      */
     private function getLastChangesetsBefore($timestamp) {

plugins/graphontrackersv5/include/data-transformation/GraphOnTrackersV5_Scrum_Burnup_DataBuilder.class.php

Doc Comments +3 added lines

@@ -60,6 +60,9 @@
         return $data;
     }
     
+    /**
+     * @param string $column
+     */
     protected function extractDataFromResult($res, $ids, $column) {
         $data = array();
         if ($res && db_numrows($res)) {

plugins/graphontrackersv5/include/graphic-library/GraphOnTrackersV5_Engine.class.php

Doc Comments +2 added lines

@@ -61,6 +61,8 @@
      * If the given color is undefined(null), then we must take one from the current
      * theme (in available_colors).
      *
+     * @param string $available_colors
+     * @param integer $max_colors
      * @return string hexadecimal representation of the color
      */
     private function fillTheBlanks($color, $available_colors, $max_colors, &$i) {

plugins/graphontrackersv5/include/graphic-library/GraphOnTrackersV5_Engine_Gantt.class.php

Doc Comments +10 added lines

@@ -310,6 +310,9 @@ 
         return $bar;
     }
     
+    /**
+     * @param integer $pos
+     */
     protected function addMilestone($pos, $data, $params = array()) {
         $format = "Y-m-d";
         $aLabel   = isset($params['label']) ? $params['label'] : array($data['id'], html_entity_decode($data['summary']));
@@ -331,6 +334,9 @@ 
         return $milestone;
     }
     
+    /**
+     * @param integer $pos
+     */
     protected function addErrorBar($pos, $data) {
         $format   = "Y-m-d";
         
@@ -362,6 +368,10 @@ 
         $bar->SetPattern(GANTT_RDIAG,"black", 96);
     }
     
+    /**
+     * @param integer $pos
+     * @param boolean $progress
+     */
     protected function addLateBar($pos, $data, $progress, $params = array()) {
         $bar = $this->addBar($pos, $data, $progress, $params);
         $bar->SetColor($this->graph->getLateBarColor().":0.7");

plugins/graphontrackersv5/include/GraphOnTrackersV5_Renderer.class.php

Doc Comments +6 added lines

@@ -27,6 +27,9 @@ 
     protected $chart_to_edit;
     protected $plugin;
 
+    /**
+     * @param GraphOnTrackersV5Plugin $plugin
+     */
     public function __construct($id, $report, $name, $description, $rank, $plugin) {
         parent::__construct($id, $report, $name, $description, $rank);
         $this->charts        = null;
@@ -124,6 +127,9 @@ 
         return $html;
     }
 
+    /**
+     * @param boolean $readonly
+     */
     protected function fetchCharts($matching_ids, PFUser $current_user, $in_dashboard = false, $readonly = null, $store_in_session = true) {
         $html = '';
         $hp = Codendi_HTMLPurifier::instance();

plugins/graphontrackersv5/include/GraphOnTrackersV5_Widget_Chart.class.php

Doc Comments +4 added lines

@@ -28,6 +28,10 @@
 abstract class GraphOnTrackersV5_Widget_Chart extends Widget {
     var $chart_title;
     var $chart_id;
+
+    /**
+     * @param string $id
+     */
     function GraphOnTrackersV5_Widget_Chart($id, $owner_id, $owner_type) {
         $this->Widget($id);
         $this->setOwner($owner_id, $owner_type);

plugins/graphontrackersv5/include/GraphOnTrackersV5PluginInfo.class.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
 
 class GraphOnTrackersV5PluginInfo extends PluginInfo {
     
+    /**
+     * @param GraphOnTrackersV5Plugin $plugin
+     */
     function GraphOnTrackersV5PluginInfo(&$plugin) {
         $this->PluginInfo($plugin);
         $this->setPluginDescriptor(new GraphOnTrackersV5PluginDescriptor());