EGroupware / egroupware

jdots/inc/class.jdots_framework.inc.php

Doc Comments +1 added lines, -5 removed lines

@@ -115,6 +115,7 @@ 
 	/**
 	 * Sets the sidebox width accoringly to the app_specific_sidebar_width setting, either
      * in the current application or globaly
+	 * @param integer $val
 	 */
 	private static function set_sidebar_width($app, $val)
 	{
@@ -427,11 +428,6 @@ 
 	/**
 	* Add menu items to the topmenu template class to be displayed
 	*
-	* @param array $app application data
-	* @param mixed $alt_label string with alternative menu item label default value = null
-	* @param string $urlextra string with alternate additional code inside <a>-tag
-	* @access protected
-	* @return void
 	*/
 	function _add_topmenu_item(array $app_data,$alt_label=null)
 	{

login.php

Doc Comments +3 added lines

@@ -122,6 +122,9 @@
 	   exit;
 	}
 
+	/**
+	 * @return string
+	 */
 	function check_logoutcode($code)
 	{
 		switch($code)

mail/inc/class.mail_activesync.inc.php

Doc Comments +3 added lines, -10 removed lines

@@ -309,13 +309,7 @@ 
      * the new message as any other new message in a folder.
      *
      * @param string $rfc822 mail
-     * @param array $smartdata=array() values for keys:
-     * 	'task': 'forward', 'new', 'reply'
-     *  'itemid': id of message if it's an reply or forward
-     *  'folderid': folder
-     *  'replacemime': false = send as is, false = decode and recode for whatever reason ???
-	 *	'saveinsentitems': 1 or absent?
-     * @param boolean|double $protocolversion=false
+     * @param boolean|double $protocolversion
      * @return boolean true on success, false on error
      *
      * @see eg. BackendIMAP::SendMail()
@@ -1762,7 +1756,7 @@ 
 	 * @param string $displayname => new folder name (to be created, or to be renamed to)
 	 * @param string $type folder type, ignored in IMAP
 	 *
-	 * @return array|boolean stat array or false on error
+	 * @return boolean stat array or false on error
 	 */
 	public function ChangeFolder($id, $oldid, $displayname, $type)
 	{
@@ -1777,7 +1771,7 @@ 
 	 * @param string $id of the folder to delete
 	 *
 	 * @return
-	 * @TODO check what is to be returned
+	 boolean @TODO check what is to be returned
 	 */
 	public function DeleteFolder($parentid, $id)
 	{
@@ -1811,7 +1805,6 @@ 
 	 *
 	 * @param int $account mail account id
 	 * @param string $folder
-	 * @param int $id=0
 	 * @return string
 	 * @throws egw_exception_wrong_parameter
 	 */

mail/inc/class.mail_compose.inc.php

Doc Comments +8 added lines, -1 removed lines

@@ -1477,6 +1477,10 @@ 
 	// $_mode can be:
 	// single: for a reply to one address
 	// all: for a reply to all
+
+	/**
+	 * @param emailadmin_imap $_icServer
+	 */
 	function getDraftData($_icServer, $_folder, $_uid, $_partID=NULL)
 	{
 		unset($_icServer);	// not used
@@ -1673,6 +1677,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param emailadmin_imap $_icServer
+	 */
 	function getForwardData($_icServer, $_folder, $_uid, $_partID, $_mode=false)
 	{
 		if ($_mode)
@@ -1932,7 +1939,7 @@ 
 	/**
 	 * Gather the replyData and save it with the session, to be used then
 	 *
-	 * @param $_mode can be:
+	 * @param string $_mode can be:
 	 * 		single: for a reply to one address
 	 * 		all: for a reply to all
 	 * 		forward: inlineforwarding of a message with its attachments

mail/inc/class.mail_tree.inc.php

Doc Comments +7 added lines, -7 removed lines

@@ -50,7 +50,7 @@ 
 	/**
 	 * Mail tree constructor
 	 *
-	 * @param object $mail_ui
+	 * @param mail_ui $mail_ui
 	 */
 	function __construct($mail_ui) {
 		$this->ui = $mail_ui;
@@ -62,7 +62,7 @@ 
 	 * @param string $_profileID icServer profile id
 	 * @param string $_err error message to be shown on tree node
 	 * @param mixed $_path
-	 * @param mixed $_parent
+	 * @param string $_parent
 	 * @return array returns an array of tree node
 	 */
 	static function treeLeafNoConnectionArray($_profileID, $_err, $_path, $_parent)
@@ -94,7 +94,7 @@ 
 	/**
 	 * Get folder data from path
 	 *
-	 * @param string $path a node path
+	 * @param string $_path a node path
 	 * @return array returns an array of data extracted from given node path
 	 */
 	static function pathToFolderData ($_path, $_hDelimiter)
@@ -131,7 +131,7 @@ 
 	/**
 	 * Check if the given tree id is account node (means root)
 	 *
-	 * @param type $_node a tree id node
+	 * @param string|null $_node a tree id node
 	 * @return boolean returns true if the node is account node otherwise false
 	 */
 	private static function isAccountNode ($_node)
@@ -163,7 +163,7 @@ 
 	 *
 	 * @param string $_parent = null no parent node means root with the first level of folders
 	 * @param string $_profileID = '' icServer id
-	 * @param int|boolean $_openTopLevel = 1 Open top level folders on load if it's set to 1|true,
+	 * @param integer $_openTopLevel = 1 Open top level folders on load if it's set to 1|true,
 	 *  false|0 leaves them in closed state
 	 * @param $_noCheckboxNS = false no checkbox for namesapaces makes sure to not put checkbox for namespaces node
 	 * @param boolean $_subscribedOnly = false get only subscribed folders
@@ -444,7 +444,7 @@ 
 	 *
 	 * @param type $_profileID = null Null means all accounts and giving profileid means fetches node for the account
 	 * @param type $_noCheckbox = false option to switch checkbox of
-	 * @param type $_openTopLevel = 0 option to either start the node opened (1) or closed (0)
+	 * @param integer $_openTopLevel = 0 option to either start the node opened (1) or closed (0)
 	 *
 	 * @return array an array of baseNodes of accounts
 	 */
@@ -491,7 +491,7 @@ 
 	 *
 	 * @param string $_parent = null no parent node means root with the first level of folders
 	 * @param string $_profileID = '' active profile / acc_id
-	 * @param int|boolean $_openTopLevel = 1 Open top level folders on load if it's set to 1|true,
+	 * @param integer $_openTopLevel = 1 Open top level folders on load if it's set to 1|true,
 	 *  false|0 leaves them in closed state
 	 * @param boolean $_subscribedOnly = false get only subscribed folders
 	 * @param boolean $_allInOneGo = false, true will get all folders (dependes on subscribedOnly option) of the account in one go

notifications/inc/class.notifications.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -185,7 +185,6 @@ 
 	/**
 	 * Return notification errors
 	 *
-	 * @param boolean $reset=false true: reset all errors
 	 * @return array
 	 */
 	public static function errors($reset=false)
@@ -434,7 +433,7 @@ 
 	 * Sets backends that should be skipped even if the user
 	 * defined them in its chain
 	 *
-	 * @param array $_skip_backends array with names of the backends to be skipped
+	 * @param string[] $_skip_backends array with names of the backends to be skipped
 	 * e.g. array('popup', 'winpopup')
 	 */
 	public function set_skip_backends(array $_skip_backends) {

notifications/inc/class.notifications_jdesk_ajax.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 	 * this function calls all other recurring AJAX notifications methods
 	 * to have ONE single recurring AJAX call per user
 	 *
-	 * @return xajax response
+	 * @return string response
 	 */
 	public function get_notifications($browserNotify = false)
 	{

notifications/inc/class.notifications_jpopup.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -133,7 +133,7 @@ 
 	* renders additional infos from sender and subject
 	*
 	* @param string $_subject
-	* @return html rendered info as complete string
+	* @return string rendered info as complete string
 	*/
 	private function render_infos($_subject = false) {
 		$infos = array();
@@ -149,7 +149,6 @@ 
 	* saves notification into database so that the client can fetch it from there
 	*
 	* @param string $_message
-	* @param array $_user_sessions
 	*/
 	private function save( $_message ) {
 		$result = $this->db->insert( self::_notification_table, array(

notifications/inc/class.notifications_popup.inc.php

Doc Comments +3 added lines, -5 removed lines

@@ -117,7 +117,6 @@ 
 	 * saves notification into database so that the client can fetch it from there
 	 *
 	 * @param string $_message
-	 * @param array $_user_sessions
 	 */
 	private function save( $_message ) {
 		$result = $this->db->insert( self::_notification_table, array(
@@ -179,9 +178,8 @@ 
 	 * returns javascript to open a popup window: window.open(...)
 	 *
 	 * @param string $link link or this.href
-	 * @param string $target='_blank' name of target or this.target
-	 * @param int $width=750 width of the window
-	 * @param int $height=400 height of the window
+	 * @param int $width width of the window
+	 * @param int $height height of the window
 	 * @return string javascript (using single quotes)
 	 */
 	private function jspopup($link,$target='_blank',$width=750,$height=410)
@@ -202,7 +200,7 @@ 
 	 * renders additional infos from sender and subject
 	 *
 	 * @param string $_subject
-	 * @return html rendered info as complete string
+	 * @return string rendered info as complete string
 	 */
 	private function render_infos($_subject = false) {
 		$infos = array();