Fix minor documentation issues

Change-Id: I0d2c0f09e8e93b9f623c01a591b0b5f840eebb2c
Signed-off-by: Michal Bloch <m.bloch@samsung.com>

diff --git a/doc/usb_host_doc.h b/doc/usb_host_doc.h
index 02100ead40cf9d806b555d099e236046cce9e600..0e72e0d14d600766f972ee1dfed6ccb4e7139978 100644 (file)
--- a/doc/usb_host_doc.h
+++ b/doc/usb_host_doc.h
@@ -36,7 +36,7 @@
  * Before using any of usb_host API functions you must initialize API context.
  * Also you must cleanup context after using USB host API.
  *
- * @section CAPI_USB_HOST_MOUDLE_FEATURES Related Features
+ * @section CAPI_USB_HOST_MODULE_FEATURES Related Features
  * This API is related with the following features:
  *  - %http://tizen.org/feature/usb.host
  *
@@ -52,10 +52,10 @@
  * @defgroup CAPI_USB_HOST_DEV_MODULE USB Host Device
  * @brief This API is used to manage USB devices
  * @ingroup CAPI_USB_HOST_MODULE
- * @section CAPI_USB_HOST_DEV_MOUDLE_OVERVIEW Overview
+ * @section CAPI_USB_HOST_DEV_MODULE_OVERVIEW Overview
  * Operations described here help with enumerating, opening and closing devices.
  *
- * @section CAPI_USB_HOST_DEV_MOUDLE_OPENING Opening a device node
+ * @section CAPI_USB_HOST_DEV_MODULE_OPENING Opening a device node
  * In order to communicate with device, you must open a device.
  * The easiest way to do this is to use usb_host_device_open_with_vid_pid() function.
  * However, it is not recommended in most of real-life applications, since there can be more than
@@ -89,8 +89,8 @@
  * The example code above shows how to open a device for communication and clean up
  * allocated resources afterwards.
  * First, we iterate through all connected devices looking for the one we want to communicate with.
- * The check() function can be implemented based on any device parameters. Use usb_host_get_*
- * functions to get these parameters, e.g. usb_host_get_device_descriptor().
+ * The check() function can be implemented based on any device parameters. Use usb_host_device_get_*
+ * functions to get these parameters, e.g. usb_host_device_get_id_vendor().
  * If we found a device, we can open it by usb_host_device_open() and perform
  * communication with it.
  * After performing communication we should close device and free device list.
@@ -100,12 +100,12 @@
  * 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
+ * Devices reached by calling usb_host_get_device_list() have a reference count of
  * 1, and usb_host_free_device_list() 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
+ * @section CAPI_USB_HOST_DEV_MODULE_PREPARING Preparing Communication
  * Before communicating with device, you should claim the interface you want to communicate
  * on. Kernel driver can be attached to the interface and you should detach it if you want
  * to use that interface. You can do it directly by calling usb_host_kernel_driver_active() and
@@ -121,7 +121,7 @@
  * Remember to release claimed interfaces after communication and re-attach manually detached
  * kernel drivers.
  *
- * @section CAPI_USB_HOST_DEV_MOUDLE_FEATURES Related Features
+ * @section CAPI_USB_HOST_DEV_MODULE_FEATURES Related Features
  * This API is related with the following features:
  *  - %http://tizen.org/feature/usb.host
  *
@@ -139,7 +139,7 @@
  * @section CAPI_USB_HOST_CONFIG_MODULE_OVERVIEW Overview
  * Data structures and operations described here are related to USB configuration.
  *
- * @section CAPI_USB_HOST_CONFIG_MOUDLE_FEATURES Related Features
+ * @section CAPI_USB_HOST_CONFIG_MODULE_FEATURES Related Features
  * This API is related with the following features:
  *  - %http://tizen.org/feature/usb.host
  *
@@ -158,7 +158,7 @@
  * Data structures and operations described here are related to USB interface.
  * Each interface has number of endpoints used for performing transfer operations.
  *
- * @section CAPI_USB_HOST_INTERFACE_MOUDLE_FEATURES Related Features
+ * @section CAPI_USB_HOST_INTERFACE_MODULE_FEATURES Related Features
  * This API is related with the following features:
  *  - %http://tizen.org/feature/usb.host
  *
@@ -173,11 +173,11 @@
  * @defgroup CAPI_USB_HOST_ENDPOINT_MODULE USB Endpoint
  * @brief USB endpoint-related API
  * @ingroup CAPI_USB_HOST_MODULE
- * @section CAPI_USB_HOST_INTERFACE_MODULE_OVERVIEW Overview
+ * @section CAPI_USB_HOST_ENDPOINT_MODULE_FEATURES Overview
  * Data structures and operations described here are related to USB endpoint.
  * Endpoints are used to perform USB transfers.
  *
- * @section CAPI_USB_HOST_ENDPOINT_MOUDLE_FEATURES Related Features
+ * @section CAPI_USB_HOST_ENDPOINT_MODULE_FEATURES Related Features
  * This API is related with the following features:
  *  - %http://tizen.org/feature/usb.host
  *
@@ -216,7 +216,7 @@
  * In this example data buffer contains data received from device. Value of transfered
  * is set to the number of received bytes.
  *
- * @section CAPI_USB_HOST_SYNCIO_MOUDLE_FEATURES Related Features
+ * @section CAPI_USB_HOST_SYNCIO_MODULE_FEATURES Related Features
  * This API is related with the following features:
  *  - %http://tizen.org/feature/usb.host
  *

diff --git a/include/usb_host.h b/include/usb_host.h
index 566fded9895875dcff9873f49b0d512b1e31576e..79f3cd6117275ac97832f12725fd4c4eb22ccccb 100644 (file)
--- a/include/usb_host.h
+++ b/include/usb_host.h
@@ -141,7 +141,7 @@ typedef struct usb_host_context_s *usb_host_context_h;
  * @details This structure represents USB device found on USB bus.
  *
  * This can be obtained by usb_host_get_device_list() or usb_host_device_open_with_vid_pid().
- * Some basic operations can be performed on closed device obtained by usb_host_device_list().
+ * Some basic operations can be performed on closed device obtained by usb_host_get_device_list().
  * To perform any I/O operations the device must be opened by calling usb_host_device_open()
  * or usb_host_device_open_with_vid_pid().
  *
@@ -705,7 +705,7 @@ int usb_host_config_is_self_powered(usb_host_config_h config, bool *self_powered
  * false otherwise
  * @return 0 on success, negative error code otherwise
  * @retval #USB_HOST_ERROR_NONE Successful
- * @retval @USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
+ * @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
  * @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
  */
 int usb_host_config_support_remote_wakeup(usb_host_config_h config, bool *remote_wakeup);