Enalean / tuleap

plugins/docman/include/Docman_MetadataComparator.class.php

Doc Comments +6 added lines

@@ -27,6 +27,10 @@ 
     var $srcGo;
     var $dstGo;
 
+    /**
+     * @param integer $srcGroupId
+     * @param integer $dstGroupId
+     */
     function Docman_MetadataComparator($srcGroupId, $dstGroupId, $themePath) {
         $this->docmanIcons = new Docman_Icons($themePath.'/images/ic/');
         $pm = ProjectManager::instance();
@@ -37,6 +41,8 @@ 
     /**
      * For a five object iterator, return an array of object indexed by
      * $func applied on object.
+     * @param ArrayIterator $iter
+     * @param string $func
      */
     function getArrayFromIterator($iter, $func) {
         $a = array();

plugins/docman/include/Docman_MetadataDao.class.php

Doc Comments +6 added lines

@@ -42,6 +42,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param boolean $onlyUsed
+     */
     function searchByGroupId($id, $onlyUsed, $type = array()) {
         $where_clause = '';
         if($onlyUsed) {
@@ -143,6 +146,9 @@ 
 
     }
 
+    /**
+     * @param string $sql
+     */
     function _createAndReturnId($sql) {
         $inserted = $this->update($sql);
         if ($inserted) {

plugins/docman/include/Docman_MetadataFactory.class.php

Doc Comments +5 added lines

@@ -98,6 +98,7 @@ 
 
     /**
      * Create a Metadata object based on DB a entry.
+     * @param string $id
      */
     function &getRealMetadata($id) {
         $md = null;
@@ -147,6 +148,7 @@ 
      * Fetch and append HardCoded metadata variable parameters.
      *
      * Some HardCoded are customizable at project level.
+     * @param Docman_Metadata|null $md
      */
     function appendHardCodedMetadataParams(&$md) {
         $sBo =& Docman_SettingsBo::instance($this->groupId);
@@ -452,6 +454,9 @@ 
         return false;
     }
 
+    /**
+     * @param Docman_Metadata $md
+     */
     function create(&$md) {
         $md->setGroupId($this->groupId);
 

plugins/docman/include/Docman_MetadataHtml.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -56,6 +56,9 @@ 
         return $mdh;
     }
 
+    /**
+     * @param boolean $whitelist
+     */
     function buildFieldArray($mdIter, $mdla, $whitelist, $formName, $themePath) {
         $fields = array();
         $formParams = array('form_name' => $formName,
@@ -212,7 +215,7 @@ 
     /**
      * Return field input validator.
      *
-     * @return string
+     * @return Docman_ValidateMetadataIsNotEmpty|null
      */
     function &getValidator() {
         $validator = null;

plugins/docman/include/Docman_MetadataListOfValuesElementDao.class.php

Doc Comments +6 added lines

@@ -51,6 +51,9 @@ 
         return $this->retrieve($sql);
     }
 
+    /**
+     * @param boolean $onlyActive
+     */
     function searchByName($metadataId, $name, $onlyActive) {
         $where_clause = '';
         if($onlyActive === true) {
@@ -184,6 +187,9 @@ 
         }
     }
 
+    /**
+     * @param string $sql
+     */
     function _createAndReturnId($sql) {
         $inserted = $this->update($sql);
         if ($inserted) {

plugins/docman/include/Docman_MetadataListOfValuesElementFactory.class.php

Doc Comments +5 added lines

@@ -49,6 +49,7 @@ 
      * Delete the the ListOfValueElement.
      * Then keep metadata_value consistent: if there is no entry for a given
      * (item, $this->metadataId), create a default entry (NONE value).
+     * @param Docman_MetadataListOfValuesElement $love
      */
     function delete(&$love) {
         $dao =& $this->getDao();
@@ -131,6 +132,9 @@ 
         }
     }
 
+    /**
+     * @param boolean $onlyActive
+     */
     function &getIteratorByFieldId($id, $mdLabel, $onlyActive) {
         $loveArray = $this->getListByFieldId($id, $mdLabel, $onlyActive);
         $loveIter  = new ArrayIterator($loveArray);
@@ -296,6 +300,7 @@ 
 
     /**
      * Return static list of status (hardcoded metadata with hardcoded values)
+     * @param integer $status
      */
     function &getStatusList($status=null) {
         $ea = array();

plugins/docman/include/Docman_MetaMetadataHtml.class.php

Doc Comments +3 added lines

@@ -34,6 +34,9 @@
         $this->str_no = $GLOBALS['Language']->getText('plugin_docman', 'admin_md_detail_param_no');
     }
 
+    /**
+     * @param string|false $sthCanChange
+     */
     function getName(&$sthCanChange) {
         $mdContent = '';
         $mdContent .= '<tr>';

plugins/docman/include/Docman_NotificationsManager.class.php

Doc Comments +9 added lines

@@ -51,6 +51,9 @@ 
      */
     private $mail_builder;
 
+    /**
+     * @param string|null $url
+     */
     function __construct(Project $project, $url, $feedback, MailBuilder $mail_builder) {
         parent::__construct();
 
@@ -172,6 +175,9 @@ 
         return $users;
     }
 
+    /**
+     * @param PFUser $user
+     */
     function _buildMessage($event, $params, $user) {
         $type = '';
         switch($event) {
@@ -200,6 +206,9 @@ 
         );
     }
 
+    /**
+     * @param string $msg
+     */
     protected function _addMessage(PFUser $to, $subject, $msg, $link) {
         if (!isset($this->notifications[$msg])) {
             $subject = '['. util_unconvert_htmlspecialchars($this->_group_name) .' - Documents] '. $subject;

plugins/docman/include/Docman_NotificationsManager_Add.class.php

Doc Comments +7 added lines

@@ -47,6 +47,10 @@ 
                 break;
         }
     }
+
+    /**
+     * @param string $message_type
+     */
     function _getMessageForUser(&$user, $message_type, $params) {
         $msg = '';
         switch($message_type) {
@@ -66,6 +70,9 @@ 
         return $msg;
     }
 
+    /**
+     * @param string $type
+     */
     protected function getMessageLink($type, $params) {
         switch($type) {
             case self::MESSAGE_ADDED: