From: Michal Bloch Date: Thu, 26 Sep 2024 18:28:51 +0000 (+0200) Subject: Also add 50+ chars @details docs X-Git-Tag: accepted/tizen/unified/20241001.004108^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Faccepted%2Ftizen_unified_x;p=platform%2Fcore%2Fapi%2Fusb-host.git Also add 50+ chars @details docs Most functions already had @details as appropriate. Change-Id: Iecf4fd9ff4efd2a9da4c226ca6f4d0f7d0ff09d7 --- diff --git a/doc/usb_host_doc.h b/doc/usb_host_doc.h index 0e72e0d..c1231c9 100644 --- a/doc/usb_host_doc.h +++ b/doc/usb_host_doc.h @@ -21,6 +21,7 @@ * @ingroup CAPI_SYSTEM_FRAMEWORK * @defgroup CAPI_USB_HOST_MODULE USB Host * @brief This module provides an API for raw access to USB devices. + * @details This module provides an interface for raw access to USB devices. * * @section CAPI_USB_HOST_MODULE_HEADER Required Header * \#include @@ -50,7 +51,8 @@ * * * @defgroup CAPI_USB_HOST_DEV_MODULE USB Host Device - * @brief This API is used to manage USB devices + * @brief The device module API is used to manage USB devices + * @details The device module API is used to manage USB devices * @ingroup CAPI_USB_HOST_MODULE * @section CAPI_USB_HOST_DEV_MODULE_OVERVIEW Overview * Operations described here help with enumerating, opening and closing devices. @@ -134,7 +136,8 @@ * More details on featuring your application can be found from Feature List. * * @defgroup CAPI_USB_HOST_CONFIG_MODULE USB Configuration - * @brief USB configuration-related API + * @brief This API is used to handle USB device configuration + * @details This API is used to handle USB device configuration * @ingroup CAPI_USB_HOST_MODULE * @section CAPI_USB_HOST_CONFIG_MODULE_OVERVIEW Overview * Data structures and operations described here are related to USB configuration. @@ -152,7 +155,8 @@ * More details on featuring your application can be found from Feature List. * * @defgroup CAPI_USB_HOST_INTERFACE_MODULE USB Interface - * @brief USB interface-related API + * @brief This API is used to handle tasks related to USB interfaces + * @details This API is used to handle tasks related to USB interfaces * @ingroup CAPI_USB_HOST_MODULE * @section CAPI_USB_HOST_INTERFACE_MODULE_OVERVIEW Overview * Data structures and operations described here are related to USB interface. @@ -171,7 +175,8 @@ * More details on featuring your application can be found from Feature List. * * @defgroup CAPI_USB_HOST_ENDPOINT_MODULE USB Endpoint - * @brief USB endpoint-related API + * @brief This API is used to handle tasks related to USB endpoints + * @details This API is used to handle tasks related to USB endpoints * @ingroup CAPI_USB_HOST_MODULE * @section CAPI_USB_HOST_ENDPOINT_MODULE_FEATURES Overview * Data structures and operations described here are related to USB endpoint. @@ -191,6 +196,7 @@ * * @defgroup CAPI_USB_HOST_SYNCIO_MODULE Synchronous IO * @brief This API is used to perform synchronous operations + * @details This API is used to perform synchronous operations * @ingroup CAPI_USB_HOST_MODULE * @section CAPI_USB_HOST_SYNCIO_MODULE_OVERVIEW Overview * A transfer is performed by single function call @@ -230,6 +236,7 @@ * * @defgroup CAPI_USB_HOST_HOTPLUG_MODULE Hotplug event notification * @brief This API is used to register callbacks to be called when devices are connected or disconnected. + * @details This API is used to register callbacks to be called when devices are connected or disconnected. * @ingroup CAPI_USB_HOST_MODULE * @section CAPI_USB_HOST_HOTPLUG_MODULE_OVERVIEW Overview * Functions described here can be used to register callbacks to be called on events such as @@ -237,6 +244,7 @@ * * @defgroup CAPI_USB_HOST_ASYNC_MODULE Asynchronous IO * @brief This API is used to perform asynchronous operations + * @details This API is used to perform asynchronous operations * @ingroup CAPI_USB_HOST_MODULE * @section CAPI_USB_HOST_ASYNC_MODULE_OVERVIEW Overview * Asynchronous transfers are performed by submitting previously prepared transfer handle (#usb_host_transfer_h). diff --git a/include/usb_host.h b/include/usb_host.h index 506e162..7491274 100644 --- a/include/usb_host.h +++ b/include/usb_host.h @@ -28,6 +28,7 @@ extern "C" { /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief An enumeration representing USB endpoint direction. + * @details Used to control whether an endpoint writes or reads data. * @since_tizen 3.0 */ typedef enum { @@ -38,6 +39,7 @@ typedef enum { /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief An enumeration representing USB endpoint transfer type. + * @details Used to control how a data transfer request is going to operate. * @since_tizen 3.0 */ typedef enum { @@ -50,6 +52,7 @@ typedef enum { /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Enumeration of isochronous endpoint's synchronization type. + * @details Used to control how a data transfer request is going to be synchronized. * @since_tizen 3.0 */ typedef enum { @@ -62,6 +65,7 @@ typedef enum { /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief An enumeration representing USB endpoint usage type. + * @details Used to control what sort of tasks an endpoint is up to. * @since_tizen 3.0 */ typedef enum { @@ -73,6 +77,7 @@ typedef enum { /** * @ingroup CAPI_USB_HOST_MODULE * @brief Enumeration of error codes reported by USB host API. + * @details Most USB Host functions will return those errors to denote what happened. * @since_tizen 3.0 */ typedef enum { @@ -96,6 +101,7 @@ typedef enum { /** * @ingroup CAPI_USB_HOST_HOTPLUG_MODULE * @brief An enumeration representing USB hotplug event types. + * @details Says whether a hotplug event was about attachment or detachment. * @since_tizen 4.0 */ typedef enum { @@ -107,6 +113,7 @@ typedef enum { /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief An enumeration representing USB async transfer status codes. + * @details Used to give the current status of a USB transfer handle. * @since_tizen 5.0 */ typedef enum { @@ -207,6 +214,7 @@ typedef struct usb_host_transfer_s *usb_host_transfer_h; /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief An type representing a USB transfer finish callback. + * @details Use to be notified for when a USB transfer is done. * @since_tizen 5.0 * @param[in] transfer Transfer for which this callback was set * @param[in] user_data User data pointer passed on callback registration @@ -294,7 +302,8 @@ int usb_host_free_device_list(usb_host_device_h *devs, bool unref_devices); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Increments the reference counter of given USB device - * @details Increment ref count of device. + * @details Increment ref count of device. If ref count reaches zero, + * device will be destroyed. * @since_tizen 3.0 * @param[in] dev Device to reference * @return 0 on success, error code otherwise @@ -422,7 +431,7 @@ int usb_host_device_get_port_numbers(usb_host_device_h dev, int *port_numbers, i /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets a USB configuration from a device given an index. - * @details Gets a USB configuration from a device. + * @details Gets a USB configuration from a device given an index. * @since_tizen 3.0 * @remarks @a config must be freed with usb_host_config_destroy(). * @param[in] dev Device @@ -460,7 +469,7 @@ int usb_host_get_active_config(usb_host_device_h dev, usb_host_config_h *config) /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Sets a configuration as the currently active on a device. - * @details Set active configuration for a device. + * @details Sets a configuration as the currently active on a device. * @since_tizen 3.0 * @param[in] configuration Handle to configuration to be activated * @return 0 on success, otherwise a negative error value @@ -477,6 +486,7 @@ int usb_host_set_config(usb_host_config_h configuration); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Returns a USB device back to the unconfigured state. + * @details Returns a USB device back to the unconfigured state. * @since_tizen 4.0 * @param[in] dev Device to be unconfigured * @return 0 on success, otherwise a negative error value @@ -507,6 +517,7 @@ int usb_host_device_get_bcd_usb(usb_host_device_h dev, int *bcd_usb); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets the numerical device class of given USB device. + * @details Gets the numerical device class of given USB device. * @since_tizen 3.0 * @param[in] dev A device * @param[out] device_class Device class @@ -520,6 +531,7 @@ int usb_host_device_get_class(usb_host_device_h dev, int *device_class); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets the numerical sub class of given USB device. + * @details Gets the numerical sub class of given USB device. * @since_tizen 3.0 * @param[in] dev A device * @param[out] subclass Device subclass @@ -533,6 +545,7 @@ int usb_host_device_get_sub_class(usb_host_device_h dev, int *subclass); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets the protocol being used by the given USB device. + * @details Gets the protocol being used by the given USB device. * @since_tizen 3.0 * @param[in] dev A device * @param[out] protocol Device protocol @@ -546,6 +559,7 @@ int usb_host_device_get_protocol(usb_host_device_h dev, int *protocol); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets the maximum packet size for endpoint 0 on given USB device. + * @details Gets the maximum packet size for endpoint 0 on given USB device. * @since_tizen 3.0 * @param[in] dev A device * @param[out] max_packet_size Maximum size of single packet, in bytes @@ -559,6 +573,7 @@ int usb_host_device_get_max_packet_size_0(usb_host_device_h dev, int *max_packet /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets the numerical vendor identifier of the given USB device. + * @details Gets the numerical vendor identifier of the given USB device. * @since_tizen 3.0 * @param[in] dev A device * @param[out] vendor_id Vendor id of @a dev @@ -572,6 +587,7 @@ int usb_host_device_get_id_vendor(usb_host_device_h dev, int *vendor_id); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets the numerical product identifier of the given USB device. + * @details Gets the numerical product identifier of the given USB device. * @since_tizen 3.0 * @param[in] dev A device * @param[out] product_id Product id of @a dev @@ -585,6 +601,7 @@ int usb_host_device_get_id_product(usb_host_device_h dev, int *product_id); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets device release number in binary-coded decimal. + * @details Gets device release number in binary-coded decimal. * @since_tizen 3.0 * @param[in] dev A device * @param[out] device_bcd Device release number @@ -598,6 +615,7 @@ int usb_host_device_get_bcd_device(usb_host_device_h dev, int *device_bcd); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets the number of configurations for given USB device. + * @details Gets the number of configurations for given USB device. * @since_tizen 3.0 * @param[in] dev A device * @param[out] num_configurations Number of configurations for given device @@ -611,6 +629,7 @@ int usb_host_device_get_num_configurations(usb_host_device_h dev, int *num_confi /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Checks whether given USB device is currently opened. + * @details Checks whether given USB device is currently opened. * @since_tizen 3.0 * @param[in] dev A device * @param[out] is_opened True if device is opened, false otherwise @@ -624,6 +643,7 @@ int usb_host_is_device_opened(usb_host_device_h dev, bool *is_opened); /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets string describing an open device's manufacturer, in ASCII. + * @details Gets string describing an open device's manufacturer, in ASCII. * @since_tizen 3.0 * @param[in] dev A handle to opened device * @param[in, out] length Data buffer size/how much was actually used @@ -640,6 +660,7 @@ int usb_host_device_get_manufacturer_str(usb_host_device_h dev, int *length, uns /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets product string of an open USB device, in ASCII. + * @details Gets product string of an open USB device, in ASCII. * @since_tizen 3.0 * @param[in] dev A handle to opened device * @param[in, out] length Data buffer size/how much was actually used @@ -656,6 +677,7 @@ int usb_host_device_get_product_str(usb_host_device_h dev, int *length, unsigned /** * @ingroup CAPI_USB_HOST_DEV_MODULE * @brief Gets the serial number of an open USB device, in ASCII. + * @details Gets the serial number of an open USB device, in ASCII. * @since_tizen 3.0 * @param[in] dev A handle to opened device * @param[in, out] length Data buffer size/how much was actually used @@ -672,6 +694,7 @@ int usb_host_device_get_serial_number_str(usb_host_device_h dev, int *length, un /** * @ingroup CAPI_USB_HOST_CONFIG_MODULE * @brief Gets number of interfaces for given configuration. + * @details Gets number of interfaces for given configuration. * @since_tizen 3.0 * @param[in] config A configuration * @param[out] num_interfaces Number of interfaces @@ -685,6 +708,7 @@ int usb_host_config_get_num_interfaces(usb_host_config_h config, int *num_interf /** * @ingroup CAPI_USB_HOST_CONFIG_MODULE * @brief Checks if device is self-powered in given configuration. + * @details Checks if device is self-powered in given configuration. * @since_tizen 3.0 * @param[in] config A configuration * @param[out] self_powered True if device is self-powered in given configuration, @@ -699,6 +723,7 @@ int usb_host_config_is_self_powered(usb_host_config_h config, bool *self_powered /** * @ingroup CAPI_USB_HOST_CONFIG_MODULE * @brief Checks if device in given configuration supports remote wakeup. + * @details Checks if device in given configuration supports remote wakeup. * @since_tizen 3.0 * @param[in] config A configuration * @param[out] remote_wakeup True if device supports remote wakeup in given configuration, @@ -713,6 +738,7 @@ int usb_host_config_support_remote_wakeup(usb_host_config_h config, bool *remote /** * @ingroup CAPI_USB_HOST_CONFIG_MODULE * @brief Gets maximum power in given USB configuration, in mA. + * @details Gets maximum power in given USB configuration, in mA. * @since_tizen 3.0 * @param[in] config A configuration * @param[out] max_power Maximum power, in mA @@ -726,6 +752,7 @@ int usb_host_config_get_max_power(usb_host_config_h config, int *max_power); /** * @ingroup CAPI_USB_HOST_CONFIG_MODULE * @brief Gets a string describing a USB configuration into given buffer. + * @details Gets a string describing a USB configuration into given buffer. * @since_tizen 3.0 * @param[in] config A configuration * @param[in, out] length Data buffer size/how much was actually used @@ -813,6 +840,7 @@ int usb_host_release_interface(usb_host_interface_h interface); /** * @ingroup CAPI_USB_HOST_INTERFACE_MODULE * @brief Gets the "number" of the given USB interface handle. + * @details Gets the "number" of the given USB interface handle. * @since_tizen 3.0 * @param[in] interface An interface * @param[out] number Number of given interface @@ -826,6 +854,7 @@ int usb_host_interface_get_number(usb_host_interface_h interface, int *number); /** * @ingroup CAPI_USB_HOST_INTERFACE_MODULE * @brief Gets the number of endpoints in given USB interface. + * @details Gets the number of endpoints in given USB interface. * @since_tizen 3.0 * @param[in] interface An interface * @param[out] num_endpoints Number of endpoints in @a interface @@ -839,7 +868,7 @@ int usb_host_interface_get_num_endpoints(usb_host_interface_h interface, int *nu /** * @ingroup CAPI_USB_HOST_INTERFACE_MODULE * @brief Gets an endpoint via index from given USB interface. - * @details Get a USB endpoint from interface by its index. + * @details Gets an endpoint via index from given USB interface. * @since_tizen 3.0 * @param[in] interface Interface handle * @param[in] ep_index index of endpoint to retrieve (counting from 0) @@ -856,6 +885,7 @@ int usb_host_interface_get_endpoint(usb_host_interface_h interface, int ep_index /** * @ingroup CAPI_USB_HOST_INTERFACE_MODULE * @brief Sets an alternative setting for given USB interface. + * @details Sets an alternative setting for given USB interface. * @since_tizen 3.0 * @param[in] interface Interface handle * @param[in] altsetting Index of new alternative setting for given interface @@ -868,6 +898,7 @@ int usb_host_interface_set_altsetting(usb_host_interface_h interface, int altset /** * @ingroup CAPI_USB_HOST_INTERFACE_MODULE * @brief Gets current alternative setting from an interface. + * @details Gets current alternative setting from an interface. * @since_tizen 4.0 * @param[in] interface Interface handle * @param[out] altsetting Index of alternative setting set for the given interface @@ -881,6 +912,7 @@ int usb_host_interface_get_altsetting(usb_host_interface_h interface, int *altse /** * @ingroup CAPI_USB_HOST_INTERFACE_MODULE * @brief Gets a string describing the given USB interface into a buffer. + * @details Gets a string describing the given USB interface into a buffer. * @since_tizen 3.0 * @param[in] interface An interface * @param[in, out] length Data buffer size/how much was actually used @@ -899,6 +931,7 @@ int usb_host_interface_get_str(usb_host_interface_h interface, int *length, /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Gets the "number" of the given USB endpoint handle. + * @details Gets the "number" of the given USB endpoint handle. * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] number Number of given endpoint @@ -912,6 +945,7 @@ int usb_host_endpoint_get_number(usb_host_endpoint_h ep, int *number); /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Gets the direction of the given USB endpoint handle. + * @details Gets the direction of the given USB endpoint handle. * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] direction Direction of endpoint (a value from enum #usb_host_endpoint_direction_e) @@ -925,6 +959,7 @@ int usb_host_endpoint_get_direction(usb_host_endpoint_h ep, usb_host_endpoint_di /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Gets transfer type of the given USB endpoint handle. + * @details Gets transfer type of the given USB endpoint handle. * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] transfer_type Transfer type (a value from enum #usb_host_transfer_type_e) @@ -938,6 +973,7 @@ int usb_host_endpoint_get_transfer_type(usb_host_endpoint_h ep, usb_host_transfe /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Gets synchronization type of given USB endpoint handle. + * @details Gets synchronization type of given USB endpoint handle. * @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) @@ -951,6 +987,7 @@ int usb_host_endpoint_get_synch_type(usb_host_endpoint_h ep, usb_host_iso_sync_t /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Gets the usage type of the given USB endpoint handle. + * @details Gets the usage type of the given USB endpoint handle. * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] usage_type Usage type (a value from enum #usb_host_usage_type_e) @@ -964,6 +1001,7 @@ int usb_host_endpoint_get_usage_type(usb_host_endpoint_h ep, usb_host_usage_type /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Gets max packet size from given USB endpoint handle. + * @details Gets max packet size from given USB endpoint handle. * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] max_packet_size Max packet size, in bytes @@ -976,6 +1014,7 @@ int usb_host_endpoint_get_max_packet_size(usb_host_endpoint_h ep, int *max_packe /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Gets interval for polling endpoint for data transfers. + * @details Gets interval for polling endpoint for data transfers. * @since_tizen 3.0 * @param[in] ep An endpoint * @param[out] interval Interval for polling, in frame counts (refer to USB protocol specification) @@ -1056,6 +1095,7 @@ int usb_host_transfer(usb_host_endpoint_h ep, unsigned char *data, int length, /** * @ingroup CAPI_USB_HOST_HOTPLUG_MODULE * @brief Sets a callback function to be invoked when a device is connected or disconnected. + * @details Sets a callback function to be invoked when a device is connected or disconnected. * @since_tizen 4.0 * @param[in] ctx Context handle * @param[in] cb The callback function to be registered @@ -1073,6 +1113,7 @@ int usb_host_set_hotplug_cb(usb_host_context_h ctx, usb_host_hotplug_cb cb, usb_ /** * @ingroup CAPI_USB_HOST_HOTPLUG_MODULE * @brief Unsets the (dis)connection hotplug callback function. + * @details Unsets the (dis)connection hotplug callback function. * @since_tizen 4.0 * @param[in] handle Handle of the callback to be unregistered * @return 0 on success, negative error code on error @@ -1250,6 +1291,7 @@ int usb_host_transfer_set_num_iso_packets(usb_host_transfer_h transfer, unsigned /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Sets request type for control transfer setup packet. + * @details Sets request type for control transfer setup packet. * @since_tizen 5.0 * @param[in] transfer A transfer handle * @param[in] bm_request_type bmRequestType type field for the setup packet @@ -1264,6 +1306,7 @@ int usb_host_control_transfer_set_request_type(usb_host_transfer_h transfer, uin /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Sets request field for control transfer setup packet. + * @details Sets request field for control transfer setup packet. * @since_tizen 5.0 * @param[in] transfer A transfer handle * @param[in] b_request Request field for the setup packet @@ -1278,6 +1321,7 @@ int usb_host_control_transfer_set_request(usb_host_transfer_h transfer, uint8_t /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Sets w_value field for control transfer setup packet. + * @details Sets w_value field for control transfer setup packet. * @since_tizen 5.0 * @param[in] transfer A transfer handle * @param[in] w_value wValue field for the setup packet @@ -1292,6 +1336,7 @@ int usb_host_control_transfer_set_value(usb_host_transfer_h transfer, uint16_t w /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Sets w_index field for control transfer setup packet. + * @details Sets w_index field for control transfer setup packet. * @since_tizen 5.0 * @param[in] transfer A transfer handle * @param[in] w_index wIndex field for the setup packet @@ -1306,6 +1351,7 @@ int usb_host_control_transfer_set_index(usb_host_transfer_h transfer, uint16_t w /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Gets the status of a transfer from a transfer handle. + * @details Gets the status of a transfer from a transfer handle. * @since_tizen 5.0 * @param[in] transfer Transfer handle * @param[out] status Status of this transfer @@ -1319,6 +1365,7 @@ int usb_host_transfer_get_status(usb_host_transfer_h transfer, int *status); /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Borrows a handle to the transfer data from a transfer handle. + * @details Borrows a handle to the transfer data from a transfer handle. * @since_tizen 5.0 * @remarks @a data is part of the transfer object and should not be released * separately. It should not be accessed after @a transfer is destroyed. @@ -1335,6 +1382,7 @@ int usb_host_transfer_get_data(usb_host_transfer_h transfer, unsigned char **dat /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Gets the *control* transfer data from a transfer handle. + * @details Gets the *control* transfer data from a transfer handle. * @since_tizen 5.0 * @remarks @a data is part of the transfer object and should not be released * separately. It should not be accessed after @a transfer is destroyed. @@ -1366,6 +1414,7 @@ int usb_host_transfer_get_length(usb_host_transfer_h transfer, unsigned int *len /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Gets number of isochronous packets for this transfer. + * @details Gets number of isochronous packets for this transfer. * @since_tizen 5.0 * @param[in] transfer Transfer handle * @param[out] num_iso_packets Number of isochronous packets @@ -1379,7 +1428,7 @@ int usb_host_transfer_get_num_iso_packets(usb_host_transfer_h transfer, unsigned /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Sets an isochronous individual packet length for a transfer handle. - * @details This function sets length of individual packet. + * @details Sets an isochronous individual packet length for a transfer handle. * @since_tizen 5.0 * @param[in] transfer Transfer handle * @param[in] packet_number Number of isochronous packet @@ -1396,6 +1445,7 @@ int usb_host_transfer_set_iso_packet_length(usb_host_transfer_h transfer, unsign /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Gets an isochronous packet status from a transfer handle. + * @details Gets an isochronous packet status from a transfer handle. * @since_tizen 5.0 * @param[in] transfer Transfer handle * @param[in] packet_number Number of isochronous packet @@ -1411,6 +1461,7 @@ int usb_host_transfer_get_iso_packet_status(usb_host_transfer_h transfer, unsign /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Gets data buffer of isochronous packet from a transfer handle. + * @details Gets data buffer of isochronous packet from a transfer handle. * @since_tizen 5.0 * @remarks @a data is part of the transfer object and should not be released * separately. It should not be accessed after @a transfer is destroyed. @@ -1429,6 +1480,7 @@ int usb_host_transfer_get_iso_packet_data(usb_host_transfer_h transfer, unsigned /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Gets isochronous packet data buffer length from a transfer handle. + * @details Gets isochronous packet data buffer length from a transfer handle. * @since_tizen 5.0 * @param[in] transfer Transfer handle * @param[in] packet_number Number of isochronous packet @@ -1444,6 +1496,7 @@ int usb_host_transfer_get_iso_packet_length(usb_host_transfer_h transfer, unsign /** * @ingroup CAPI_USB_HOST_ENDPOINT_MODULE * @brief Gets type of a transfer from a given transfer handle. + * @details Gets type of a transfer from a given transfer handle. * @since_tizen 5.0 * @param[in] transfer Transfer handle * @param[out] transfer_type Transfer type (a value from enum #usb_host_transfer_type_e) @@ -1472,7 +1525,7 @@ int usb_host_transfer_destroy(usb_host_transfer_h transfer); /** * @ingroup CAPI_USB_HOST_ASYNC_MODULE * @brief Submits an initialized, asynchronous USB transfer. - * @details Calling this will start actual transfer. + * @details Submits an initialized, asynchronous USB transfer. Calling this will start actual transfer. * @since_tizen 5.0 * @param[in] transfer Transfer handle to be submitted * @return 0 on success, negative error code on error