Enalean / tuleap

plugins/graphontrackersv5/include/data-access/GraphOnTrackersV5_Chart_Burndown.class.php

Doc Comments +6 added lines, -2 removed lines

@@ -36,6 +36,10 @@ 
      */
     protected $start_date;
     public function getStartDate() { return $this->start_date; }
+
+    /**
+     * @param integer $start_date
+     */
     public function setStartDate($start_date) { return $this->start_date = $start_date; }
     
     /**
@@ -126,14 +130,14 @@ 
     }
     
     /**
-     * @return GraphOnTrackerV5_Engine The engine associated to the concrete chart
+     * @return GraphOnTrackersV5_Engine_Burndown The engine associated to the concrete chart
      */
     protected function getEngine() {
         return new GraphOnTrackersV5_Engine_Burndown();
     }
     
     /**
-     * @return ChartDataBuilder The data builder associated to the concrete chart
+     * @return GraphOnTrackersV5_Burndown_DataBuilder The data builder associated to the concrete chart
      */
     protected function getChartDataBuilder($artifacts) {
         return new GraphOnTrackersV5_Burndown_DataBuilder($this,$artifacts);

plugins/graphontrackersv5/include/data-access/GraphOnTrackersV5_Chart_CumulativeFlow.class.php

Doc Comments +10 added lines, -2 removed lines

@@ -39,6 +39,10 @@ 
      */
     protected $start_date;
     public function getStartDate() { return $this->start_date; }
+
+    /**
+     * @param integer $start_date
+     */
     public function setStartDate($start_date) { return $this->start_date = $start_date; }
 
     /**
@@ -53,6 +57,10 @@ 
      */
     protected $stop_date;
     public function getStopDate() { return $this->stop_date; }
+
+    /**
+     * @param integer $stop_date
+     */
     public function setStopDate($stop_date) { return $this->stop_date = $stop_date; }
 
     /**
@@ -141,14 +149,14 @@ 
     }
 
     /**
-     * @return GraphOnTrackerV5_Engine The engine associated to the concrete chart
+     * @return GraphOnTrackersV5_Engine_CumulativeFlow The engine associated to the concrete chart
      */
     protected function getEngine() {
         return new GraphOnTrackersV5_Engine_CumulativeFlow();
     }
 
     /**
-     * @return ChartDataBuilder The data builder associated to the concrete chart
+     * @return GraphOnTrackersV5_CumulativeFlow_DataBuilder The data builder associated to the concrete chart
      */
     protected function getChartDataBuilder($artifacts) {
         return new GraphOnTrackersV5_CumulativeFlow_DataBuilder($this,$artifacts);

plugins/graphontrackersv5/include/data-access/GraphOnTrackersV5_Report.class.php

Doc Comments +5 added lines, -1 removed lines

@@ -230,7 +230,11 @@
      * 
      * @param string The report name.
      * @param string The report description.
-     * @return id on success, false on failure.
+     * @param integer $user_id
+     * @param string $name
+     * @param string $description
+     * @param integer $scope
+     * @return GraphOnTrackersV5_Report|null on success, false on failure.
      */
     public static function create($atid, $user_id, $name, $description, $scope) {
         $sql = sprintf("INSERT INTO plugin_graphontrackersv5_report_graphic 

plugins/graphontrackersv5/include/data-access/GraphOnTrackersV5_ReportDao.class.php

Doc Comments +3 added lines

@@ -33,6 +33,9 @@
             DataAccessObject::DataAccessObject($da);
         }
         
+        /**
+         * @param string $scope
+         */
         public function searchByTrackerIdAndScope($tracker_id, $scope) {
             $sql = "SELECT * FROM plugin_graphontrackersv5_report_graphic WHERE group_artifact_id = ";
             $sql .= $this->da->escapeInt($tracker_id);

plugins/graphontrackersv5/include/data-access/GraphOnTrackersV5_ReportFactory.class.php

Doc Comments +2 added lines

@@ -44,6 +44,8 @@
     
     /**
      * Copy the charts from Report $from_report to Report $to_report
+     * @param GraphOnTrackersV5_Report $from_report
+     * @param GraphOnTrackersV5_Report|null $to_report
      */
     public function copyCharts($from_report, $to_report) {
         foreach($from_report->getCharts() as $c) {

plugins/graphontrackersv5/include/data-access/GraphOnTrackersV5_Scrum_Chart_Burnup.class.php

Doc Comments +19 added lines, -3 removed lines

@@ -31,6 +31,10 @@ 
      */
     protected $start_date;
     public function getStartDate() { return $this->start_date; }
+
+    /**
+     * @param integer $start_date
+     */
     public function setStartDate($start_date) { return $this->start_date = $start_date; }
     
     /**
@@ -38,12 +42,20 @@ 
      */
     protected $duration;
     public function getDuration() { return $this->duration; }
+
+    /**
+     * @param integer $duration
+     */
     public function setDuration($duration) { return $this->duration = $duration; }
     
     /**
      * The remaining effort field
      */
     protected $remaining_field;
+
+    /**
+     * @return boolean
+     */
     public function getRemainingField() { return $this->remaining_field; }
     public function setRemainingField($remaining_field) { return $this->remaining_field = $remaining_field; }
     
@@ -51,6 +63,10 @@ 
      * The done field
      */
     protected $done_field;
+
+    /**
+     * @return boolean
+     */
     public function getDoneField() { return $this->done_field; }
     public function setDoneField($done_field) { return $this->done_field = $done_field; }
     
@@ -78,7 +94,7 @@ 
 
     /**
      * Create an instance of the chart
-     * @return GraphOnTrackersV5_Chart
+     * @return GraphOnTrackersV5_Scrum_Chart_Burnup|null
      */
     public static function create($graphic_report, $id, $rank, $title, $description, $width, $height) {
         $sql = sprintf("INSERT INTO plugin_graphontrackersv5_scrum_burnup
@@ -121,14 +137,14 @@ 
     
     
     /**
-     * @return GraphOnTracker_Engine The engine associated to the concrete chart
+     * @return GraphOnTrackersV5_Scrum_Burnup_Engine The engine associated to the concrete chart
      */
     protected function getEngine() {
         return new GraphOnTrackersV5_Scrum_Burnup_Engine();
     }
     
     /**
-     * @return ChartDataBuilder The data builder associated to the concrete chart
+     * @return GraphOnTrackersV5_Scrum_Burnup_DataBuilder The data builder associated to the concrete chart
      */
     protected function getChartDataBuilder($artifacts) {
         return new GraphOnTrackersV5_Scrum_Burnup_DataBuilder($this,$artifacts);

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