EGroupware / egroupware

mail/inc/class.mail_ui.inc.php

Doc Comments +12 added lines, -9 removed lines

@@ -1541,7 +1541,7 @@ 
 	 * function splitRowID - split the rowID into its parts
 	 *
 	 * @param string $_rowID string - a colon separated string in the form accountID:profileID:folder:message_uid
-	 * @return array populated named result array (accountID,profileID,folder,msgUID)
+	 * @return string populated named result array (accountID,profileID,folder,msgUID)
 	 */
 	static function splitRowID($_rowID)
 	{
@@ -1623,9 +1623,9 @@ 
 	 * function header2gridelements - to populate the grid elements with the collected Data
 	 *
 	 * @param array $_headers headerdata to process
-	 * @param array $cols cols to populate
+	 * @param string[] $cols cols to populate
 	 * @param array $_folderName to ensure the uniqueness of the uid over all folders
-	 * @param array $_folderType used to determine if we need to populate from/to
+	 * @param integer $_folderType used to determine if we need to populate from/to
 	 * @return array populated result array
 	 */
 	public function header2gridelements($_headers, $cols, $_folderName, $_folderType=0)
@@ -2863,6 +2863,9 @@ 
 		return $GLOBALS['egw']->framework->header();
 	}
 
+	/**
+	 * @param string $body
+	 */
 	function showBody(&$body, $print=true,$fullPageTags=true)
 	{
 		$BeginBody = '<div class="mailDisplayBody">
@@ -3099,9 +3102,9 @@ 
 	 * Replace CID with proper type of content understandable by browser
 	 *
 	 * @param type $_body content of message
-	 * @param type $_mailbox mail box
-	 * @param type $_uid uid
-	 * @param type $_partID part id
+	 * @param string $_mailbox mail box
+	 * @param string $_uid uid
+	 * @param string $_partID part id
 	 * @param type $_type = 'src' type of inline image that needs to be resolved and replaced
 	 *	- types: {plain|src|url|background}
 	 * @return string returns body content including all CID replacements
@@ -3283,7 +3286,7 @@ 
 	 * @param string $_folder (passed by reference) will set the folder used. must be set with a folder, but will hold modifications if
 	 *					folder is modified
 	 * @param string $importID ID for the imported message, used by attachments to identify them unambiguously
-	 * @return mixed $messageUID or exception
+	 * @return string $messageUID or exception
 	 */
 	function importMessageToFolder($_formData,&$_folder,$importID='')
 	{
@@ -3444,7 +3447,7 @@ 
 	 *
 	 * @param string _messageID UID
 	 *
-	 * @return xajax response
+	 * @return string|null response
 	 */
 	function loadEmailBody($_messageID=null,$_partID=null,$_htmloptions=null)
 	{
@@ -3995,7 +3998,7 @@ 
 	 * ajax_deleteFolder - its called via json, so the function must start with ajax (or the class-name must contain ajax)
 	 * @param string $_folderName folder to delete
 	 * @param boolean $_return = false wheter return the success value (true) or send response to client (false)
-	 * @return nothing
+	 * @return null|boolean
 	 */
 	function ajax_deleteFolder($_folderName, $_return = false)
 	{

notifications/inc/class.notifications_email.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -131,7 +131,7 @@
 	 * @param array $_links
 	 * @param boolean $_render_html
 	 * @param boolean $_render_external
-	 * @return plain or html rendered link(s) as complete string
+	 * @return false|string or html rendered link(s) as complete string
 	 */
 	private function render_links($_links = false, $_render_html = false, $_render_external = true) {
 		if(!is_array($_links) || count($_links) == 0) { return false; }

notifications/inc/class.notifications_winpopup.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -155,7 +155,7 @@ 
 	 * checks for a valid IPv4-address without CIDR notation
 	 *
 	 * @param string $_ip
-	 * @return true or false
+	 * @return integer or false
 	 */
 	private function valid_ip($_ip) {
 		return eregi('^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$',$_ip);
@@ -165,7 +165,7 @@ 
 	 * renders additional info from subject
 	 *
 	 * @param string $_subject
-	 * @return plain rendered info as complete string
+	 * @return string|false rendered info as complete string
 	 */
 	private function render_infos($_subject = false) {
 		$newline = "\n";

redirect.php

Doc Comments +4 added lines

@@ -24,6 +24,10 @@
 
 	if(!function_exists('html_entity_decode'))
 	{
+
+		/**
+		 * @param integer $quote_style
+		 */
 		function html_entity_decode($given_html, $quote_style = ENT_QUOTES)
 		{
 			$trans_table = array_flip(get_html_translation_table( HTML_SPECIALCHARS, $quote_style));

resources/inc/class.resources_export_csv.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
 	/**
 	 * Exports records as defined in $_definition
 	 *
-	 * @param egw_record $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function export( $_stream, importexport_definition $_definition) {
 		$options = $_definition->plugin_options;

resources/inc/class.resources_import_csv.inc.php

Doc Comments +2 added lines, -4 removed lines

@@ -28,9 +28,7 @@ 
 
 	/**
 	 * imports entries according to given definition object.
-	 * @param resource $_stream
-	 * @param string $_charset
-	 * @param definition $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function init(importexport_definition $_definition ) {
 
@@ -52,7 +50,7 @@ 
 	*
 	* Updates the count of actions taken
 	*
-	* @return boolean success
+	* @return null|boolean success
 	*/
 	protected function import_record(importexport_iface_egw_record &$record, &$import_csv)
 	{

resources/inc/class.resources_so.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 	 *
 	 * @param string $key key of value to get
 	 * @param int $res_id resource id
-	 * @return mixed value of key and resource, false if key or id not found.
+	 * @return integer value of key and resource, false if key or id not found.
 	 */
 	function get_value($key,$res_id)
 	{

setup/inc/class.setup_cmd_ldap.inc.php

Doc Comments -3 removed lines

@@ -936,9 +936,6 @@
 	 *
 	 * Uses $this->ldap_host, $this->ldap_admin and $this->ldap_admin_pw to connect.
 	 *
-	 * @param string $this->object_class ='qmailUser'
-	 * @param string $this->mbox_attr ='mailmessagestore' lowercase!!!
-	 * @param string $this->mail_login_type ='email' 'email', 'vmailmgr', 'standard' or 'uidNumber'
 	 * @return string with success message N entries modified
 	 * @throws Api\Exception if dn not found, not listable or delete fails
 	 */

setup/inc/class.setup_detection.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
 	/**
 	 * Check if header exists and is up to date
 	 *
-	 * @return int 1=no header.inc.php, 2=no header admin pw, 3=no instances, 4=need upgrade, 10=ok
+	 * @return string 1=no header.inc.php, 2=no header admin pw, 3=no instances, 4=need upgrade, 10=ok
 	 */
 	function check_header()
 	{