EGroupware / egroupware

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_record.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
 	 * destructor
 	 *
 	 * @return 
-	 */
+	 void
 	public function __destruct( );
 
 } // end of iface_export_record

importexport/inc/class.importexport_iface_import_plugin.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -29,8 +29,8 @@
 	/**
 	 * imports entries according to given definition object.
 	 *
-	 * @param stram $_stram
-	 * @param definition $_definition
+	 * @param stram $_stream
+	 * @param importexport_definition $_definition
 	 * @return int number of successful imports
 	 */
 	public function import( $_stream, importexport_definition $_definition );

importexport/inc/class.importexport_iface_import_record.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 	 * cleanup
 	 *
 	 * @return 
-	 */
+	 void
 	public function __destruct( );
 
 	/**

importexport/inc/class.importexport_import_csv.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -137,8 +137,8 @@ 
 	/**
 	 * updates $this->record
 	 *
-	 * @param mixed $_position
-	 * @return bool
+	 * @param string $_position
+	 * @return null|false
 	 */
 	private function get_raw_record( $_position = 'next' ) {
 		switch ($_position) {
@@ -244,7 +244,7 @@ 
 	/**
 	 * does conversions according to $this->conversion
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	protected function do_conversions() {
 		if ( $record = importexport_helper_functions::conversion( $this->record, $this->conversion, $this->conversion_class )) {

importexport/inc/class.importexport_import_ui.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -295,7 +295,7 @@
 		 *
 		 * @param importexport_iface_import_plugin $plugin Instance of plugin to be used
 		 * @param resource $stream
-		 * @param importexport_definition $definition
+		 * @param importexport_definition $definition_obj
 		 * @return String HTML fragment illustrating how the data will be understood by Egw
 		 */
 		protected function preview(importexport_iface_import_plugin &$plugin, &$stream, importexport_definition &$definition_obj)

infolog/inc/class.infolog_bo.inc.php

Doc Comments +2 added lines, -5 removed lines

@@ -1226,7 +1226,7 @@ 
 	 * Is called as hook to participate in the linking
 	 *
 	 * @param int|array $info int info_id or array with infolog entry
-	 * @return string|boolean string with the title, null if $info not found, false if no perms to view
+	 * @return string string with the title, null if $info not found, false if no perms to view
 	 */
 	function link_title($info)
 	{
@@ -1324,9 +1324,6 @@ 
 	/**
 	 * hook called be calendar to include events or todos in the cal-dayview
 	 *
-	 * @param int $args[year], $args[month], $args[day] date of the events
-	 * @param int $args[owner] owner of the events
-	 * @param string $args[location] calendar_include_{events|todos}
 	 * @return array of events (array with keys starttime, endtime, title, view, icon, content)
 	 */
 	function cal_to_include($args)
@@ -1515,7 +1512,7 @@ 
 	 * Get names for categories specified by their id's
 	 *
 	 * @param array|string $cat_id_list array or comma-sparated list of id's
-	 * @return array with names
+	 * @return string|boolean with names
 	 */
 	function get_categories($cat_id_list)
 	{