Enalean / tuleap

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_ChangesetValue_PermissionsOnArtifact.class.php

Doc Comments +2 added lines

@@ -37,6 +37,8 @@
      * @param Tracker_FormElement_Field_Date $field       The field of the value
      * @param boolean                        $has_changed If the changeset value has chnged from the previous one
      * @param array                          $perms   The permissions
+     * @param integer $id
+     * @param boolean $used
      */
     public function __construct($id, $field, $has_changed, $used, $perms) {
         parent::__construct($id, $field, $has_changed);

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_ChangesetValue_Text.class.php

Doc Comments +8 added lines

@@ -48,6 +48,7 @@ 
      * @param boolean                          $has_changed If the changeset value has chnged from the previous one
      * @param string                           $text        The string
      * @param string                           $format      The format
+     * @param integer $id
      */
     public function __construct($id, $field, $has_changed, $text, $format) {
         parent::__construct($id, $field, $has_changed);
@@ -92,6 +93,7 @@ 
  
     /**
      * By default, changeset values are returned as string in 'value' field
+     * @param string $value
      */
     protected function encapsulateRawSoapValue($value) {
         $value = Encoding_SupportedXmlCharEncoding::getXMLCompatibleString($value);
@@ -108,6 +110,9 @@ 
         return $this->getFullRESTRepresentation($this->getText());
     }
 
+    /**
+     * @param string $value
+     */
     protected function getFullRESTRepresentation($value) {
         $classname_with_namespace = 'Tuleap\Tracker\REST\Artifact\ArtifactFieldValueTextRepresentation';
 
@@ -180,6 +185,7 @@ 
     }
 
     /**
+     * @param string $formated_diff
      * @return string text to be displayed in mail notifications when the text has been changed
      */
     protected function fetchHtmlMailDiff($formated_diff, $artifact_id, $changeset_id) {
@@ -214,6 +220,7 @@ 
     /**
     * Display the diff in changeset
     *
+    * @param string $format
     * @return string The text to display
     */
     public function fetchDiff($previous, $next, $format) {
@@ -242,6 +249,7 @@ 
     }
 
     /**
+     * @param string $formated_diff
      * @return string text to be displayed in web ui when the text has been changed
      */
     protected function fetchDiffInFollowUp($formated_diff) {

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_PossibleParentsRetriever.php

Doc Comments +4 added lines

@@ -27,6 +27,10 @@
         $this->artifact_factory = $artifact_factory;
     }
 
+    /**
+     * @param integer $limit
+     * @param integer $offset
+     */
     public function getPossibleArtifactParents(Tracker $parent_tracker, PFUser $user, $limit, $offset) {
         $label            = '';
         $possible_parents = array();

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_PriorityHistoryChange.class.php

Doc Comments +3 added lines

@@ -71,6 +71,9 @@
     private $prioritized_on;
 
 
+    /**
+     * @param boolean $has_been_raised
+     */
     public function __construct(
         Tracker_ArtifactFactory $tracker_artifact_factory,
         $id,

plugins/tracker/include/Tracker/Artifact/Tracker_Artifact_PriorityManager.class.php

Doc Comments +15 added lines

@@ -83,6 +83,12 @@ 
         $this->priority_dao->moveArtifactBefore($artifact_id, $successor_id);
     }
 
+    /**
+     * @param integer $artifact_id
+     * @param integer $successor_id
+     * @param integer $context_id
+     * @param integer $project_id
+     */
     public function moveArtifactBeforeWithHistoryChangeLogging($artifact_id, $successor_id, $context_id, $project_id) {
         $old_global_rank = $this->getGlobalRank($artifact_id);
         $this->priority_dao->moveArtifactBefore($artifact_id, $successor_id);
@@ -107,6 +113,9 @@ 
         }
     }
 
+    /**
+     * @param integer $successor_id
+     */
     public function moveListOfArtifactsBefore(array $list_of_artifact_ids, $successor_id, $context_id, $project_id) {
         $ranks_before_move = $this->getGlobalRanks($list_of_artifact_ids);
 
@@ -132,6 +141,9 @@ 
         }
     }
 
+    /**
+     * @param integer $predecessor_id
+     */
     public function moveListOfArtifactsAfter(array $list_of_artifact_ids, $predecessor_id, $context_id, $project_id) {
         $ranks_before_move = $this->getGlobalRanks($list_of_artifact_ids);
 
@@ -157,6 +169,9 @@ 
         }
     }
 
+    /**
+     * @param integer $rank_after_move
+     */
     private function didArtifactRankChange($rank_before_move, $rank_after_move) {
         return $rank_after_move !== $rank_before_move;
     }

plugins/tracker/include/Tracker/Artifact/Tracker_ArtifactCreator.class.php

Doc Comments +1 added lines

@@ -49,6 +49,7 @@
     /**
      * Add an artefact in the tracker
      *
+     * @param boolean $send_notification
      * @return Tracker_Artifact or false if an error occured
      */
     public function create(

plugins/tracker/include/Tracker/Artifact/Tracker_ArtifactFactory.class.php

Doc Comments +6 added lines, -3 removed lines

@@ -59,7 +59,6 @@ 
     /**
      * Allows clear factory instance for test. DO NOT USE IT IN PRODUCTION!
      * 
-     * @param Tracker_ArtifactFactory $factory 
      */
     public static function clearInstance() {
         self::$instance = null;
@@ -118,6 +117,7 @@ 
      * @param int $tracker_id The id of the tracker
      * @param int $limit      The maximum number of artifacts returned
      * @param int $offset
+     * @param boolean $reverse_order
      *
      * @return Tracker_Artifact_PaginatedArtifacts
      */
@@ -182,7 +182,7 @@ 
     /**
      *
      * @param PFUser $user
-     * @param type $tracker_id
+     * @param integer $tracker_id
      * @param type $limit
      * @param type $offset
      * @return Tracker_Artifact_PaginatedArtifacts
@@ -200,6 +200,9 @@ 
         return new Tracker_Artifact_PaginatedArtifacts($artifacts, $size);
     }
 
+    /**
+     * @param integer $tracker_id
+     */
     public function getClosedArtifactsByTrackerIdUserCanView(PFUser $user, $tracker_id) {
         $artifacts = array();
         foreach ($this->getDao()->searchClosedByTrackerId($tracker_id) as $row) {
@@ -380,7 +383,7 @@ 
     }
 
     /**
-     * @return Tracker_Artifact[]
+     * @return DataAccessResult
      */
     public function getLinkedArtifacts(Tracker_Artifact $artifact) {
         return $this->getDao()->getLinkedArtifacts($artifact->getId())->instanciateWith(array($this, 'getInstanceFromRow'));

plugins/tracker/include/Tracker/Artifact/View/Edit.class.php

Doc Comments +1 added lines, -2 removed lines

@@ -123,7 +123,6 @@ 
     /**
      * Returns HTML code to display the artifact follow-up comments
      *
-     * @param PFUser $current_user the current user
      *
      * @return string The HTML code for artifact follow-up comments
      */
@@ -200,7 +199,7 @@ 
     }
 
     /**
-     * @return Tracker_ArtifactByEmailStatus
+     * @return boolean
      */
     private function canUpdateArtifactByMail() {
         $config = new TrackerPluginConfig(

plugins/tracker/include/Tracker/Artifact/XMLImport.class.php

Doc Comments +3 added lines

@@ -44,6 +44,9 @@
     /** @var WrapperLogger */
     private $logger;
 
+    /**
+     * @param boolean $send_notifications
+     */
     public function __construct(
         XML_RNGValidator $rng_validator,
         Tracker_ArtifactCreator $artifact_creator,