Enalean / tuleap

plugins/docmanwatermark/include/DocmanWatermark_ItemFactory.class.php

Doc Comments +1 added lines

@@ -96,6 +96,7 @@
      * Current code is not really clean, but as there is no clean interface
      * for ugroups & permission manangement...
      * 
+     * @param Docman_Item $item
      * @return Array
      */
     public function getPeopleToNotifyWhenWatermarkingIsDisabled($item) {

plugins/docmanwatermark/include/DocmanWatermark_LogDao.class.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
         return $this->retrieve($sql);
     }
     
+    /**
+     * @param integer $watermarked
+     */
     function logEvent($itemId, $userId, $watermarked) {
         $sql = 'INSERT INTO plugin_docmanwatermark_item_excluded_log'.
                '(item_id, time, who, watermarked) VALUES '.

plugins/docmanwatermark/include/DocmanWatermark_MetadataFactory.class.php

Doc Comments +3 added lines

@@ -44,6 +44,9 @@
         return $this->dao;
     }
     
+    /**
+     * @param DocmanWatermark_Metadata $wmd
+     */
     public function setField($wmd) {
         // remove the old field related watermarking values if any
         $dwmvf = new DocmanWatermark_MetadataValueFactory();

plugins/docmanwatermark/include/DocmanWatermark_MetadataImportFactory.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -107,6 +107,7 @@ 
     /**
      * Private Method to copy the watermarkmetadata setup from the src project to target project
      * @param  int md_id: the metadata id to insert in the table plugin_docman_watermark_md_extension
+     * @param integer $md_id
      * @return void
      */    
     private function copyWatermarkMetadata($md_id){
@@ -120,7 +121,6 @@ 
 
     /**
      * Private Method to copy the metadata values setup from the src project to target project
-     * @param  ArrayIterator(int) $dwmvs : iterator of metadata values  to insert in the table plugin_docman_watermark_love_md_extension
      * @return void
      */     
     

plugins/docmanwatermark/include/DocmanWatermark_Stamper.class.php

Doc Comments +1 added lines

@@ -239,6 +239,7 @@
     *
     * @param float $percentage. watermarking percentage.
     * @param int $pageCount Total number of pages in the pdf document.
+    * @param double $percentage
     *
     * @return array $pagesToWatermark page numbers
     */

plugins/docmanwatermark/include/docmanwatermarkPlugin.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -193,7 +193,7 @@
     /**
      * Wrapper for DocmanWatermark_MetadataFactory object
      * 
-     * @return DocmanWatermark_MetadataFactory
+     * @return DocmanWatermark_ItemFactory
      */
     function getDocmanWatermark_ItemFactory() {
         include_once 'DocmanWatermark_ItemFactory.class.php';

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;