From: Paweł Szewczyk Date: Thu, 16 Feb 2017 10:22:27 +0000 (+0100) Subject: Remove trailing whitespaces X-Git-Tag: submit/tizen_3.0/20170406.043526~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ee6cf6614d19fc882f9e620d791037da20069d27;p=platform%2Fcore%2Fapi%2Fusb-host.git Remove trailing whitespaces Change-Id: I023d56f6ee55de8caf2d46df8356bcd0a4a4b4a0 Signed-off-by: Paweł Szewczyk --- diff --git a/doc/usb_host_doc.h b/doc/usb_host_doc.h index cd7ae9d..2b6b18a 100644 --- a/doc/usb_host_doc.h +++ b/doc/usb_host_doc.h @@ -87,7 +87,7 @@ * Each device has reference counter. Functions usb_host_ref_device() and usb_host_unref_device() are used to ref or unref device. * When ref counter reach 0 device will be freed. * Devices reached by calling usb_host_get_devices() have a reference count of 1, - * and usb_host_free_devices() can optionally decrease the reference count on all devices in the list. + * and usb_host_free_devices() can optionally decrease the reference count on all devices in the list. * usb_host_device_open() adds another reference which is later destroyed by usb_host_device_close(). * * @section CAPI_USB_HOST_DEV_MOUDLE_PREPARING Preparing Communication diff --git a/include/usb_host.h b/include/usb_host.h index 2f9255f..c8dc9cb 100644 --- a/include/usb_host.h +++ b/include/usb_host.h @@ -170,7 +170,7 @@ typedef struct usb_host_endpoint_s *usb_host_endpoint_h; * @since_tizen 3.0 * @remarks @a ctx should be destroyed by calling usb_host_destroy() when no longer needed. * @param[out] ctx Context pointer - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_OUT_OF_MEMORY Out of memory * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -188,7 +188,7 @@ int usb_host_create(usb_host_context_h *ctx); * the memory used by library. * @since_tizen 3.0 * @param[in] ctx Context to deinitialize - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed * @retval #USB_HOST_ERROR_NONE Success @@ -217,7 +217,7 @@ int usb_host_destroy(usb_host_context_h ctx); * @param[in] ctx Context handle * @param[out] devs An array of devices * @param[out] length Number of devices - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_OUT_OF_MEMORY Out of memory * @retval #USB_HOST_ERROR_NOT_SUPPORTED Operation not supported @@ -239,7 +239,7 @@ int usb_host_get_device_list(usb_host_context_h ctx, usb_host_device_h **devs, i * @param[in] devs List of devices * @param[in] unref_devices Set to @c true to unreference devices, * set to @c false to not unref - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed * @retval #USB_HOST_ERROR_NONE Successful @@ -254,7 +254,7 @@ int usb_host_free_device_list(usb_host_device_h *devs, bool unref_devices); * @details Increment ref count of device. * @since_tizen 3.0 * @param[in] dev Device to reference - * @return @c 0 on success, + * @return @c 0 on success, * error code otherwise * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed * @retval #USB_HOST_ERROR_NONE Successful @@ -268,7 +268,7 @@ int usb_host_ref_device(usb_host_device_h dev); * @details Decrements ref count of device. If ref count reaches zero, device will be destroyed. * @since_tizen 3.0 * @param[in] dev Device to unreference - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -283,7 +283,7 @@ int usb_host_unref_device(usb_host_device_h dev); * (including transfer operations and strings introspection). * @since_tizen 3.0 * @param[in] dev Device to open - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_OUT_OF_MEMORY Memory allocation failure @@ -303,7 +303,7 @@ int usb_host_device_open(usb_host_device_h dev); * It destroys reference that was added by usb_host_device_open(). * @since_tizen 3.0 * @param[in] dev Device that should be closed - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_DEVICE_NOT_OPENED If device is not opened * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -322,7 +322,7 @@ int usb_host_device_close(usb_host_device_h dev); * @param[in] vendor_id idVendor of connected device * @param[in] product_id idProduct of connected device * @param[out] device_handle Opened device handle - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_OUT_OF_MEMORY Insufficient memory @@ -340,7 +340,7 @@ int usb_host_device_open_with_vid_pid(usb_host_context_h ctx, * @since_tizen 3.0 * @param[in] dev Device handle * @param[out] bus_number Device bus number - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -357,7 +357,7 @@ int usb_host_device_get_bus_number(usb_host_device_h dev, int *bus_number); * @since_tizen 3.0 * @param[in] dev Device * @param[out] device_address Device address - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -375,7 +375,7 @@ int usb_host_device_get_address(usb_host_device_h dev, int *device_address); * @param[out] port_numbers Array to be filled with port numbers * @param[in] port_numbers_len Max length of array * @param[out] ports_count Number of all ports obtained from device - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -394,7 +394,7 @@ int usb_host_device_get_port_numbers(usb_host_device_h dev, int *port_numbers, i * @param[in] dev Device * @param[in] config_index Index of configuration to retrieve (counting from 0) * @param[out] config Output location for USB configuration - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_FOUND The configuration does not exist @@ -413,7 +413,7 @@ int usb_host_device_get_config(usb_host_device_h dev, int config_index, usb_host * @since_tizen 3.0 * @param[in] dev A device * @param[out] config Handle to active configuration - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NO_SUCH_DEVICE the dev has been disconnected * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -430,7 +430,7 @@ int usb_host_get_active_config(usb_host_device_h dev, usb_host_config_h *config) * @details Set active configuration for a device. * @since_tizen 3.0 * @param[in] configuration Handle to configuration to be activated - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_FOUND Requested configuration does not exist @@ -451,7 +451,7 @@ int usb_host_set_config(usb_host_config_h configuration); * @since_tizen 3.0 * @param[in] dev A device * @param[out] bcd_usb Bcd release number of USB - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -467,7 +467,7 @@ int usb_host_device_get_bcd_usb(usb_host_device_h dev, int *bcd_usb); * @since_tizen 3.0 * @param[in] dev A device * @param[out] device_class Device class - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -482,7 +482,7 @@ int usb_host_device_get_class(usb_host_device_h dev, int *device_class); * @since_tizen 3.0 * @param[in] dev A device * @param[out] subclass Device subclass - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -497,7 +497,7 @@ int usb_host_device_get_sub_class(usb_host_device_h dev, int *subclass); * @since_tizen 3.0 * @param[in] dev A device * @param[out] protocol Device protocol - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -512,7 +512,7 @@ int usb_host_device_get_protocol(usb_host_device_h dev, int *protocol); * @since_tizen 3.0 * @param[in] dev A device * @param[out] max_packet_size Maximum size of single packet, in bytes - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -527,7 +527,7 @@ int usb_host_device_get_max_packet_size_0(usb_host_device_h dev, int *max_packet * @since_tizen 3.0 * @param[in] dev A device * @param[out] vendor_id Vendor ID of @a dev - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -542,7 +542,7 @@ int usb_host_device_get_id_vendor(usb_host_device_h dev, int *vendor_id); * @since_tizen 3.0 * @param[in] dev A device * @param[out] product_id Product ID of @a dev - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -557,7 +557,7 @@ int usb_host_device_get_id_product(usb_host_device_h dev, int *product_id); * @since_tizen 3.0 * @param[in] dev A device * @param[out] device_bcd Device release number - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -572,7 +572,7 @@ int usb_host_device_get_bcd_device(usb_host_device_h dev, int *device_bcd); * @since_tizen 3.0 * @param[in] dev A device * @param[out] num_configurations Number of configurations for given device - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -588,7 +588,7 @@ int usb_host_device_get_num_configurations(usb_host_device_h dev, int *num_confi * @param[in] dev A device * @param[out] is_opened @c true if device is opened, * @c false otherwise - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -604,7 +604,7 @@ int usb_host_is_device_opened(usb_host_device_h dev, bool *is_opened); * @param[in] dev A handle to opened device * @param[in, out] length Data buffer size/how much was actually used * @param[out] data Buffer to store string - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_OVERFLOW There was no space in buffer @@ -623,7 +623,7 @@ int usb_host_device_get_manufacturer_str(usb_host_device_h dev, int *length, uns * @param[in] dev A handle to opened device * @param[in, out] length Data buffer size/how much was actually used * @param[out] data Buffer to store string - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_OVERFLOW There was no space in buffer @@ -642,7 +642,7 @@ int usb_host_device_get_product_str(usb_host_device_h dev, int *length, unsigned * @param[in] dev A handle to opened device * @param[in, out] length Data buffer size/how much was actually used * @param[out] data Buffer to store string - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_OVERFLOW There was no space in buffer @@ -660,7 +660,7 @@ int usb_host_device_get_serial_number_str(usb_host_device_h dev, int *length, un * @since_tizen 3.0 * @param[in] config A configuration * @param[out] num_interfaces Number of interfaces - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -676,7 +676,7 @@ int usb_host_config_get_num_interfaces(usb_host_config_h config, int *num_interf * @param[in] config A configuration * @param[out] self_powered @c true if device is self-powered in given configuration, * @c false otherwise - * @return @c 0 on success, + * @return @c 0 on success, * negative error code otherwise * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -692,7 +692,7 @@ int usb_host_config_is_self_powered(usb_host_config_h config, bool *self_powered * @param[in] config A configuration * @param[out] remote_wakeup @c true if device supports remote wakeup in given configuration, * @c false otherwise - * @return @c 0 on success, + * @return @c 0 on success, * negative error code otherwise * @retval #USB_HOST_ERROR_NONE Successful * @retval @USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -707,7 +707,7 @@ int usb_host_config_support_remote_wakeup(usb_host_config_h config, bool *remote * @since_tizen 3.0 * @param[in] config A configuration * @param[out] max_power Maximum power, in mA - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -723,7 +723,7 @@ int usb_host_config_get_max_power(usb_host_config_h config, int *max_power); * @param[in] config A configuration * @param[in, out] length Data buffer size/how much was actually used * @param[out] data Buffer to store string - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -744,7 +744,7 @@ int usb_host_device_get_config_str(usb_host_config_h config, int *length, unsign * @param[in] config Configuration handle * @param[in] interface_index Index of interface to retrieve (counting from 0) * @param[out] interface Interface handle - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_FOUND Configuration does not exist @@ -761,7 +761,7 @@ int usb_host_config_get_interface(usb_host_config_h config, int interface_index, * @details Frees configuration obtained from usb_host_device_get_config(). * @since_tizen 3.0 * @param[in] config Configuration to free - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -781,7 +781,7 @@ int usb_host_config_destroy(usb_host_config_h config); * @param[in] interface The bInterfaceNumber of interface to claim * @param[in] force Set to @c true to auto detach kernel driver, * set to @c false to not detach it - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_FOUND Requested interface does not exist @@ -800,7 +800,7 @@ int usb_host_claim_interface(usb_host_interface_h interface, bool force); * This is a blocking function. * @since_tizen 3.0 * @param[in] interface The bInterfaceNumber of interface to release - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_FOUND Interface was not claimed @@ -819,7 +819,7 @@ int usb_host_release_interface(usb_host_interface_h interface); * @since_tizen 3.0 * @param[in] interface An interface * @param[out] number Number of given interface - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -834,7 +834,7 @@ int usb_host_interface_get_number(usb_host_interface_h interface, int *number); * @since_tizen 3.0 * @param[in] interface An interface * @param[out] num_endpoints Number of endpoints in @a interface - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -853,7 +853,7 @@ int usb_host_interface_get_num_endpoints(usb_host_interface_h interface, int *nu * @param[in] interface Interface handle * @param[in] ep_index Index of endpoint to retrieve (counting from 0) * @param[out] ep Endpoint handle - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -868,7 +868,7 @@ int usb_host_interface_get_endpoint(usb_host_interface_h interface, int ep_index * @since_tizen 3.0 * @param[in] interface Interface handle * @param[in] altsetting Index of new alternative setting for given interface - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -883,7 +883,7 @@ int usb_host_interface_set_altsetting(usb_host_interface_h interface, int altset * @param[in] interface An interface * @param[in, out] length Data buffer size/how much was actually used * @param[out] data Buffer to store string - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -901,7 +901,7 @@ int usb_host_interface_get_str(usb_host_interface_h interface, int *length, * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] number Number of given endpoint - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -916,7 +916,7 @@ int usb_host_endpoint_get_number(usb_host_endpoint_h ep, int *number); * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] direction Direction of endpoint (a value from enum #usb_host_endpoint_direction_e) - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -931,7 +931,7 @@ int usb_host_endpoint_get_direction(usb_host_endpoint_h ep, usb_host_endpoint_di * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] transfer_type Transfer type (a value from enum #usb_host_transfer_type_e) - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -946,7 +946,7 @@ int usb_host_endpoint_get_transfer_type(usb_host_endpoint_h ep, usb_host_transfe * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] synch_type Synch type (a value from enum #usb_host_iso_sync_type_e) - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -961,7 +961,7 @@ int usb_host_endpoint_get_synch_type(usb_host_endpoint_h ep, usb_host_iso_sync_t * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] usage_type Usage type (a value from enum #usb_host_usage_type_e) - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported @@ -976,7 +976,7 @@ int usb_host_endpoint_get_usage_type(usb_host_endpoint_h ep, usb_host_usage_type * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] max_packet_size Max packet size, in bytes - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -990,7 +990,7 @@ int usb_host_endpoint_get_max_packet_size(usb_host_endpoint_h ep, int *max_packe * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] interval Interval for polling, in frame counts (refer to USB protocol specification) - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed @@ -1020,7 +1020,7 @@ int usb_host_endpoint_get_interval(usb_host_endpoint_h ep, int *interval); * before giving up due to no response being received. For an unlimited * @param[out] transferred Number of transferred bytes * timeout, 0 value should be used - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_TIMED_OUT Transfer timed out @@ -1051,7 +1051,7 @@ int usb_host_control_transfer(usb_host_device_h dev, * @param[in] timeout Timeout (in milliseconds) that this function should wait * before giving up due to no response being received (for an unlimited * timeout 0 value should be used) - * @return @c 0 on success (and populates @a transferred), + * @return @c 0 on success (and populates @a transferred), * negative error code on error * @retval #USB_HOST_ERROR_NONE Successful * @retval #USB_HOST_ERROR_TIMED_OUT Transfer timed out