Enalean / tuleap

plugins/hudson/include/HudsonJob.class.php

Doc Comments +8 added lines, -1 removed lines

@@ -84,6 +84,9 @@ 
          $this->dom_job = $this->_getXMLObject($this->hudson_job_url);
     }
     
+    /**
+     * @param string $hudson_job_url
+     */
     protected function _getXMLObject($hudson_job_url) {
         $xmlstr = @file_get_contents($hudson_job_url, false, $this->context);
         if ($xmlstr !== false) {
@@ -124,6 +127,10 @@ 
     function getUrl() {
         return $this->getDomJob()->url;
     }
+
+    /**
+     * @return string
+     */
     function getColor() {
         return $this->getDomJob()->color;
     }
@@ -301,7 +308,7 @@ 
      * @exception if unable to open build URL or if response is an error
      *  
      * @param string $token if CI server has activated security (login/password), then a token is mandatory to build jobs. This token is defined in the job configuration.
-     * @return response of build call.
+     * @return string of build call.
      */
     function launchBuild($token = null) {
         $url = $this->hudson_dobuild_url;

plugins/hudson/include/HudsonJobFactory.class.php

Doc Comments +6 added lines

@@ -46,6 +46,9 @@ 
         return $this->jobs[$owner_type][$owner_id];
     }
 
+    /**
+     * @param integer $group_id
+     */
     public function getJobsByGroup($group_id) {
         $dar = $this->getDao()->searchByGroupID($group_id);
         $jobs = array();
@@ -60,6 +63,9 @@ 
         return $jobs;
     }
 
+    /**
+     * @param integer $user_id
+     */
     public function getJobsByUser($user_id) {
         $dar = $this->getDao()->searchByUserID($user_id);
         $jobs = array();

plugins/hudson/include/hudsonPluginInfo.class.php

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
 
 class hudsonPluginInfo extends PluginInfo {
     
+    /**
+     * @param hudsonPlugin $plugin
+     */
     function hudsonPluginInfo(&$plugin) {
         $this->PluginInfo($plugin);
         $this->setPluginDescriptor(new hudsonPluginDescriptor());

plugins/hudson/include/HudsonTestResult.class.php

Doc Comments +3 added lines

@@ -56,6 +56,9 @@
         $this->dom_job = $this->_getXMLObject($this->hudson_test_result_url);
     }
     
+    /**
+     * @param string $hudson_test_result_url
+     */
     protected function _getXMLObject($hudson_test_result_url) {
         $xmlstr = @file_get_contents($hudson_test_result_url, false, $this->context);
         if ($xmlstr !== false) {

plugins/hudson/include/hudsonViews.class.php

Doc Comments +5 added lines

@@ -387,6 +387,11 @@
         echo "<script>Element.toggle('hudson_add_job', 'slide');</script>";
     }
 
+    /**
+     * @param Project $project
+     * @param string $add_or_edit
+     * @param string $action
+     */
     private function displayForm(
         $project,
         $services,

plugins/hudson/include/HudsonWidget.class.php

Doc Comments +3 added lines

@@ -29,6 +29,9 @@
      */
     protected $hudsonJobFactory;
     
+    /**
+     * @param string $widget_id
+     */
     public function __construct($widget_id, HudsonJobFactory $factory) {
         parent::__construct($widget_id);
         $this->hudsonJobFactory = $factory;

plugins/IM/include/IM_Widget_MyRoster.class.php

Doc Comments +4 added lines

@@ -13,6 +13,10 @@
 class IM_Widget_MyRoster extends Widget {
     var $plugin;
     var $request;
+
+    /**
+     * @param IMPlugin $plugin
+     */
     function IM_Widget_MyRoster($plugin) {
         $this->Widget('plugin_im_myroster');
         $this->plugin = $plugin;

plugins/IM/include/IMDao.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -14,7 +14,7 @@ 
     
     /**
     * Constructs the IMDao
-    * @param $da instance of the DataAccess class
+    * @param IMDataAccess $da instance of the DataAccess class
     */
     function __construct($da) {
         parent::__construct($da);
@@ -133,6 +133,7 @@ 
 	
 	/**
 	 * to set muc members
+	 * @param string $jid
 	 */
 	 function add_muc_room_user($roomID,$jid/*,$nickname='',$firstName='',$lastName='',$url='',$faqentry=''*/) {
 		$forma="INSERT INTO ".$this->openfire_db_name.".ofMucMember(roomID,jid)
@@ -151,6 +152,8 @@ 
 	
 	/**
 	 * muc room affiliation
+	 * @param string $jid
+	 * @param integer $affiliation
 	 */
 	 function muc_room_affiliation($roomID,$jid,$affiliation) {
 		$forma="INSERT INTO ".$this->openfire_db_name.".ofMucAffiliation(roomID,jid,affiliation)

plugins/IM/include/IMPlugin.class.php

Doc Comments +11 added lines, -6 removed lines

@@ -19,6 +19,9 @@ 
     var $last_im_datas=array();
     var $last_im_datas_remove=array();
 
+    /**
+     * @param integer $id
+     */
     function __construct($id,$debug=IM_DEBUG_OFF) {
         parent::__construct($id);
 
@@ -157,6 +160,10 @@ 
     }
 
     protected $dynamicpresence_alreadydisplayed;
+
+    /**
+     * @param string $jid
+     */
     function getDynamicPresence($jid) {
         $id = md5($jid);
         $html = '<img class="jid_'. $id .'"src="'. $this->getThemePath() .'/images/icons/blank.png" width="16" height="16" alt="" style="vertical-align:top" />';
@@ -190,6 +197,9 @@ 
         return $html;
     }
     
+    /**
+     * @param string $jid
+     */
     function getPresence($jid) {
         if (!isset($this->_cache_presence[$jid])) {
            if($this->_get_im_object()){
@@ -279,7 +289,7 @@ 
 	 * This function is called when the event "project_is_deleted" is called
      * Action: lock the muc room
      *
-	 * @param array $param : contains the group_id ($params['group_id'])
+	 * @param array $params : contains the group_id ($params['group_id'])
 	 * 
 	 * Before, we deleted the MUC room, but now, we only lock it,
 	 * because we want to be able to go back to Active status (that will unlock the MUC Room).
@@ -503,7 +513,6 @@ 
 	}
 	/**
 	 * to remove a member on a muc
-	 * @param array $params:contains the data which comes from the envent listened.
 	 */
 	public function im_muc_remove_member($params){
 		//group infos
@@ -530,7 +539,6 @@ 
 	
 	/**
 	 * for hook administration :display an URL to access IM administration.
-	 * @param array $params:contains the data which comes from the envent listened.
 	 */
  	function siteAdminHooks($params) {
        global $Language;
@@ -584,7 +592,6 @@ 
 	}
 	/**
 	 * to display an user's jabber identification JID in web interface personnal page
-	 * @param array $eParams:contains the data which comes from the envent listened.
 	 */
  	function im_process_display_user_jabber_id ($eParams) {
 		$this->im_process_display_jabber_id ($eParams);
@@ -592,7 +599,6 @@ 
 	
 	/**
 	 * to display an user's jabber identification JID in web interface developper profil
-	 * @param array $eParams:contains the data which comes from the envent listened.
 	 */
 	function im_process_display_user_jabber_id_in_account (array $params) {
             $im_object  = $this->_get_im_object();
@@ -680,7 +686,6 @@ 
         
 	/**
  	 * display project members presence 
- 	 * @param array $params:contains the data which comes from the envent listened.
  	 */
 	function im_process_display_presence ($params) {
         $user = $this->getUserManager()->getCurrentUser();