Enalean / tuleap

plugins/docmanwatermark/include/DocmanWatermarkPluginInfo.class.php

Doc Comments +8 added lines

@@ -27,6 +27,9 @@ 
 
 class DocmanWatermarkPluginInfo extends PluginInfo {
     
+    /**
+     * @param DocmanWatermarkPlugin $plugin
+     */
     function __construct($plugin) {
         $this->PluginInfo($plugin);
         $this->setPluginDescriptor(new DocmanWatermarkPluginDescriptor());
@@ -84,6 +87,11 @@ 
         }
     }
     
+    /**
+     * @param string $name
+     *
+     * @return string
+     */
     function getPropertyValueForName($name) {
         $desc = $this->getPropertyDescriptorForName($name);
         return $desc ? $desc->getValue() : $desc;

plugins/forumml/include/ForumML_FileStorage.class.php

Doc Comments +7 added lines, -1 removed lines

@@ -49,8 +49,10 @@ 
      * @param list: mailing-list name
      * @param date: date of attachment in YYYY_MM_DD format
      * @param encod: encoding of attachment
+     * @param string $filename
+     * @param string $date
      * 
-     * @return int size of attached file
+     * @return string|false size of attached file
      */
     function store($filename, $content, $list, $date, $encod="") {
         $path = $this->_getPath($filename, $list, $date, "store");
@@ -91,6 +93,7 @@ 
      * @param list: mailing-list name
      * @param date: attachment date (YYYY_MM_DD)
      * @param string type: upload/store 
+     * @param string $type
      * 
      * @return string path
      */
@@ -135,6 +138,9 @@ 
         return $path.$name.$ext;
     }
 
+    /**
+     * @param string $path
+     */
     function fileExists($path) {
         return is_file($path);
     }

plugins/forumml/include/ForumML_HTMLPurifier.class.php

Doc Comments +2 added lines

@@ -67,6 +67,8 @@
 	
     /**
      * HTML Purifier configuration factory
+     * @param integer $level
+     * @return integer
      */
     function getHPConfig($level) {
         $config = null;

plugins/forumml/include/ForumMLInsert.class.php

Doc Comments +9 added lines

@@ -49,6 +49,12 @@ 
     }
 
     // Insert values into forumml_attachment table 
+
+    /**
+     * @param integer $id_message
+     * @param string $filename
+     * @param string|false $filepath
+     */
     function insertAttachment($id_message, $filename,$filetype,$filepath,$content_id="") {
         if (is_file($filepath)) {
             $filesize = filesize($filepath);
@@ -104,6 +110,9 @@ 
         return false;
     }
 
+    /**
+     * @param integer $date
+     */
     function updateParentDate($messageId, $date) {
         if ($messageId != 0) {
             $sql = 'SELECT id_parent, last_thread_update FROM plugin_forumml_message WHERE id_message = '.$messageId;

plugins/forumml/include/ForumMLPluginInfo.class.php

Doc Comments +6 added lines

@@ -24,6 +24,9 @@ 
 
 class ForumMLPluginInfo extends PluginInfo {
     
+    /**
+     * @param ForumMLPlugin $plugin
+     */
     function __construct($plugin) {
         parent::__construct($plugin);
         $this->setPluginDescriptor(new ForumMLPluginDescriptor());
@@ -82,6 +85,9 @@ 
         }	
 	}
     
+	/**
+	 * @param string $name
+	 */
 	function getPropertyValueForName($name) {
         $desc = $this->getPropertyDescriptorForName($name);
         return $desc ? $desc->getValue() : $desc;

plugins/forumml/tests/ForumML_FileStorageTest.php

Doc Comments +6 added lines

@@ -38,6 +38,9 @@ 
         $this->_namePattern = "`[^a-z0-9_-]`i";
     }
 
+    /**
+     * @param string $path
+     */
     private function _deleteIfExists($path) {
         if (is_dir($path)) {
             rmdir($path);
@@ -46,6 +49,9 @@ 
         }
     }
 
+    /**
+     * @param string $path
+     */
     private function _getFileStorage($path) {
         $fs = new ForumML_FileStorageTestVersion($this);
         $fs->root = $path;

plugins/forumml/www/forumml_utils.php

Doc Comments +3 added lines

@@ -661,6 +661,9 @@
     echo '</div>';
 }
 
+/**
+ * @param string $link
+ */
 function getAnonymousForumMLReplyURL($link) {
         return '/account/login.php?return_to='.urlencode($link);
 }

plugins/fulltextsearch/include/ElasticSearch/RequestDocmanDataFactory.class.php

Doc Comments -1 removed lines

@@ -180,7 +180,6 @@
      * Builds the indexed data for first indexation
      *
      * @param Docman_Item    $item
-     * @param Docman_Version $version
      *
      * @return array
      */

plugins/fulltextsearch/include/ElasticSearch/SearchClientFacade.class.php

Doc Comments +4 added lines

@@ -77,6 +77,7 @@ 
     }
 
     /**
+     * @param string $terms
      * @return array to be used for querying ES
      */
     protected function getSearchInFieldsQuery($terms, $fields, $offset) {
@@ -161,6 +162,9 @@ 
         return $query;
     }
 
+    /**
+     * @param string[] $returned_fields
+     */
     private function addFieldsForDocman(&$returned_fields) {
         $returned_fields[] = 'title';
     }