EGroupware / egroupware

filemanager/inc/class.filemanager_ui.inc.php

Doc Comments +6 added lines, -1 removed lines

@@ -536,6 +536,9 @@ 
 	 * @param int &$errs=null on return number of errors
 	 * @param int &$dirs=null on return number of dirs deleted
 	 * @param int &$files=null on return number of files deleted
+	 * @param integer $errs
+	 * @param integer $files
+	 * @param integer $dirs
 	 * @return string success or failure message displayed to the user
 	 */
 	static public function action($action,$selected,$dir=null,&$errs=null,&$files=null,&$dirs=null)
@@ -704,6 +707,9 @@ 
 	 * @param int &$errs=null on return number of errors
 	 * @param int &$dirs=null on return number of dirs deleted
 	 * @param int &$files=null on return number of files deleted
+	 * @param integer $errs
+	 * @param integer $dirs
+	 * @param integer $files
 	 * @return string
 	 */
 	public static function do_delete(array $selected, &$errs=null, &$dirs=null, &$files=null)
@@ -1325,7 +1331,6 @@ 
 	 *
 	 * @param string $action eg. 'delete', ...
 	 * @param array $selected selected path(s)
-	 * @param string $dir=null current directory
 	 * @see static::action()
 	 */
 	public static function ajax_action($action, $selected, $dir=null, $props=null)

home/inc/class.home_ui.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -155,7 +155,7 @@
 	 * Get a list of the user's portlets, and their associated values & settings, for display
 	 *
 	 * Actual portlet content is provided by each portlet.
-	 * @param template etemplate so attributes can be set
+	 * @param template Etemplate so attributes can be set
 	 */
 	protected function get_user_portlets(Etemplate &$template)
 	{

importexport/inc/class.importexport_basic_import_csv.inc.php

Doc Comments +5 added lines, -6 removed lines

@@ -118,8 +118,7 @@ 
 	/**
 	 * imports entries according to given definition object.
 	 * @param resource $_stream
-	 * @param string $_charset
-	 * @param definition $_definition
+	 * @param importexport_definition $_definition
 	 */
 	public function import( $_stream, importexport_definition $_definition ) {
 		$import_csv = new importexport_import_csv( $_stream, array(
@@ -222,7 +221,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)
 	{
@@ -274,7 +273,7 @@ 
 	 * @param condition array = array('string' => field name)
 	 * @param matches - On return, will be filled with matching records
 	 *
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	protected function exists(importexport_iface_egw_record &$record, Array &$condition, &$matches = array())
 	{
@@ -451,7 +450,7 @@ 
 	/**
 	 * Allows an extending class to alter a row for preview
 	 *
-	 * @param egw_record $row_entry
+	 * @param importexport_iface_egw_record $row_entry
 	 */
 	protected function row_preview(importexport_iface_egw_record &$row_entry)
 	{
@@ -523,7 +522,7 @@ 
 	 * Get the primary key for an entry based on a custom field
 	 * Returns key, so regular linking can take over
 	 *
-	 * @param int $record_number Row number, used for errors
+	 * @param int $record_num Row number, used for errors
 	 * @param string $app Target application name
 	 * @param string $value CSV value in the form of custom_field_name:value
 	 */

importexport/inc/class.importexport_definitions_bo.inc.php

Doc Comments +1 added lines, -3 removed lines

@@ -139,7 +139,6 @@ 
 	/**
 	* Save a definition
 	*
-	* @param definition $definition
 	*/
 	public function save(Array $data) {
 		$definition = new importexport_definition();
@@ -209,7 +208,7 @@ 
 	/**
 	 * imports definitions from file
 	 *
-	 * @param string $import_file
+	 * @param string $_import_file
 	 * @throws Exeption
 	 * @return void
 	 */
@@ -268,7 +267,6 @@ 
 	 * It is not possible to handle some plugin options automatically, because they
 	 * just don't have equivalents.  (eg: What to do with unknown categories)
 	 *
-	 * @param importexport_definition $definition Import definition
 	 *
 	 * @return importexport_definition Export definition
 	 */

importexport/inc/class.importexport_definitions_ui.inc.php

Doc Comments +4 added lines, -3 removed lines

@@ -82,7 +82,7 @@ 
 	/**
 	 * List defined {im|ex}ports
 	 *
-	 * @param array $content=null
+	 * @param array $content
 	 */
 	function index($content = null,$msg='')
 	{
@@ -309,8 +309,9 @@ 
 	 * @param int &$success number of succeded actions
 	 * @param int &$failed number of failed actions (not enought permissions)
 	 * @param string &$action_msg translated verb for the actions, to be used in a message like %1 entries 'deleted'
-	 * @param string/array $session_name 'index' or 'email', or array with session-data depending if we are in the main list or the popup
-	 * @return boolean true if all actions succeded, false otherwise
+	 * @param string $session_name 'index' or 'email', or array with session-data depending if we are in the main list or the popup
+	 * @param string $msg
+	 * @return null|boolean true if all actions succeded, false otherwise
 	 */
 	function action($action,$selected,$use_all,&$success,&$failed,&$action_msg,$session_name,&$msg)
 	{

importexport/inc/class.importexport_export_csv.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -96,7 +96,7 @@ 
 	 *
 	 * @param stram $_stream resource where records are exported to.
 	 * @param array _options options for specific backends
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function __construct( $_stream, array $_options ) {
 		if (!is_object($GLOBALS['egw']->translation)) {
@@ -151,7 +151,7 @@ 
 	 * exports a record into resource of handle
 	 *
 	 * @param importexport_iface_egw_record record
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function export_record( importexport_iface_egw_record $_record ) {
 		$this->record = $_record;
@@ -284,7 +284,7 @@ 
 	 *
 	 * Uses the static variable $types to convert various datatypes.
 	 *
-	 * @param record Record to be converted
+	 * @param record importexport_iface_egw_record to be converted
 	 * @parem fields List of field types => field names to be converted
 	 * @param appname Current appname if you want to do custom fields too
 	 */

importexport/inc/class.importexport_helper_functions.inc.php

Doc Comments +4 added lines, -3 removed lines

@@ -123,7 +123,7 @@ 
 	/**
 	 * converts accound_lid to account_id
 	 *
-	 * @param mixed $_account_lid comma seperated list or array with lids
+	 * @param mixed $_account_lids comma seperated list or array with lids
 	 * @return mixed comma seperated list or array with ids
 	 */
 	public static function account_name2id( &$_account_lids ) {
@@ -203,7 +203,7 @@ 
 	/**
 	 * converts account_ids to account_lids
 	 *
-	 * @param mixed $_account_ids comma seperated list or array with ids
+	 * @param mixed $_account_id comma seperated list or array with ids
 	 * @return mixed comma seperated list or array with lids
 	 */
 	public static function account_id2name( $_account_id ) {
@@ -419,7 +419,7 @@ 
 	/**
 	 * returns a list of importexport plugins
 	 *
-	 * @param string $_tpye {import | export | all}
+	 * @param string $_type {import | export | all}
 	 * @param string $_appname {<appname> | all}
 	 * @return array(<appname> => array( <type> => array(<plugin> => <title>)))
 	 */
@@ -591,6 +591,7 @@ 
 	 *
 	 * @param $app_name String name of app
 	 * @param $plugin_name Name of the plugin
+	 * @param importexport_wizard_basic_export_csv $wizard_plugin
 	 *
 	 * @return Array ([fieldname] => array(widget settings), ...)
 	 */

importexport/inc/class.importexport_iface_egw_record.inc.php

Doc Comments +3 added lines

@@ -35,6 +35,7 @@ 
 	 * reads record from backend if identifier is given.
 	 *
 	 * @param string $_identifier
+	 * @return void
 	 */
 	public function __construct( $_identifier='' );
 	
@@ -50,6 +51,7 @@ 
 	 *
 	 * @param string $_attribute_name
 	 * @param data $data
+	 * @return void
 	 */
 	public function __set($_attribute_name, $data);
 	
@@ -126,6 +128,7 @@ 
 	/**
 	 * destructor
 	 *
+	 * @return void
 	 */
 	public function __destruct();
 

importexport/inc/class.importexport_iface_export_plugin.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -107,7 +107,7 @@
 	 * and automatic conversions.  In most cases they are named <appname>_egw_record,
 	 * but projectmanager is an exception to this.
 	 *
-	 * @return string;
+	 * @return string
 	 */
 	public static function get_egw_record_class();
 } // end of iface_export_plugin