From: Michal Bloch <m.bloch@samsung.com>
Date: Wed, 25 Sep 2024 19:06:23 +0000 (+0200)
Subject: Add some 50+ char @details docs
X-Git-Tag: accepted/tizen/unified/20241001.004115^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Faccepted%2Ftizen_unified_toolchain;p=platform%2Fcore%2Fapi%2Fperipheral-io.git

Add some 50+ char @details docs

Some of them overlap with @briefs because there isn't really much to say.

Change-Id: Iedfe1b5c1f36952efddc181e6c1469b2beed9070
---

diff --git a/doc/peripheral_io_doc.h b/doc/peripheral_io_doc.h
index 4f6f083..f6660c5 100644
--- a/doc/peripheral_io_doc.h
+++ b/doc/peripheral_io_doc.h
@@ -18,6 +18,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 connected to the IoT device.
+ * @details   The @ref CAPI_SYSTEM_PERIPHERAL_IO_MODULE API provides access to the low level device providers, including GPIO, I2C, PWM, ADC, UART and SPI.
  *
  * @section   CAPI_SYSTEM_PERIPHERAL_IO_MODULE_HEADER Required Header
  *            \#include <peripheral_io.h>
@@ -32,6 +33,7 @@
  * @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 peripherals connected to the IoT device.
+ * @details   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 <peripheral_io.h>
@@ -40,7 +42,7 @@
  *
  * 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
+ * @section   CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE_FEATURE Related Features
  *
  * This API is related with the following feature:\n
  * - http://tizen.org/feature/peripheral_io.gpio\n
@@ -61,6 +63,7 @@
  * @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 peripherals connected to the IoT device.
+ * @details   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 <peripheral_io.h>
@@ -69,7 +72,7 @@
  *
  * 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
+ * @section   CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE_FEATURE Related Features
  *
  * This API is related with the following feature:\n
  * - http://tizen.org/feature/peripheral_io.i2c\n
@@ -90,6 +93,7 @@
  * @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 peripherals connected to the IoT device.
+ * @details   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 <peripheral_io.h>
@@ -119,6 +123,7 @@
  * @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 peripherals connected to the IoT device.
+ * @details   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 <peripheral_io.h>
@@ -148,6 +153,7 @@
  * @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 peripherals connected to the IoT device.
+ * @details   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 <peripheral_io.h>
@@ -177,6 +183,7 @@
  * @ingroup   CAPI_SYSTEM_PERIPHERAL_IO_MODULE
  * @defgroup  CAPI_SYSTEM_PERIPHERAL_IO_ADC_MODULE ADC
  * @brief     The @ref CAPI_SYSTEM_PERIPHERAL_IO_ADC_MODULE API provides functions to control ADC peripherals connected to the IoT device.
+ * @details   The @ref CAPI_SYSTEM_PERIPHERAL_IO_ADC_MODULE API provides functions to control ADC peripherals connected to the IoT device.
  *
  * @section   CAPI_SYSTEM_PERIPHERAL_IO_ADC_MODULE_HEADER Required Header
  *            \#include <peripheral_io.h>
diff --git a/include/peripheral_io.h b/include/peripheral_io.h
index 27985c3..b9d436b 100644
--- a/include/peripheral_io.h
+++ b/include/peripheral_io.h
@@ -32,10 +32,12 @@ extern "C" {
 /**
  * @file peripheral_io.h
  * @brief This file contains the public peripheral-io interface.
+ * @details Useful for controlling peripheral devices like sensors, servomotors and whatnot.
  */
 
 /**
  * @brief Enumeration for error codes returned by the peripheral-io API.
+ * @details Most peripheral-io API functions can return one of these codes to specify an error.
  * @since_tizen 4.0
  */
 typedef enum {
@@ -62,6 +64,7 @@ typedef enum {
 
 /**
  * @brief Enumeration representing GPIO device direction options.
+ * @details Some interfaces require you to specify whether data goes in or out.
  * @since_tizen 4.0
  */
 typedef enum {
@@ -72,6 +75,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for edge types for the GPIO interrupt.
+ * @details Some interfaces require you to specify what kind of signal edge produces an interrupt.
  * @since_tizen 4.0
  */
 typedef enum {
@@ -83,6 +87,7 @@ typedef enum {
 
 /**
  * @brief An opaque handle to an object representing a GPIO pin.
+ * @details A handle to a single GPIO pin, for use with most GPIO interfaces
  * @since_tizen 4.0
  */
 typedef struct _peripheral_gpio_s *peripheral_gpio_h;
@@ -90,6 +95,7 @@ typedef struct _peripheral_gpio_s *peripheral_gpio_h;
 /**
  * @platform
  * @brief Opens a GPIO pin and returns a handle representing it
+ * @details Starts the lifetime of the handle and allocates its needed resources.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -116,6 +122,7 @@ EXPORT_API int peripheral_gpio_open(int gpio_pin, peripheral_gpio_h *gpio);
 /**
  * @platform
  * @brief Closes a GPIO pin and frees the resources associated with the handle
+ * @details This function should be called at the end of the object's lifetime to avoid a memleak.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -138,6 +145,7 @@ EXPORT_API int peripheral_gpio_close(peripheral_gpio_h gpio);
 /**
  * @platform
  * @brief Sets the input/output direction of given GPIO pin.
+ * @details Sets whether data goes in or out on given GPIO pin.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -163,6 +171,7 @@ EXPORT_API int peripheral_gpio_set_direction(peripheral_gpio_h gpio, peripheral_
 /**
  * @platform
  * @brief Sets the input edge mode of given GPIO pin device.
+ * @details Changes which kind of edge mode the GPIO pin is in.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -212,6 +221,7 @@ typedef void(*peripheral_gpio_interrupted_cb)(peripheral_gpio_h gpio, peripheral
 /**
  * @platform
  * @brief Sets the GPIO interrupted callback to be invoked when the GPIO interrupt is triggered.
+ * @details Sets the GPIO interrupted callback to be invoked when the GPIO interrupt is triggered.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -235,6 +245,7 @@ EXPORT_API int peripheral_gpio_set_interrupted_cb(peripheral_gpio_h gpio, periph
 /**
  * @platform
  * @brief Unsets the GPIO interrupted callback invoked when the GPIO interrupt is triggered.
+ * @details Unsets the GPIO interrupted callback invoked when the GPIO interrupt is triggered.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -254,6 +265,7 @@ EXPORT_API int peripheral_gpio_unset_interrupted_cb(peripheral_gpio_h gpio);
 /**
  * @platform
  * @brief Gets the current value being exposed on the GPIO pin.
+ * @details Reads data from the GPIO pin to the specified address.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -277,6 +289,7 @@ EXPORT_API int peripheral_gpio_read(peripheral_gpio_h gpio, uint32_t *value);
 /**
  * @platform
  * @brief Sets the value to be exposed on the given GPIO pin.
+ * @details Writes data into the GPIO pin from the specified address.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -310,6 +323,7 @@ EXPORT_API int peripheral_gpio_write(peripheral_gpio_h gpio, uint32_t value);
 
 /**
  * @brief An opaque handle representing the I2C slave device.
+ * @details A handle to a single I2C slave device, for use with most I2C slave interfaces
  * @since_tizen 4.0
  */
 typedef struct _peripheral_i2c_s *peripheral_i2c_h;
@@ -317,6 +331,7 @@ typedef struct _peripheral_i2c_s *peripheral_i2c_h;
 /**
  * @platform
  * @brief Opens an I2C slave device and returns a handle representing it
+ * @details Starts the lifetime of the handle and allocates its needed resources.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -345,7 +360,7 @@ EXPORT_API int peripheral_i2c_open(int bus, int address, peripheral_i2c_h *i2c);
  * @brief Enumeration for open flags (bitmask) for an i2c device.
  * @since_tizen 6.5
  *
- * @remarks Enum values are supposed to be used as bitmask, where only one
+ * @details Enum values are supposed to be used as bitmask, where only one
  * value can be specified for following flag groups:
  * - locking mode - either #PERIPHERAL_OPEN_FLAGS_PRIVATE or #PERIPHERAL_OPEN_FLAGS_SHARED can be used
  *
@@ -361,6 +376,7 @@ typedef enum {
 /**
  * @platform
  * @brief Opens an I2C slave device and returns a representing handle
+ * @details Starts the lifetime of the handle and allocates its needed resources.
  * @since_tizen 6.5
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -389,6 +405,7 @@ EXPORT_API int peripheral_i2c_open_flags(int bus, int address, peripheral_open_f
 /**
  * @platform
  * @brief Closes an I2C slave device and frees resources associated with the handle.
+ * @details This function should be called at the end of the object's lifetime to avoid a memleak.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -409,6 +426,7 @@ EXPORT_API int peripheral_i2c_close(peripheral_i2c_h i2c);
 /**
  * @platform
  * @brief Reads the bytes data from the I2C slave device into a buffer
+ * @details Reads the bytes data from the I2C slave device into a buffer
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -432,6 +450,7 @@ EXPORT_API int peripheral_i2c_read(peripheral_i2c_h i2c, uint8_t *data, uint32_t
 /**
  * @platform
  * @brief Writes the bytes data from a buffer to the I2C slave device.
+ * @details Writes the bytes data from a buffer to the I2C slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -455,6 +474,7 @@ EXPORT_API int peripheral_i2c_write(peripheral_i2c_h i2c, uint8_t *data, uint32_
 /**
  * @platform
  * @brief Reads single byte data from the register of the I2C slave device.
+ * @details Reads single byte data from the register of the I2C slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -478,6 +498,7 @@ EXPORT_API int peripheral_i2c_read_register_byte(peripheral_i2c_h i2c, uint8_t r
 /**
  * @platform
  * @brief Writes single byte data to the register of the I2C slave device.
+ * @details Writes single byte data to the register of the I2C slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -501,6 +522,7 @@ EXPORT_API int peripheral_i2c_write_register_byte(peripheral_i2c_h i2c, uint8_t
 /**
  * @platform
  * @brief Reads word data from the register of the I2C slave device.
+ * @details Reads word data from the register of the I2C slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -524,6 +546,7 @@ EXPORT_API int peripheral_i2c_read_register_word(peripheral_i2c_h i2c, uint8_t r
 /**
  * @platform
  * @brief Writes word data to the register of the I2C slave device.
+ * @details Writes word data to the register of the I2C slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -555,12 +578,14 @@ EXPORT_API int peripheral_i2c_write_register_word(peripheral_i2c_h i2c, uint8_t
 
 /**
  * @brief An opaque handle representing a PWM peripherals pin.
+ * @details A handle to a single PWM peripherals pin, for use with most PWM interfaces
  * @since_tizen 4.0
  */
 typedef struct _peripheral_pwm_s *peripheral_pwm_h;
 
 /**
  * @brief Enumeration for representing PWN active signal Polarity.
+ * @details Controls whether an active PWM signal has high or low/inversed polarity.
  * @since_tizen 4.0
  */
 typedef enum {
@@ -571,6 +596,7 @@ typedef enum {
 /**
  * @platform
  * @brief Opens the PWM pin and returns a handle representing it
+ * @details Starts the lifetime of the handle and allocates its needed resources.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -598,6 +624,7 @@ EXPORT_API int peripheral_pwm_open(int chip, int pin, peripheral_pwm_h *pwm);
 /**
  * @platform
  * @brief Closes a PWM pin and frees resources associated with the handle.
+ * @details This function should be called at the end of the object's lifetime to avoid a memleak.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -620,6 +647,7 @@ EXPORT_API int peripheral_pwm_close(peripheral_pwm_h pwm);
 /**
  * @platform
  * @brief Sets the period length in nanoseconds for the given PWM pin.
+ * @details Sets the period length in nanoseconds for the given PWM pin.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -641,6 +669,7 @@ EXPORT_API int peripheral_pwm_set_period(peripheral_pwm_h pwm, uint32_t period_n
 /**
  * @platform
  * @brief Sets the length of a duty cycle of the given PWM pin.
+ * @details Sets the length of a duty cycle of the given PWM pin.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -662,6 +691,7 @@ EXPORT_API int peripheral_pwm_set_duty_cycle(peripheral_pwm_h pwm, uint32_t duty
 /**
  * @platform
  * @brief Sets the active signal polarity of the given PWM pin.
+ * @details Sets the active signal polarity of the given PWM pin.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -685,6 +715,7 @@ EXPORT_API int peripheral_pwm_set_polarity(peripheral_pwm_h pwm, peripheral_pwm_
 /**
  * @platform
  * @brief Toggles whether given PWM peripherals pin is enabled.
+ * @details Toggles whether given PWM peripherals pin is enabled.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -714,6 +745,7 @@ EXPORT_API int peripheral_pwm_set_enabled(peripheral_pwm_h pwm, bool enabled);
 
 /**
  * @brief An opaque handle representing an ADC peripherals pin.
+ * @details A handle to a single ADC pin, for use with most ADC interfaces
  * @since_tizen 5.0
  */
 typedef struct _peripheral_adc_s *peripheral_adc_h;
@@ -721,6 +753,7 @@ typedef struct _peripheral_adc_s *peripheral_adc_h;
 /**
  * @platform
  * @brief Opens the ADC pin and returns a handle representing it
+ * @details Starts the lifetime of the handle and allocates its needed resources.
  * @since_tizen 5.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -748,6 +781,7 @@ EXPORT_API int peripheral_adc_open(int device, int channel, peripheral_adc_h *ad
 /**
  * @platform
  * @brief Closes the ADC pin and frees the resources associated with it.
+ * @details This function should be called at the end of the object's lifetime to avoid a memleak.
  * @since_tizen 5.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -770,6 +804,7 @@ EXPORT_API int peripheral_adc_close(peripheral_adc_h adc);
 /**
  * @platform
  * @brief Gets the current value of the ADC peripherals pin.
+ * @details Gets the current value of the ADC peripherals pin.
  * @since_tizen 5.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -800,12 +835,14 @@ EXPORT_API int peripheral_adc_read(peripheral_adc_h adc, uint32_t *value);
 
 /**
  * @brief An opaque handle representing a UART peripherals device.
+ * @details A handle to a single UART slave device, for use with most UART peripherals interfaces
  * @since_tizen 4.0
  */
 typedef struct _peripheral_uart_s *peripheral_uart_h;
 
 /**
  * @brief Enumeration for signal baud rate for UART slave devices.
+ * @details Controls the baud rate, i.e. signals per second on a UART device
  * @since_tizen 4.0
  */
 typedef enum {
@@ -832,6 +869,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for data byte size for UART slave devices.
+ * @details Controls how many bits per byte are there for data, on UART slave devices.
  * @since_tizen 4.0
  */
 typedef enum {
@@ -843,6 +881,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for parity bit for UART slave devices.
+ * @details Controls whether parity is even, odd, or none for UART devices
  * @since_tizen 4.0
  */
 typedef enum {
@@ -853,6 +892,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for the number of stop bits for UART slave devices.
+ * @details Controls whether there is one or two stop bits for UART devices
  * @since_tizen 4.0
  */
 typedef enum {
@@ -862,6 +902,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for hardware flow control for UART slave devices.
+ * @details Controls details of the hardware flow control on UART devices
  * @since_tizen 4.0
  */
 typedef enum {
@@ -871,6 +912,7 @@ typedef enum {
 
 /**
  * @brief Enumeration for software flow control for UART slave devices.
+ * @details Controls details of the software flow control on UART devices
  * @since_tizen 4.0
  */
 typedef enum {
@@ -881,6 +923,7 @@ typedef enum {
 /**
  * @platform
  * @brief Opens the UART slave device and returns a handle representing it
+ * @details Starts the lifetime of the handle and allocates its needed resources.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -907,6 +950,7 @@ EXPORT_API int peripheral_uart_open(int port, peripheral_uart_h *uart);
 /**
  * @platform
  * @brief Opens the UART slave device using specified open flags, and returns a handle representing it
+ * @details Starts the lifetime of the handle and allocates its needed resources.
  * @since_tizen 6.5
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -934,6 +978,7 @@ EXPORT_API int peripheral_uart_open_flags(int port, peripheral_open_flags_e flag
 /**
  * @platform
  * @brief Closes the UART slave device and frees resources associated with the handle.
+ * @details This function should be called at the end of the object's lifetime to avoid a memleak.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -954,6 +999,7 @@ EXPORT_API int peripheral_uart_close(peripheral_uart_h uart);
 /**
  * @platform
  * @brief Sets the baud rate for the given UART slave device.
+ * @details Sets the baud rate for the given UART slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -977,6 +1023,7 @@ EXPORT_API int peripheral_uart_set_baud_rate(peripheral_uart_h uart, peripheral_
 /**
  * @platform
  * @brief Sets data byte size for the given UART slave device.
+ * @details Sets data byte size for the given UART slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1000,6 +1047,7 @@ EXPORT_API int peripheral_uart_set_byte_size(peripheral_uart_h uart, peripheral_
 /**
  * @platform
  * @brief Sets the parity bit for the given UART slave device.
+ * @details Sets the parity bit for the given UART slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1023,6 +1071,7 @@ EXPORT_API int peripheral_uart_set_parity(peripheral_uart_h uart, peripheral_uar
 /**
  * @platform
  * @brief Sets the number of stop bits for the UART slave device.
+ * @details Sets the number of stop bits for the UART slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1046,6 +1095,7 @@ EXPORT_API int peripheral_uart_set_stop_bits(peripheral_uart_h uart, peripheral_
 /**
  * @platform
  * @brief Sets hardware and software flow control of the UART slave device.
+ * @details Sets hardware and software flow control of the UART slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1073,6 +1123,7 @@ EXPORT_API int peripheral_uart_set_flow_control(peripheral_uart_h uart,
 /**
  * @platform
  * @brief Reads data from the UART slave device into a local buffer.
+ * @details Reads data from the UART slave device into a local buffer.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1098,6 +1149,7 @@ EXPORT_API int peripheral_uart_read(peripheral_uart_h uart, uint8_t *data, uint3
 /**
  * @platform
  * @brief Discards data queued for writing to UART slave device, but not yet transmitted.
+ * @details Discards data queued for writing to UART slave device, but not yet transmitted.
  * @since_tizen 8.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1119,6 +1171,7 @@ EXPORT_API int peripheral_uart_flush(peripheral_uart_h uart);
 /**
  * @platform
  * @brief Waits for all data queued for UART to be transmitted.
+ * @details Waits for all data queued for UART to be transmitted.
  * @since_tizen 8.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1140,6 +1193,7 @@ EXPORT_API int peripheral_uart_drain(peripheral_uart_h uart);
 /**
  * @platform
  * @brief Writes data from a buffer to the UART slave device.
+ * @details Writes data from a buffer to the UART slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1172,12 +1226,14 @@ EXPORT_API int peripheral_uart_write(peripheral_uart_h uart, uint8_t *data, uint
 
 /**
  * @brief An opaque handle representing a SPI peripherals slave device.
+ * @details A handle to a single SPI slave device, for use with most SPI interfaces
  * @since_tizen 4.0
  */
 typedef struct _peripheral_spi_s *peripheral_spi_h;
 
 /**
  * @brief Enumeration of transfer modes for SPI slave devices.
+ * @details Use this to control CPOL and CPHa modes on the device.
  * @since_tizen 4.0
  */
 typedef enum {
@@ -1189,6 +1245,7 @@ typedef enum {
 
 /**
  * @brief Enumeration of bit orders for SPI slave device interfaces.
+ * @details Sets whether the most or the least significant bit goes first
  * @since_tizen 4.0
  */
 typedef enum {
@@ -1199,6 +1256,7 @@ typedef enum {
 /**
  * @platform
  * @brief Opens a SPI slave device and returns a handle representing it.
+ * @details Starts the lifetime of the handle and allocates its needed resources.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1226,6 +1284,7 @@ EXPORT_API int peripheral_spi_open(int bus, int cs, peripheral_spi_h *spi);
 /**
  * @platform
  * @brief Closes the SPI slave device and frees resources associated with the handle.
+ * @details This function should be called at the end of the object's lifetime to avoid a memleak.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1248,6 +1307,7 @@ EXPORT_API int peripheral_spi_close(peripheral_spi_h spi);
 /**
  * @platform
  * @brief Sets the transfer mode for the given SPI slave device.
+ * @details Sets the transfer mode for the given SPI slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1271,6 +1331,7 @@ EXPORT_API int peripheral_spi_set_mode(peripheral_spi_h spi, peripheral_spi_mode
 /**
  * @platform
  * @brief Sets the transfer bit order for given SPI slave device.
+ * @details Sets the transfer bit order for given SPI slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1295,6 +1356,7 @@ EXPORT_API int peripheral_spi_set_bit_order(peripheral_spi_h spi, peripheral_spi
 /**
  * @platform
  * @brief Sets the number of bits per word for given SPI slave device.
+ * @details Sets the number of bits per word for given SPI slave device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1316,6 +1378,7 @@ EXPORT_API int peripheral_spi_set_bits_per_word(peripheral_spi_h spi, uint8_t bi
 /**
  * @platform
  * @brief Sets the board-dependent frequency of the SPI bus.
+ * @details Sets the frequency, in hertz, if the board supports it
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1338,6 +1401,7 @@ EXPORT_API int peripheral_spi_set_frequency(peripheral_spi_h spi, uint32_t freq_
 /**
  * @platform
  * @brief Reads the bytes data from the SPI slave device to a local buffer.
+ * @details Receives data into the specified buffer from the device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1362,6 +1426,7 @@ EXPORT_API int peripheral_spi_read(peripheral_spi_h spi, uint8_t *data, uint32_t
 /**
  * @platform
  * @brief Writes the bytes data buffer to the SPI slave device.
+ * @details Puts data from the specified buffer unto the device.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio
@@ -1386,6 +1451,7 @@ EXPORT_API int peripheral_spi_write(peripheral_spi_h spi, uint8_t *data, uint32_
 /**
  * @platform
  * @brief Exchanges (read and write) the bytes data to the SPI slave device.
+ * @details Performs data switcheroo. Essentially a combined write and read call.
  * @since_tizen 4.0
  * @privlevel platform
  * @privilege http://tizen.org/privilege/peripheralio