Enalean / tuleap

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

plugins/docman/include/Docman_Filter.class.php

Doc Comments +3 added lines

@@ -460,6 +460,9 @@
 class Docman_FilterGlobalText extends Docman_FilterText {
     var $dynTextFields;
 
+    /**
+     * @param Docman_Metadata $md
+     */
     function Docman_FilterGlobalText($md, $dynTextFields) {
         parent::Docman_FilterText($md);
         $this->dynTextFields = $dynTextFields;

plugins/docman/include/Docman_FilterFactory.class.php

Doc Comments +3 added lines

@@ -220,6 +220,9 @@
         return $filter;
     }
     
+    /**
+     * @param Docman_ListMetadata $md
+     */
     function createItemTypeFilter($md, $advSearch) {
         if ($advSearch) {
             $f = new Docman_FilterItemTypeAdvanced($md);

plugins/docman/include/Docman_FolderFactory.class.php

Doc Comments +1 added lines

@@ -36,6 +36,7 @@
      * existing function that handle prefences in this way.
      *
      * @param Folder
+     * @param Docman_Folder $folder
      */
     function collapse($folder) {
         user_del_preference(PLUGIN_DOCMAN_EXPAND_FOLDER_PREF.'_'.$folder->getGroupId().'_'.$folder->getId());

plugins/docman/include/Docman_HtmlFilter.class.php

Doc Comments +3 added lines

@@ -78,6 +78,9 @@
         return $html;
     }
 
+    /**
+     * @param string $formName
+     */
     function toHtml($formName, $trashLinkBase) {
         $trashLink = '';
         if($trashLinkBase) {

plugins/docman/include/Docman_Icons.class.php

Doc Comments +14 added lines

@@ -25,10 +25,17 @@ 
  */
 class Docman_Icons {
     var $images_path;
+
+    /**
+     * @param string $images_path
+     */
     function Docman_Icons($images_path) {
         $this->images_path = $images_path;
     }
     
+    /**
+     * @param string $action
+     */
     function getActionIcon($action) {
         switch ($action) {
             case 'popup': 
@@ -186,10 +193,17 @@ 
     function getSpinner() {
         return $this->images_path . 'spinner.gif';
     }
+
+    /**
+     * @param string $icon
+     */
     function getIcon($icon) {
         return $this->images_path . $icon;
     }
 
+    /**
+     * @param string $icon
+     */
     function getThemeIcon($icon) {
         return util_get_image_theme('ic/'.$icon);
     }