Enalean / tuleap

plugins/docman/bin/DocmanImport/ImportFromDocmanV1.class.php

Doc Comments +3 added lines

@@ -94,6 +94,9 @@
         );
     }
 
+    /**
+     * @param integer $folder_id
+     */
     private function importDump(Project $project, $folder_id) {
         $xml_import = new XMLDocmanImport(
             'import:',

plugins/docman/bin/DocmanImport/Trees.class.php

Doc Comments +1 added lines

@@ -117,6 +117,7 @@
     
     /**
      * Set recursively the given tag to all nodes of the tree
+     * @param string $tag
      */
     private static function tagTree(&$tree, $tag) {
         $tree['tag'] = $tag;

plugins/docman/bin/DocmanImport/XMLDocmanImport.class.php

Doc Comments +52 added lines, -2 removed lines

@@ -98,10 +98,17 @@ 
     /**
      * XMLDocmanImport constructor
      *
-     * @param int    $groupId  Group ID
      * @param string $wsdl     WSDL location
      * @param string $login    Login
      * @param string $password Password
+     * @param string $command
+     * @param string $project
+     * @param integer $projectId
+     * @param boolean $force
+     * @param boolean $reorder
+     * @param string $importMessageMetadata
+     * @param boolean $autoRetry
+     * @param boolean $log
      */
     public function __construct($command, $project, $projectId, $wsdl, $login, $password, $force, $reorder, $importMessageMetadata, $autoRetry, $log) {
 
@@ -150,6 +157,8 @@ 
     /**
      * Search the next file name that can be used
      * If the file "name" exists in the folder, the next name to use is "name (2)", then "name (3)", etc.
+     * @param string $folder
+     * @param string $fileName
      */
     private function searchNextFreeFileName($folder, $fileName) {
 
@@ -245,6 +254,8 @@ 
 
     /**
      * Import an item to the specified parent folder
+     * @param string $xmlDoc
+     * @param string $path
      */
     public function importPath($xmlDoc, $parentId, $path) {
 
@@ -679,6 +690,7 @@ 
 
     /**
      * Converts a string to a type code
+     * @param string $type
      */
     private static function typeStringToCode($type) {
         switch ($type) {
@@ -692,6 +704,7 @@ 
 
     /**
      * Displays an error and terminates execution of the script
+     * @param string $error
      */
     protected function exitError($error) {
         exit (PHP_EOL."Fatal error: ".PHP_EOL.$error.PHP_EOL);
@@ -754,6 +767,7 @@ 
 
     /**
      * Parse a date given as an ISO8601 date or a timestamp
+     * @param string $s
      * @return The corresponding timestamp
      */
     private function parseDate($s) {
@@ -956,6 +970,9 @@ 
 
     }
 
+    /**
+     * @param Exception $e
+     */
     protected function askWhatToDo($e) {
         self::printException($e);
 
@@ -994,6 +1011,8 @@ 
 
     /**
      * Creates a folder
+     * @param integer $parentId
+     * @param string $ordering
      */
     private function createFolder($parentId, $title, $description, $ordering, $status, array $permissions, array $metadata, $owner, $createDate, $updateDate) {
         $this->initRetryCounter();
@@ -1014,6 +1033,8 @@ 
 
     /**
      * Creates an empty document
+     * @param integer $parentId
+     * @param string $ordering
      */
     private function createEmpty($parentId, $title, $description, $ordering, $status, $obsolescenceDate, array $permissions, array $metadata, $owner, $createDate, $updateDate) {
         $this->initRetryCounter();
@@ -1034,6 +1055,9 @@ 
 
     /**
      * Creates a wiki page
+     * @param integer $parentId
+     * @param string $ordering
+     * @param string $pagename
      */
     private function createWiki($parentId, $title, $description, $ordering, $status, $obsolescenceDate, array $permissions, array $metadata, $pagename, $owner, $createDate, $updateDate) {
         $this->initRetryCounter();
@@ -1054,6 +1078,9 @@ 
 
     /**
      * Creates a link
+     * @param integer $parentId
+     * @param string $ordering
+     * @param string $url
      */
     private function createLink($parentId, $title, $description, $ordering, $status, $obsolescenceDate, array $permissions, array $metadata, $url, $owner, $createDate, $updateDate) {
         $this->initRetryCounter();
@@ -1074,6 +1101,10 @@ 
 
     /**
      * Creates an embedded file
+     * @param integer $parentId
+     * @param string $ordering
+     * @param string $file
+     * @param string $author
      */
     private function createEmbeddedFile($parentId, $title, $description, $ordering, $status, $obsolescenceDate, array $permissions, array $metadata, $file, $author, $date, $owner, $createDate, $updateDate) {
         $this->initRetryCounter();
@@ -1096,6 +1127,12 @@ 
 
     /**
      * Creates a file
+     * @param integer $parentId
+     * @param string $ordering
+     * @param string $file
+     * @param string $fileName
+     * @param string $fileType
+     * @param string $author
      */
     private function createFile($parentId, $title, $description, $ordering, $status, $obsolescenceDate, array $permissions, array $metadata, $file, $fileName, $fileType, $author, $date, $owner, $createDate, $updateDate) {
         $infoStr = "Creating file              '$title' ($file, $fileName, $fileType)";
@@ -1157,7 +1194,8 @@ 
     /**
      * Compares the local and the distant checksums
      *
-     * @return true if they are the same
+     * @param string $filename
+     * @return boolean if they are the same
      */
     private function checkChecksum($item_id, $filename) {
 
@@ -1178,6 +1216,12 @@ 
 
     /**
      * Create a new file version
+     * @param string $label
+     * @param string $changeLog
+     * @param string $file
+     * @param string $fileName
+     * @param string $fileType
+     * @param string $author
      */
     protected function createFileVersion($itemId, $label, $changeLog, $file, $fileName, $fileType, $author, $date) {
         $infoStr = "                      Version '$label' ($file, $fileName, $fileType)";
@@ -1232,6 +1276,12 @@ 
         }
     }
 
+    /**
+     * @param string $label
+     * @param string $changeLog
+     * @param string $file
+     * @param string $author
+     */
     protected function createEmbeddedFileVersion($itemId, $label, $changeLog, $file, $author, $date) {
         $this->initRetryCounter();
         do {

plugins/docman/bin/DocmanImport/XMLDocmanUpdate.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -294,7 +294,7 @@ 
     /**
      * Compares the version checksums in order to decide what to do.
      * For each version of the item, the checksum of the local file and the remote file are compared
-     * @return true  if we just have to send the new versions to the server
+     * @return boolean  if we just have to send the new versions to the server
      *         false if some versions have been created server-side (so we will need to delete and recreate the whole item)
      */
     private function checkVersionChecksums($itemId, $node) {
@@ -510,6 +510,7 @@ 
     
     /**
      * Updates a wiki document
+     * @param string $pageName
      */
     private function updateWiki($itemId, $itemInfo, $pageName) {
         // Assign variables
@@ -542,6 +543,7 @@ 
     
     /**
      * Updates a link
+     * @param string $url
      */
     private function updateLink($itemId, $itemInfo, $url) {
         // Assign variables

plugins/docman/include/ApprovalTable/ApprovalTable.class.php

Doc Comments +4 added lines

@@ -172,6 +172,10 @@
 
     // Reviewers management
     // Should be managed with SplObjectStorage in Php 5
+
+    /**
+     * @param Docman_ApprovalReviewer $reviewer
+     */
     function addReviewer($reviewer) {
         $this->reviewers[$reviewer->getId()] = $reviewer;
     }

plugins/docman/include/ApprovalTable/File/FileFactory.class.php

Doc Comments +1 added lines

@@ -33,6 +33,7 @@
 
     /**
      *
+     * @param Docman_File $item
      */
     function __construct($item, $versionNumber=null) {
         parent::__construct($item);

plugins/docman/include/ApprovalTable/Item/ItemDao.class.php

Doc Comments +14 added lines

@@ -22,6 +22,9 @@ 
 
 class Docman_ApprovalTableItemDao extends DataAccessObject {
 
+    /**
+     * @param integer $item_id
+     */
     public function getTableByItemId($item_id, $fields='*') {
         $sql = 'SELECT '.$fields.
             ' FROM plugin_docman_approval'.
@@ -57,6 +60,11 @@ 
         return $groupBy;
     }
 
+    /**
+     * @param boolean $status
+     * @param string $fields
+     * @param string $where
+     */
     function getTableWithStatus($status, $fields, $where, $join='', $orderBy='', $limit='') {
         $groupBy = '';
         if($status) {
@@ -75,6 +83,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param string $field
+     */
     function createTable($field, $id, $userId, $description, $date, $status, $notification) {
         $sql = 'INSERT INTO plugin_docman_approval'.
             '('.$field.', table_owner, date, description, status, notification)'.
@@ -149,6 +160,9 @@ 
         }
     }
 
+    /**
+     * @param string $sql
+     */
     function _createAndReturnId($sql) {
         $inserted = $this->update($sql);
         if ($inserted) {

plugins/docman/include/ApprovalTable/NotificationCycle.class.php

Doc Comments +11 added lines

@@ -79,6 +79,9 @@ 
 
     /**
      * Action
+     * @param PFUser $reviewer
+     * @param boolean $isLastReviewer
+     * @param boolean $withComments
      */
     function reviewerApprove($reviewer, $isLastReviewer, $withComments) {
         if($isLastReviewer) {
@@ -96,6 +99,7 @@ 
 
     /**
      * Action
+     * @param PFUser $reviewer
      */
     function reviewerReject($reviewer) {
         $this->sendNotifRejected($reviewer);
@@ -104,6 +108,8 @@ 
 
     /**
      * Action
+     * @param PFUser $reviewer
+     * @param boolean $isLastReviewer
      */
     function reviewerDecline($reviewer, $isLastReviewer) {
         $this->sendNotifReviewDeclined($reviewer);
@@ -115,6 +121,7 @@ 
 
     /**
      * Action
+     * @param PFUser $reviewer
      */
     function reviewerComment($reviewer) {
         $this->sendNotifReviewCommented($reviewer);
@@ -210,6 +217,7 @@ 
     /**
      * Update item status according to parameters.
      * Not in use today.
+     * @param integer $status
      */
     function changeItemStatus($reviewer, $status) {
        // TBD
@@ -521,6 +529,9 @@ 
         return $this->table;
     }
 
+    /**
+     * @param PFUser $owner
+     */
     function setOwner(&$owner) {
         $this->owner = $owner;
     }

plugins/docman/include/ApprovalTable/Reminder.class.php

Doc Comments +2 added lines, -3 removed lines

@@ -98,7 +98,7 @@ 
      *
      * @param Docman_ApprovalTable $table Approval table
      *
-     * @return Boolean
+     * @return null|boolean
      */
     private function notifyNextReviewer(Docman_ApprovalTable $table) {
         $dao = new Docman_ApprovalTableReviewerDao(CodendiDataAccess::instance());
@@ -121,7 +121,7 @@ 
      * @param Docman_ApprovalTable $table      Approval table
      * @param Integer              $reviewerId Id of the reviewer
      *
-     * @return Boolean
+     * @return null|boolean
      */
     private function notifyIndividual(Docman_ApprovalTable $table, $reviewerId) {
         $hp       = Codendi_HTMLPurifier::instance();
@@ -191,7 +191,6 @@ 
     /**
      * Retrieve url to access a given docman item
      *
-     * @param Docman_Item $table The approval table that its reminder notification will be sent
      *
      * @return String
      */