From 9ca0cbee549562738ac79c21b1470d568e5cab09 Mon Sep 17 00:00:00 2001 From: Segwon Date: Wed, 25 Oct 2017 15:49:54 +0900 Subject: [PATCH] doc: changed the word 'device' to the correct meaning. Change-Id: I770f16fee6e36e17c285632d5b5c8e5ef4f9bde5 Signed-off-by: Segwon --- doc/peripheral_io_doc.h | 42 ++++++++++++++++++++--------------------- include/peripheral_io.h | 32 +++++++++++++++---------------- 2 files changed, 37 insertions(+), 37 deletions(-) diff --git a/doc/peripheral_io_doc.h b/doc/peripheral_io_doc.h index bad2569..6741d54 100644 --- a/doc/peripheral_io_doc.h +++ b/doc/peripheral_io_doc.h @@ -17,7 +17,7 @@ /** * @ingroup CAPI_SYSTEM_FRAMEWORK * @defgroup CAPI_SYSTEM_PERIPHERAL_IO_MODULE Peripheral IO - * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_MODULE API provides functions to make use of peripherals in the device. + * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_MODULE API provides functions to make use of peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_MODULE_HEADER Required Header * \#include @@ -31,14 +31,14 @@ /** * @ingroup CAPI_SYSTEM_PERIPHERAL_IO_MODULE * @defgroup CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE GPIO - * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE API provides functions to control GPIO in the device. + * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE API provides functions to control GPIO peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE_HEADER Required Header * \#include * * @section CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE_OVERVIEW Overview * - * This @ref CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE API provides functions to control GPIO in the device. + * This @ref CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE API provides functions to control GPIO peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE_FEATURE Realted Features * @@ -47,10 +47,10 @@ * * It is recommended to use features in your application for reliability.\n * - * You can check if a device supports the related features for this API \n + * You can check if a IoT device supports the related features for this API \n * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n * - * To ensure your application is only running on the device with specific features, \n + * To ensure your application is only running on the IoT device with specific features, \n * please define the features in your manifest file using the manifest editor in the SDK.\n * * More details on featuring your application can be found from Feature Element. @@ -60,14 +60,14 @@ /** * @ingroup CAPI_SYSTEM_PERIPHERAL_IO_MODULE * @defgroup CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE I2C - * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE API provides functions to control I2C in the device. + * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE API provides functions to control I2C peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE_HEADER Required Header * \#include * * @section CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE_OVERVIEW Overview * - * This @ref CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE API provides functions to control I2C in the device. + * This @ref CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE API provides functions to control I2C peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE_FEATURE Realted Features * @@ -76,10 +76,10 @@ * * It is recommended to use features in your application for reliability.\n * - * You can check if a device supports the related features for this API \n + * You can check if a IoT device supports the related features for this API \n * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n * - * To ensure your application is only running on the device with specific features, \n + * To ensure your application is only running on the IoT device with specific features, \n * please define the features in your manifest file using the manifest editor in the SDK.\n * * More details on featuring your application can be found from Feature Element. @@ -89,14 +89,14 @@ /** * @ingroup CAPI_SYSTEM_PERIPHERAL_IO_MODULE * @defgroup CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE SPI - * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE API provides functions to control SPI in the device. + * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE API provides functions to control SPI peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE_HEADER Required Header * \#include * * @section CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE_OVERVIEW Overview * - * This @ref CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE API provides functions to control SPI in the device. + * This @ref CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE API provides functions to control SPI peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE_FEATURE Realted Features * @@ -105,10 +105,10 @@ * * It is recommended to use features in your application for reliability.\n * - * You can check if a device supports the related features for this API \n + * You can check if a IoT device supports the related features for this API \n * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n * - * To ensure your application is only running on the device with specific features, \n + * To ensure your application is only running on the IoT device with specific features, \n * please define the features in your manifest file using the manifest editor in the SDK.\n * * More details on featuring your application can be found from Feature Element. @@ -118,14 +118,14 @@ /** * @ingroup CAPI_SYSTEM_PERIPHERAL_IO_MODULE * @defgroup CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE UART - * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE API provides functions to control UART in the device. + * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE API provides functions to control UART peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE_HEADER Required Header * \#include * * @section CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE_OVERVIEW Overview * - * This @ref CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE API provides functions to control UART in the device. + * This @ref CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE API provides functions to control UART peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE_FEATURE Realted Features * @@ -134,10 +134,10 @@ * * It is recommended to use features in your application for reliability.\n * - * You can check if a device supports the related features for this API \n + * You can check if a IoT device supports the related features for this API \n * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n * - * To ensure your application is only running on the device with specific features, \n + * To ensure your application is only running on the IoT device with specific features, \n * please define the features in your manifest file using the manifest editor in the SDK.\n * * More details on featuring your application can be found from Feature Element. @@ -147,14 +147,14 @@ /** * @ingroup CAPI_SYSTEM_PERIPHERAL_IO_MODULE * @defgroup CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE PWM - * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE API provides functions to control PWM in the device. + * @brief The @ref CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE API provides functions to control PWM peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE_HEADER Required Header * \#include * * @section CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE_OVERVIEW Overview * - * This @ref CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE API provides functions to control PWM in the device. + * This @ref CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE API provides functions to control PWM peripherals connected to the IoT device. * * @section CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE_FEATURE Realted Features * @@ -163,10 +163,10 @@ * * It is recommended to use features in your application for reliability.\n * - * You can check if a device supports the related features for this API \n + * You can check if a IoT device supports the related features for this API \n * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n * - * To ensure your application is only running on the device with specific features, \n + * To ensure your application is only running on the IoT device with specific features, \n * please define the features in your manifest file using the manifest editor in the SDK.\n * * More details on featuring your application can be found from Feature Element. diff --git a/include/peripheral_io.h b/include/peripheral_io.h index 7ff48d4..bb11f34 100644 --- a/include/peripheral_io.h +++ b/include/peripheral_io.h @@ -491,7 +491,7 @@ int peripheral_i2c_write_register_word(peripheral_i2c_h i2c, uint8_t reg, uint16 */ /** - * @brief The handle of the PWM device. + * @brief The handle of the PWM peripherals. * @since_tizen 4.0 */ typedef struct _peripheral_pwm_s *peripheral_pwm_h; @@ -650,7 +650,7 @@ int peripheral_pwm_set_enabled(peripheral_pwm_h pwm, bool enabled); */ /** - * @brief The handle to the UART device. + * @brief The handle to the UART peripherals. * @since_tizen 4.0 */ typedef struct _peripheral_uart_s *peripheral_uart_h; @@ -783,7 +783,7 @@ int peripheral_uart_close(peripheral_uart_h uart); * @privilege http://tizen.org/privilege/peripheralio * * @param[in] uart The UART handle - * @param[in] baud Baud rate of the UART device + * @param[in] baud Baud rate of the UART slave device * * @return 0 on success, otherwise a negative error value * @retval #PERIPHERAL_ERROR_NONE Successful @@ -806,7 +806,7 @@ int peripheral_uart_set_baud_rate(peripheral_uart_h uart, peripheral_uart_baud_r * @privilege http://tizen.org/privilege/peripheralio * * @param[in] uart The UART handle - * @param[in] byte_size Byte size of the UART device + * @param[in] byte_size Byte size of the UART slave device * * @return 0 on success, otherwise a negative error value * @retval #PERIPHERAL_ERROR_NONE Successful @@ -829,7 +829,7 @@ int peripheral_uart_set_byte_size(peripheral_uart_h uart, peripheral_uart_byte_s * @privilege http://tizen.org/privilege/peripheralio * * @param[in] uart The UART handle - * @param[in] parity Parity bit of the UART device + * @param[in] parity Parity bit of the UART slave device * * @return 0 on success, otherwise a negative error value * @retval #PERIPHERAL_ERROR_NONE Successful @@ -852,7 +852,7 @@ int peripheral_uart_set_parity(peripheral_uart_h uart, peripheral_uart_parity_e * @privilege http://tizen.org/privilege/peripheralio * * @param[in] uart The UART handle - * @param[in] stop_bits Stop bits of the UART device + * @param[in] stop_bits Stop bits of the UART slave device * * @return 0 on success, otherwise a negative error value * @retval #PERIPHERAL_ERROR_NONE Successful @@ -952,7 +952,7 @@ int peripheral_uart_write(peripheral_uart_h uart, uint8_t *data, uint32_t length */ /** - * @brief The handle of a SPI device. + * @brief The handle of a SPI peripherals. * @since_tizen 4.0 */ typedef struct _peripheral_spi_s *peripheral_spi_h; @@ -987,7 +987,7 @@ typedef enum { * * @param[in] bus The SPI bus number * @param[in] cs The SPI chip select number - * @param[out] spi The SPI device handle + * @param[out] spi The SPI slave device handle * * @return 0 on success, otherwise a negative error value * @retval #PERIPHERAL_ERROR_NONE Successful @@ -1011,7 +1011,7 @@ int peripheral_spi_open(int bus, int cs, peripheral_spi_h *spi); * @privlevel platform * @privilege http://tizen.org/privilege/peripheralio * - * @param[in] spi The SPI device handle + * @param[in] spi The SPI slave device handle * * @return 0 on success, otherwise a negative error value * @retval #PERIPHERAL_ERROR_NONE Successful @@ -1033,7 +1033,7 @@ int peripheral_spi_close(peripheral_spi_h spi); * @privlevel platform * @privilege http://tizen.org/privilege/peripheralio * - * @param[in] spi The SPI device handle + * @param[in] spi The SPI slave device handle * @param[in] mode The SPI transfer mode * * @return 0 on success, otherwise a negative error value @@ -1056,7 +1056,7 @@ int peripheral_spi_set_mode(peripheral_spi_h spi, peripheral_spi_mode_e mode); * @privlevel platform * @privilege http://tizen.org/privilege/peripheralio * - * @param[in] spi The SPI device handle + * @param[in] spi The SPI slave device handle * @param[in] bit_order The transfer bit order * * @return 0 on success, otherwise a negative error value @@ -1079,7 +1079,7 @@ int peripheral_spi_set_bit_order(peripheral_spi_h spi, peripheral_spi_bit_order_ * @privlevel platform * @privilege http://tizen.org/privilege/peripheralio * - * @param[in] spi The SPI device handle + * @param[in] spi The SPI slave device handle * @param[in] bits The number of bits per word (in bits) * * @return 0 on success, otherwise a negative error value @@ -1101,7 +1101,7 @@ int peripheral_spi_set_bits_per_word(peripheral_spi_h spi, uint8_t bits); * @privilege http://tizen.org/privilege/peripheralio * @remarks The frequencies supported are board dependent. * - * @param[in] spi The SPI device handle + * @param[in] spi The SPI slave device handle * @param[in] freq_hz Frequency to set (in Hz) * * @return 0 on success, otherwise a negative error value @@ -1122,7 +1122,7 @@ int peripheral_spi_set_frequency(peripheral_spi_h spi, uint32_t freq_hz); * @privlevel platform * @privilege http://tizen.org/privilege/peripheralio * - * @param[in] spi The SPI device handle + * @param[in] spi The SPI slave device handle * @param[out] data The data buffer to read * @param[in] length The size of data buffer (in bytes) * @@ -1146,7 +1146,7 @@ int peripheral_spi_read(peripheral_spi_h spi, uint8_t *data, uint32_t length); * @privlevel platform * @privilege http://tizen.org/privilege/peripheralio * - * @param[in] spi The SPI device handle + * @param[in] spi The SPI slave device handle * @param[in] data The data buffer to write * @param[in] length The size of data buffer (in bytes) * @@ -1170,7 +1170,7 @@ int peripheral_spi_write(peripheral_spi_h spi, uint8_t *data, uint32_t length); * @privlevel platform * @privilege http://tizen.org/privilege/peripheralio * - * @param[in] spi The SPI device handle + * @param[in] spi The SPI slave device handle * @param[in] txdata The data buffer to write * @param[out] rxdata The data buffer to read * @param[in] length The size of txdata and rxdata buffer (in bytes) -- 2.34.1