Enalean / tuleap

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);
 
 	/*

plugins/IM/include/jabbex_api/lib/group_mng/GroupManagerInterface.php

Doc Comments +14 added lines

@@ -5,14 +5,28 @@
 	 * Uses the information of the global variables of the class to
 	 * make a shared group available by setting its parameters.
 	 */
+
+	/**
+	 * @return void
+	 */
 	function create_shared_group();
 	
+	/**
+	 * @return void
+	 */
 	function set_group_short_name($short_name);
+
+	/**
+	 * @return void
+	 */
 	function set_group_full_name($full_name);
 	function get_group_short_name();
 	function get_group_full_name();
 	public function get_log();	
 	
+	/**
+	 * @return void
+	 */
 	function set_jab_connector(&$jab);
 		
 }

plugins/IM/include/jabbex_api/lib/group_mng/Openfire.php

Doc Comments +8 added lines

@@ -44,9 +44,17 @@
 	public function set_group_short_name($short_name){
 		$this->group_short_name = $short_name;
 	}
+
+	/**
+	 * @param string $full_name
+	 */
 	public function set_group_full_name($full_name){
 		$this->group_full_name = $full_name;
 	}
+
+	/**
+	 * @param Jabber $jab
+	 */
 	public function set_jab_connector(&$jab){
 		$this->jab = &$jab;
 	}

plugins/IM/include/jabbex_api/lib/jabberclass-0.9/class_Jabber.php

Doc Comments +48 added lines

@@ -188,6 +188,10 @@ 
 	if (function_exists('mhash')) { // is the Mhash extension installed?
 
 		// implement the sha1() function using mhash
+
+		/**
+		 * @param string $str
+		 */
 		function sha1($str) {
 			return bin2hex(mhash(MHASH_SHA1, $str));
 		}
@@ -360,12 +364,20 @@ 
 	
 
 	// returns a unique ID to be sent with packets
+
+	/**
+	 * @param string $prefix
+	 */
 	function _unique_id($prefix) {
 		$this->_unique_counter++;
 		return $prefix."_" . md5(time() . $this->_remote_ip . $this->_unique_counter);
 	}
 	
 	// public method for creating a log entry
+
+	/**
+	 * @param string $msg
+	 */
 	function log($msg,$level=1) {
 		$this->_log($msg,$level);
 	}
@@ -449,6 +461,10 @@ 
 	//                    specify the correct IP to connect to here
 	//	
 	//
+
+	/**
+	 * @param string $server_host
+	 */
 	function connect($server_host,$server_port=5222,$connect_timeout=null,$alternate_ip=false) {
 		
 		if (is_null($connect_timeout)) $connect_timeout = DEFAULT_CONNECT_TIMEOUT;
@@ -545,11 +561,20 @@ 
 	
 	// sets a user's presence (when simply used to set your availability, it's more convenient
 	// to call this way, as usually only the first 2 fields are necessary)
+
+	/**
+	 * @param string $show
+	 * @param string $status
+	 */
 	function set_presence($show = NULL, $status = NULL, $to = NULL, $priority = NULL) {
 		return $this->send_presence(NULL,$to,$show,$status,$priority);
 	}
 	
 	// sends presence to another contact/entity
+
+	/**
+	 * @param string $type
+	 */
 	function send_presence($type = NULL, $to = NULL, $show = NULL, $status = NULL, $priority = NULL) {
 		$xml = "<presence";
 		$xml .= ($to) ? " to='$to'" : '';
@@ -586,6 +611,9 @@ 
 	   return strtr($string, $trans);
 	}	
 	
+	/**
+	 * @param string $payload
+	 */
 	function message($to, $type = "normal", $id = NULL, $body = NULL, $thread = NULL, $subject = NULL, $payload = NULL, $raw = false) {
 		if ($to && ($body || $subject || $payload)) {
 			if (!$id) $id = $this->_unique_id("msg");
@@ -939,6 +967,11 @@ 
 	
 	// Sets a handler for a particular IQ packet ID (and optionally packet type).
 	// Assumes that $method is the name of a method of $this
+
+	/**
+	 * @param string $method
+	 * @param string $type
+	 */
 	function _set_iq_handler($method,$id,$type=NULL) {
 		if (is_null($type)) $type = "_all";
 		$this->_iq_handlers[$id][$type] = array(&$this,$method);
@@ -1477,6 +1510,10 @@ 
 	}
 	
 	// request software version from a JabberID
+
+	/**
+	 * @param string $jid
+	 */
 	function request_version($jid) {
 		
 		$this->_log('Requesting version information from '.$jid);
@@ -2048,6 +2085,9 @@ 
 		return $transport;
 	}
 		
+	/**
+	 * @param string $domain
+	 */
 	function get_transport($domain) {
 		$transport = @$this->services[$domain]["type"];
 		return $this->standardize_transport($transport);
@@ -2060,6 +2100,11 @@ 
 	// ==== Packet Handling & Connection Methods =============================================
 
 	// generates and transmits an IQ packet
+
+	/**
+	 * @param string $xmlns
+	 * @param string $from
+	 */
 	function _send_iq($to = NULL, $type = 'get', $id = NULL, $xmlns = NULL, $payload = NULL, $from = NULL) {
 		if (!preg_match("/^(get|set|result|error)$/", $type)) {
 			unset($type);
@@ -2166,6 +2211,9 @@ 
 		return array_shift($this->_packet_queue);
 	}
 	
+	/**
+	 * @param string $incoming
+	 */
 	function _split_incoming($incoming) {
 		$temp = preg_split("/<(message|iq|presence|stream)(?=[\:\s\>])/", $incoming, -1, PREG_SPLIT_DELIM_CAPTURE);
 		$array = array();

plugins/IM/include/jabbex_api/lib/jabberclass-0.9/class_SHA1Library.php

Doc Comments +15 added lines

@@ -129,6 +129,10 @@ 
 	 * Perform the appropriate triplet combination function for the current
 	 * iteration
 	 */
+
+	/**
+	 * @param integer $t
+	 */
 	function sha1_ft($t, $b, $c, $d)
 	{
 		if($t < 20) return ($b & $c) | ((~$b) & $d);
@@ -142,6 +146,10 @@ 
 	 * Silly php does not understand the inline-if operator well when nested,
 	 * so that's why it's ()ed now.
 	 */
+
+	/**
+	 * @param integer $t
+	 */
 	function sha1_kt($t)
 	{
 		return ($t < 20) ?  1518500249 : (($t < 40) ?  1859775393 :
@@ -183,6 +191,10 @@ 
 	/*
 	 * Bitwise rotate a 32-bit number to the left.
 	 */
+
+	/**
+	 * @param integer $cnt
+	 */
 	function rol($num, $cnt)
 	{
 		return ($num << $cnt) | $this->zerofill_rightshift($num, (32 - $cnt));
@@ -254,6 +266,9 @@ 
 
 if ( !function_exists('sha1') )
 {
+	/**
+	 * @param string $string
+	 */
 	function sha1( $string, $raw_output = false )
 	{
 		$library = &new SHA1Library();

plugins/IM/include/jabbex_api/lib/jabberclass-0.9/class_XMLParser.php

Doc Comments +3 added lines

@@ -73,6 +73,9 @@
 	// _xml_depth()
 	// (c) Hans Anderson / http://www.hansanderson.com/php/xml/
 
+	/**
+	 * @param integer $i
+	 */
 	function _xml_depth($vals, &$i) {
 		$children = array();