EGroupware / egroupware

emailadmin/inc/class.emailadmin_smtp_ads.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -146,7 +146,7 @@
 	/**
 	 * Constructor
 	 *
-	 * @param string $defaultDomain=null
+	 * @param string $defaultDomain
 	 */
 	function __construct($defaultDomain=null)
 	{

emailadmin/inc/class.emailadmin_smtp_ldap.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -628,7 +628,7 @@
 	 * @param int $_accountID
 	 * @param string $_forwardingAddress
 	 * @param string $_keepLocalCopy 'yes'
-	 * @return boolean true on success, false on error writing to ldap
+	 * @return boolean|null true on success, false on error writing to ldap
 	 */
 	function saveSMTPForwarding($_accountID, $_forwardingAddress, $_keepLocalCopy)
 	{

emailadmin/inc/class.emailadmin_smtp_sql.inc.php

Doc Comments +4 added lines, -4 removed lines

@@ -55,7 +55,7 @@ 
 	/**
 	 * Constructor
 	 *
-	 * @param string $defaultDomain=null
+	 * @param string $defaultDomain
 	 */
 	function __construct($defaultDomain=null)
 	{
@@ -101,7 +101,7 @@ 
 	 * from all accounts!
 	 *
 	 * @param int|string $user numerical account-id, account-name or email address
-	 * @param boolean $match_uid_at_domain=true true: uid@domain matches, false only an email or alias address matches
+	 * @param boolean $match_uid_at_domain true: uid@domain matches, false only an email or alias address matches
 	 * @return array with values for keys 'mailLocalAddress', 'mailAlternateAddress' (array), 'mailForwardingAddress' (array),
 	 * 	'accountStatus' ("active"), 'quotaLimit' and 'deliveryMode' ("forwardOnly")
 	 */
@@ -227,8 +227,8 @@ 
 	 * @param string $_accountStatus
 	 * @param string $_mailLocalAddress
 	 * @param int $_quota in MB
-	 * @param boolean $_forwarding_only=false true: store only forwarding info, used internally by saveSMTPForwarding
-	 * @param string $_setMailbox=null used only for account migration
+	 * @param boolean $_forwarding_only true: store only forwarding info, used internally by saveSMTPForwarding
+	 * @param string $_setMailbox used only for account migration
 	 * @return boolean true on success, false on error writing to ldap
 	 */
 	function setUserData($_uidnumber, array $_mailAlternateAddress, array $_mailForwardingAddress, $_deliveryMode,

etemplate/doc/et_media/inc/class.ui_et_media.inc.php

Doc Comments +1 added lines, -2 removed lines

@@ -127,8 +127,7 @@
 	/**
 	 * Show files shared
 	 *
-	 * @param array $content=null
-	 * @param string $msg=''
+	 * @param array $content
 	 */
 	public function index(array $content=null)
 	{

etemplate/inc/class.ajax_captcha_widget.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -104,7 +104,7 @@ 
 	 * @param boolean &$loop can be set to true to request a re-submision of the form/dialog

 	 * @param object &$tmpl the eTemplate the widget belongs too

 	 * @param mixed &value_in the posted values (already striped of magic-quotes)

-	 * @return boolean true if $value has valid content, on false no content will be returned!

+	 * @return false|null true if $value has valid content, on false no content will be returned!

 	 */

 	function post_process($name,&$value,&$extension_data,&$loop,&$tmpl,$value_in)

 	{

@@ -862,7 +862,7 @@ 
    *

    * @access private

    * @since 1.0.2

-   * @return mixed  false on failure, a word on success

+   * @return false|string  false on failure, a word on success

    */

   function readCodeFromFile()

   {

etemplate/inc/class.bo_merge.inc.php

Doc Comments +18 added lines, -16 removed lines

@@ -353,9 +353,9 @@ 
 	 *
 	 * Calls get_links() repeatedly to get all the combinations for the content.
 	 *
-	 * @param $app String appname
+	 * @param string $app String appname
 	 * @param $id String ID of record
-	 * @param $prefix
+	 * @param string $prefix
 	 * @param $content String document content
 	 */
 	protected function get_all_links($app, $id, $prefix, &$content)
@@ -428,7 +428,7 @@ 
 	 * Format a datetime
 	 *
 	 * @param int|string|DateTime $time unix timestamp or Y-m-d H:i:s string (in user time!)
-	 * @param string $format=null format string, default $this->datetime_format
+	 * @param string $format format string, default $this->datetime_format
 	 * @deprecated use egw_time::to($time='now',$format='')
 	 * @return string
 	 */
@@ -470,7 +470,6 @@ 
 	/**
 	 * getExportLimit
 	 * checks if there is an exportlimit set, and returns
-	 * @param mixed $app_limit checks and validates app_limit, if not set returns the global limit
 	 *
 	 * @return mixed - no if no export is allowed, false if there is no restriction and int as there is a valid restriction
 	 *		you may have to cast the returned value to int, if you want to use it as number
@@ -517,7 +516,7 @@ 
 	 * @param mixed $app_limit app_limit, if not set checks the global limit
 	 * @param string $checkas [AND|ISALLOWED], AND default; if set to ISALLOWED it is checked if Export is allowed
 	 *
-	 * @return bool - true if no export is allowed or a limit is set, false if there is no restriction
+	 * @return boolean|null - true if no export is allowed or a limit is set, false if there is no restriction
 	 */
 	public static function hasExportLimit($app_limit,$checkas='AND')
 	{
@@ -534,7 +533,6 @@ 
 	 * @param array $ids array with contact id(s)
 	 * @param string &$err error-message on error
 	 * @param string $mimetype mimetype of complete document, eg. text/*, application/vnd.oasis.opendocument.text, application/rtf
-	 * @param array $fix=null regular expression => replacement pairs eg. to fix garbled placeholders
 	 * @return string|boolean merged document or false on error
 	 */
 	public function &merge($document,$ids,&$err,$mimetype,array $fix=null)
@@ -566,6 +564,9 @@ 
 		return $content;
 	}
 
+	/**
+	 * @param string $mimetype
+	 */
 	protected function apply_styles (&$content, $mimetype, $mso_application_progid=null)
 	{
 		if (!isset($mso_application_progid))
@@ -666,8 +667,7 @@ 
 	 * @param array $ids array with contact id(s)
 	 * @param string &$err error-message on error
 	 * @param string $mimetype mimetype of complete document, eg. text/*, application/vnd.oasis.opendocument.text, application/rtf
-	 * @param array $fix=null regular expression => replacement pairs eg. to fix garbled placeholders
-	 * @param string $charset=null charset to override default set by mimetype or export charset
+	 * @param string $charset charset to override default set by mimetype or export charset
 	 * @return string|boolean merged document or false on error
 	 */
 	public function &merge_string($content,$ids,&$err,$mimetype,array $fix=null,$charset=null)
@@ -904,7 +904,7 @@ 
 	 * @param array $replacements name => replacement pairs
 	 * @param string $mimetype mimetype of content
 	 * @param string $mso_application_progid='' MS Office 2003: 'Excel.Sheet' or 'Word.Document'
-	 * @param string $charset=null charset to override default set by mimetype or export charset
+	 * @param string $charset charset to override default set by mimetype or export charset
 	 * @return string
 	 */
 	protected function replace($content,array $replacements,$mimetype,$mso_application_progid='',$charset=null)
@@ -1123,6 +1123,8 @@ 
 
 	/**
 	 * Convert numeric values in spreadsheets into actual numeric values
+	 * @param string $content
+	 * @param string $mimetype
 	 */
 	protected function format_spreadsheet_numbers(&$content, $names, $mimetype)
 	{
@@ -1192,6 +1194,7 @@ 
 
 	/**
 	 * Convert date / timestamp values in spreadsheets into actual date / timestamp values
+	 * @param string $mimetype
 	 */
 	protected function format_spreadsheet_dates(&$content, $names, &$values, $mimetype)
 	{
@@ -1296,6 +1299,7 @@ 
 	/**
 	 * Expand link_to custom fields with the merge replacements from the app
 	 * but only if the template uses them.
+	 * @param string $app
 	 */
 	public function cf_link_to_expand($values, $content, &$replacements, $app = null)
 	{
@@ -1360,7 +1364,7 @@ 
 	/**
 	 * Process special flags, such as IF or NELF
 	 *
-	 * @param content Text to be examined and changed
+	 * @param content string to be examined and changed
 	 * @param replacements array of markers => replacement
 	 *
 	 * @return changed content
@@ -1672,8 +1676,7 @@ 
 	 * Get a list of document actions / files from the given directory
 	 *
 	 * @param string $dirs Directory(s comma or space separated) to search
-	 * @param string $prefix='document_' prefix for array keys
-	 * @param array|string $mime_filter=null allowed mime type(s), default all, negative filter if $mime_filter[0] === '!'
+	 * @param array|string $mime_filter allowed mime type(s), default all, negative filter if $mime_filter[0] === '!'
 	 * @return array List of documents, suitable for a selectbox.  The key is document_<filename>.
 	 */
 	public static function get_documents($dirs, $prefix='document_', $mime_filter=null, $app='')
@@ -1728,10 +1731,8 @@ 
 	 *
 	 * @param string $dirs Directory(s comma or space separated) to search
 	 * @param int $group see nextmatch_widget::egw_actions
-	 * @param string $caption='Insert in document'
-	 * @param string $prefix='document_'
 	 * @param string $default_doc='' full path to default document to show on top with action == 'document'!
-	 * @param int|string $export_limit=null export-limit, default $GLOBALS['egw_info']['server']['export_limit']
+	 * @param int|string $export_limit export-limit, default $GLOBALS['egw_info']['server']['export_limit']
 	 * @return array see nextmatch_widget::egw_actions
 	 */
 	public static function document_action($dirs, $group=0, $caption='Insert in document', $prefix='document_', $default_doc='',
@@ -1934,6 +1935,7 @@ 
 	 *
 	 * @param string &$document maybe relative path of document, on return true absolute path to existing document
 	 * @param string $dirs comma or whitespace separated directories
+	 * @param string $document
 	 * @return string|boolean false if document exists, otherwise string with error-message
 	 */
 	public static function check_document(&$document, $dirs)
@@ -1977,7 +1979,7 @@ 
 	 * Reimplemented from etemplate to NOT use user prefs for Excel 2003, which gives an xml error
 	 *
 	 * @param int|float|string $number
-	 * @param int $num_decimal_places=2
+	 * @param int $num_decimal_places
 	 * @param string $_mimetype=''
 	 * @return string
 	 */

etemplate/inc/class.bo_tracking.inc.php

Doc Comments +3 added lines, -4 removed lines

@@ -521,7 +521,7 @@ 
 	 * @param array $data current entry
 	 * @param array $old = null old/last state of the entry or null for a new entry
 	 * @param boolean $deleted = null can be set to true to let the tracking know the item got deleted or undelted
-	 * @param array $email_notified=null if present will return the emails notified, if given emails in that list will not be notified
+	 * @param array $email_notified if present will return the emails notified, if given emails in that list will not be notified
 	 * @return boolean true on success, false on error (error messages are in $this->errors)
 	 */
 	public function do_notifications($data,$old,$deleted=null,&$email_notified=null)
@@ -789,7 +789,7 @@ 
 	 * Return date+time formatted for the currently notified user (prefs in $GLOBALS['egw_info']['user']['preferences'])
 	 *
 	 * @param int|string|DateTime $timestamp in server-time
-	 * @param boolean $do_time=true true=allways (default), false=never print the time, null=print time if != 00:00
+	 * @param boolean $do_time true=allways (default), false=never print the time, null=print time if != 00:00
 	 *
 	 * @return string
 	 */
@@ -816,7 +816,6 @@ 
 	 * The default implementation prefers depending on the prefer_user_as_sender class-var the user over
 	 * what is returned by get_config('sender').
 	 *
-	 * @param int $user account_lid of user
 	 * @param array $data
 	 * @param array $old
 	 * @param bool $prefer_id returns the userid rather than email
@@ -866,7 +865,7 @@ 
 	 *
 	 * @param array $data
 	 * @param array $old
-	 * @param boolean $deleted=null can be set to true to let the tracking know the item got deleted or undelted
+	 * @param boolean $deleted can be set to true to let the tracking know the item got deleted or undelted
 	 * @param int|string $receiver nummeric account_id or email address
 	 * @return string
 	 */

etemplate/inc/class.boetemplate.inc.php

Doc Comments +14 added lines, -25 removed lines

@@ -103,8 +103,8 @@ 
 	 *
 	 * @param string $disabled expression to check, eg. "!@var" for !$content['var']
 	 * @param array $content the content-array in the context of the grid
-	 * @param int $row=null to be able to use $row or $row_content in value of checks
-	 * @param int $c=null to be able to use $row or $row_content in value of checks
+	 * @param integer $row
+	 * @param integer $c
 	 * @return boolean true if the row/col is disabled or false if not
 	 */
 	protected function check_disabled($disabled,$content,$row=null,$c=null)
@@ -263,7 +263,6 @@ 
 	 * As you usually have col- and row-headers, data-cells start with '1' or 'A' !!!
 	 *
 	 * @param array $cell with data of cell: name, type, size, ...
-	 * @param int $c,$r col/row index starting from 0
 	 * @param string &$idx returns the index in $content and $readonlys (NOT $sel_options !!!)
 	 * @param string &$idx_cname returns the basename for the form-name: is $idx if only one value
 	 *		(no ',') is given in size (name (not template-fields) are always only one value)
@@ -346,7 +345,7 @@ 
 	 *  disables all cells with name == $name
 	 *
 	 * @param sting $name cell-name
-	 * @param boolean $disabled=true disable or enable a cell, default true=disable
+	 * @param boolean $disabled disable or enable a cell, default true=disable
 	 * @return mixed number of changed cells or False, if none changed
 	 */
 	function disableElement($name,$disabled=True)
@@ -387,8 +386,8 @@ 
 	/**
 	 *  disables all cells with name == $name
 	 *
-	 * @param sting $name cell-name
-	 * @param boolean $disabled=true disable or enable a cell, default true=disable
+	 * @param string $name cell-name
+	 * @param boolean $disabled disable or enable a cell, default true=disable
 	 * @return reference to attribute
 	 * @deprecated use disableElement($name, $disabled=true)
 	 */
@@ -401,11 +400,10 @@ 
 	 * set one or more attibutes for row $n
 	 *
 	 * @param int $n numerical row-number starting with 1 (!)
-	 * @param string $height percent or pixel or '' for no height
-	 * @param string $class name of css class (without the leading '.') or '' for no class
-	 * @param string $valign alignment (top,middle,bottom) or '' for none
-	 * @param boolean $disabled True or expression or False to disable or enable the row (Only the number 0 means dont change the attribute !!!)
-	 * @param string $path='/0' default is the first widget in the tree of children
+	 * @param integer $height percent or pixel or '' for no height
+	 * @param integer $class name of css class (without the leading '.') or '' for no class
+	 * @param integer $valign alignment (top,middle,bottom) or '' for none
+	 * @param integer $disabled True or expression or False to disable or enable the row (Only the number 0 means dont change the attribute !!!)
 	 * @return false if $path is no grid or array(height,class,valign,disabled) otherwise
 	 */
 	function set_row_attributes($n,$height=0,$class=0,$valign=0,$disabled=0,$path='/0')
@@ -432,8 +430,6 @@ 
 	 * disables row $n
 	 *
 	 * @param int $n numerical row-number starting with 1 (!)
-	 * @param boolean $enable=false can be used to re-enable a row if set to True
-	 * @param string $path='/0' default is the first widget in the tree of children
 	 */
 	function disable_row($n,$enable=False,$path='/0')
 	{
@@ -444,9 +440,8 @@ 
 	 * set one or more attibutes for column $c
 	 *
 	 * @param int|string $c numerical column-number starting with 0 (!), or the char-code starting with 'A'
-	 * @param string $width percent or pixel or '' for no height
-	 * @param mixed $disabled=0 True or expression or False to disable or enable the column (Only the number 0 means dont change the attribute !!!)
-	 * @param string $path='/0' default is the first widget in the tree of children
+	 * @param integer $width percent or pixel or '' for no height
+	 * @param mixed $disabled True or expression or False to disable or enable the column (Only the number 0 means dont change the attribute !!!)
 	 * @return false if $path specifies no grid or array(width,disabled) otherwise
 	 */
 	function set_column_attributes($c,$width=0,$disabled=0,$path='/0')
@@ -473,7 +468,6 @@ 
 	 *
 	 * @param int|string $c numerical column-number starting with 0 (!), or the char-code starting with 'A'
 	 * @param boolean $enable can be used to re-enable a column if set to True
-	 * @param string $path='/0' default is the first widget in the tree of children
 	 */
 	function disable_column($c,$enable=False,$path='/0')
 	{
@@ -490,8 +484,6 @@ 
 	/**
 	 * trys to load the Extension / Widget-class from the app or etemplate
 	 *
-	 * @param string $name name of the extension, the classname should be class.${name}_widget.inc.php
-	 *	the $name might be "$name.$app" to give a app-name (default is the current app,or template-name)
 	 * @return string|boolean human readable name or false if not found/loadable
 	 */
 	function loadExtension($type)
@@ -527,8 +519,6 @@ 
 	/**
 	 * checks if extension is loaded (load it if it isnt) and optional checks if it has a given method
 	 *
-	 * @param string $name name of the extension, the classname should be class.${name}_widget.inc.php
-	 *	the $name might be "$name.$app" to give a app-name (default is the current app,or template-name)
 	 * @param string $function 'pre_process', 'post_process' or 'render'
 	 * @return boolean true if the extension (incl. method) exists, else false
 	 */
@@ -782,7 +772,7 @@ 
 	 * For the 3. Column in the 2. row of a grid which is the only widget in the children-tree it is eg.: "/0/2C"
 	 *
 	 * @param string $path path in the widget tree
-	 * @param int $ancestor=0 0: widget itself, 1: parent, 2: grand-parent, ...
+	 * @param int $ancestor 0: widget itself, 1: parent, 2: grand-parent, ...
 	 * @return array referenz to the widget spezified or null, if it's not found
 	 */
 	function &get_widget_by_path($path,$ancestor=0)
@@ -838,9 +828,9 @@ 
 	 * - csv_split('"a""b,c",d') === array('a"b,c','d')	// to escape enclosures double them!
 	 *
 	 * @param string $str
-	 * @param int $num=null in how many parts to split maximal, parts over this number end up (unseparated) in the last part
 	 * @param string $delimiter=','
 	 * @param string $enclosure='"'
+	 * @param integer $num
 	 * @return array
 	 */
 	static function csv_split($str,$num=null,$delimiter=',',$enclosure='"')
@@ -908,8 +898,7 @@ 
 	/**
 	 * stores the etemplate in the cache in egw_info
 	 *
-	 * @param boetemplate $tpl=null required parameter for static use!
-	 * @param boolean $only_update_older=false true only update cache, if it contains an older template
+	 * @param boolean $only_update_older true only update cache, if it contains an older template
 	 */
 	public /*static*/ function store_in_cache(boetemplate $tpl=null, $only_update_older=false)
 	{

etemplate/inc/class.bolangfile.inc.php

Doc Comments +3 added lines

@@ -218,6 +218,9 @@
 		return $this->target_langarray;
 	}
 
+	/**
+	 * @param string $which
+	 */
 	function write_file($which,$app_name,$userlang)
 	{
 		switch ($which)