Enalean / tuleap

plugins/docman/include/Docman_TokenDao.class.php

Doc Comments +5 added lines, -1 removed lines

@@ -28,6 +28,7 @@ 
 
     /**
     * Searches Docman_Token by Url 
+    * @param integer $user_id
     * @return DataAccessResult
     */
     function searchUrl($user_id, $token) {
@@ -39,7 +40,9 @@ 
     
     /**
     * create a row in the table plugin_docman_tokens 
-    * @return true or id(auto_increment) if there is no error
+    * @param integer $user_id
+    * @param string $token
+    * @return boolean or id(auto_increment) if there is no error
     */
     function create($user_id, $token, $url) {
 		$sql = sprintf("INSERT INTO plugin_docman_tokens (user_id, token, url, created_at) VALUES (%s, %s, %s, NOW())",
@@ -53,6 +56,7 @@ 
     
     /**
     * delete a row in the table plugin_docman_tokens
+    * @param integer $user_id
     */
     function delete($user_id, $token) {
         $sql = sprintf("DELETE FROM plugin_docman_tokens WHERE (TO_DAYS(NOW()) - TO_DAYS(created_at)) > 1 OR (user_id = %s AND token = %s)",

plugins/docman/include/Docman_VersionDao.class.php

Doc Comments +4 added lines

@@ -212,6 +212,10 @@
             return false;
         }
     }
+
+    /**
+     * @param string $sql
+     */
     function _createAndReturnId($sql) {
         $inserted = $this->update($sql);
         if ($inserted) {

plugins/docman/include/Docman_Widget_MyDocman.class.php

Doc Comments +4 added lines

@@ -23,6 +23,10 @@
 */
 class Docman_Widget_MyDocman extends Widget {
     var $pluginPath;
+
+    /**
+     * @param string $pluginPath
+     */
     function Docman_Widget_MyDocman($pluginPath) {
         $this->Widget('plugin_docman_mydocman');
         $this->pluginPath = $pluginPath;

plugins/docman/include/Docman_Widget_MyDocmanSearch.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -25,6 +25,9 @@ 
     
     var $pluginPath;
 
+    /**
+     * @param string $pluginPath
+     */
     function __construct($pluginPath) {
         parent::__construct('plugin_docman_mydocman_search');
         $this->_pluginPath = $pluginPath;
@@ -94,7 +97,7 @@ 
      * else 0
      * 
      * @param $docman_id int  Document Id
-     * @param $user      User User Id
+     * @param PFUser $user      User User Id
      * @return group_id 
      **/
     function returnAllowedGroupId($docman_id, $user){

plugins/docman/include/Docman_Widget_ProjectEmbedded.class.php

Doc Comments +3 added lines

@@ -24,6 +24,9 @@
 require_once('Docman_Widget_Embedded.class.php');
 class Docman_Widget_ProjectEmbedded extends Docman_Widget_Embedded {
     
+    /**
+     * @param string $plugin_path
+     */
     public function __construct($plugin_path) {
         parent::__construct('plugin_docman_project_embedded', 
                             HTTPRequest::instance()->get('group_id'), 

plugins/docman/include/Docman_Wiki.class.php

Doc Comments +3 added lines

@@ -49,6 +49,9 @@
         return $row;
     }
 
+    /**
+     * @param Docman_Widget_Embedded $visitor
+     */
     function accept(&$visitor, $params = array()) {
         return $visitor->visitWiki($this, $params);
     }

plugins/docman/include/Docman_WikiController.class.php

Doc Comments +6 added lines

@@ -356,6 +356,9 @@ 
         }

     }

 

+    /**
+     * @param string $referrer_id
+     */
     function showReferrerPath($referrer_id, $group_id) {

         $parents = array();

         $html = HTML();

@@ -390,6 +393,9 @@ 
         return $html;

     }

 

+    /**
+     * @param string $referrer_id
+     */
     function getDocumentPath($id, $group_id, $referrer_id = null) {

         $parents = array();

         $html = HTML();

plugins/docman/include/docmanPlugin.class.php

Doc Comments +15 added lines

@@ -603,6 +603,9 @@ 
         $params['html'][]= $html;
     }
 
+    /**
+     * @param integer $limit
+     */
     function showPendingVersions($versions, $groupId, $nbVersions, $offset, $limit) {
         $hp = Codendi_HTMLPurifier::instance();
 
@@ -656,6 +659,9 @@ 
         return $html;
     }
 
+    /**
+     * @param integer $limit
+     */
     function showPendingItems($res, $groupId, $nbItems, $offset, $limit) {
         $hp = Codendi_HTMLPurifier::instance();
         require_once('Docman_ItemFactory.class.php');
@@ -831,6 +837,9 @@ 
         );
     }
 
+    /**
+     * @param Docman_WikiRequest $request
+     */
     protected function getWikiController($request) {
         return $this->getController('Docman_WikiController', $request);
     }
@@ -842,6 +851,9 @@ 
         return $this->getController('Docman_HTTPController', $request);
     }
     
+    /**
+     * @param Codendi_Request $request
+     */
     protected function getCoreController($request) {
         return $this->getController('Docman_CoreController', $request);
     }
@@ -850,6 +862,9 @@ 
         return $this->getController('Docman_SOAPController', $request);
     }
 
+    /**
+     * @param string $controller
+     */
     protected function getController($controller, $request) {
         if (!isset($this->controller[$controller])) {
             include_once $controller.'.class.php';

plugins/docman/include/DocmanPluginInfo.class.php

Doc Comments +8 added lines

@@ -25,6 +25,9 @@ 
 
 class DocmanPluginInfo extends PluginInfo {
     
+    /**
+     * @param DocmanPlugin $plugin
+     */
     function DocmanPluginInfo(&$plugin) {
         $this->PluginInfo($plugin);
         $this->setPluginDescriptor(new DocmanPluginDescriptor($plugin));
@@ -82,6 +85,11 @@ 
         }
     }
     
+    /**
+     * @param string $name
+     *
+     * @return string
+     */
     function getPropertyValueForName($name) {
         $desc = $this->getPropertyDescriptorForName($name);
         return $desc ? $desc->getValue() : $desc;