From: Kunhoon Baik <knhoon.baik@samsung.com>
Date: Thu, 24 Nov 2016 09:08:43 +0000 (+0900)
Subject: Fix API reference warning - several fixes
X-Git-Tag: submit/tizen_3.0/20161128.140207^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=fde9dd056f8a49aa7c83a52cad23346a1abfcfd8;p=platform%2Fcore%2Fapi%2Fusb-host.git

Fix API reference warning - several fixes

Change-Id: I6b68af3d69c620bd6f0b8081e216a2882912f7ef
---

diff --git a/include/usb_host.h b/include/usb_host.h
index ec11f6d..f8b761c 100644
--- a/include/usb_host.h
+++ b/include/usb_host.h
@@ -71,6 +71,7 @@ typedef enum {
 } usb_host_usage_type_e;
 
 /**
+ * @ingroup CAPI_USB_HOST_MODULE
  * @brief Enumeration of error codes reported by USB host API.
  * @since_tizen 3.0
  */
@@ -481,7 +482,7 @@ int usb_host_device_get_max_packet_size_0(usb_host_device_h dev, int *max_packet
  * @brief Gets vendor id.
  * @since_tizen 3.0
  * @param[in] dev A device
- * @param[out] vendor_id Vendor id of @dev
+ * @param[out] vendor_id Vendor id of @a dev
  * @return 0 on success, otherwise a negative error value
  * @retval #USB_HOST_ERROR_NONE Successful
  * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
@@ -705,7 +706,7 @@ int usb_host_config_destroy(usb_host_config_h config);
  * Remember to call usb_host_release_interface() when communication
  * with the device is finished.
  * @since_tizen 3.0
- * @param[in] interface_number The bInterfaceNumber of interface to claim
+ * @param[in] interface The bInterfaceNumber of interface to claim
  * @param[in] force Set to true to auto detach kernel driver, set to false to not detach it
  * @return 0 on success, otherwise a negative error value
  * @retval #USB_HOST_ERROR_NONE Successful
@@ -724,7 +725,7 @@ int usb_host_claim_interface(usb_host_interface_h interface, bool force);
  * @details Releases interface previously claimed by usb_host_claim_interface().
  * This is a blocking function.
  * @since_tizen 3.0
- * @param[in] interface_number The bInterfaceNumber of interface to release
+ * @param[in] interface The bInterfaceNumber of interface to release
  * @return 0 on success, otherwise a negative error value
  * @retval #USB_HOST_ERROR_NONE Successful
  * @retval #USB_HOST_ERROR_NOT_FOUND Interface was not claimed
@@ -768,7 +769,7 @@ int usb_host_interface_get_num_endpoints(usb_host_interface_h interface, int *nu
  * @details Get a USB endpoint from interface by its index.
  * @since_tizen 3.0
  * @param[in] interface Interface handle
- * @param[in] config_index index of endpoint to retrieve (counting from 0)
+ * @param[in] ep_index index of endpoint to retrieve (counting from 0)
  * @param[out] ep Endpoint handle
  * @remarks @a ep handle is no longer valid when config will be destroyed. There is no need to destroy it,
  * it is done automatically when the configuration is destroyed.
@@ -796,7 +797,7 @@ int usb_host_interface_set_altsetting(usb_host_interface_h interface, int altset
  * @brief Gets string describing an interface.
  * @since_tizen 3.0
  * @param[in] interface An interface
- * @param[in/out] length Data buffer size/how much was actually used
+ * @param[in, out] length Data buffer size/how much was actually used
  * @param[out] data Buffer to store string
  * @return 0 on success, otherwise a negative error value
  * @retval #USB_HOST_ERROR_NONE Successful
@@ -907,7 +908,7 @@ int usb_host_endpoint_get_interval(usb_host_endpoint_h ep, int *interval);
  * @since_tizen 3.0
  * @remarks The wValue, wIndex and wLength fields values should be given in host-endian
  * byte order.
- * @param[in] handle Device handle
+ * @param[in] dev Device handle
  * @param[in] bm_request_type bmRequestType type field for the setup packet
  * @param[in] b_request bRequest field for the setup packet
  * @param[in] w_value wValue field for the setup packet