Enalean / tuleap

plugins/cardwall/include/OnTop/Config/Command/DeleteMappingFields.class.php

Doc Comments +3 added lines

@@ -78,6 +78,9 @@
             && $this->mappingExists($mapping_tracker->getId());
     }
 
+    /**
+     * @param integer $mapping_tracker_id
+     */
     private function mappingExists($mapping_tracker_id) {
         return isset($this->existing_mappings[$mapping_tracker_id])
             && $this->existing_mappings[$mapping_tracker_id] instanceof Cardwall_OnTop_Config_TrackerMappingFreestyle;

plugins/cardwall/include/OnTop/Config/TrackerMappingFactory.class.php

Doc Comments +3 added lines, -2 removed lines

@@ -65,7 +65,7 @@ 
      * Get all mappings defined for the cardwall on top of a tracker
      *
      * @param Tracker $tracker The tracker
-     * @param array   $columns array of Cardwall_Column
+     * @param Cardwall_OnTop_Config_ColumnCollection   $columns array of Cardwall_Column
      *
      * @return Cardwall_OnTop_Config_TrackerMapping[]
      */
@@ -113,6 +113,7 @@ 
     }
 
     /**
+     * @param Tracker_FormElement_Field $mapping_field
      * @return Cardwall_OnTop_Config_TrackerMappingFreestyle
      */
     private function instantiateFreestyleMapping(Tracker $tracker, array &$mappings, Tracker $mapping_tracker, array $available_fields, $mapping_field) {
@@ -126,7 +127,7 @@ 
     }
 
     /**
-     * @return Cardwall_OnTop_Config_TrackerMappingFreestyle
+     * @return Cardwall_OnTop_Config_TrackerMappingNoField
      */
     private function instantiateNoFieldMapping(Tracker $mapping_tracker, array $available_fields) {
         return new Cardwall_OnTop_Config_TrackerMappingNoField(

plugins/cardwall/include/OnTop/Config/ValueMapping.class.php

Doc Comments +6 added lines

@@ -65,10 +65,16 @@
         return $this->matchLabel($artifact_status_label) || $this->matchNone($artifact_status_label);
     }
 
+    /**
+     * @param string $artifact_status_label
+     */
     private function matchLabel($artifact_status_label) {
         return $this->getValueLabel() == $artifact_status_label;
     }
 
+    /**
+     * @param string $artifact_status_label
+     */
     private function matchNone($artifact_status_label) {
         return $artifact_status_label === null && $this->getValueId() == 100;
     }

plugins/cardwall/include/OnTop/Config/View/Admin.class.php

Doc Comments +5 added lines

@@ -29,6 +29,9 @@ 
         return $this->generateAdminForm($config);
     }
 
+    /**
+     * @param Cardwall_OnTop_Config $config
+     */
     private function generateAdminForm($config) {
         $column_definition_view = new Cardwall_OnTop_Config_View_ColumnDefinition($config);
         $checked                = $config->isEnabled() ? 'checked="checked"' : '';
@@ -52,6 +55,8 @@ 
     }
 
      /**
+     * @param string $page
+     * @param string $category
      * @return string
      */
     private function translate($page, $category, $args = "") {

plugins/cardwall/include/OnTop/Config/View/ColumnDefinition.class.php

Doc Comments +9 added lines

@@ -207,6 +207,9 @@ 
         return $html;
     }
 
+    /**
+     * @param Cardwall_Column $column
+     */
     private function decorateEdit($column) {
         $id   = 'column_'. $column->id .'_field';
         $hexa = ColorHelper::CssRGBToHexa($column->bgcolor);
@@ -215,6 +218,10 @@ 
         return $html;
     }
 
+    /**
+     * @param string $id
+     * @param string $classname
+     */
     private function fetchSquareColor($id, $title, $classname, $img = 'blank16x16.png') {
         $html = '';
         $bgcolor = "background-color:$title;";
@@ -261,6 +268,8 @@ 
     }
 
     /**
+     * @param string $page
+     * @param string $category
      * @return string
      */
     protected function translate($page, $category, $args = "") {

plugins/cardwall/include/OnTop/ConfigEmpty.class.php

Doc Comments +3 added lines, -4 removed lines

@@ -43,8 +43,7 @@ 
     /**
      * Get Frestyle columns for Cardwall_OnTop, or status columns if none
      * 
-     * @param Tracker $tracker
-     * @return Cardwall_OnTop_Config_ColumnCollection
+     * @return boolean
      */
     public function getDashboardColumns() {
         return false;
@@ -52,7 +51,7 @@ 
 
     /**
      * Get Columns from the values of a $field
-     * @return Cardwall_OnTop_Config_ColumnCollection
+     * @return boolean
      */
     public function getRendererColumns(Tracker_FormElement_Field_List $cardwall_field) {
         return false;
@@ -91,7 +90,7 @@ 
      *
      * @param array $fields array of Tracker_FormElement_Field_Selectbox
      *
-     * @return Cardwall_MappingCollection
+     * @return boolean
      */
     public function getCardwallMappings(array $fields, Cardwall_OnTop_Config_ColumnCollection $cardwall_columns) {
         return false;

plugins/cardwall/include/OnTop/ConfigFactory.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
     }
 
     /**
-     * @param Tracker $tracker
+     * @param Tracker $tracker_id
      * 
      * @return \Cardwall_OnTop_Config
      */

plugins/cardwall/include/OnTop/Dao.class.php

Doc Comments +10 added lines

@@ -41,6 +41,9 @@ 
         return $this->update($sql);
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     public function disable($tracker_id) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $sql = "DELETE FROM plugin_cardwall_on_top
@@ -49,6 +52,7 @@ 
     }
 
     /**
+     * @param integer $tracker_id
      * @return boolean
      */
     public function isFreestyleEnabled($tracker_id) {
@@ -66,10 +70,16 @@ 
         return $this->updateFreestyleColumns($tracker_id, 1);
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     public function disableFreestyleColumns($tracker_id) {
         return $this->updateFreestyleColumns($tracker_id, 0);
     }
 
+    /**
+     * @param integer $value
+     */
     private function updateFreestyleColumns($tracker_id, $value) {
         $tracker_id = $this->da->escapeInt($tracker_id);
         $value      = $this->da->escapeInt($value);

plugins/cardwall/include/OnTop/IConfig.class.php

Doc Comments +21 added lines

@@ -24,12 +24,24 @@ 
  */
 interface Cardwall_OnTop_IConfig {
     
+    /**
+     * @return Tracker|null
+     */
     public function getTracker();
 
+    /**
+     * @return boolean
+     */
     public function isEnabled();
 
+    /**
+     * @return boolean
+     */
     public function enable();
 
+    /**
+     * @return boolean
+     */
     public function disable();
 
     public function getDashboardColumns();
@@ -40,14 +52,23 @@ 
 
     public function getTrackers();
 
+    /**
+     * @return Cardwall_OnTop_Config_TrackerMapping|null
+     */
     public function getMappingFor(Tracker $mapping_tracker);
 
+    /**
+     * @return boolean
+     */
     public function isInColumn(Tracker_Artifact                                     $artifact, 
                                Cardwall_FieldProviders_IProvideFieldGivenAnArtifact $field_provider, 
                                Cardwall_Column                                      $column);
 
     public function getCardwallMappings(array $fields, Cardwall_OnTop_Config_ColumnCollection $cardwall_columns);
 
+    /**
+     * @return void
+     */
     public function fillMappingsWithOnTopMappings(Cardwall_MappingCollection             $mappings, 
                                                   Cardwall_OnTop_Config_ColumnCollection $columns);
 }