Enalean / tuleap

plugins/docman/include/Docman_Actions.class.php

Doc Comments +9 added lines, -2 removed lines

@@ -76,6 +76,9 @@ 
         return $ret_id;
     }
 
+    /**
+     * @param string $field
+     */
     private function _raiseMetadataChangeEvent(&$user, &$item, $group_id, $old, $new, $field) {
         $logEventParam = array('group_id' => $group_id,
                                'item'     => &$item,
@@ -1173,8 +1176,8 @@ 
     * The force parameter must be set to true if you want to bypass permissions checking (@see permission_add_ugroup).
     * Pretty difficult to know if a user can update the permissions which does not exist for a new item...
     *
-    * @param $group_id integer The id of the project
-    * @param $item_id integer The id of the item
+    * @param integer $group_id integer The id of the project
+    * @param integer $item_id integer The id of the item
     * @param $permission_definition array The definission of the permission (pretty name, relations between perms, internal name, ...)
     * @param $old_permissions array The permissions before
     * @param &$done_permissions array The permissions after
@@ -1862,6 +1865,7 @@ 
 
     /**
      * @access private
+     * @param Docman_ApprovalTableReviewerFactory $atrf
      */
     function _approval_update_add_users($atrf, $usUserList, $sUgroups) {
         $noError = true;
@@ -1929,6 +1933,7 @@ 
 
     /**
      * @access private
+     * @param Docman_ApprovalTableReviewerFactory $atrf
      */
     function _approval_update_del_users($atrf, $selectedUsers) {
         $deletedUsers = 0;
@@ -1947,6 +1952,7 @@ 
 
     /**
      * @access private
+     * @param Docman_ApprovalTableReviewerFactory $atrf
      */
     function _approval_update_notify_users($atrf, $selectedUsers) {
         $notifiedUsers = 0;
@@ -1972,6 +1978,7 @@ 
 
     /**
      * @access private
+     * @param Docman_ApprovalTableReviewerFactory $atrf
      */
     function _approval_update_notif_resend($atrf) {
         $res = $atrf->notifyReviewers();

plugins/docman/include/Docman_ActionsDeleteVisitor.class.php

Doc Comments +3 added lines

@@ -145,6 +145,9 @@
         return $this->visitDocument($item, $params);
     }
 
+    /**
+     * @param Docman_Item $item
+     */
     public function restrictAccess($item, $params = array()) {
         // Check whether there is other references to this wiki page.
         $dao = $this->_getItemDao();

plugins/docman/include/Docman_BuildItemMappingVisitor.class.php

Doc Comments +2 added lines

@@ -164,6 +164,7 @@ 
      * When a child of the source item is not found in the destination item,
      * the search stops, the mapping is (obviously) not done and the source
      * child and its future brothers are discared.
+     * @param Docman_Folder $dstItem
      */
     function compareFolderChildren($srcItem, $dstItem) {
         $nodesToInspect = array();
@@ -210,6 +211,7 @@ 
 
     /**
      * Search if there is an equivalent of $item in $parentId.
+     * @param integer $parentId
      */
     function searchMatchingItem($item, $parentId) {
         $dao =& $this->getItemDao();

plugins/docman/include/Docman_CloneItemsVisitor.class.php

Doc Comments +3 added lines

@@ -228,6 +228,9 @@
         }
     }
     
+    /**
+     * @param string $mdLabel
+     */
     function _metadataEnabled($srcGroupId, $mdLabel) {
         if(!isset($this->_cacheMetadataUsage[$mdLabel])) {
             $srcSettingsBo =& $this->_getSettingsBo($srcGroupId);

plugins/docman/include/Docman_Controller.class.php

Doc Comments +12 added lines

@@ -125,6 +125,7 @@ 
     /**
      * Wrapper to i18n string call for docman.
      * static
+     * @param string $key
      */
     function txt($key, $vars = array()) {
         return $GLOBALS['Language']->getText('plugin_docman', $key, $vars);
@@ -147,6 +148,9 @@ 
         }
     }
 
+    /**
+     * @param integer $srcGroupId
+     */
     function _cloneDocman($srcGroupId, $dstGroupId, $ugroupsMapping) {
         $user = $this->getUser();
 
@@ -1550,6 +1554,9 @@ 
         }
     }
 
+    /**
+     * @param string $name
+     */
     function getProperty($name) {
         $info =& $this->plugin->getPluginInfo();
         return $info->getPropertyValueForName($name);
@@ -1647,6 +1654,7 @@ 
     * Checks that the new property have a non-empty name,
     * and also checks that the same name is not already taken by
     * another property
+    * @param string $name
     */
     private function validateNewMetadata($name) {
         $name = trim($name);
@@ -1671,6 +1679,7 @@ 
     * Checks that the updating property have a non-empty name,
     * and if the name have been changed, also checks that the same
     * name is not already taken by another property
+    * @param string $name
     */
     private function validateUpdateMetadata($name, $label) {
         $name = trim($name);
@@ -1697,6 +1706,9 @@ 
         return $valid;
     }
     
+    /**
+     * @param integer $loveId
+     */
     function validateLove($loveId, $md, &$love) {
         $valid = false;
         

plugins/docman/include/Docman_Empty.class.php

Doc Comments +3 added lines

@@ -28,6 +28,9 @@
         parent::Docman_Document($data);
     }
 
+    /**
+     * @param Docman_Widget_Embedded $visitor
+     */
     function accept(&$visitor, $params = array()) {
         return $visitor->visitEmpty($this, $params);
     }

plugins/docman/include/Docman_Error_PermissionDenied.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -66,6 +66,7 @@ 
      * the url sent to the project admin will be edited to "https://codendi.org/plugins/docman/?group_id=1564&action=details&section=permissions&id=96739"
      *
      * @parameter String $url
+     * @param string $url
      *
      * @return String
      */
@@ -106,7 +107,7 @@ 
      *
      * @param String $url The URL
      *
-     * @return Array
+     * @return Project
      */
     function urlQueryToArray($url) {
         $params = array();
@@ -165,6 +166,7 @@ 
     /**
      * Wrapper for Docman_PermissionManager
      *
+     * @param integer $groupId
      * @return Docman_PermissionsManager
      */
     function _getPermissionManagerInstance($groupId) {
@@ -174,6 +176,7 @@ 
     /**
      * Wrapper for Docman_ItemFactory
      *
+     * @param integer $groupId
      * @return Docman_ItemFactory
      */
     function _getItemFactoryInstance($groupId) {

plugins/docman/include/Docman_File.class.php

Doc Comments +11 added lines

@@ -30,9 +30,17 @@ 
     }
     
     var $currentVersion;
+
+    /**
+     * @param Docman_Version $currentVersion
+     */
     function setCurrentVersion(&$currentVersion) {
         $this->currentVersion =& $currentVersion;
     }
+
+    /**
+     * @return Docman_Version
+     */
     function &getCurrentVersion() {
         return $this->currentVersion;
     }
@@ -42,6 +50,9 @@ 
         return $row;
     }
 
+    /**
+     * @param Docman_Widget_Embedded $visitor
+     */
     function accept(&$visitor, $params = array()) {
         return $visitor->visitFile($this, $params);
     }

plugins/docman/include/Docman_FileStorage.class.php

Doc Comments +4 added lines

@@ -71,6 +71,10 @@
         }
     }
     
+    /**
+     * @param string $dst_name
+     * @param integer $dst_version_number
+     */
     function copy($srcPath, $dst_name, $dst_group_id, $dst_item_id, $dst_version_number) {
         $dstPath = $this->_getPath($dst_name, $dst_group_id, $dst_item_id, $dst_version_number);