Enalean / tuleap

plugins/docmanwatermark/include/DocmanWatermark_Controller.class.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
     var $user_can_admin;
     var $docmanPath;
     
+    /**
+     * @param HTTPRequest $request
+     */
     function __construct($plugin, $docmanPath,$pluginPath, $themePath, $request) {
         $this->request        = $request;
         $this->user           = null;

plugins/docmanwatermark/include/DocmanWatermark_HTTPController.class.php

Doc Comments +4 added lines

@@ -25,6 +25,10 @@
 
 class DocmanWatermark_HTTPController extends DocmanWatermark_Controller {
 
+    /**
+     * @param DocmanWatermarkPlugin $plugin
+     * @param string $pluginPath
+     */
     public function __construct($plugin, $docmanPath,$pluginPath, $themePath) {
         parent::__construct($plugin, $docmanPath,$pluginPath, $themePath, HTTPRequest::instance());
     }

plugins/docmanwatermark/include/DocmanWatermark_ItemDao.class.php

Doc Comments +9 added lines

@@ -41,6 +41,9 @@ 
         return false;
     }
     
+    /**
+     * @param integer $itemId
+     */
     public function searchItemNotWatermarked($itemId) {
         $sql = 'SELECT NULL FROM plugin_docmanwatermark_item_excluded WHERE item_id = '.$this->da->quoteSmart($itemId);
         $dar = $this->retrieve($sql);
@@ -50,6 +53,9 @@ 
         return false;
     }
     
+    /**
+     * @param integer $itemId
+     */
     public function enableWatermarking($itemId) {
         $sql = 'DELETE FROM plugin_docmanwatermark_item_excluded WHERE item_id = '.$this->da->quoteSmart($itemId);
         if ($this->update($sql)) {
@@ -58,6 +64,9 @@ 
         return false;
     }
     
+    /**
+     * @param integer $itemId
+     */
     public function disableWatermarking($itemId) {
         $sql = 'INSERT INTO plugin_docmanwatermark_item_excluded (item_id) VALUES ('.$this->da->quoteSmart($itemId).')';
         if ($this->update($sql)) {

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';