Enalean / tuleap

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());

plugins/agiledashboard/include/AgileDashboardRouter.class.php

Doc Comments +3 added lines

@@ -401,6 +401,9 @@
         }
     }
 
+    /**
+     * @param Planning_Controller $default_controller
+     */
     public function routeShowTopPlanning(Codendi_Request $request, $default_controller) {
         $user = $request->getCurrentUser();
         if (! $user) {

plugins/agiledashboard/include/AgileDashboardRouterBuilder.php

Doc Comments +6 added lines

@@ -125,6 +125,8 @@ 
     }
 
     /**
+     * @param Codendi_Request $request
+     * @param AgileDashboard_Milestone_Pane_PanePresenterBuilderFactory $pane_presenter_builder_factory
      * @return Planning_VirtualTopMilestonePaneFactory
      */
     private function getTopMilestonePaneFactory(
@@ -143,6 +145,10 @@ 
         );
     }
 
+    /**
+     * @param Planning_MilestoneFactory $milestone_factory
+     * @param AgileDashboard_PaneInfoFactory $pane_info_factory
+     */
     private function getPanePresenterBuilderFactory($milestone_factory, $pane_info_factory) {
         $icon_factory = new AgileDashboard_PaneIconLinkPresenterCollectionFactory($pane_info_factory);
 

plugins/agiledashboard/include/Planning/ArtifactLinker.class.php

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
         return $source_artifact;
     }
 
+    /**
+     * @param string $key
+     */
     private function getSourceArtifact(Codendi_Request $request, $key) {
         $artifact_id = (int) $request->getValidated($key, 'uint', 0);
         return $this->artifact_factory->getArtifactById($artifact_id);

plugins/agiledashboard/include/Planning/ArtifactMilestone.class.php

Doc Comments +6 added lines, -2 removed lines

@@ -223,6 +223,10 @@ 
         return $artifacts;
     }
 
+    /**
+     * @param Tracker_Artifact[] $artifacts
+     * @param PFUser $user
+     */
     private function addChildrenNodes(ArtifactNode $root_node, &$artifacts, $user) {
         foreach ($root_node->getChildren() as $node) {
             $artifact    = $node->getObject();
@@ -307,7 +311,7 @@ 
     /**
      * @param array $artifacts_ids
      * @param PFUser $user
-     * @return Boolean True if nothing went wrong
+     * @return boolean|null True if nothing went wrong
      */
     public function solveInconsistencies(PFUser $user, array $artifacts_ids) {
         $success  = true;
@@ -327,7 +331,7 @@ 
 
     /**
      * @see Planning_Milestone::getDuration()
-     * @return float
+     * @return integer
      */
     public function getDuration() {
         return $this->duration;

plugins/agiledashboard/include/Planning/MilestoneController.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
      *   - pass $request to actions (e.g. show).
      *
      * @param Codendi_Request           $request
-     * @param PlanningFactory           $planning_factory
+     * @param PlanningFactory           $pane_factory
      * @param Planning_MilestoneFactory $milestone_factory
      */
     public function __construct(

plugins/agiledashboard/include/Planning/MilestoneControllerFactory.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
      *
      * @param Codendi_Request $request
      *
-     * @return Planning_MilestoneController
+     * @return Planning_VirtualTopMilestoneController
      */
     public function getVirtualTopMilestoneController(Codendi_Request $request) {
         return new Planning_VirtualTopMilestoneController(