Enalean / tuleap

plugins/graphontrackers/include/data-access/GraphOnTrackers_Report.class.php

Doc Comments +8 added lines, -5 removed lines

@@ -66,7 +66,7 @@ 
 
     /**
     * getter method to set report_graphic_id
-    *     @return null
+    *     @return string
     */  
       
     function getId() {
@@ -116,7 +116,7 @@ 
     /**
     * getter method to get graphic report scope
     *
-    *     @return int scope : the graphic report scope (Personal,Project)
+    *     @return string scope : the graphic report scope (Personal,Project)
     */  
        
     function getScope() {
@@ -136,7 +136,7 @@ 
     /**
     * getter method to get graphic report artifact group identifier
     *
-    *     @return int group_artifact_id : tracker type
+    *     @return string group_artifact_id : tracker type
     */
       
     function getGroup_artifact_id() {
@@ -161,7 +161,7 @@ 
     /**
     * getter method to get user identifier
     *
-    *     @return int user_id : the user identifier
+    *     @return string user_id : the user identifier
     */
     function getUserId() {
         return $this->user_id;
@@ -170,6 +170,7 @@ 
     /**
     * setter method to set user identifier
     *  @param int user_id: the user identifier
+    * @param integer $user_id
     */  
        
     function setUserId($user_id) {
@@ -203,6 +204,7 @@ 
     *
     * param scope: the scope code
     *
+    * @param string $scope
     * @return string
     */
 
@@ -277,7 +279,8 @@ 
      * 
      * @param string The report name.
      * @param string The report description.
-     * @return id on success, false on failure.
+     * @param integer $user_id
+     * @return GraphOnTrackers_Report|null on success, false on failure.
      */
     public static function create($atid, $user_id, $name, $description, $scope) {
         $sql = sprintf("INSERT INTO plugin_graphontrackers_report_graphic 

plugins/graphontrackers/include/data-access/GraphOnTrackers_ReportDao.class.php

Doc Comments +4 added lines

@@ -25,6 +25,10 @@
      *  Data Access Object for GraphOnTrackers_Report 
      */
     class GraphOnTrackers_ReportDao extends DataAccessObject {
+
+        /**
+         * @param string $scope
+         */
         public function searchByTrackerIdAndScope($tracker_id, $scope) {
             $sql = "SELECT * FROM plugin_graphontrackers_report_graphic WHERE group_artifact_id = ";
             $sql .= $this->da->escapeInt($tracker_id);

plugins/graphontrackers/include/data-access/GraphOnTrackers_ReportFactory.class.php

Doc Comments +2 added lines

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

plugins/graphontrackers/include/data-transformation/GraphOnTrackers_Chart_GanttDataBuilder.class.php

Doc Comments +1 added lines

@@ -166,6 +166,7 @@
 
     /**
      * Fill engine object with database results depending of data type
+     * @param string $type
      */
     protected function _fillEngineData($res, $engine, $type) {
         if ($res && !db_error($res)) {

plugins/graphontrackers/include/graphic-library/GraphOnTrackers_Engine_Bar.class.php

Doc Comments +3 added lines

@@ -93,6 +93,9 @@
         return $this->graph;
     }
     
+    /**
+     * @param string $color
+     */
     function getBarPlot($data, $color) {
         $b = new BarPlot($data);
         //parameters hard coded for the moment

plugins/graphontrackers/include/GraphOnTrackersPluginInfo.class.php

Doc Comments +3 added lines

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

plugins/graphontrackers/include/html-generators/GraphicEngineHtml.class.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
     
     protected $theme_path;
     
+    /**
+     * @param integer $user_id
+     */
     function graphicEngineHtml($group_artifact_id,$user_id,$theme_path) {
         $this->grf = new graphicReportFactory($group_artifact_id,$user_id);
         $this->theme_path = $theme_path;

plugins/graphontrackersv5/include/common/HTML_Element_Selectbox_TrackerFields_TextsV5.class.php

Doc Comments +4 added lines

@@ -27,6 +27,10 @@
  */
 class HTML_Element_Selectbox_TrackerFields_TextsV5 extends HTML_Element_Selectbox {
 
+    /**
+     * @param Tracker $tracker
+     * @param string $name
+     */
     public function __construct($tracker, $label, $name, $value, $with_none = false, $onchange = "", $desc="") {
         parent::__construct($label, $name, $value, $with_none, $onchange, $desc);
         

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

Doc Comments -1 removed lines

@@ -81,7 +81,6 @@
     /**
      * Display the report list
      *
-     * @param : $reports      the list the reports within an artifact to display
      *
      * @return void
      */