Enalean / tuleap

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();

plugins/IM/include/IMPluginInfo.class.php

Doc Comments +3 added lines

@@ -4,6 +4,9 @@
 
 class IMPluginInfo extends PluginInfo {
 
+    /**
+     * @param IMPlugin $plugin
+     */
     function IMPluginInfo(&$plugin) {
         $this->PluginInfo($plugin);
         $this->setPluginDescriptor(new IMPluginDescriptor());

plugins/IM/include/jabbex_api/EventHandler.php

Doc Comments +9 added lines

@@ -17,6 +17,9 @@ 
 	private $kick_muc_members = false; // Set to true when locking a MUC, so users are kicked from the room.
 	/***/
 
+	/**
+	 * @param Jabber $jab
+	 */
 	function __construct(&$jab) {
 		$this->jab = &$jab;
 		$this->first_roster_update = true;
@@ -91,6 +94,12 @@ 
 	/**************************************
 	 ******* MUC Rooms
 	 **************************************/
+
+	/**
+	 * @param string|null $muc_room_full_name
+	 * @param string|null $muc_room_description
+	 * @param string|null $muc_room_owner_username
+	 */
 	function set_muc_room_info($muc_room_short_name, $muc_room_full_name, $muc_room_description, $muc_room_owner_username){
 		$this->muc_room_info = array (
 			"muc_room_short_name" => $muc_room_short_name,

plugins/IM/include/jabbex_api/installation/install.php

Doc Comments +9 added lines

@@ -590,6 +590,10 @@ 
 	/*
 	 * Adds/updates a property's value to the Openfire's DB.
 	 */
+
+	/**
+	 * @param string $property
+	 */
 	function _add_property($property,$value){
 		$this->_db_connect($this->arguments["USER_OF_DB"],$this->arguments["PWD_OF_DB"],$this->arguments["OF_DB_HOST"],$this->arguments["OF_DB_PORT"],$this->arguments["OF_DB_NAME"]);
 		
@@ -619,6 +623,11 @@ 
 	/*
 	 * Adds/updates a muc property's value to the Openfire's DB.
 	 */
+
+	/**
+	 * @param string $property
+	 * @param string $value
+	 */
 	function _add_muc_property($property,$value){
 		$this->_db_connect($this->arguments["USER_OF_DB"],$this->arguments["PWD_OF_DB"],$this->arguments["OF_DB_HOST"],$this->arguments["OF_DB_PORT"],$this->arguments["OF_DB_NAME"]);
 		

plugins/IM/include/jabbex_api/Jabbex.php

Doc Comments +12 added lines

@@ -18,6 +18,10 @@ 
 	/*
 	 * Initialize configuration
 	 */
+
+	/**
+	 * @param boolean $session
+	 */
 	public function __construct($session) {
 		$session = trim($session);
 		if(!isset($session) || !is_string($session) || empty($session)){
@@ -134,6 +138,10 @@ 
 	/*
 	 * Auxiliary function for lock_muc_room and unlock_muc_room.
 	 */
+
+	/**
+	 * @param string $muc_room_short_name
+	 */
 	private function _muc_locker($muc_room_short_name, $lock = true)
 	{
 		if( !$this->check_parameters->NotEmptyString($muc_room_short_name) ){
@@ -429,6 +437,10 @@ 
 	/*
 	 * Revoke membership of a user in a muc room
 	 */
+
+	/**
+	 * @param string $username
+	 */
 	public function muc_remove_member($muc_room_short_name, $username){
 		$muc_room_short_name = strtolower($muc_room_short_name);
 		$username = strtolower($username);

plugins/IM/include/jabbex_api/JabbexInterface.php

Doc Comments +8 added lines

@@ -24,6 +24,10 @@ 
 	 * @param muc_room_description 	  string Short description of the Room. Mapped from project's "Short Description".
 	 * @param muc_room_owner_username string The username of who's creating the room. Mapped from project owner.
 	 */
+
+	/**
+	 * @return boolean
+	 */
 	function create_muc_room($muc_room_short_name, $muc_room_full_name, $muc_room_description, $muc_room_owner_username);
 
 
@@ -80,6 +84,10 @@ 
 	 * @param group_short_name 	  	Index of the group. Mapped from project's "Short Name".
 	 * @param group_full_name 	  	string Displayed on the Members' roster. Mapped from project's "Full Name".
 	 */
+
+	/**
+	 * @return boolean
+	 */
 	function create_shared_group($group_short_name, $group_full_name);
 
 	/*