EGroupware / egroupware

admin/inc/class.admin_customfields.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -548,7 +548,7 @@
 	 * Validate and create a new content type
 	 *
 	 * @param array $content
-	 * @return string|boolean New type ID, or false for error
+	 * @return false|string New type ID, or false for error
 	 */
 	function create_content_type(&$content)
 	{

api/src/Storage/Merge.php

Doc Comments +15 added lines, -8 removed lines

@@ -373,9 +373,9 @@ 
 	 *
 	 * Calls get_links() repeatedly to get all the combinations for the content.
 	 *
-	 * @param $app String appname
-	 * @param $id String ID of record
-	 * @param $prefix
+	 * @param string $app String appname
+	 * @param integer $id String ID of record
+	 * @param string $prefix
 	 * @param $content String document content
 	 */
 	protected function get_all_links($app, $id, $prefix, &$content)
@@ -535,7 +535,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')
 	{
@@ -585,6 +585,9 @@ 
 		return $content;
 	}
 
+	/**
+	 * @param string $mimetype
+	 */
 	protected function apply_styles (&$content, $mimetype, $mso_application_progid=null)
 	{
 		if (!isset($mso_application_progid))
@@ -1178,6 +1181,8 @@ 
 
 	/**
 	 * Convert numeric values in spreadsheets into actual numeric values
+	 * @param string $content
+	 * @param string $mimetype
 	 */
 	protected function format_spreadsheet_numbers(&$content, $names, $mimetype)
 	{
@@ -1247,6 +1252,7 @@ 
 
 	/**
 	 * Convert date / timestamp values in spreadsheets into actual date / timestamp values
+	 * @param string $mimetype
 	 */
 	protected function format_spreadsheet_dates(&$content, $names, &$values, $mimetype)
 	{
@@ -1351,6 +1357,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)
 	{
@@ -1416,7 +1423,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
@@ -1729,8 +1736,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='')
@@ -1997,7 +2003,8 @@ 
 	 *
 	 * @param string &$document maybe relative path of document, on return true absolute path to existing document
 	 * @param string $dirs comma or whitespace separated directories
-	 * @return string|boolean false if document exists, otherwise string with error-message
+	 * @param string $document
+	 * @return false|string false if document exists, otherwise string with error-message
 	 */
 	public static function check_document(&$document, $dirs)
 	{

api/src/Link.php

Doc Comments +3 added lines, -3 removed lines

@@ -433,7 +433,7 @@ 
 	 * generate temporary link_id used as array-key
 	 *
 	 * @param string $app app-name
-	 * @param mixed $id
+	 * @param string $id
 	 * @return string
 	 */
 	static function temp_link_id($app,$id)
@@ -579,7 +579,7 @@ 
 	 * @param string|array $id ='' id if $app_link_id is an appname or array with links, if 1. entry not yet created
 	 * @param string $app2 ='' second app
 	 * @param string $id2 ='' id in $app2
-	 * @return array with link-data or False
+	 * @return string with link-data or False
 	 */
 	static function get_link($app_link_id,$id='',$app2='',$id2='')
 	{
@@ -1197,7 +1197,7 @@ 
 	 * @param string $app appname to link the file to
 	 * @param string $id id in $app
 	 * @param string $file VFS path to link to
-	 * @return boolean true on success, false on failure
+	 * @return null|boolean true on success, false on failure
 	 */
 	static function link_file($app,$id,$file)
 	{

api/src/Accounts.php

Doc Comments +2 added lines, -3 removed lines

@@ -799,7 +799,7 @@ 
 	 * Not all existing accounts are visible because off account_selection preference: 'none' or 'groupmembers'
 	 *
 	 * @param int|string $account_id nummeric account_id or account_lid
-	 * @return boolean true = account is visible, false = account not visible, null = account does not exist
+	 * @return null|boolean true = account is visible, false = account not visible, null = account does not exist
 	 */
 	function visible($account_id)
 	{
@@ -994,7 +994,6 @@ 
 	 *
 	 * @param string $account_lid
 	 * @param string $passwd
-	 * @param array $GLOBALS['auto_create_acct'] values for 'firstname', 'lastname', 'email' and 'primary_group'
 	 * @return int|boolean account_id or false on error
 	 */
 	function auto_add($account_lid, $passwd)
@@ -1114,7 +1113,7 @@ 
 	 *
 	 * We use now an instance-wide read-cache storing account-data and members(hips).
 	 *
-	 * @param int|array $account_ids user- or group-id(s) for which cache should be invalidated, default 0 = only search/name2id cache
+	 * @param integer $account_ids user- or group-id(s) for which cache should be invalidated, default 0 = only search/name2id cache
 	 */
 	static function cache_invalidate($account_ids=0)
 	{

api/src/Contacts/Ldap.php

Doc Comments -1 removed lines

@@ -213,7 +213,6 @@
 	/**
 	 * Remove attributes we are not allowed to update
 	 *
-	 * @param array $attributes
 	 */
 	function sanitize_update(array &$ldapContact)
 	{

api/src/Mailer.php

Doc Comments +2 added lines, -2 removed lines

@@ -251,7 +251,7 @@ 
 	/**
 	 * Add one or multiple addresses to Cc
 	 *
-	 * @param string|array|Horde_Mail_Rfc822_List $address
+	 * @param string $address
 	 * @param string $personal ='' only used if $address is a string
 	 */
 	function addCc($address, $personal=null)
@@ -381,7 +381,7 @@ 
 	/**
 	 * Adds an embedded image or other inline attachment
 	 *
-	 * @param string|resource $data Path to the attachment or open file-descriptor
+	 * @param string $data Path to the attachment or open file-descriptor
 	 * @param string $cid Content ID of the attachment.  Use this to identify
 	 *        the Id for accessing the image in an HTML form.
 	 * @param string $name Overrides the attachment name.

calendar/inc/class.calendar_category_report.inc.php

Doc Comments +1 added lines

@@ -89,6 +89,7 @@
 	 * @param int $weekend weekend option
 	 * @param int $min_days min_days option
 	 * @param int $unit unit option
+	 * @param integer $end_range
 	 *
 	 */
 	public function process_days(&$events_log, &$week_sum, &$day,$day_index, $events, $cat_id, $holidays, $weekend, $min_days, $unit, $start_range, $end_range)

addressbook/inc/class.addressbook_export_vcard.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
 	/**
 	 * Exports records as defined in $_definition
 	 *
-	 * @param egw_record $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function export( $_stream, importexport_definition $_definition) {
 

admin/inc/class.admin_export_users_csv.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,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;
@@ -88,7 +88,7 @@ 
 	 * return html for options.
 	 * this way the plugin has all opportunities for options tab
 	 *
-	 * @return string html
+	 * @return boolean html
 	 */
 	public function get_options_etpl() {
 		return false;